BME680 sensor component documentation by arcsur · Pull Request #4432 · home-assistant/home-assistant.io

arcsur · 2018-01-16T09:36:41Z

Description:

Pull request in home-assistant (if applicable): home-assistant/core#11695

Checklist:

Branch: Fixes, changes and adjustments should be created against current. New documentation for platforms/components and features should go to next.
The documentation follow the standards.

frenck

@arcsur I've reviewed the document, could you please take a look at the requested changes? 👍

frenck · 2018-01-16T20:00:07Z

+comments: false
+sharing: true
+footer: true
+logo: raspberry-pi.png


This is actually a sensor by Bosch right? Why show the Raspberry PI logo?

I used the same logo as was used for the BME280 sensor which this is closely related to. It is a directly connected I2C sensor typically used on platforms such as the raspberry pi as it needs a GPIO connection. I am open to any suggestions as to what to change it to but again, I was simply mirroring the existing BME280 component's logo in the existing documentation for consistency.

I've approved the changes. Nevertheless, maybe the logo should be the Bosch logo? Since that is the brand/manufacturer?

Not sure myself either, I'm just bringing it up.

I think for consistency with the BME280, we should keep it as the RPi logo for now. However if anyone wanted to propose a general change later to all these RPi library based sensors, I would not have objections.

The other thing is I have no idea on the requirements to use Bosch's logo and if they would have any objections or possible legal concerns for doing so.

frenck · 2018-01-16T20:00:18Z

+  - platform: bme680
+```
+
+Configuration variables:


Please use the configuration tags, for more information please see:
https://home-assistant.io/developers/documentation/create_page/#configuration

Implemented

frenck · 2018-01-16T20:02:08Z

+---
+
+
+The `bme680` sensor platform allows you to read temperature, humidity, pressure and gas resistance values of a [Bosch BME680 Environmental sensor](https://cdn-shop.adafruit.com/product-files/3660/BME680.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.  In addition, it includes a basic air quality calculation that uses gas resistance and humidity measurements to calculate a percentage based air quality measurement.


Missing comma: humidity, pressure and gas -> humidity, pressure, and gas

I2c -> I2C

I don't believe there should be a comma in front of the and in any form of English. (I am British so I may be missing an American English thing here but some quick Googling shows this to be incorrect.

Ok so some more googling later and this is what seems to be referred to as the "Oxford Comma".
Your documentation standards (https://home-assistant.io/developers/documentation/standards/) specifically states to avoid the Oxford comma:
"Don’t put two spaces after a period and avoid the “Oxford comma”.

frenck · 2018-01-16T20:02:50Z

+- **oversampling_pressure** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 2.
+- **oversampling_humidity** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 4.
+- **filter_size** (*Optional*): IIR filter size as described in the sensor datasheet. Can be 0 (off), 1, 3, 7, 15, 31, 63 or 127. Default is 3.
+- **gas_heater_temperature** (*Optional*): The temperature to heat the hotplate to for gas resistance measurements as descibed in the sensor datasheet.  Can be between 200-400&deg;C. Default is 320&deg;C.


descibed -> described

frenck · 2018-01-16T20:05:52Z

+- **oversampling_humidity** (*Optional*): Oversampling multiplier as described in the sensor datasheet. Can be 0 (no sampling), 1, 2, 4, 8, or 16. Default is 4.
+- **filter_size** (*Optional*): IIR filter size as described in the sensor datasheet. Can be 0 (off), 1, 3, 7, 15, 31, 63 or 127. Default is 3.
+- **gas_heater_temperature** (*Optional*): The temperature to heat the hotplate to for gas resistance measurements as descibed in the sensor datasheet.  Can be between 200-400&deg;C. Default is 320&deg;C.
+- **gas_heater_duration** (*Optional*): The duration to heat the hotplate in milliseconds for gas resistance measurements as descibed in the sensor datasheet.  Can be between 1-4032 ms. In reality you will likely need between 80-100ms to reach a stable temperature.  Using a duration greater than 1000ms is unadvisable as it will essentially result in the heater being continually on due to the 1 second update interval. Default is 150 ms.


descibed -> described

Missing comma: In reality you -> In reality, you

unadvisable -> inadvisable

1 second -> 1-second

frenck · 2018-01-16T20:11:30Z

+
+- **name** (*Optional*): The name of the sensor
+- **i2c_bus** (*Optional*): I2c bus where the sensor is. Defaults to 1, for Raspberry Pi 2, 3 Zero and Zero-W.
+- **i2c_address** (*Optional*): I2c address of the sensor. It is 0x76 or 0x77. Default 0x77.


I2c -> I2C

Fixed for both i2c_bus and i2c_address lines.

frenck · 2018-01-16T20:11:41Z

+
+## {% 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 0x77), add more details to the `configuration.yaml` file:


I2c -> I2C

frenck · 2018-01-16T20:11:49Z

+
+## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
+
+Enable I2c interface with the Raspberry Pi configuration utility:


I2c -> I2C

frenck · 2018-01-16T20:12:06Z

+$ sudo reboot
+```
+
+### {% linkable_title Check the i2c address of the sensor %}


