Update category (#6182)

This commit is contained in:
Fabian Affolter 2018-09-03 12:20:17 +02:00 committed by GitHub
parent 95546aa3fc
commit dcd46c2d86
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
29 changed files with 133 additions and 125 deletions

View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Binary Sensor
ha_category: Environment
ha_release: 0.39
logo: noaa.png
---
@ -18,6 +18,8 @@ This service gives a number 0-100 representing the current likelihood of visible
You can check the attributes of the sensor to see your exact forecast.
## {% linkable_title Configuration %}
To add the aurora binary sensor to your installation, add the following to your `configuration.yaml` file:
```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: bloomsky.png
ha_category: Binary Sensor
ha_category: Environment
ha_release: 0.14
ha_iot_class: "Cloud Polling"
---
@ -17,6 +17,8 @@ The `bloomsky` binary sensor platform allows you to get data from your BloomSky
To get your BloomSky binary sensors working with Home Assistant, follow the instructions for the [BloomSky component](/components/bloomsky/) first.
## {% linkable_title Configuration %}
To use your BloomSky binary sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: command_line.png
ha_category: Binary Sensor
ha_category: Utility
ha_release: 0.12
ha_iot_class: "Local Polling"
---
@ -16,6 +16,8 @@ ha_iot_class: "Local Polling"
The `command_line` binary sensor platform issues specific commands to get data.
## {% linkable_title Configuration %}
To use your Command binary sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: rachio.png
ha_category: Sensor
ha_category: Irrigation
ha_iot_class: "Cloud Push"
ha_release: 0.73
---
@ -18,9 +18,10 @@ The `rachio` binary sensor platform allows you to view the status of your [Rachi
Once configured, a binary sensor will be added that shows whether or not each controller in the account provided is online and reachable by Rachio's servers.
<p class='note'>
You must have the [Rachio component](/components/rachio/) configured to use this switch.
You must have the [Rachio component](/components/rachio/) configured to use this switch.
</p>
## {% linkable_title Configuration %}
To add this platform to your installation, add the following to your `configuration.yaml` file:

View File

@ -13,7 +13,7 @@ ha_iot_class: "Cloud Polling"
ha_release: 0.63
---
The `Melissa` climate platform allows you to control your [Melissa Climate](http://seemelissa.com/) from within Home Assistant.
The `melissa` climate platform allows you to control your [Melissa Climate](http://seemelissa.com/) from within Home Assistant.
The climate platform will be automatically configured if Melissa component is configured.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: juicenet.png
ha_category: Hub
ha_category: Energy
ha_release: 0.47
---

View File

@ -1,6 +1,6 @@
---
layout: page
title: "Melissa Climate"
title: "Melissa"
description: "Instructions on how to integrate Melissa Climate into Home Assistant."
date: 2017-01-05 17:30
sidebar: true
@ -14,7 +14,7 @@ ha_release: 0.63
ha_iot_class: "Cloud Polling"
---
The `Melissa` component is the main component to connect to a [Melissa Climate](http://seemelissa.com/) A/C control.
The `melissa` component is the main component to connect to a [Melissa Climate](http://seemelissa.com/) A/C control.
## {% linkable_title Configuration %}

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: rachio.png
ha_category: Hub
ha_category: Irrigation
ha_iot_class: "Cloud Push"
ha_release: 0.73
---
@ -22,6 +22,8 @@ The `rachio` platform allows you to control your [Rachio irrigation system](http
1. Click "Get API Key"
1. Copy the API key from the dialog that opens.
## {% linkable_title Configuration %}
To add this platform to your installation, add the following to your `configuration.yaml` file:
```yaml

View File

@ -13,30 +13,17 @@ ha_release: 0.53
ha_iot_class: "Cloud Polling"
---
The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/)
API for air quality data. Data can be collected via latitude/longitude or by
city/state/country. The resulting information creates sensors for the Air
Quality Index (AQI), the human-friendly air quality level, and the main
pollutant of that area. Sensors that conform to either/both the
[U.S. and Chinese air quality standards](http://www.clm.com/publication.cfm?ID=366)
can be created.
The `airvisual` sensor platform queries the [AirVisual](https://airvisual.com/) API for air quality data. Data can be collected via latitude/longitude or by city/state/country. The resulting information creates sensors for the Air Quality Index (AQI), the human-friendly air quality level, and the main pollutant of that area. Sensors that conform to either/both the [U.S. and Chinese air quality standards](http://www.clm.com/publication.cfm?ID=366) can be created.
This platform requires an AirVisual API key, which can be obtained
[here](https://airvisual.com/api). Note that the platform was designed using
the "Community" package; the "Startup" and "Enterprise" package keys should
continue to function, but actual results may vary (or not work at all).
This platform requires an AirVisual API key, which can be obtained [here](https://airvisual.com/api). Note that the platform was designed using the "Community" package; the "Startup" and "Enterprise" package keys should continue to function, but actual results may vary (or not work at all).
<p class='note warning'>
The "Community" API key is limited to 10,000 calls per month. In order to leave
a buffer, the `airvisual` platform queries the API every 10 minutes by default.
Modification of this (via the `scan_interval` key) to a too-low value may
result in your API key being deactivated.
The "Community" API key is limited to 10,000 calls per month. In order to leave a buffer, the `airvisual` platform queries the API every 10 minutes by default. Modification of this (via the `scan_interval` key) to a too-low value may result in your API key being deactivated.
</p>
## {% linkable_title Configuring the Platform via Latitude/Longitude %}
## {% linkable_title Configuration via Latitude/Longitude %}
To enable the platform and gather data via latitude/longitude, add the
following lines to your `configuration.yaml` file:
To enable the platform and gather data via latitude/longitude, add the following lines to your `configuration.yaml` file:
```yaml
sensor:
@ -58,59 +45,53 @@ sensor:
{% configuration %}
api_key:
description: your AirVisual API key
description: Your AirVisual API key.
required: required
type: string
monitored_conditions:
description: the air quality standard(s) to use (`us` for U.S., `cn` for Chinese)
description: "The air quality standard(s) to use (`us` for U.S., `cn` for Chinese)."
required: required
type: list
default: ['us', 'cn']
show_on_map:
description: whether to show a marker on the map at the specified location
description: "Whether to show a marker on the map at the specified location."
required: optional
type: boolean
default: true
scan_interval:
description: the rate at which AirVisual should be polled for new data
description: "The rate at which AirVisual should be polled for new data."
required: optional
type: int
default: 600
latitude:
description: the latitude of the location to monitor
description: The latitude of the location to monitor.
required: optional
type: str
default: the latitude defined under the `homeassistant` key in `configuration.yaml`
default: "The latitude defined under the `homeassistant` key in `configuration.yaml`."
longitude:
description: the longitude of the location to monitor
description: The longitude of the location to monitor.
required: optional
type: str
default: the longitude defined under the `homeassistant` key in `configuration.yaml`
type: string
default: "The longitude defined under the `homeassistant` key in `configuration.yaml`."
city:
description: the city to monitor
description: The city to monitor.
required: optional
type: str
type: string
state:
description: the state the city belongs to
description: The state the city belongs to.
required: optional
type: str
type: string
country:
description: the country the state belongs to
description: The country the state belongs to.
required: optional
type: str
type: string
{% endconfiguration %}
## {% linkable_title Determining the City/State/Country %}
To easily determine the proper values for a particular location, use the
[AirVisual region directory](https://airvisual.com/world). Once you browse to
the particular city you want, take note of the breadcrumb title, which is of
the form `country > state/region > city`. Use this information to fill out
`configuration.yaml`.
To easily determine the proper values for a particular location, use the [AirVisual region directory](https://airvisual.com/world). Once you browse to the particular city you want, take note of the breadcrumb title, which is of the form `country > state/region > city`. Use this information to fill out `configuration.yaml`.
For example, Sao Paulo, Brazil shows a breadcrumb title of
`Brazil > Sao Paulo > Sao Paulo` thus, the proper configuration would look
like this:
For example, Sao Paulo, Brazil shows a breadcrumb title of `Brazil > Sao Paulo > Sao Paulo`. Thus, the proper configuration would look like this:
```yaml
sensor:
@ -126,19 +107,14 @@ sensor:
## {% linkable_title Sensor Types %}
When configured, the platform will create three sensors for each configured
air quality standard:
When configured, the platform will create three sensors for each configured air quality standard:
### Air Quality Index
**Description:** This sensor displays a numeric air quality index (AQI), a
metric for the overall "health" of the air.
**Example Sensor Name:** `sensor.chinese_air_quality_index`
**Example Sensor Value:** `32`
**Explanation:**
- **Description:** This sensor displays a numeric air quality index (AQI), a metric for the overall "health" of the air.
- **Example Sensor Name:** `sensor.chinese_air_quality_index`
- **Example Sensor Value:** `32`
- **Explanation:**
AQI | Status | Description
------- | :----------------: | ----------
@ -151,23 +127,16 @@ AQI | Status | Description
### Air Pollution Level
**Description:** This sensor displays the associated `Status` (from the above
table) for the current AQI.
**Sample Sensor Name:** `sensor.us_air_pollution_level`
**Example Sensor Value:** `Moderate`
- **Description:** This sensor displays the associated `Status` (from the above table) for the current AQI.
- **Sample Sensor Name:** `sensor.us_air_pollution_level`
- **Example Sensor Value:** `Moderate`
### Main Pollutant
**Description:** This sensor displays the pollutant whose value is currently
highest.
**Sample Sensor Name:** `sensor.us_main_pollutant`
**Example Sensor Value:** `PM2.5`
**Explanation:**
- **Description:** This sensor displays the pollutant whose value is currently highest.
- **Sample Sensor Name:** `sensor.us_main_pollutant`
- **Example Sensor Value:** `PM2.5`
- **Explanation:**
Pollutant | Symbol | More Info
------- | :----------------: | ----------
@ -176,3 +145,4 @@ Particulate (<= 10 μm) | PM10 | [EPA: Particulate Matter (PM) Pollution ](https
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)
Carbon Monoxide | CO | [EPA: Carbon Monoxide (CO) Pollution in Outdoor Air](https://www.epa.gov/co-pollution)

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: command_line.png
ha_category: Sensor
ha_category: Utility
ha_release: pre 0.7
ha_iot_class: "Local Polling"
---
@ -16,6 +16,8 @@ ha_iot_class: "Local Polling"
The `command_line` sensor platform that issues specific commands to get data. This might become our most powerful platform as it allows anyone to integrate any type of sensor into Home Assistant that can get data from the command line.
## {% linkable_title Configuration %}
To enable it, add the following lines to your `configuration.yaml`:
```yaml

View File

@ -1,6 +1,6 @@
---
layout: page
title: "Daikin AC"
title: "Daikin AC Sensor"
description: "Instructions on how to integrate Daikin AC(s) with Home Assistant."
date: 2017-12-03 05:00
sidebar: True
@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: daikin.png
ha_category: Sensor
ha_category: Environment
ha_release: 0.59
ha_iot_class: "Local Polling"
---
@ -23,6 +23,8 @@ The `daikin` sensor platform integrates Daikin air conditioning systems into Hom
Please note, the `daikin` platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant.
</p>
## {% linkable_title Configuration %}
To enable the platform manually, add the following lines to your `configuration.yaml` file:
```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: dyson.png
ha_category: Sensor
ha_category: Environment
ha_iot_class: "Cloud Polling"
ha_release: 0.47
---

View File

@ -1,6 +1,6 @@
---
layout: page
title: "Fido"
title: "Fido Sensor"
description: "Instructions on how to integrate Fido data usage within Home Assistant."
date: 2017-01-01 17:17
sidebar: true
@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: fido.png
ha_category: Sensor
ha_category: Network
ha_release: 0.39
ha_iot_class: "Cloud Polling"
---
@ -16,7 +16,9 @@ ha_iot_class: "Cloud Polling"
Integrate your [Fido](https://www.fido.ca/) account information into Home Assistant.
To enable this sensor, add the following lines to your `configuration.yaml`:
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: juicenet.png
ha_category: Sensor
ha_category: Energy
ha_release: 0.47
---

View File

@ -8,14 +8,14 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: DIY
ha_release: 0.58
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).
#### {% linkable_title Tested Devices %}
### {% linkable_title Tested Devices %}
- Technoline TX 29 IT (temperature only)
- Technoline TX 29 DTH-IT (including humidity)
@ -27,6 +27,9 @@ Since the sensor change their ID after each powercycle/battery change you can ch
```bash
$ sudo pylacrosse -d /dev/ttyUSB0 scan
```
## {% linkable_title Configuration %}
To use your `lacrosse` compatible sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

View File

@ -8,12 +8,12 @@ comments: false
sharing: true
footer: true
logo: mclimate.png
ha_category: Sensor
ha_category: Environment
ha_iot_class: "Cloud Polling"
ha_release: 0.63
---
The `Melissa` platform allows you to get data from your [Melissa](http://seemelissa.com/) sensors from within Home Assistant.
The `melissa` platform allows you to get data from your [Melissa](http://seemelissa.com/) sensors from within Home Assistant.
The sensor platform will be automatically configured if Melissa component is configured.

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: netatmo.png
ha_category: Sensor
ha_category: Environment
ha_iot_class: "Cloud Polling"
ha_release: 0.77
---
@ -60,7 +60,7 @@ areas:
type: string
default: Netatmo Public Data
type:
description: How to calculate the value of the sensor if there are multiple stations reporting data. Accepts `max` or `avg`.
description: "How to calculate the value of the sensor if there are multiple stations reporting data. Accepts `max` or `avg`."
required: false
type: string
default: max

View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: netgear.png
ha_release: 0.72
ha_category: Sensor
ha_category: Network
ha_iot_class: "Local Polling"
---
@ -17,6 +17,10 @@ The `netgear_lte` sensor platform allows you to monitor your Netgear LTE modem.
This requires you to have set up the [Netgear LTE component](/components/netgear_lte/).
## {% linkable_title Configuration %}
To enable the sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
@ -28,16 +32,16 @@ sensor:
{% configuration %}
sensors:
description: Sensor types to create.
required: true
type: list
keys:
sms:
description: Number of unread SMS messages in the modem inbox.
usage:
description: Amount of data transferred.
description: Sensor types to create.
required: true
type: list
keys:
sms:
description: Number of unread SMS messages in the modem inbox.
usage:
description: Amount of data transferred.
host:
description: The modem to use. Not needed if you only have one.
required: false
type: string
description: The modem to use. Not needed if you only have one.
required: false
type: string
{% endconfiguration %}

View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Weather
ha_category: Environment
ha_release: 0.75
logo: noaa.png
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: openevse.png
ha_category: Sensor
ha_category: Car
ha_release: "0.38"
ha_iot_class: "Local Polling"
---

View File

@ -13,7 +13,20 @@ ha_iot_class: "Local Polling"
ha_release: 0.68
---
[SigFox](https://www.sigfox.com/en) component adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ( [snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)).
[SigFox](https://www.sigfox.com/en) component adding a sensor for each Sigfox device registered with your account. The default name of sensors is `sigfox_{DEVICE_ID}` where `DEVICE_ID` is the devices Sigfox ID. The state of an added Sigfox sensor is the payload of the last message published by that device. Additionally, there are attributes for the latitude and longitude coordinates of the device, as well as the signal-to-noise ratio ([snr](https://en.wikipedia.org/wiki/Signal-to-noise_ratio)).
## {% linkable_title Setup %}
Note that `your_api_login` and `your_api_password` are your **API access credentials** which can be accessed by following:
1. Log into [Sigfox backend](https://backend.sigfox.com)
1. Select `GROUP`
1. Select `API ACCESS`
1. Click on `new` and create new access entry
## {% linkable_title Configuration %}
To use this sensor, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -39,9 +52,3 @@ name:
type: string
{% endconfiguration %}
Note that `your_api_login` and `your_api_password` are your **API access credentials** which can be accessed by following:
1. Log into [Sigfox backend](https://backend.sigfox.com)
1. Select `GROUP`
1. Select `API ACCESS`
1. Click on `new` and create new access entry

View File

@ -9,7 +9,7 @@ sharing: true
footer: true
logo: smappee.png
ha_release: "0.64"
ha_category: Sensor
ha_category: Energy
---
[Smappee](https://www.smappee.com/) controller for energy monitoring and Comport plug switches.

View File

@ -3,25 +3,28 @@ layout: page
title: Social Blade Sensor
description: "Instructions on how to set up Social Blade Sensor within Home Assistant."
date: 2018-04-23 08:00
sidebar: false
sidebar: true
comments: false
sharing: true
footer: true
logo: socialblade.png
ha_category: Sensor
ha_category: Multimedia
ha_release: 0.69
ha_iot_class: "Cloud Polling"
---
The `socialblade` sensor component allows you get updates on a youtube channel using your social blade channel id. The sensor gets the subscribers and total views count from [Social Blade Website]( https://socialblade.com/)
The `socialblade` sensor platform allows you get updates on a Youtube channel using your social blade channel ID. The sensor gets the subscribers and total views count from [Social Blade Website]( https://socialblade.com/).
to get the channel id you can go to [Social Blade Website]( https://socialblade.com/) and search for youtube channel by username, then select the channel and grab the id from the url.
The channel id will be the last part of the url :
https://socialblade.com/youtube/channel/{channel_id}
## {% linkable_title Setup %}
## Example for `configuration.yaml` :
To get the channel ID you can go to [Social Blade Website]( https://socialblade.com/) and search for Youtube channel by username, then select the channel and grab the ID from the URL. The channel ID will be the last part of the URL: https://socialblade.com/youtube/channel/{channel_id}
## {% linkable_title Configuration %}
To enable the sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: socialblade
channel_id: YOUR_CHANNEL_NUMBER
@ -29,7 +32,7 @@ sensor:
{% configuration %}
channel_id:
description: channel id number optained from the URL when you access Social Blade web client.
description: Channel id number optained from the URL when you access Social Blade web client.
required: true
type: string
{% endconfiguration %}

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: sql.png
ha_category: Sensor
ha_category: Utility
ha_release: 0.63
---

View File

@ -9,12 +9,14 @@ sharing: true
footer: true
logo: sytadin.png
ha_release: 0.57
ha_category: Sensor
ha_category: Car
ha_iot_class: "Clound Polling"
---
The `sytadin` sensor platform allows you to monitor traffic details from [Sytadin](http://www.sytadin.fr).
## {% linkable_title Configuration %}
To add Sytadin to your installation, add the following to your `configuration.yaml` file:
```yaml

View File

@ -1,6 +1,6 @@
---
layout: page
title: "IKEA Trådfri sensors"
title: "IKEA Trådfri sensor"
description: "Access and control your ZigBee-based IKEA Trådfri (Tradfri) Sensors."
date: 2017-04-12 22.04
sidebar: true

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: worldtidesinfo.png
ha_category: Weather
ha_category: Environment
ha_release: 0.52
---

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: xiaomi.png
ha_category: Sensor
ha_category: Health
ha_iot_class: "Local Polling"
ha_release: 0.66
---
@ -26,6 +26,8 @@ Currently, the supported features are:
Please follow the instructions on [Retrieving the Access Token](/components/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token.
## {% linkable_title Configuration %}
To add a Xiaomi Mi Air Quality Monitor to your installation, add the following to your `configuration.yaml` file:
```yaml

View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: rachio.png
ha_category: Switch
ha_category: Irrigation
ha_iot_class: "Cloud Push"
ha_release: 0.46
---
@ -21,6 +21,8 @@ Once configured, a switch will be added for every zone that is enabled on every
You must have the [Rachio component](/components/rachio/) configured to use this switch.
</p>
## {% linkable_title Configuration %}
To add this platform to your installation, add the following to your `configuration.yaml` file:
```yaml