👕 Markdown fixes (#8916)

This commit is contained in:
Franck Nijhof 2019-03-12 16:14:23 +01:00 committed by GitHub
parent 5842625a21
commit 0145d48812
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
46 changed files with 99 additions and 148 deletions

View File

@ -13,7 +13,6 @@ ha_release: 0.35
ha_iot_class: Cloud Polling ha_iot_class: Cloud Polling
--- ---
Integrate your [Hydro-Québec](https://www.hydroquebec.com/portail/) consumption profile information into Home Assistant. Integrate your [Hydro-Québec](https://www.hydroquebec.com/portail/) consumption profile information into Home Assistant.
<p class='note warning'> <p class='note warning'>

View File

@ -13,7 +13,6 @@ ha_release: 0.25
ha_iot_class: Cloud Push ha_iot_class: Cloud Push
--- ---
The `imap` sensor platform is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol) and reporting the amount of unread emails. The `imap` sensor platform is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol) and reporting the amount of unread emails.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}

View File

@ -98,7 +98,6 @@ queries:
default: value default: value
{% endconfiguration %} {% endconfiguration %}
## {% linkable_title Examples %} ## {% linkable_title Examples %}
### {% linkable_title Full configuration %} ### {% linkable_title Full configuration %}

View File

@ -29,7 +29,6 @@ sensor:
address: '2/0/0' address: '2/0/0'
``` ```
{% configuration %} {% configuration %}
address: address:
description: KNX group address of the sensor. description: KNX group address of the sensor.
@ -45,7 +44,6 @@ type:
type: string type: string
{% endconfiguration %} {% endconfiguration %}
| type | unit | expected KNX DPT | | type | unit | expected KNX DPT |
|--------------------|------|------------------| |--------------------|------|------------------|
| percent | % | 5.001 | | percent | % | 5.001 |
@ -79,8 +77,6 @@ type:
| DPT-14 | | 14.* | | DPT-14 | | 14.* |
| 4byte_float | | 14.* | | 4byte_float | | 14.* |
## {% linkable_title Full example %} ## {% linkable_title Full example %}
```yaml ```yaml

View File

