Skip to content

Commit ad242d6

Browse files
committed
Update 'ha_release' and formatting updates
1 parent 2094220 commit ad242d6

File tree

3 files changed

+89
-73
lines changed

3 files changed

+89
-73
lines changed

source/_components/sensor.bh1750.markdown

Lines changed: 31 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
---
22
layout: page
33
title: "BH1750 Light sensor"
4-
description: "Instructions how to integrate a BH1750 light sensor in a Raspberry PI into Home Assistant."
4+
description: "Instructions how to integrate a BH1750 light sensor into Home Assistant."
55
date: 2017-06-10 00:00
66
sidebar: true
77
comments: false
88
sharing: true
99
footer: true
1010
logo: raspberry-pi.png
1111
ha_category: Sensor
12-
ha_release: 0.47
12+
ha_release: 0.48
1313
ha_iot_class: "Local Push"
1414
---
1515

1616

17-
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.
17+
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.
18+
19+
Tested devices:
20+
21+
- [Raspberry Pi](https://www.raspberrypi.org/)
22+
1823

1924
To use your BH1750 sensor in your installation, add the following to your `configuration.yaml` file:
2025

@@ -24,7 +29,19 @@ sensor:
2429
- platform: BH1750
2530
```
2631
27-
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.
32+
Configuration variables:
33+
34+
- **name** (*Optional*): The name of the sensor
35+
- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x23 or 0x5C.
36+
- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
37+
- **operation_mode** (*Optional*): Working mode for the sensor. Defaults to `continuous_high_res_mode_1` for continuous measurement and 1 lx resolution.
38+
- **measurement_delay_ms** (*Optional*): Delay time in ms for waiting the sensor to get the measure. Defaults to 120 ms.
39+
- **multiplier** (*Optional*): Correction coefficient to multiply the measured light level. Value between 0.1 and 10. Default is 1.
40+
41+
42+
## {% linkable_title Full Examples %}
43+
44+
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.
2845

2946
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`.
3047

@@ -39,43 +56,36 @@ sensor:
3956
scan_interval: 25
4057
```
4158

42-
Configuration variables:
43-
44-
- **name** (*Optional*): The name of the sensor
45-
- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x23 or 0x5C.
46-
- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
47-
- **operation_mode** (*Optional*): Working mode for the sensor. Defaults to `continuous_high_res_mode_1` for continuous measurement and 1 lx resolution.
48-
- **measurement_delay_ms** (*Optional*): Delay time in ms for waiting the sensor to get the measure. Defaults to 120 ms.
49-
- **multiplier** (*Optional*): Correction coefficient to multiply the measured light level. Value between 0.1 and 10. Default is 1.
50-
59+
## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
5160

52-
### Directions for installing smbus support on Raspberry Pi:
61+
Enable I2c interface with the Raspberry Pi configuration utility:
5362

54-
Enable I2c interface with the Raspberry Pi config utility:
5563
```bash
5664
# pi user environment: Enable i2c interface
57-
sudo raspi-config
65+
$ sudo raspi-config
5866
```
67+
5968
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.
6069

6170
Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
71+
6272
```bash
6373
# pi user environment: Install i2c dependencies and utilities
64-
sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
74+
$ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
6575
6676
# pi user environment: Add homeassistant user to the i2c group
67-
sudo addgroup homeassistant i2c
77+
$ sudo addgroup homeassistant i2c
6878
6979
# pi user environment: Reboot Raspberry Pi to apply changes
70-
sudo reboot
80+
$ sudo reboot
7181
```
7282

73-
###### Check the i2c address of the sensor
83+
### {% linkable_title Check the i2c address of the sensor %}
7484

7585
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors:
7686

7787
```bash
78-
/usr/sbin/i2cdetect -y 1
88+
$ /usr/sbin/i2cdetect -y 1
7989
```
8090

8191
It will output a table like this:

source/_components/sensor.bme280.markdown

Lines changed: 37 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
---
22
layout: page
33
title: "BME280 Sensor"
4-
description: "Instructions how to integrate a BME280 sensor in a Raspberry PI into Home Assistant."
4+
description: "Instructions how to integrate a BME280 sensor into Home Assistant."
55
date: 2017-06-10 00:00
66
sidebar: true
77
comments: false
88
sharing: true
99
footer: true
1010
logo: raspberry-pi.png
1111
ha_category: Sensor
12-
ha_release: 0.47
12+
ha_release: 0.48
1313
ha_iot_class: "Local Push"
1414
---
1515

1616

17-
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.
17+
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.
18+
19+
Tested devices:
20+
21+
- [Raspberry Pi](https://www.raspberrypi.org/)
1822

1923
To use your BME280 sensor in your installation, add the following to your `configuration.yaml` file:
2024

@@ -24,7 +28,23 @@ sensor:
2428
- platform: bme280
2529
```
2630
27-
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:
31+
Configuration variables:
32+
33+
- **name** (*Optional*): The name of the sensor
34+
- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x76 or 0x77.
35+
- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
36+
- **operation_mode** (*Optional*): Power mode for the sensor. Use 2 for forced mode or 3 for normal mode. Defaults to normal mode.
37+
- **time_standby** (*Optional*): Standby time in ms for normal mode of operation as described in the sensor datasheet. Defaults to 5 ms.
38+
- **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.
39+
- **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.
40+
- **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.
41+
- **filter_mode** (*Optional*): IIR filter coeficient as described in the sensor datasheet. Default is 0, for filter off.
42+
- **delta_temperature** (*Optional*): Absolute delta for temperature correction.
43+
- **monitored_conditions** array (*Optional*): Conditions to monitor. Available conditions are *temperature*, *humidity* and *pressure*. By default all three are displayed.
44+
45+
## {% linkable_title Full Examples %}
46+
47+
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:
2848

2949
```yaml
3050
# Example of customized configuration.yaml entry
@@ -47,25 +67,9 @@ sensor:
4767

4868
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.
4969

50-
Configuration variables:
51-
52-
- **name** (*Optional*): The name of the sensor
53-
- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x76 or 0x77.
54-
- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
55-
- **operation_mode** (*Optional*): Power mode for the sensor. Use 2 for forced mode or 3 for normal mode. Defaults to normal mode.
56-
- **time_standby** (*Optional*): Standby time in ms for normal mode of operation as described in the sensor datasheet. Defaults to 5 ms.
57-
- **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.
58-
- **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.
59-
- **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.
60-
- **filter_mode** (*Optional*): IIR filter coeficient as described in the sensor datasheet. Default is 0, for filter off.
61-
- **delta_temperature** (*Optional*): Absolute delta for temperature correction.
62-
- **monitored_conditions** array (*Optional*): Conditions to monitor. Available conditions are *temperature*, *humidity* and *pressure*. By default all three are displayed.
63-
64-
#### Customizing the sensor data
65-
66-
**Give the values friendly names & icons**
70+
## {% linkable_title Customizing the sensor data %}
6771

68-
Add the following to your `customize`
72+
Give the values friendly names and icons, add the following to your `customize:` section.
6973

7074
```yaml
7175
# Example configuration.yaml entry
@@ -81,9 +85,7 @@ customize:
8185
friendly_name: "Pressure"
8286
```
8387

84-
**Create a group**
85-
86-
Add the following to your `groups`
88+
To create a group, add the following to your `groups` section.
8789

8890
```yaml
8991
# Example configuration.yaml entry
@@ -96,38 +98,39 @@ group:
9698
- sensor.ambient_pressure
9799
```
98100

101+
## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
99102

100-
### Directions for installing smbus support on Raspberry Pi:
103+
Enable I2c interface with the Raspberry Pi configuration utility:
101104

102-
Enable I2c interface with the Raspberry Pi config utility:
103105
```bash
104106
# pi user environment: Enable i2c interface
105-
sudo raspi-config
107+
$ sudo raspi-config
106108
```
109+
107110
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.
108111

109112
Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
113+
110114
```bash
111115
# pi user environment: Install i2c dependencies and utilities
112-
sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
116+
$ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
113117
114118
# pi user environment: Add homeassistant user to the i2c group
115-
sudo addgroup homeassistant i2c
119+
$ sudo addgroup homeassistant i2c
116120
117121
# pi user environment: Reboot Raspberry Pi to apply changes
118-
sudo reboot
122+
$ sudo reboot
119123
```
120124

121-
###### Check the i2c address of the sensor
125+
### {% linkable_title Check the i2c address of the sensor %}
122126

123127
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors:
124128

125129
```bash
126-
/usr/sbin/i2cdetect -y 1
130+
$ /usr/sbin/i2cdetect -y 1
127131
```
128132

129133
It will output a table like this:
130-
131134
```text
132135
0 1 2 3 4 5 6 7 8 9 a b c d e f
133136
00: -- -- -- -- -- -- -- -- -- -- -- -- --

source/_components/sensor.htu21d.markdown

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
---
22
layout: page
33
title: "HTU21D Temperature and humidity sensor"
4-
description: "Instructions how to integrate a HTU21D Temperature and humidity sensor in a Raspberry PI into Home Assistant."
4+
description: "Instructions how to integrate a HTU21D Temperature and humidity sensor into Home Assistant."
55
date: 2017-06-10 00:00
66
sidebar: true
77
comments: false
88
sharing: true
99
footer: true
1010
logo: raspberry-pi.png
1111
ha_category: Sensor
12-
ha_release: 0.47
12+
ha_release: 0.48
1313
ha_iot_class: "Local Push"
1414
---
1515

1616

17-
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/).
17+
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).
18+
19+
Tested devices:
20+
21+
- [Raspberry Pi](https://www.raspberrypi.org/)
1822

1923
To use your HTU21D sensor in your installation, add the following to your `configuration.yaml` file:
2024

@@ -29,11 +33,10 @@ Configuration variables:
2933
- **name** (*Optional*): The name of the sensor
3034
- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2 and 3.
3135
32-
#### Customizing the sensor data
3336
34-
**Give the values friendly names & icons**
37+
## {% Customizing the sensor data %}
3538
36-
Add the following to your `customize`
39+
Give the values friendly names and icons, add the following to your `customize:` section.
3740

3841
```yaml
3942
# Example configuration.yaml entry
@@ -46,9 +49,7 @@ customize:
4649
friendly_name: "Humidity"
4750
```
4851

49-
**Create a group**
50-
51-
Add the following to your `groups`
52+
To create a group, add the following to your `groups` section.
5253

5354
```yaml
5455
# Example configuration.yaml entry
@@ -60,37 +61,39 @@ group:
6061
- sensor.htu21d_sensor_humidity
6162
```
6263

63-
### Directions for installing smbus support on Raspberry Pi:
64+
## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
65+
66+
Enable I2c interface with the Raspberry Pi configuration utility:
6467

65-
Enable I2c interface with the Raspberry Pi config utility:
6668
```bash
6769
# pi user environment: Enable i2c interface
68-
sudo raspi-config
70+
$ sudo raspi-config
6971
```
72+
7073
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish` and you'll be prompted to reboot.
7174

7275
Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
76+
7377
```bash
7478
# pi user environment: Install i2c dependencies and utilities
75-
sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
79+
$ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
7680
7781
# pi user environment: Add homeassistant user to the i2c group
78-
sudo addgroup homeassistant i2c
82+
$ sudo addgroup homeassistant i2c
7983
8084
# pi user environment: Reboot Raspberry Pi to apply changes
81-
sudo reboot
85+
$ sudo reboot
8286
```
8387

84-
###### Check the i2c address of the sensor
88+
### {% linkable_title Check the i2c address of the sensor %}
8589

8690
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors:
8791

8892
```bash
89-
/usr/sbin/i2cdetect -y 1
93+
$ /usr/sbin/i2cdetect -y 1
9094
```
9195

9296
It will output a table like this:
93-
9497
```text
9598
0 1 2 3 4 5 6 7 8 9 a b c d e f
9699
00: -- -- -- -- -- -- -- -- -- -- -- -- --

0 commit comments

Comments
 (0)