Add documentation for the Enviro pHAT sensor #2557
Conversation
| footer: true | ||
| logo: raspberry-pi.png | ||
| ha_category: Sensor | ||
| ha_iot_class: "Local Push" |
There was a problem hiding this comment.
It was merged but not released yet, what should happen, wait for the actual release, or how to know what the ha_version value should be?
| ha_iot_class: "Local Push" | ||
| --- | ||
|
|
||
| The `envirophat` sensor platform allows you to display information collected by an [Enviro pHATT](https://shop.pimoroni.com/products/enviro-phat) add-on board for the Raspberry Pi. The board featues a wide range of sensors, such as: |
|
|
||
| Configuration variables: | ||
|
|
||
| - **display_options** (*Optional*) array: List of readings to monitor. Defaults is monitoring all of them: |
There was a problem hiding this comment.
"Defaults" should be "Defaults" I believe.
There was a problem hiding this comment.
You mean "Default" (without the plural, right?)
| - **voltage_3**: voltage reading on Analog In 3 in units of V | ||
| - **use_led** (*Optional*) True / False boolean; Default value is False, declaring that the onboard LEDs are *not* used for the color measurements thus these readings are based on the ambient light. If the value is set to True, the onboard LEDs will blink whenever a reading is taken. | ||
|
|
||
| **Notes**: |
There was a problem hiding this comment.
Put ## in front of your note to make it a Title.
| ``` | ||
|
|
||
|
|
||
| ### Directions for installing on Raspberry Pi All-In-One installer and HASSbian: |
There was a problem hiding this comment.
Are the packages not installed by default by the component? If they are this section should really not be needed.
| pip3 install envirophat | ||
| ``` | ||
|
|
||
| #### Enabling the required `i2c-1` device |
There was a problem hiding this comment.
This section is not part of the above comment.
|
|
||
| ### Give the values friendly names & icons | ||
|
|
||
| Add something like the following to your [`customize` section](/docs/configuration/customizing-devices/): |
There was a problem hiding this comment.
I would recommend removing the ` around customize since the formatting is overwritten by the link color.
|
Changes looks really good! 🍰 |
|
Will include the ha_version in one more commit now that I know the correct
value!:)
…On May 4, 2017 19:17, "Fredrik Lindqvist" ***@***.***> wrote:
Changes looks really good! 🍰
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#2557 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AACXz_iYAMJdnKKt7dwaZnCK4OYqVmVWks5r2hYsgaJpZM4NPwSi>
.
|
|
Added updates as mentioned + caught some more. |
* Add documentation for the Enviro pHAT sensor * sensor.envirophat: incorporating feedback * sensor.envirophat: update metadata
|
Cherry-picked for 0.44 |
Description:
Add support for the Enviro pHAT for Raspberry Pi (
sensor.envirophat), see hardwareinfo at https://shop.pimoroni.com/products/enviro-phat
Pull request in home-assistant: home-assistant/core#7427