mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-02 09:17:35 +00:00
1aca7b08cf
* e.g. to e.g., and proper case for Home Assistant * Instructions how to -> Instructions on how to
91 lines
3.1 KiB
Markdown
91 lines
3.1 KiB
Markdown
---
|
||
layout: page
|
||
title: "Raspihats Binary Sensor"
|
||
description: "Instructions on how to integrate Raspihats add-on boards for Raspberry Pi into Home Assistant as a binary_sensor."
|
||
date: 2017-05-01 04:09
|
||
sidebar: true
|
||
comments: false
|
||
sharing: true
|
||
footer: true
|
||
logo: raspihats.png
|
||
ha_category: Binary Sensor
|
||
ha_release: 0.44
|
||
ha_iot_class: "Local Push"
|
||
---
|
||
|
||
The `raspihats` binary sensor platform allows you to read sensor values using the digital inputs of the [raspihats](http://www.raspihats.com/) boards.
|
||
|
||
To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file:
|
||
|
||
```yaml
|
||
# Example configuration.yaml entry
|
||
binary_sensor:
|
||
- platform: raspihats
|
||
i2c_hats:
|
||
- board: DI6acDQ6rly
|
||
address: 0x60
|
||
channels:
|
||
- index: 0
|
||
name: PIR Office
|
||
invert_logic: true
|
||
device_class: motion
|
||
- index: 1
|
||
name: PIR Bedroom
|
||
```
|
||
|
||
Configuration variables:
|
||
|
||
- **i2c_hats** (*Optional*): Array of used I2C-HATs.
|
||
- **board** (*Required*): The board name [Di16, Di6Rly6, DI16ac, DI6acDQ6rly].
|
||
- **address** (*Required*): The board I2C address, hex value.
|
||
- **channels** (*Required*): Array of used digital input channels.
|
||
- **index** (*Required*): Digital input channel index.
|
||
- **name** (*Required*): Friendly name to use for the frontend.
|
||
- **invert_logic** (*Optional*): Inverts the input logic, default is `false`.
|
||
- **device_class** (*Optional*): See device classes in [binary_sensor component](/components/binary_sensor/), default is `None`
|
||
|
||
## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
|
||
|
||
Enable I2c interface with the Raspberry Pi configuration utility:
|
||
|
||
```bash
|
||
# pi user environment: Enable i2c interface
|
||
$ sudo raspi-config
|
||
```
|
||
|
||
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish`.
|
||
|
||
Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
|
||
|
||
```bash
|
||
# pi user environment: Install i2c dependencies and utilities
|
||
$ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
|
||
|
||
# pi user environment: Add homeassistant user to the i2c group
|
||
$ sudo usermod -a -G i2c homeassistant
|
||
```
|
||
|
||
### {% linkable_title Check the i2c address of the sensor %}
|
||
|
||
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address:
|
||
|
||
```bash
|
||
$ /usr/sbin/i2cdetect -y 1
|
||
```
|
||
|
||
It will output a table like this:
|
||
|
||
```text
|
||
0 1 2 3 4 5 6 7 8 9 a b c d e f
|
||
00: -- -- -- -- -- -- -- -- -- -- -- -- --
|
||
10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
|
||
20: -- -- -- 23 -- -- -- -- -- -- -- -- -- -- -- --
|
||
30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
|
||
40: 40 -- -- -- -- -- UU -- -- -- -- -- -- -- -- --
|
||
50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
|
||
60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
|
||
70: -- -- -- -- -- -- -- 77
|
||
```
|
||
|
||
For more details about the `raspihats` add-on boards for Raspberry Pi, visit [raspihats.com](http://www.raspihats.com/).
|