i2c -> I2C

frenck · 2018-01-16T20:12:24Z

+70: -- -- -- -- -- -- -- 76
+```
+
+So you can see the sensor address that you are looking for is **0x76** (there is another i2c device on that Raspberry Pi).


i2c -> I2C

arcsur · 2018-01-19T08:13:24Z

@frenck I have made the changes requested with the exception of the "Oxford Comma" change as that is against the documentation standards and the logo change. Please see the comments against both of these items for more information and let me know if more changes are required.

frenck · 2018-01-19T10:37:21Z

@arcsur I'm not starting a discussion on the Oxford comma, there are enough discussions on it already (virtually everywhere) ;)

frenck · 2018-01-23T08:55:08Z

Parent PR got merged. Merging this one in as well.

arcsur added 2 commits January 16, 2018 17:26

Added documentation for BME680 sensor platform

aa536f7

Removed yr sensor from configuration.yaml example

2617efb

arcsur mentioned this pull request Jan 16, 2018

BME680 Sensor Component home-assistant/core#11695

Merged

9 tasks

frenck added the new-integration This PR adds documentation for a new Home Assistant integration label Jan 16, 2018

frenck requested changes Jan 16, 2018

View reviewed changes

Implemented pull request review comments.

4c05609

arcsur changed the title ~~Bme680~~ BME680 sensor platform documentation Jan 19, 2018

arcsur changed the title ~~BME680 sensor platform documentation~~ BME680 sensor component documentation Jan 19, 2018

frenck self-assigned this Jan 19, 2018

frenck approved these changes Jan 19, 2018

View reviewed changes

frenck removed their assignment Jan 19, 2018

frenck closed this Jan 23, 2018

frenck reopened this Jan 23, 2018

frenck merged commit 65b8334 into home-assistant:next Jan 23, 2018

arcsur deleted the bme680 branch January 24, 2018 10:52

		---


		The `bme680` sensor platform allows you to read temperature, humidity, pressure and gas resistance values of a [Bosch BME680 Environmental sensor](https://cdn-shop.adafruit.com/product-files/3660/BME680.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. In addition, it includes a basic air quality calculation that uses gas resistance and humidity measurements to calculate a percentage based air quality measurement.


		## {% 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 0x77), add more details to the `configuration.yaml` file:


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

		Enable I2c interface with the Raspberry Pi configuration utility:

Uh oh!

Conversation

arcsur commented Jan 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist:

Uh oh!

frenck left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

arcsur commented Jan 19, 2018

Uh oh!

frenck commented Jan 19, 2018

Uh oh!

frenck commented Jan 23, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

arcsur commented Jan 16, 2018 •

edited

Loading