Skip to content

add BME280 sensor platform doc #2797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 22, 2017
Merged

add BME280 sensor platform doc #2797

merged 5 commits into from
Jun 22, 2017

Conversation

azogue
Copy link
Member

@azogue azogue commented Jun 10, 2017

Description:

Documentation for new sensor platform: BME280. It includes directions for installing the needed dependencies and more.

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

@fabaff fabaff added the new-integration This PR adds documentation for a new Home Assistant integration label Jun 12, 2017
Copy link
Contributor

@Landrash Landrash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good with some minor feedback.


###### Check the i2c address of the sensor

If you have `sudo apt-get install i2c-tools`, you can call the i2c device detector with:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some rephrasing of this sentence would be preferable.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Landrash, thanks for reviewing!

What about now?

# Example configuration.yaml entry
sensor:
- platform: bme280
name: Ambient
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Name can be removed from this example since it's an optional variable.

Copy link
Contributor

@Landrash Landrash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good and can be merged after parent PR is merged.

@azogue
Copy link
Member Author

azogue commented Jun 15, 2017

hi @Landrash,

PRs #2820 and #2821 are related to this and share the section about the i2c install and i2c address detection. I don't know if there is another place in the doc to add these common instructions, and link in each sensor doc.

In addition, I'm waiting for review for the three I2c sensors, and @fabaff was telling me about making a i2c component where to append the i2c sensors as platforms, but the conversation is not over yet, so I don't know if the common section should go on a future new component page. For now I added it to all three.

@Landrash
Copy link
Contributor

@azogue I'll review the other also. Nice to se more native support for sensors on the pi's. Have you by any chance tried this out on any of the other SOC platforms?

@azogue
Copy link
Member Author

azogue commented Jun 16, 2017

Sorry @Landrash, I only have raspberries (but I have a lot!). These sensors are working smoothly in Raspberry Pi 2, RPI 3 and RPI Zero W, I could test them also in an ancient RPI 1 rev B, but I suppose it will work too.
For other SOC platforms with a I2c bus handled with smbus-cffi I understand that there would be no problem, but I can't say, hence the title only refers to the Raspberry Pi.

Thank you very much for your attention, btw

@azogue
Copy link
Member Author

azogue commented Jun 16, 2017

text highlighting here too

Copy link
Member

@fabaff fabaff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 🐦

@fabaff fabaff merged commit 937a282 into home-assistant:next Jun 22, 2017
@azogue azogue deleted the sensor-bme280 branch July 8, 2017 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-integration This PR adds documentation for a new Home Assistant integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants