jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-16 22:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update 'ha_release' and formatting updates

Browse Source
This commit is contained in:
Fabian Affolter 2017-06-22 09:20:04 +02:00
parent 2094220a42
commit ad242d6b3c
No known key found for this signature in database
GPG Key ID: DDF3D6F44AAB1336
3 changed files with 89 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
source/_components/sensor.bh1750.markdown
View File

@ -1,7 +1,7 @@
--- ---
layout: page layout: page
title: "BH1750 Light sensor" title: "BH1750 Light sensor"
description: "Instructions how to integrate a BH1750 light sensor in a Raspberry PI into Home Assistant." description: "Instructions how to integrate a BH1750 light sensor into Home Assistant."
date: 2017-06-10 00:00 date: 2017-06-10 00:00
sidebar: true sidebar: true
comments: false comments: false
@ -9,12 +9,17 @@ sharing: true
footer: true footer: true
logo: raspberry-pi.png logo: raspberry-pi.png
ha_category: Sensor ha_category: Sensor
ha_release: 0.47 ha_release: 0.48
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---
The `bh1750` sensor platform allows you to read the ambient light level in lux from a [BH1750FVI sensor](http://cpre.kmutnb.ac.th/esl/learning/bh1750-light-sensor/bh1750fvi-e_datasheet.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins) to your [Raspberry Pi](https://www.raspberrypi.org/). It allows you to use all the resolution modes of the sensor described in its datasheet. The `bh1750` sensor platform allows you to read the ambient light level in lux from a [BH1750FVI sensor](http://cpre.kmutnb.ac.th/esl/learning/bh1750-light-sensor/bh1750fvi-e_datasheet.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the resolution modes of the sensor described in its datasheet.
Tested devices:
- [Raspberry Pi](https://www.raspberrypi.org/)
To use your BH1750 sensor in your installation, add the following to your `configuration.yaml` file: To use your BH1750 sensor in your installation, add the following to your `configuration.yaml` file:
@ -24,7 +29,19 @@ sensor:
- platform: BH1750 - platform: BH1750
``` ```
Or, if you want to specify the resolution mode of the digital sensor or need to change the default I2c address (which is 0x23), add more details to the yaml config. Configuration variables:
- **name** (*Optional*): The name of the sensor
- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x23 or 0x5C.
- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
- **operation_mode** (*Optional*): Working mode for the sensor. Defaults to `continuous_high_res_mode_1` for continuous measurement and 1 lx resolution.
- **measurement_delay_ms** (*Optional*): Delay time in ms for waiting the sensor to get the measure. Defaults to 120 ms.
- **multiplier** (*Optional*): Correction coefficient to multiply the measured light level. Value between 0.1 and 10. Default is 1.
## {% linkable_title Full Examples %}
If you want to specify the resolution mode of the digital sensor or need to change the default I2c address (which is 0x23), add more details to the `configuration.yaml` file.
The sensor can work with resolutions of 0.5 lx (high res mode 1), 1 lx (high res mode 2) or 4 lx (low res mode), and make measurements continuously or one time each call. To set any of these operation modes, select one of these combinations: `continuous_low_res_mode`, `continuous_high_res_mode_2`, `continuous_high_res_mode_1`, `one_time_high_res_mode_1`, `one_time_high_res_mode_2`, `one_time_low_res_mode`. The sensor can work with resolutions of 0.5 lx (high res mode 1), 1 lx (high res mode 2) or 4 lx (low res mode), and make measurements continuously or one time each call. To set any of these operation modes, select one of these combinations: `continuous_low_res_mode`, `continuous_high_res_mode_2`, `continuous_high_res_mode_1`, `one_time_high_res_mode_1`, `one_time_high_res_mode_2`, `one_time_low_res_mode`.
@ -39,43 +56,36 @@ sensor:
scan_interval: 25 scan_interval: 25
``` ```
Configuration variables: ## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
- **name** (*Optional*): The name of the sensor Enable I2c interface with the Raspberry Pi configuration utility:
- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x23 or 0x5C.
- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
- **operation_mode** (*Optional*): Working mode for the sensor. Defaults to `continuous_high_res_mode_1` for continuous measurement and 1 lx resolution.
- **measurement_delay_ms** (*Optional*): Delay time in ms for waiting the sensor to get the measure. Defaults to 120 ms.
- **multiplier** (*Optional*): Correction coefficient to multiply the measured light level. Value between 0.1 and 10. Default is 1.
### Directions for installing smbus support on Raspberry Pi:
Enable I2c interface with the Raspberry Pi config utility:
```bash ```bash
# pi user environment: Enable i2c interface # pi user environment: Enable i2c interface
sudo raspi-config $ sudo raspi-config
``` ```
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot. Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.
Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group: Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
```bash ```bash
# pi user environment: Install i2c dependencies and utilities # pi user environment: Install i2c dependencies and utilities
sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev $ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
# pi user environment: Add homeassistant user to the i2c group # pi user environment: Add homeassistant user to the i2c group
sudo addgroup homeassistant i2c $ sudo addgroup homeassistant i2c
# pi user environment: Reboot Raspberry Pi to apply changes # pi user environment: Reboot Raspberry Pi to apply changes
sudo reboot $ sudo reboot
``` ```
###### Check the i2c address of the sensor ### {% 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: After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors:
```bash ```bash
/usr/sbin/i2cdetect -y 1 $ /usr/sbin/i2cdetect -y 1
``` ```
It will output a table like this: It will output a table like this:

71
source/_components/sensor.bme280.markdown
View File

@ -1,7 +1,7 @@
--- ---
layout: page layout: page
title: "BME280 Sensor" title: "BME280 Sensor"
description: "Instructions how to integrate a BME280 sensor in a Raspberry PI into Home Assistant." description: "Instructions how to integrate a BME280 sensor into Home Assistant."
date: 2017-06-10 00:00 date: 2017-06-10 00:00
sidebar: true sidebar: true
comments: false comments: false
@ -9,12 +9,16 @@ sharing: true
footer: true footer: true
logo: raspberry-pi.png logo: raspberry-pi.png
ha_category: Sensor ha_category: Sensor
ha_release: 0.47 ha_release: 0.48
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---
The `bme280` sensor platform allows you to read temperature, humidity and pressure values of a [Bosch BME280 Environmental sensor](https://cdn-shop.adafruit.com/datasheets/BST-BME280_DS001-10.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins) to your [Raspberry Pi](https://www.raspberrypi.org/). It allows you to use all the operation modes of the sensor described in its datasheet. The `bme280` sensor platform allows you to read temperature, humidity and pressure values of a [Bosch BME280 Environmental sensor](https://cdn-shop.adafruit.com/datasheets/BST-BME280_DS001-10.pdf) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins). It allows you to use all the operation modes of the sensor described in its datasheet.
Tested devices:
- [Raspberry Pi](https://www.raspberrypi.org/)
To use your BME280 sensor in your installation, add the following to your `configuration.yaml` file: To use your BME280 sensor in your installation, add the following to your `configuration.yaml` file:
@ -24,7 +28,23 @@ sensor:
- platform: bme280 - platform: bme280
``` ```
Or, if you want to specify the working mode of the digital sensor or need to change the default I2c address (which is 0x76), add more details to the yaml config: Configuration variables:
- **name** (*Optional*): The name of the sensor
- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x76 or 0x77.
- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
- **operation_mode** (*Optional*): Power mode for the sensor. Use 2 for forced mode or 3 for normal mode. Defaults to normal mode.
- **time_standby** (*Optional*): Standby time in ms for normal mode of operation as described in the sensor datasheet. Defaults to 5 ms.
- **oversampling_temperature** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1.
- **oversampling_pressure** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1.
- **oversampling_humidity** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1.
- **filter_mode** (*Optional*): IIR filter coeficient as described in the sensor datasheet. Default is 0, for filter off.
- **delta_temperature** (*Optional*): Absolute delta for temperature correction.
- **monitored_conditions** array (*Optional*): Conditions to monitor. Available conditions are *temperature*, *humidity* and *pressure*. By default all three are displayed.
## {% linkable_title Full Examples %}
If you want to specify the working mode of the digital sensor or need to change the default I2c address (which is 0x76), add more details to the `configuration.yaml` file:
```yaml ```yaml
# Example of customized configuration.yaml entry # Example of customized configuration.yaml entry
@ -47,25 +67,9 @@ sensor:
This sensor is somehow famous for generating relatively high temperature measurements compared to other sensors (it looks like self-heating does not feel good for some encapsulations). If you experience this problem, you can define an absolute delta of temperature correction using a negative number. This sensor is somehow famous for generating relatively high temperature measurements compared to other sensors (it looks like self-heating does not feel good for some encapsulations). If you experience this problem, you can define an absolute delta of temperature correction using a negative number.
Configuration variables: ## {% linkable_title Customizing the sensor data %}
- **name** (*Optional*): The name of the sensor Give the values friendly names and icons, add the following to your `customize:` section.
- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x76 or 0x77.
- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
- **operation_mode** (*Optional*): Power mode for the sensor. Use 2 for forced mode or 3 for normal mode. Defaults to normal mode.
- **time_standby** (*Optional*): Standby time in ms for normal mode of operation as described in the sensor datasheet. Defaults to 5 ms.
- **oversampling_temperature** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1.
- **oversampling_pressure** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1.
- **oversampling_humidity** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 1.
- **filter_mode** (*Optional*): IIR filter coeficient as described in the sensor datasheet. Default is 0, for filter off.
- **delta_temperature** (*Optional*): Absolute delta for temperature correction.
- **monitored_conditions** array (*Optional*): Conditions to monitor. Available conditions are *temperature*, *humidity* and *pressure*. By default all three are displayed.
#### Customizing the sensor data
**Give the values friendly names & icons**
Add the following to your `customize`
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -81,9 +85,7 @@ customize:
friendly_name: "Pressure" friendly_name: "Pressure"
``` ```
**Create a group** To create a group, add the following to your `groups` section.
Add the following to your `groups`
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -96,38 +98,39 @@ group:
- sensor.ambient_pressure - sensor.ambient_pressure
``` ```
## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
### Directions for installing smbus support on Raspberry Pi: Enable I2c interface with the Raspberry Pi configuration utility:
Enable I2c interface with the Raspberry Pi config utility:
```bash ```bash
# pi user environment: Enable i2c interface # pi user environment: Enable i2c interface
sudo raspi-config $ sudo raspi-config
``` ```
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot. Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.
Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group: Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
```bash ```bash
# pi user environment: Install i2c dependencies and utilities # pi user environment: Install i2c dependencies and utilities
sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev $ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
# pi user environment: Add homeassistant user to the i2c group # pi user environment: Add homeassistant user to the i2c group
sudo addgroup homeassistant i2c $ sudo addgroup homeassistant i2c
# pi user environment: Reboot Raspberry Pi to apply changes # pi user environment: Reboot Raspberry Pi to apply changes
sudo reboot $ sudo reboot
``` ```
###### Check the i2c address of the sensor ### {% 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: After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors:
```bash ```bash
/usr/sbin/i2cdetect -y 1 $ /usr/sbin/i2cdetect -y 1
``` ```
It will output a table like this: It will output a table like this:
```text ```text
0 1 2 3 4 5 6 7 8 9 a b c d e f 0 1 2 3 4 5 6 7 8 9 a b c d e f
00: -- -- -- -- -- -- -- -- -- -- -- -- -- 00: -- -- -- -- -- -- -- -- -- -- -- -- --

39
source/_components/sensor.htu21d.markdown
View File

@ -1,7 +1,7 @@
--- ---
layout: page layout: page
title: "HTU21D Temperature and humidity sensor" title: "HTU21D Temperature and humidity sensor"
description: "Instructions how to integrate a HTU21D Temperature and humidity sensor in a Raspberry PI into Home Assistant." description: "Instructions how to integrate a HTU21D Temperature and humidity sensor into Home Assistant."
date: 2017-06-10 00:00 date: 2017-06-10 00:00
sidebar: true sidebar: true
comments: false comments: false
@ -9,12 +9,16 @@ sharing: true
footer: true footer: true
logo: raspberry-pi.png logo: raspberry-pi.png
ha_category: Sensor ha_category: Sensor
ha_release: 0.47 ha_release: 0.48
ha_iot_class: "Local Push" ha_iot_class: "Local Push"
--- ---
The `htu21d` sensor platform allows you to read the temperature and humidity from a [HTU21D sensor](http://www.datasheetspdf.com/PDF/HTU21D/779951/1) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins) to your [Raspberry Pi](https://www.raspberrypi.org/). The `htu21d` sensor platform allows you to read the temperature and humidity from a [HTU21D sensor](http://www.datasheetspdf.com/PDF/HTU21D/779951/1) connected via [I2c](https://en.wikipedia.org/wiki/I²C) bus (SDA, SCL pins).
Tested devices:
- [Raspberry Pi](https://www.raspberrypi.org/)
To use your HTU21D sensor in your installation, add the following to your `configuration.yaml` file: To use your HTU21D sensor in your installation, add the following to your `configuration.yaml` file:
@ -29,11 +33,10 @@ Configuration variables:
- **name** (*Optional*): The name of the sensor - **name** (*Optional*): The name of the sensor
- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3. - **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
#### Customizing the sensor data
**Give the values friendly names & icons** ## {% Customizing the sensor data %}
Add the following to your `customize` Give the values friendly names and icons, add the following to your `customize:` section.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -46,9 +49,7 @@ customize:
friendly_name: "Humidity" friendly_name: "Humidity"
``` ```
**Create a group** To create a group, add the following to your `groups` section.
Add the following to your `groups`
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -60,37 +61,39 @@ group:
- sensor.htu21d_sensor_humidity - sensor.htu21d_sensor_humidity
``` ```
### Directions for installing smbus support on Raspberry Pi: ## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
Enable I2c interface with the Raspberry Pi configuration utility:
Enable I2c interface with the Raspberry Pi config utility:
```bash ```bash
# pi user environment: Enable i2c interface # pi user environment: Enable i2c interface
sudo raspi-config $ sudo raspi-config
``` ```
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot. Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.
Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group: Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
```bash ```bash
# pi user environment: Install i2c dependencies and utilities # pi user environment: Install i2c dependencies and utilities
sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev $ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
# pi user environment: Add homeassistant user to the i2c group # pi user environment: Add homeassistant user to the i2c group
sudo addgroup homeassistant i2c $ sudo addgroup homeassistant i2c
# pi user environment: Reboot Raspberry Pi to apply changes # pi user environment: Reboot Raspberry Pi to apply changes
sudo reboot $ sudo reboot
``` ```
###### Check the i2c address of the sensor ### {% 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: After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors:
```bash ```bash
/usr/sbin/i2cdetect -y 1 $ /usr/sbin/i2cdetect -y 1
``` ```
It will output a table like this: It will output a table like this:
```text ```text
0 1 2 3 4 5 6 7 8 9 a b c d e f 0 1 2 3 4 5 6 7 8 9 a b c d e f
00: -- -- -- -- -- -- -- -- -- -- -- -- -- 00: -- -- -- -- -- -- -- -- -- -- -- -- --