@ -13,11 +13,11 @@ ha_iot_class: Local Polling
ha_release: "0.40" ha_release: "0.40"
--- ---
The `kwb` component integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller (http://www.kwbheizung.de/de/produkte/kwb-comfort-3.html) into Home Assistant. The `kwb` component integrates the sensors of KWB Easyfire pellet central heating units with the Comfort3 controller (<http://www.kwbheizung.de/de/produkte/kwb-comfort-3.html>) into Home Assistant.
Direct connection via serial (RS485) or via telnet terminal server is supported. The serial cable has to be attached to the control unit port 25 (which is normally used for detached control terminals). Direct connection via serial (RS485) or via telnet terminal server is supported. The serial cable has to be attached to the control unit port 25 (which is normally used for detached control terminals).
Since this serial protocol is proprietary and closed, only most temperature sensors and a few control relays are supported, the rest is still WIP (see https://www.mikrocontroller.net/topic/274137). Since this serial protocol is proprietary and closed, only most temperature sensors and a few control relays are supported, the rest is still WIP (see <https://www.mikrocontroller.net/topic/274137>).
Direct connection via serial port: Direct connection via serial port:

View File

@ -15,7 +15,7 @@ ha_iot_class: Local Polling
The `lacrosse` sensor platform is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip). The `lacrosse` sensor platform is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip).
### {% linkable_title Tested Devices %} ## {% linkable_title Tested Devices %}
- Technoline TX 29 IT (temperature only) - Technoline TX 29 IT (temperature only)
- Technoline TX 29 DTH-IT (including humidity) - Technoline TX 29 DTH-IT (including humidity)
@ -25,7 +25,7 @@ The `lacrosse` sensor platform is using the data provided by a [Jeelink](https:/
Since the sensor change their ID after each powercycle/battery change you can check what sensor IDs are available by using the command-line tool `pylacrosse` from the pylacrosse package. Since the sensor change their ID after each powercycle/battery change you can check what sensor IDs are available by using the command-line tool `pylacrosse` from the pylacrosse package.
```bash ```bash
$ sudo pylacrosse -d /dev/ttyUSB0 scan sudo pylacrosse -d /dev/ttyUSB0 scan
``` ```
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
@ -92,7 +92,6 @@ sensor:
type: integer type: integer
{% endconfiguration %} {% endconfiguration %}
## {% linkable_title Examples %} ## {% linkable_title Examples %}
To setup a lacrosse sensor with multiple sensors, add the following to your `configuration.yaml` file: To setup a lacrosse sensor with multiple sensors, add the following to your `configuration.yaml` file:
@ -119,4 +118,3 @@ sensor:
id: 72 id: 72
``` ```
{% endraw %} {% endraw %}

View File

@ -13,7 +13,6 @@ ha_iot_class: Cloud Polling
ha_release: "0.20" ha_release: "0.20"
--- ---
The `lastfm` sensor platform will allow you to see whenever a user starts scrobbling, their play count, last song played, and top song played on [Last.fm](http://www.last.fm). The `lastfm` sensor platform will allow you to see whenever a user starts scrobbling, their play count, last song played, and top song played on [Last.fm](http://www.last.fm).
## {% linkable_title Setup %} ## {% linkable_title Setup %}

View File

@ -13,7 +13,6 @@ ha_category: Energy
ha_iot_class: Cloud Polling ha_iot_class: Cloud Polling
--- ---
The `linky` sensor platform is showing the last day consumption of your home from the [Linky electric meter](https://www.enedis.fr/english). The `linky` sensor platform is showing the last day consumption of your home from the [Linky electric meter](https://www.enedis.fr/english).
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
@ -38,4 +37,3 @@ password:
required: true required: true
type: string type: string
{% endconfiguration %} {% endconfiguration %}

View File

@ -13,14 +13,12 @@ ha_iot_class: Cloud Polling
ha_release: 0.52 ha_release: 0.52
--- ---
The `london_air` component [queries](http://api.erg.kcl.ac.uk/AirQuality/Hourly/MonitoringIndex/GroupName=London/Json) the London air quality [data feed](https://www.londonair.org.uk/LondonAir/API/) provided by Kings College London. A single sensor will be added for each `location` ([local authority district or borough](https://en.wikipedia.org/wiki/List_of_London_boroughs)) specified in the configuration file. The state of each sensor is the overall air quality in that borough. Note that only 28 of the 32 boroughs have data available. The `london_air` component [queries](http://api.erg.kcl.ac.uk/AirQuality/Hourly/MonitoringIndex/GroupName=London/Json) the London air quality [data feed](https://www.londonair.org.uk/LondonAir/API/) provided by Kings College London. A single sensor will be added for each `location` ([local authority district or borough](https://en.wikipedia.org/wiki/List_of_London_boroughs)) specified in the configuration file. The state of each sensor is the overall air quality in that borough. Note that only 28 of the 32 boroughs have data available.
Boroughs can have multiple monitoring sites at different geographical positions within the borough, and each of those sites can monitor up to six different kinds of pollutant. The pollutants are described [here](http://api.erg.kcl.ac.uk/AirQuality/Information/Species/Json) and are Carbon Monoxide ([CO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsCO.aspx)), Nitrogen Dioxide ([NO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsNO2.aspx)), Ozone ([O3](http://www.londonair.org.uk/LondonAir/guide/WhatIsO3.aspx)), Sulfur Dioxide ([SO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsSO2.aspx)), PM2.5 & PM10 [particulates](http://www.londonair.org.uk/LondonAir/guide/WhatIsPM.aspx). The `latitude` and `longitude` of each site is accessible through a `data` attribute of the sensor, as are details about the pollutants monitored at that site. The `sites` attribute of a sensor displays how many monitoring sites that sensor covers. The `updated` attribute of a sensor states when the data was last published. Nominally data is published hourly, but in my experience this can vary. To limit the number of requests made by the sensor, a single API request is made every 30 minutes. Boroughs can have multiple monitoring sites at different geographical positions within the borough, and each of those sites can monitor up to six different kinds of pollutant. The pollutants are described [here](http://api.erg.kcl.ac.uk/AirQuality/Information/Species/Json) and are Carbon Monoxide ([CO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsCO.aspx)), Nitrogen Dioxide ([NO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsNO2.aspx)), Ozone ([O3](http://www.londonair.org.uk/LondonAir/guide/WhatIsO3.aspx)), Sulfur Dioxide ([SO2](http://www.londonair.org.uk/LondonAir/guide/WhatIsSO2.aspx)), PM2.5 & PM10 [particulates](http://www.londonair.org.uk/LondonAir/guide/WhatIsPM.aspx). The `latitude` and `longitude` of each site is accessible through a `data` attribute of the sensor, as are details about the pollutants monitored at that site. The `sites` attribute of a sensor displays how many monitoring sites that sensor covers. The `updated` attribute of a sensor states when the data was last published. Nominally data is published hourly, but in my experience this can vary. To limit the number of requests made by the sensor, a single API request is made every 30 minutes.
To add sensors to Home-assistant for all possible areas/boroughs add the following to your `configuration.yaml` file: To add sensors to Home-assistant for all possible areas/boroughs add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry for a single sensor # Example configuration.yaml entry for a single sensor
sensor: sensor:

View File

@ -13,10 +13,8 @@ ha_iot_class: Cloud Polling
ha_release: 0.49 ha_release: 0.49
--- ---
The `london_underground` sensor will display the status of London underground lines, as well as the Overground, DLR and Tfl rail. The `london_underground` sensor will display the status of London underground lines, as well as the Overground, DLR and Tfl rail.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
sensor: sensor:

View File

@ -94,5 +94,4 @@ units:
description: Use US units. description: Use US units.
{% endconfiguration %} {% endconfiguration %}
Details about the API are available in the [Magicseaweed documentation](https://magicseaweed.com/developer/forecast-api). Details about the API are available in the [Magicseaweed documentation](https://magicseaweed.com/developer/forecast-api).

View File

@ -14,7 +14,7 @@ Sensors are gathering information about states and conditions.
Home Assistant currently supports a wide range of sensors. They are able to display information which are provides by Home Assistant directly, are gathered from web services, and, of course, physical devices. Please check the sidebar for a full list of supported sensor platforms. Home Assistant currently supports a wide range of sensors. They are able to display information which are provides by Home Assistant directly, are gathered from web services, and, of course, physical devices. Please check the sidebar for a full list of supported sensor platforms.
### {% linkable_title Device Class %} ## {% linkable_title Device Class %}
The way these sensors are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for sensors: The way these sensors are displayed in the frontend can be modified in the [customize section](/docs/configuration/customizing-devices/). The following device classes are supported for sensors:

View File

@ -13,7 +13,6 @@ ha_iot_class: Local Polling
ha_release: 0.32 ha_release: 0.32
--- ---
The `mfi` sensor platform to allow you to monitor [mFi mPort interface and sensors](https://www.ubnt.com/mfi/mport/). The `mfi` sensor platform to allow you to monitor [mFi mPort interface and sensors](https://www.ubnt.com/mfi/mport/).
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}

View File

@ -22,8 +22,8 @@ Depending on the operating system you're running, you have to configure the prop
- On [Hass.io](/hassio/installation/): `mitemp_bt` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does). - On [Hass.io](/hassio/installation/): `mitemp_bt` will work out of the box as long as the host supports Bluetooth (like the Raspberry Pi does).
- On a [generic Docker installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host. - On a [generic Docker installation](/docs/installation/docker/): Works out of the box with `--net=host` and properly configured Bluetooth on the host.
- On other Linux systems: - On other Linux systems:
- Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one. - Preferred solution: Install the `bluepy` and `btlewrap` library (via pip). When using a virtual environment, make sure to use install the library in the right one.
- Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`. - Fallback solution: Install `btlewrap` library (via pip) and `gatttool` via your package manager. Depending on the distribution, the package name might be: `bluez`, `bluetooth` or `bluez-deprecated`.
- Windows and MacOS are currently not supported by the `btlewrap` library. - Windows and MacOS are currently not supported by the `btlewrap` library.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}

View File

@ -13,7 +13,6 @@ ha_release: pre 0.7
ha_iot_class: Local Push ha_iot_class: Local Push
--- ---
The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers. The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}

View File

@ -21,13 +21,13 @@ When the sensor detects a new call, its state changes to 'ring' for each ring an
To find the path of your USB modem, run: To find the path of your USB modem, run:
```bash ```bash
$ ls /dev/ttyACM* ls /dev/ttyACM*
``` ```
If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hassbian) give access to the stick with: If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hassbian) give access to the stick with:
```bash ```bash
$ sudo usermod -a -G dialout homeassistant sudo usermod -a -G dialout homeassistant
``` ```
Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/). Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/).
@ -55,7 +55,6 @@ device:
default: "`/dev/ttyACM0`" default: "`/dev/ttyACM0`"
{% endconfiguration %} {% endconfiguration %}
To find the path of your USB modem, run: To find the path of your USB modem, run:
`$ ls /dev/ttyACM*` `$ ls /dev/ttyACM*`
@ -66,8 +65,6 @@ If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hass
Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/). Depending on what's plugged into your USB ports, the name found above may change. You can lock in a name, such as `/dev/modem`, by following [these instructions](http://hintshop.ludvig.co.nz/show/persistent-names-usb-serial-devices/).
## {% linkable_title Examples %} ## {% linkable_title Examples %}
Some example automations: Some example automations:

View File

@ -14,7 +14,6 @@ ha_release: 0.38
ha_qa_scale: internal ha_qa_scale: internal
--- ---
The `moon` sensor platform is tracking the moon phases. The `moon` sensor platform is tracking the moon phases.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}

View File

@ -13,7 +13,6 @@ ha_release: 0.7
ha_iot_class: Configurable ha_iot_class: Configurable
--- ---
This `mqtt` sensor platform uses the MQTT message payload as the sensor value. If messages in this `state_topic` are published with *RETAIN* flag, the sensor will receive an instant update with last known value. Otherwise, the initial state will be undefined. This `mqtt` sensor platform uses the MQTT message payload as the sensor value. If messages in this `state_topic` are published with *RETAIN* flag, the sensor will receive an instant update with last known value. Otherwise, the initial state will be undefined.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}

View File

@ -17,9 +17,11 @@ ha_release: 0.7
Integrates MySensors sensors into Home Assistant. See the [main component] for configuration instructions. Integrates MySensors sensors into Home Assistant. See the [main component] for configuration instructions.
## {% linkable_title Supported sensor types %}
The following sensor types are supported: The following sensor types are supported:
##### MySensors version 1.4 and higher ### {% linkable_title MySensors version 1.4 and higher %}
S_TYPE | V_TYPE S_TYPE | V_TYPE
-------------------|--------------------------------------- -------------------|---------------------------------------
@ -40,7 +42,7 @@ S_CUSTOM | V_VAR1, V_VAR2, V_VAR3, V_VAR4, V_VAR5
S_DUST | V_DUST_LEVEL S_DUST | V_DUST_LEVEL
S_SCENE_CONTROLLER | V_SCENE_ON, V_SCENE_OFF S_SCENE_CONTROLLER | V_SCENE_ON, V_SCENE_OFF
##### MySensors version 1.5 and higher ### {% linkable_title MySensors version 1.5 and higher %}
S_TYPE | V_TYPE S_TYPE | V_TYPE
---------------|---------------------------------- ---------------|----------------------------------
@ -53,7 +55,7 @@ S_LIGHT_LEVEL | V_LEVEL
S_AIR_QUALITY | V_LEVEL (replaces V_DUST_LEVEL) S_AIR_QUALITY | V_LEVEL (replaces V_DUST_LEVEL)
S_DUST | V_LEVEL (replaces V_DUST_LEVEL) S_DUST | V_LEVEL (replaces V_DUST_LEVEL)
##### MySensors version 2.0 and higher ### {% linkable_title MySensors version 2.0 and higher %}
S_TYPE | V_TYPE S_TYPE | V_TYPE
----------------|-------------------------- ----------------|--------------------------
@ -62,7 +64,7 @@ S_GAS | V_FLOW, V_VOLUME
S_GPS | V_POSITION S_GPS | V_POSITION
S_WATER_QUALITY | V_TEMP, V_PH, V_ORP, V_EC S_WATER_QUALITY | V_TEMP, V_PH, V_ORP, V_EC
### {% linkable_title Custom unit of measurement %} ## {% linkable_title Custom unit of measurement %}
Some sensor value types are not specific for a certain sensor type. These do not have a default unit of measurement in Home Assistant. For example, the V_LEVEL type can be used for different sensor types, dust, sound, vibration etc. Some sensor value types are not specific for a certain sensor type. These do not have a default unit of measurement in Home Assistant. For example, the V_LEVEL type can be used for different sensor types, dust, sound, vibration etc.
@ -70,6 +72,8 @@ By using V_UNIT_PREFIX, it's possible to set a custom unit for any sensor. The s
For more information, visit the [serial api] of MySensors. For more information, visit the [serial api] of MySensors.
## {% linkable_title Example sketches %}
### {% linkable_title MySensors 1.5 example sketch %} ### {% linkable_title MySensors 1.5 example sketch %}
```cpp ```cpp

View File

@ -13,14 +13,12 @@ ha_iot_class: Cloud Polling
ha_release: 0.11 ha_release: 0.11
--- ---
### {% linkable_title Basic Configuration %}
The `netatmo` sensor platform is consuming the information provided by a [Netatmo Weather Station](https://www.netatmo.com/en-us/weather/weatherstation) or a The `netatmo` sensor platform is consuming the information provided by a [Netatmo Weather Station](https://www.netatmo.com/en-us/weather/weatherstation) or a
[Netatmo Home Coach](https://www.netatmo.com/en-us/aircare/homecoach) [Netatmo](https://www.netatmo.com) devices. [Netatmo Home Coach](https://www.netatmo.com/en-us/aircare/homecoach) [Netatmo](https://www.netatmo.com) devices.
To enable the Netatmo sensor, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your sensor. To enable the Netatmo sensor, you have to set up [netatmo](/components/netatmo/), this will use discovery to add your sensor.
### {% linkable_title Advanced configuration %} ## {% linkable_title Advanced configuration %}
If you want to select a specific sensor, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`: If you want to select a specific sensor, set discovery to False for [netatmo](/components/netatmo/) and add the following lines to your `configuration.yaml`:
@ -96,7 +94,7 @@ modules:
description: Percentage of battery remaining per module. description: Percentage of battery remaining per module.
{% endconfiguration %} {% endconfiguration %}
### {% linkable_title Find your modules name %} ## {% linkable_title Find your modules name %}
You can find your modules name in your [online NetAtmo account](https://my.netatmo.com/app/station). These names can be found and changed in parameters. You have to provide these name in your Home Assistant `configuration.yaml` file. You can find your modules name in your [online NetAtmo account](https://my.netatmo.com/app/station). These names can be found and changed in parameters. You have to provide these name in your Home Assistant `configuration.yaml` file.

View File

@ -13,7 +13,6 @@ ha_release: 0.35
ha_iot_class: Local Polling ha_iot_class: Local Polling
--- ---
The `netdata` sensor platform allows you to display information collected by [Netdata](http://my-netdata.io/). The `netdata` sensor platform allows you to display information collected by [Netdata](http://my-netdata.io/).
## {% linkable_title Setup %} ## {% linkable_title Setup %}
@ -41,7 +40,6 @@ $ curl -X GET "http://[Netdata_Instance]:19999/api/v1/data?chart=[data_group]&po
- `dimension_names`: Names shown in the frontend. - `dimension_names`: Names shown in the frontend.
- `dimension_ids`: Names to use for `element`. - `dimension_ids`: Names to use for `element`.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
To add this platform to your installation, add the following to your `configuration.yaml` file: To add this platform to your installation, add the following to your `configuration.yaml` file:
@ -99,4 +97,3 @@ resources:
type: icon type: icon
default: "mdi:desktop-classic" default: "mdi:desktop-classic"
{% endconfiguration %} {% endconfiguration %}

View File

@ -26,6 +26,7 @@ sensor:
``` ```
Two sensors will be created with the following names: Two sensors will be created with the following names:
- **Energy Usage**: Current active power usage in Watts. Updated every 10 seconds. - **Energy Usage**: Current active power usage in Watts. Updated every 10 seconds.
- **Daily Energy Usage**: Daily power usage in kWh. Updated every 2.5 minutes. - **Daily Energy Usage**: Daily power usage in kWh. Updated every 2.5 minutes.

View File

@ -31,7 +31,7 @@ sensor:
{% configuration %} {% configuration %}
station_id: station_id:
description: ID of the station you'd like to track from https://tidesandcurrents.noaa.gov/tide_predictions.html. description: ID of the station you'd like to track from <https://tidesandcurrents.noaa.gov/tide_predictions.html>.
required: true required: true
type: string type: string
name: name:

View File

@ -15,6 +15,8 @@ ha_release: 0.34
The `nut` sensor platform allows you to monitor a UPS (battery backup) by using data from a [NUT](http://networkupstools.org/) (Network UPS Tools) server. The `nut` sensor platform allows you to monitor a UPS (battery backup) by using data from a [NUT](http://networkupstools.org/) (Network UPS Tools) server.
## {% linkable_title Configuration %}
To use this sensor platform, you need to add the following to your `configuration.yaml` file: To use this sensor platform, you need to add the following to your `configuration.yaml` file:
```yaml ```yaml
@ -65,7 +67,7 @@ sensor:
type: list type: list
{% endconfiguration %} {% endconfiguration %}
### {% linkable_title Example %} ## {% linkable_title Example %}
Given the following example output from NUT (your variables may differ): Given the following example output from NUT (your variables may differ):
@ -127,7 +129,7 @@ sensor:
- battery.runtime - battery.runtime
``` ```
### {% linkable_title UPS Status - human-readable version %} ## {% linkable_title UPS Status - human-readable version %}
An additional virtual sensor type `ups.status.display` is available translating the UPS status value retrieved from `ups.status` into a human-readable version. An additional virtual sensor type `ups.status.display` is available translating the UPS status value retrieved from `ups.status` into a human-readable version.

View File

@ -21,8 +21,6 @@ OhmConnect monitors real-time conditions on the electricity grid. When dirty and
You can find your OhmConnect ID under "Open Source Projects" on the [settings page](https://login.ohmconnect.com/settings). It's the string after the last `/` in the URL, e.g., for the URL `https://login.ohmconnect.com/verify-ohm-hour/AbCd1e` your ID is `AbCd1e`. You can find your OhmConnect ID under "Open Source Projects" on the [settings page](https://login.ohmconnect.com/settings). It's the string after the last `/` in the URL, e.g., for the URL `https://login.ohmconnect.com/verify-ohm-hour/AbCd1e` your ID is `AbCd1e`.
## {% linkable_title Configuration %}
To enable the OhMConnect sensor, add the following lines to your `configuration.yaml` file: To enable the OhMConnect sensor, add the following lines to your `configuration.yaml` file:
```yaml ```yaml

View File

@ -90,4 +90,3 @@ sensor:
names: names:
GENERATED_ID: FRIENDLY_NAME GENERATED_ID: FRIENDLY_NAME
``` ```

View File

@ -13,7 +13,6 @@ ha_release: 0.38
ha_iot_class: Local Polling ha_iot_class: Local Polling
--- ---
This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based wifi connection. This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based wifi connection.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}

View File

@ -13,7 +13,6 @@ ha_iot_class: Cloud Polling
ha_release: 0.23 ha_release: 0.23
--- ---
The `openexchangerates` sensor will show you the current exchange rate from [Open Exchange Rates](https://openexchangerates.org) that provides realtime exchange rates for [170 currencies](https://openexchangerates.org/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour. The `openexchangerates` sensor will show you the current exchange rate from [Open Exchange Rates](https://openexchangerates.org) that provides realtime exchange rates for [170 currencies](https://openexchangerates.org/currencies). The free account is limited to only USD as a base currency, allows 1000 requests per month, and updates every hour.
Obtain your API key [here](https://openexchangerates.org/signup) Obtain your API key [here](https://openexchangerates.org/signup)
@ -48,4 +47,3 @@ base:
type: string type: string
default: USD default: USD
{% endconfiguration %} {% endconfiguration %}

View File

@ -13,7 +13,6 @@ ha_release: 0.48
ha_iot_class: Local Polling ha_iot_class: Local Polling
--- ---
The `openhardwaremonitor` platform uses your [Open Hardware Monitor](http://openhardwaremonitor.org/) installation as a source for sensors that will display system information. The `openhardwaremonitor` platform uses your [Open Hardware Monitor](http://openhardwaremonitor.org/) installation as a source for sensors that will display system information.
## {% linkable_title Setup %} ## {% linkable_title Setup %}
@ -34,8 +33,8 @@ To open port (on Windows):
To open port with `firewalld` (Linux): To open port with `firewalld` (Linux):
```bash ```bash
$ sudo firewall-cmd --permanent --add-port=8085/tcp sudo firewall-cmd --permanent --add-port=8085/tcp
$ sudo firewall-cmd --reload sudo firewall-cmd --reload
``` ```
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
@ -59,4 +58,3 @@ sensor:
required: false required: false
type: integer type: integer
{% endconfiguration %} {% endconfiguration %}

View File

@ -13,7 +13,6 @@ ha_release: pre 0.7
ha_iot_class: Cloud Polling ha_iot_class: Cloud Polling
--- ---
The `openweathermap` platform uses [OpenWeatherMap](http://openweathermap.org/) as a source for current meteorological data for your location. The `forecast` will show you the condition in 3 h. The `openweathermap` platform uses [OpenWeatherMap](http://openweathermap.org/) as a source for current meteorological data for your location. The `forecast` will show you the condition in 3 h.
You need an API key which is free but requires a [registration](http://home.openweathermap.org/users/sign_up). You need an API key which is free but requires a [registration](http://home.openweathermap.org/users/sign_up).

View File

@ -13,7 +13,6 @@ logo: pi_hole.png
ha_release: 0.28 ha_release: 0.28
--- ---
The `pi_hole` sensor platform displays the statistical summary of a [Pi-hole](https://pi-hole.net/) system. The `pi_hole` sensor platform displays the statistical summary of a [Pi-hole](https://pi-hole.net/) system.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}

View File

@ -66,26 +66,17 @@ ZIP codes that start with 0 will cause errors.
The following metrics can be monitored: The following metrics can be monitored:
* Allergy Index: Forecasted Average (`allergy_average_forecasted`): the average * Allergy Index: Forecasted Average (`allergy_average_forecasted`): the average forecasted allergy index over the next 5 days
forecasted allergy index over the next 5 days * Allergy Index: Historical Average (`allergy_average_historical`): the average historical allergy index over the past 30 days
* Allergy Index: Historical Average (`allergy_average_historical`): the average
historical allergy index over the past 30 days
* Allergy Index: Today (`allergy_index_today`): the allergy index for today * Allergy Index: Today (`allergy_index_today`): the allergy index for today
* Allergy Index: Tomorrow (`allergy_index_tomorrow`): the allergy index for * Allergy Index: Tomorrow (`allergy_index_tomorrow`): the allergy index for tomorrow
tomorrow * Allergy Index: Yesterday (`allergy_index_yesterday`): the allergy index for yesterday
* Allergy Index: Yesterday (`allergy_index_yesterday`): the allergy index for * Asthma Index: Forecasted Average (`asthma_average_forecasted`): the average forecasted asthma index over the next 5 days
yesterday * Asthma Index: Historical Average (`asthma_average_historical`): the average historical asthma index over the past 30 days
* Asthma Index: Forecasted Average (`asthma_average_forecasted`): the average
forecasted asthma index over the next 5 days
* Asthma Index: Historical Average (`asthma_average_historical`): the average
historical asthma index over the past 30 days
* Asthma Index: Today (`asthma_index_today`): the asthma index for today * Asthma Index: Today (`asthma_index_today`): the asthma index for today
* Asthma Index: Tomorrow (`asthma_index_tomorrow`): the asthma index for * Asthma Index: Tomorrow (`asthma_index_tomorrow`): the asthma index for tomorrow
tomorrow * Asthma Index: Yesterday (`asthma_index_yesterday`): the asthma index for yesterday
* Asthma Index: Yesterday (`asthma_index_yesterday`): the asthma index for * Cold & Flu: Forecasted Average (`disease_average_forecasted`): the average forecasted cold/flu index over the next 5 days
yesterday
* Cold & Flu: Forecasted Average (`disease_average_forecasted`): the average
forecasted cold/flu index over the next 5 days
## {% linkable_title Understanding the Indices %} ## {% linkable_title Understanding the Indices %}
@ -108,8 +99,8 @@ Example values include:
Pollutant | Symbol | More Info Pollutant | Symbol | More Info
--------- | ------ | --------- --------- | ------ | ---------
Particulate (<= 2.5 μm) | PM2.5 | [EPA: Particulate Matter (PM) Pollution ](https://www.epa.gov/pm-pollution) Particulate (<= 2.5 μm) | PM2.5 | [EPA: Particulate Matter (PM) Pollution](https://www.epa.gov/pm-pollution)
Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution ](https://www.epa.gov/pm-pollution) Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution](https://www.epa.gov/pm-pollution)
Ozone | O | [EPA: Ozone Pollution](https://www.epa.gov/ozone-pollution) Ozone | O | [EPA: Ozone Pollution](https://www.epa.gov/ozone-pollution)
Sulpher Dioxide | SO2 | [EPA: Sulfur Dioxide (SO2) Pollution](https://www.epa.gov/so2-pollution) Sulpher Dioxide | SO2 | [EPA: Sulfur Dioxide (SO2) Pollution](https://www.epa.gov/so2-pollution)
Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](https://www.epa.gov/co-pollution) Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](https://www.epa.gov/co-pollution)

View File

@ -13,7 +13,6 @@ ha_release: 0.33
ha_iot_class: Cloud Polling ha_iot_class: Cloud Polling
--- ---
The `pvoutput` sensor platform consumes information from [PVOutput](http://pvoutput.org/) which were uploaded by your solar photovoltaic (PV) system. The `pvoutput` sensor platform consumes information from [PVOutput](http://pvoutput.org/) which were uploaded by your solar photovoltaic (PV) system.
To add PVOutput details to your installation, add the following to your `configuration.yaml` file: To add PVOutput details to your installation, add the following to your `configuration.yaml` file:

View File

@ -12,7 +12,6 @@ ha_category: Downloading
ha_release: 0.47 ha_release: 0.47
--- ---
This `radarr` sensor platform pulls data from a given [Radarr](https://radarr.video/) instance. This `radarr` sensor platform pulls data from a given [Radarr](https://radarr.video/) instance.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}

View File

@ -14,7 +14,6 @@ ha_release: 0.32
ha_qa_scale: internal ha_qa_scale: internal
--- ---
The `random` sensor platform is creating random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn. This can be useful if you want to test automation rules. It generates a new value every time it is polled. The `random` sensor platform is creating random sensor values (integers) out of a given range. Returned values form a [discrete uniform distribution](https://en.wikipedia.org/wiki/Discrete_uniform_distribution), meaning that each integer value in the range configured is equally likely to be drawn. This can be useful if you want to test automation rules. It generates a new value every time it is polled.
## {% linkable_title Configuration %} ## {% linkable_title Configuration %}
@ -48,4 +47,3 @@ unit_of_measurement:
required: false required: false
type: string type: string
{% endconfiguration %} {% endconfiguration %}

View File

@ -13,7 +13,6 @@ ha_release: 0.7.4
ha_iot_class: Local Polling ha_iot_class: Local Polling
--- ---
The `rest` sensor platform is consuming a given endpoint which is exposed by a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) of a device, an application, or a web service. The sensor has support for GET and POST requests. The `rest` sensor platform is consuming a given endpoint which is exposed by a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) of a device, an application, or a web service. The sensor has support for GET and POST requests.
To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request:

View File

@ -15,6 +15,8 @@ ha_iot_class: Local Polling
The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver). The `rflink` component supports devices that use [RFLink gateway firmware](http://www.nemcon.nl/blog2/), for example the [Nodo RFLink Gateway](https://www.nodo-shop.nl/nl/21-rflink-gateway). RFLink gateway is an Arduino firmware that allows two-way communication with a multitude of RF wireless devices using cheap hardware (Arduino + transceiver).
## {% linkable_title Configuration %}
First, you have to set up your [RFLink hub](/components/rflink/). First, you have to set up your [RFLink hub](/components/rflink/).
After configuring the RFLink hub, sensors will be automatically discovered and added. After configuring the RFLink hub, sensors will be automatically discovered and added.
@ -72,7 +74,7 @@ devices:
type: [list, string] type: [list, string]
{% endconfiguration %} {% endconfiguration %}
### {% linkable_title Sensors types%} ## {% linkable_title Sensors types %}
Sensor type values: Sensor type values:
@ -109,7 +111,7 @@ Sensor type values:
- windspeed - windspeed
- windtemp - windtemp
### {% linkable_title Hiding/ignoring sensors %} ## {% linkable_title Hiding/ignoring sensors %}
Sensors are added automatically when the RFLink gateway intercepts a wireless command in the ether. To prevent cluttering the frontend use any of these methods: Sensors are added automatically when the RFLink gateway intercepts a wireless command in the ether. To prevent cluttering the frontend use any of these methods:
@ -117,11 +119,11 @@ Sensors are added automatically when the RFLink gateway intercepts a wireless co
- Hide unwanted devices using [customizations](/getting-started/customizing-devices/) - Hide unwanted devices using [customizations](/getting-started/customizing-devices/)
- [Ignore devices on a platform level](/components/rflink/#ignoring-devices) - [Ignore devices on a platform level](/components/rflink/#ignoring-devices)
### {% linkable_title Device support %} ## {% linkable_title Device support %}
See [device support](/components/rflink/#device-support) See [device support](/components/rflink/#device-support)
### {% linkable_title Additional configuration examples %} ## {% linkable_title Additional configuration examples %}
Multiple sensors with `automatic_add` disabled and `aliases` Multiple sensors with `automatic_add` disabled and `aliases`
@ -148,4 +150,3 @@ sensor:
aliases: aliases:
- xiron_4001_bat - xiron_4001_bat
``` ```

View File

@ -13,7 +13,6 @@ ha_release: 0.47
ha_iot_class: Cloud Polling ha_iot_class: Cloud Polling
--- ---
The `ripple` sensor platform displays Ripple wallet balances from [Ripple.com](https://ripple.com). The `ripple` sensor platform displays Ripple wallet balances from [Ripple.com](https://ripple.com).
To add the Ripple sensor to your installation, specify a ripple address to watch in the `configuration.yaml` file: To add the Ripple sensor to your installation, specify a ripple address to watch in the `configuration.yaml` file:
@ -36,4 +35,3 @@ name:
type: string type: string
default: Ripple Balance default: Ripple Balance
{% endconfiguration %} {% endconfiguration %}

View File

@ -56,7 +56,6 @@ See it in action, with a step-by-step setup guide, thanks to a fan! (v0.87 featu
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/QZHlhQ7fqrA" frameborder="0" allowfullscreen></iframe> <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/QZHlhQ7fqrA" frameborder="0" allowfullscreen></iframe>
</div> </div>
## {% linkable_title Basic requirements %} ## {% linkable_title Basic requirements %}
1. A [personal access token](https://account.smartthings.com/tokens) tied to a Samsung or SmartThings account (see below for instructions). 1. A [personal access token](https://account.smartthings.com/tokens) tied to a Samsung or SmartThings account (see below for instructions).
@ -129,6 +128,7 @@ Event data payloads are logged at the debug level, see [debugging](#debugging) f
## {% linkable_title Platforms %} ## {% linkable_title Platforms %}
SmartThings represents devices as a set of [capabilities](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html) and the SmartThings component maps those to entity platforms in Home Assistant. A single device may be represented by one or more platforms. SmartThings represents devices as a set of [capabilities](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html) and the SmartThings component maps those to entity platforms in Home Assistant. A single device may be represented by one or more platforms.
- [Binary Sensor](#binary-sensor) - [Binary Sensor](#binary-sensor)
- [Climate](#climate) - [Climate](#climate)
- [Cover](#cover) - [Cover](#cover)
@ -276,7 +276,6 @@ The SmartThings Switch platform lets you control devices that have the [`switch`
| [`energyMeter`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Energy-Meter) | energy consumption (`today_energy_kwh` state attribute) | [`energyMeter`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Energy-Meter) | energy consumption (`today_energy_kwh` state attribute)
| [`powerMeter`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Power-Meter) | power consumption (`current_power_w` state attribute) | [`powerMeter`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Power-Meter) | power consumption (`current_power_w` state attribute)
## {% linkable_title Troubleshooting %} ## {% linkable_title Troubleshooting %}
### {% linkable_title Setup %} ### {% linkable_title Setup %}

View File

@ -17,6 +17,6 @@ ha_iot_class: Local Polling
To get your Danfoss Air sensors working with Home Assistant, follow the instructions for the general [Danfoss Air component](/components/danfoss_air/). To get your Danfoss Air sensors working with Home Assistant, follow the instructions for the general [Danfoss Air component](/components/danfoss_air/).
</p> </p>
The following switches. The following switches.
* **Boost:** Switch to manually activate boost. * **Boost:** Switch to manually activate boost.

View File

@ -65,7 +65,7 @@ Traceback (most recent call last):
[...] [...]
``` ```
The message ("Unable to find component system_healt"), source (`homeassistant.loader`) and level (`ERROR`) can easily be extracted from the log. The exact timestamp and if there is a stack trace that's shown as well. Here is another error caused by the `google_map` integration with additional output present. The message ("Unable to find component system_healt"), source (`homeassistant.loader`) and level (`ERROR`) can easily be extracted from the log. The exact timestamp and if there is a stack trace that's shown as well. Here is another error caused by the `google_map` integration with additional output present.
## {% linkable_title Examples %} ## {% linkable_title Examples %}

View File

@ -129,4 +129,3 @@ sensor:
unit_of_measurement: 'kWh' unit_of_measurement: 'kWh'
``` ```
{% endraw %} {% endraw %}

View File

@ -134,10 +134,9 @@ To obtain this value for your configuration file, you can take it from the URL o
For example, this is what would be seen in the URL bar when inside the dashboard page of a site: For example, this is what would be seen in the URL bar when inside the dashboard page of a site:
* https://127.0.0.1:8443/manage/s/ceb1m27d/dashboard `https://127.0.0.1:8443/manage/s/ceb1m27d/dashboard`
And your `site_id` value would be ceb1m27d.
And your `site_id` value would be `ceb1m27d`.
### {% linkable_title Troubleshooting and Time Synchronization %} ### {% linkable_title Troubleshooting and Time Synchronization %}
@ -152,52 +151,53 @@ If Home Assistant and the Unifi controller are running on separate machines or V
The Unifi controller returns a number of additional attributes that can be used for tracking devices, including signal strength, rx/tx rates, and which AP it is connected to. The list of possible options may vary depending on your Unifi controller version and if a device is wired or wireless. The Unifi controller returns a number of additional attributes that can be used for tracking devices, including signal strength, rx/tx rates, and which AP it is connected to. The list of possible options may vary depending on your Unifi controller version and if a device is wired or wireless.
Unifi Controller version 5.6.29 has the following options: Unifi Controller version 5.6.29 has the following options:
- _id
- _is_guest_by_uap - _id
- _last_seen_by_uap - _is_guest_by_uap
- _uptime_by_uap - _last_seen_by_uap
- ap_mac - _uptime_by_uap
- assoc_time - ap_mac
- authorized - assoc_time
- bssid - authorized
- bytes-r - bssid
- ccq - bytes-r
- channel - ccq
- essid - channel
- first_seen - essid
- hostname - first_seen
- idletime - hostname
- ip - idletime
- is_11r - ip
- is_guest - is_11r
- is_wired - is_guest
- last_seen - is_wired
- latest_assoc_time - last_seen
- mac - latest_assoc_time
- name - mac
- noise - name
- noted - noise
- oui - noted
- powersave_enabled - oui
- qos_policy_applied - powersave_enabled
- radio - qos_policy_applied
- radio_proto - radio
- rssi - radio_proto
- rx_bytes - rssi
- rx_bytes-r - rx_bytes
- rx_packets - rx_bytes-r
- rx_rate - rx_packets
- signal - rx_rate
- site_id - signal
- tx_bytes - site_id
- tx_bytes-r - tx_bytes
- tx_packets - tx_bytes-r
- tx_power - tx_packets
- tx_rate - tx_power
- uptime - tx_rate
- user_id - uptime
- usergroup_id - user_id
- vlan - usergroup_id
- vlan
## {% linkable_title Switch %} ## {% linkable_title Switch %}

View File

@ -172,6 +172,7 @@ automation:
- 26032 - 26032
- 26496 - 26496
``` ```
## {% linkable_title Attributes %} ## {% linkable_title Attributes %}
In addition to [all of the attributes provided by the `vacuum` component](/components/vacuum/#attributes), In addition to [all of the attributes provided by the `vacuum` component](/components/vacuum/#attributes),

View File

@ -82,8 +82,7 @@ If you are using climate devices the "current temp" sensor will be automatically
| `dimmer` | Partly | Dimmers are currently handled like switches so actual dimming is not supported :(| | `dimmer` | Partly | Dimmers are currently handled like switches so actual dimming is not supported :(|
| `temperature` | Yes | | | `temperature` | Yes | |
### {% linkable_title Climate Actuator/Sensor %}
### {% linkable_title Climate Actuator/Sensor%}
Home Assistant can combine temperature sensors and climate actuators into a single device. The XS1 gateway does not allow this, but a sensor and actuator can be configured separately. To make Home Assistant register them in the same climate device just prefix the **sensor** name with the actuator name on the XS1 gateway configuration, f.ex: Home Assistant can combine temperature sensors and climate actuators into a single device. The XS1 gateway does not allow this, but a sensor and actuator can be configured separately. To make Home Assistant register them in the same climate device just prefix the **sensor** name with the actuator name on the XS1 gateway configuration, f.ex:

View File

@ -118,7 +118,7 @@ Each binary_sensor created will be named after the hostname used when configurin
The `zoneminder` camera platform lets you monitor the current stream of your [ZoneMinder](https://www.zoneminder.com) cameras. The `zoneminder` camera platform lets you monitor the current stream of your [ZoneMinder](https://www.zoneminder.com) cameras.
## {% linkable_title Configuration %} ### {% linkable_title Configuration %}
To set it up, add the following information to your `configuration.yaml` file: To set it up, add the following information to your `configuration.yaml` file: