jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 15:26:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current' into next

Browse Source
This commit is contained in:
Fabian Affolter 2018-09-03 12:55:09 +02:00
commit cbdf2d7b40
No known key found for this signature in database
GPG Key ID: E23CD2DD36A4397F
97 changed files with 453 additions and 252 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_components/august.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: august.png
ha_category: Hub
ha_category: Door bell
ha_release: "0.64"
ha_iot_class: "Cloud Polling"
---

2
source/_components/binary_sensor.august.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: august.png
ha_category: Binary Sensor
ha_category: Door bell
ha_release: "0.64"
ha_iot_class: "Cloud Polling"
---

4
source/_components/binary_sensor.aurora.markdown
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

4
source/_components/binary_sensor.bayesian.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Binary Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.53
---
@ -18,6 +18,8 @@ The `bayesian` binary sensor platform observes the state from multiple sensors a
This allows for the detection of complex events that may not be readily observable, e.g., cooking, showering, in bed, the start of a morning routine, etc. It can also be used to gain greater confidence about events that _are_ directly observable, but for which the sensors can be unreliable, e.g., presence.
## {% linkable_title Configuration %}
To enable the Bayesian sensor, add the following lines to your `configuration.yaml`:
```yaml

4
source/_components/binary_sensor.bloomsky.markdown
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

4
source/_components/binary_sensor.command_line.markdown
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

2
source/_components/binary_sensor.ecobee.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: ecobee.png
ha_category: Binary Sensor
ha_category: Environment
ha_release: 0.9
ha_iot_class: "Local Push"
---

4
source/_components/binary_sensor.ping.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Binary Sensor
ha_category: Network
ha_release: 0.43
---
The `ping` binary sensor platform allows you to using `ping` to send ICMP echo requests. This way you can check if a given host is online and determine the round trip times from your Home Assistant instance to that system.
## {% linkable_title Configuration %}
To use this sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

5
source/_components/binary_sensor.rachio.markdown
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:

2
source/_components/binary_sensor.random.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.57
---

4
source/_components/binary_sensor.ring.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: ring.png
ha_category: Binary Sensor
ha_category: Doorbell
ha_release: 0.42
ha_iot_class: "Cloud Polling"
---
To get your [Ring.com](https://ring.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring).
## {% linkable_title Configuration %}
Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file:
```yaml

4
source/_components/binary_sensor.skybell.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: skybell.png
ha_category: Binary Sensor
ha_category: Doorbell
ha_release: 0.56
ha_iot_class: "Cloud Polling"
---
To get your [Skybell.com](https://skybell.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell).
## {% linkable_title Configuration %}
Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file:
```yaml

4
source/_components/binary_sensor.threshold.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Binary Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.34
---
@ -26,6 +26,8 @@ It's an alternative to the template binary sensor's `value_template:` to get the
```
{% endraw %}
## {% linkable_title Configuration %}
To enable the threshold sensor, add the following lines to your `configuration.yaml`:
```yaml

4
source/_components/binary_sensor.trend.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Binary Sensor
ha_category: Utility
logo: home-assistant.png
ha_release: 0.28
ha_iot_class: "Local Push"
@ -15,6 +15,8 @@ ha_iot_class: "Local Push"
The `trend` platform allows you to create sensors which show the trend of numeric `state` or`state_attributes` from other entities. This sensor requires at least two updates of the underlying sensor to establish a trend. Thus it can take some time to show an accurate state. It can be useful as part of automations, where you want to base an action on a trend.
## {% linkable_title Configuration %}
To enable Trend binary sensors in your installation, add the following to your `configuration.yaml` file:
```yaml

11
source/_components/binary_sensor.uptimerobot.markdown
View File

@ -8,19 +8,22 @@ comments: false
sharing: true
footer: true
logo: uptimerobot.png
ha_category: Binary Sensor
ha_category: System Monitor
ha_release: "0.72"
ha_iot_class: "Cloud Polling"
---
The `uptimerobot` binary_sensor platform allows you get the status for all of your monitors from your account on [Uptime Robot.]( https://uptimerobot.com)
The `uptimerobot` binary sensor platform allows you get the status for all of your monitors from your account on [Uptime Robot.]( https://uptimerobot.com).
## Example for `configuration.yaml` :
## {% linkable_title Configuration %}
To enable the sensor, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: uptimerobot
api_key: u432898-d2507e493b31217e6c64fd35
api_key: YOUR_API_KEY
```
{% configuration %}

2
source/_components/binary_sensor.wemo.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "Belkin WeMo Binary Sensors"
title: "Belkin WeMo Binary Sensor"
description: "Instructions on how to integrate Belkin WeMo binary sensors into Home Assistant."
date: 2016-02-20 00:45
sidebar: true

2
source/_components/binary_sensor.workday.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Binary Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.41
---

2
source/_components/camera.ring.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
To get your [Ring.com](https://ring.com/) cameras working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring). Please note that downloading and playing Ring video will require a Ring Protect plan.
## {% linkable_title Configuration %}
Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file:
```yaml

2
source/_components/camera.skybell.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
To get your [Skybell.com](https://www.skybell.com/) cameras working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell).
## {% linkable_title Configuration %}
Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file:
```yaml

2
source/_components/climate.melissa.markdown
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.

2
source/_components/cloudflare.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: cloudflare.png
ha_category: Utility
ha_category: Network
featured: false
ha_release: 0.74
---

6
source/_components/cover.template.markdown
View File

@ -13,9 +13,9 @@ ha_iot_class: "Local Push"
logo: home-assistant.png
---
The `template` platform can create covers that combine components and provides
the ability to run scripts or invoke services for each of the open, close,
stop, position, and tilt commands of a cover.
The `template` platform can create covers that combine components and provides the ability to run scripts or invoke services for each of the open, close, stop, position and tilt commands of a cover.
## {% linkable_title Configuration %}
To enable Template Covers in your installation, add the following to your
`configuration.yaml` file:

6
source/_components/device_tracker.ping.markdown
View File

@ -8,12 +8,14 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Presence Detection
ha_category: Network
ha_release: 0.36
---
The `ping` platform offers presence detection by using `ping` to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when `nmap` or other solutions don't work since `arp` doesn't work.
The `ping` device tracker platform offers presence detection by using `ping` to send ICMP echo requests. This can be useful when devices are running a firewall and are blocking UDP or TCP packets but responding to ICMP requests (like Android phones). This tracker doesn't need to know the MAC address since the host can be on a different subnet. This makes this an option to detect hosts on a different subnet when `nmap` or other solutions don't work since `arp` doesn't work.
## {% linkable_title Configuration %}
To use this presence detection in your installation, add the following to your `configuration.yaml` file:

4
source/_components/duckdns.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: duckdns.png
ha_category: Utility
ha_category: Network
featured: false
ha_release: 0.55
---
With the DuckDNS component you can keep your DuckDNS record up to date. DuckDNS is a free dynamic DNS service that allows you to point a subdomain under `duckdns.org` at your computer.
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/folder_watcher.markdown
View File

@ -22,6 +22,8 @@ This component adds [Watchdog](https://pythonhosted.org/watchdog/) file system m
Configured folders must be added to [whitelist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.
## {% linkable_title Configuration %}
To enable the Folder Watcher component in your installation, add the following to your `configuration.yaml` file:
{% raw %}

6
source/_components/freedns.markdown
View File

@ -7,13 +7,13 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Utility
ha_category: Network
ha_release: 0.67
---
With the `freedns` component you can keep your [FreeDNS](https://freedns.afraid.org) record up to date.
## {% linkable_title Configuration %}
## {% linkable_title Setup %}
You need to determine your update URL or your access token.
@ -24,6 +24,8 @@ You need to determine your update URL or your access token.
5. The access token is the part at the end of the link: `https://freedns.afraid.org/dynamic/update.php?YOUR_UPDATE_TOKEN`
6. Either put the token as `access_token` _or_ the whole URL into the `url` attribute.
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/google_domains.markdown
View File

@ -8,12 +8,14 @@ comments: false
sharing: true
footer: true
logo: google_domains.png
ha_category: Utility
ha_category: Network
ha_release: 0.57
---
With the Google Domains component you can keep your Google Domains record up to date.
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/juicenet.markdown
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
---

2
source/_components/light.skybell.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
To get your [Skybell.com](https://skybell.com/) LED light working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell).
## {% linkable_title Configuration %}
Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file:
```yaml

4
source/_components/melissa.markdown
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 %}

4
source/_components/namecheapdns.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: namecheap.png
ha_category: Utility
ha_category: Network
featured: false
ha_release: 0.56
---
@ -19,6 +19,8 @@ With the `namecheapdns` component you can automatically update your dynamic DNS
Namecheap only supports IPv4 addresses to update.
</p>
## {% linkable_title Configuration %}
To use the component in your installation, add the following to your `configuration.yaml` file:
```yaml

7
source/_components/netgear_lte.markdown
View File

@ -9,17 +9,22 @@ sharing: true
footer: true
logo: netgear.png
ha_release: 0.72
ha_category: Other
ha_category: Network
ha_iot_class: "Local Polling"
---
The Netgear LTE integration for Home Assistant allows you to observe and control [Netgear LTE modems](https://www.netgear.com/home/products/mobile-broadband/lte-modems/default.aspx), currently only tested with LB2120.
The integration provides:
* a notify service that will send an SMS
* a sensor with the number of unread SMS messages in the inbox
* a sensor with data usage
## {% linkable_title Configuration %}
To enable the component, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
netgear_lte:

4
source/_components/no_ip.markdown
View File

@ -8,12 +8,14 @@ comments: false
sharing: true
footer: true
logo: noip.png
ha_category: Utility
ha_category: Network
ha_release: 0.57
---
With the `no_ip` component you can keep your [NO-IP.com](https://www.noip.com) record up to date.
To use the component in your installation, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/rachio.markdown
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

4
source/_components/ring.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: ring.png
ha_category: Hub
ha_category: Doorbell
ha_release: 0.42
---
@ -16,6 +16,8 @@ The `ring` implementation allows you to integrate your [Ring.com](https://ring.c
Currently only doorbells are supported by this sensor.
## {% linkable_title Configuration %}
To enable device linked in your [Ring.com](https://ring.com/) account, add the following to your `configuration.yaml` file:
```yaml

100
source/_components/sensor.airvisual.markdown
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)

4
source/_components/sensor.api_stream.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Utility
ha_release: 0.33
ha_iot_class: "Local Push"
---
The `api_stream` sensor platform shows how many clients are connected to the stream API
## {% linkable_title Configuration %}
To add the connected clients to your installation, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/sensor.bbox.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: bbox.png
ha_category: Sensor
ha_category: Network
ha_release: 0.31
ha_iot_class: "Local Push"
---
@ -19,6 +19,8 @@ The `bbox` platform uses the [Bbox Modem Router](https://fr.wikipedia.org/wiki/B
Due to third party limitation, the sensors will only be available if Home Assistant and the Bbox are on the same local area network. You can check this by going to 192.168.1.254 with your web browser.
</p>
## {% linkable_title Configuration %}
To add Bbox sensors to your installation, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/sensor.canary.markdown
View File

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

4
source/_components/sensor.command_line.markdown
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

12
source/_components/sensor.crimereports.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: Social
logo: crimereports.png
ha_release: 0.42
ha_iot_class: "Cloud Polling"
@ -15,7 +15,7 @@ ha_iot_class: "Cloud Polling"
The `crimereports` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Crime Reports](http://crimereports.com). Your regional emergency services may or may not report data. The sensor only counts incidents from the current day.
## Configuration
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`. Your `radius` should be of sufficient size to capture incidents in your area.
@ -36,13 +36,13 @@ Configuration options for the Crime Reports Sensor:
- **exclude** (*Optional*): List of incident types to exclude.
## Notes
## {% linkable_title Notes %}
### Area
### {% linkable_title Area %}
Crime Reports captures all incidents in a region defined by a square shape. Home Assistant zones are circular. Therefore, the region defined by a Home Assistant zone in a Crime Reports context is a square that is big enough to fit the zone circle. Practically, this means some incidents may be captured that are outside your zone.
### Incident Types
### {% linkable_title Incident Types %}
You can explicitly include or exclude incident types. Specifying `include`s restricts the incidents to those types. Specifying `exclude`s will return all incident types except those specified.
@ -83,6 +83,6 @@ These incident types are available:
- Vehicle Stop
- Weapons Offense
### Events
### {% linkable_title Events %}
The `crimealerts` sensor fires a `crimealerts_incident` event when a new incident is detected, including the type, description, time, location, and coordinates of the incident.

6
source/_components/sensor.daikin.markdown
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

6
source/_components/sensor.discogs.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: https://www.magneticmag.com/.image/t_share/MTQ5OTE1NzU4NTczMzk3OTYw/discogs-vinyl-record-mark.png
ha_category: Sensor
ha_category: Multimedia
ha_release: 0.61
logo: discogs.png
ha_iot_class: "Cloud Polling"
@ -16,9 +16,13 @@ ha_iot_class: "Cloud Polling"
The `discogs` platform allows you to see the current amount of records in your [Discogs](https://discogs.com) collection.
## {% linkable_title Setup %}
First, you'll need to get a personal access token from your Discogs account.
You can generate a token from your profile's [Developer settings](https://www.discogs.com/settings/developers).
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml

6
source/_components/sensor.dnsip.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "DNS IP"
title: "DNS IP Sensor"
description: "Instructions on how to integrate a DNS IP sensor into Home Assistant."
date: 2017-02-25 11:05
sidebar: true
@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Network
ha_iot_class: "Cloud Polling"
ha_release: "0.40"
---
@ -21,6 +21,8 @@ The `dnsip` sensor will expose an IP address, fetched via DNS resolution, as its
You may also override the nameserver that is being used by setting the `resolver` parameter to any nameserver you like.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml

4
source/_components/sensor.duke_energy.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: duke_energy.png
ha_category: Sensor
ha_category: Energy
ha_release: "0.74"
ha_iot_class: "Cloud Polling"
---
The `duke_energy` sensor platform allows you get the previous days usage for all of your Duke Energy smart meters.
## {% linkable_title Setup %}
You will only have access to meters listed in your account at [Duke Energy Usage](https://www.duke-energy.com/my-account/usage-analysis).
This supports both electric and gas meters. Along with previous days usage, each sensor will have attributes for the previous bills total usage and average usage.

2
source/_components/sensor.dyson.markdown
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
---

6
source/_components/sensor.ebox.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "EBox"
title: "EBox Sensor"
description: "Instructions on how to integrate EBox data usage within Home Assistant."
date: 2017-02-15 17:17
sidebar: true
@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: ebox.png
ha_category: Sensor
ha_category: Network
ha_release: 0.39
ha_iot_class: "Cloud Polling"
---
Integrate your [EBox](https://client.ebox.ca/) account information into Home Assistant.
## {% linkable_title Configuration %}
To use your EBox sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/sensor.ecobee.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: ecobee.png
ha_category: Binary Sensor
ha_category: Environment
ha_release: 0.9
ha_iot_class: "Local Push"
---

4
source/_components/sensor.fail2ban.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: Network
ha_iot_class: "Local Polling"
logo: fail2ban.png
ha_release: 0.57
@ -20,6 +20,8 @@ The `fail2ban` sensor allows for IPs banned by [fail2ban](https://www.fail2ban.o
Your system must have `fail2ban` installed and correctly configured for this sensor to work. In addition, Home Assistant must be able to read the `fail2ban` log file.
</p>
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml

8
source/_components/sensor.fido.markdown
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

4
source/_components/sensor.file.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: file.png
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.45
---
@ -16,6 +16,8 @@ ha_release: 0.45
The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [whitelist_external_dirs](/docs/configuration/basic/).
## {% linkable_title Configuration %}
To enable the `file` sensor, add the following lines to your `configuration.yaml`:
```yaml

11
source/_components/sensor.filesize.markdown
View File

@ -1,6 +1,6 @@
---
layout: page
title: "File size sensor"
title: "File size Sensor"
description: "Component for monitoring the size of a file."
date: 2018-02-06 14:00
sidebar: true
@ -8,13 +8,16 @@ comments: false
sharing: true
footer: true
logo: file.png
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.64
---
Component for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](/docs/configuration/basic/).
Add to your config:
The `filesize` sensor for displaying the size in MB of a file. Note that paths must be added to [whitelist_external_dirs](/docs/configuration/basic/).
## {% linkable_title Configuration %}
To enable the `filesize` sensor, add the following lines to your `configuration.yaml`:
```yaml
sensor:

5
source/_components/sensor.filter.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: Utility
ha_release: 0.65
ha_iot_class: "Local Push"
logo: home-assistant.png
@ -21,8 +21,9 @@ The `filter` platform enables sensors that process the states of other entities.
<img src='{{site_root}}/images/screenshots/filter-sensor.png' />
</p>
To enable Filter Sensors in your installation, add the following to your `configuration.yaml` file:
## {% linkable_title Configuration %}
To enable Filter Sensors in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

4
source/_components/sensor.folder.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: file.png
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.64
---
Sensor for monitoring the contents of a folder. Note that folder paths must be added to [whitelist_external_dirs](/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria. The number of filtered files in the folder and total size in bytes of those files are exposed as attributes.
## {% linkable_title Configuration %}
To enable the `folder` sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

27
source/_components/sensor.gpsd.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: gpsd.png
ha_category: Sensor
ha_category: Utility
ha_release: 0.26
ha_iot_class: "Local Polling"
---
The `gpsd` component is using the GPS information collected by [gpsd](http://catb.org/gpsd/) and a GPS receiver.
## {% linkable_title Setup %}
A requirement is that `gpsd` is installed (`$ sudo apt-get install gpsd` or `$ sudo dnf -y install gpsd`). `gpsd` uses the socket activation feature of systemd on recent Linux distributions for USB receivers. This means that if you plug your GPS receiver in, `gpsd` is started. Other GPS device may work too, but this was not tested.
```bash
@ -40,6 +42,8 @@ Escape character is '^]'.
{"class":"VERSION","release":"3.15","rev":"3.15-2.fc23","proto_major":3,"proto_minor":11}
```
## {% linkable_title Configuration %}
To setup a GPSD sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
@ -48,8 +52,21 @@ sensor:
- platform: gpsd
```
Configuration variables:
{% configuration %}
host:
description: The host where GPSD is running.
required: false
type: string
default: localhost
port:
description: The port which GPSD is using.
required: false
type: int
default: 2947
name:
description: Friendly name to use for the frontend.
required: false
type: string
default: GPS
{% endconfiguration %}
- **host** (*Optional*): The host where GPSD is running. Defaults to `localhost`.
- **port** (*Optional*): The port which GPSD is using. Defaults to `2947`.
- **name** (*Optional*): Friendly name to use for the frontend. Default to GPS.

2
source/_components/sensor.history_stats.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.39
---

2
source/_components/sensor.juicenet.markdown
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
---

7
source/_components/sensor.lacrosse.markdown
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

4
source/_components/sensor.luftdaten.markdown
View File

@ -15,9 +15,13 @@ ha_iot_class: "Cloud Polling"
The `luftdaten` sensor platform will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station.
## {% linkable_title Setup %}
- To get the ID of a particle sensor you need to select it on the [Feinstaub map](http://deutschland.maps.luftdaten.info/) and find it in the sidebar (Column "Sensor ID").
- To get the ID of a temperature/humidity sensor you need to find it on the map hosted on [Madavi](https://www.madavi.de/sensor/feinstaub-map-dht/).
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml` file:
```yaml

6
source/_components/sensor.magicseaweed.markdown
View File

@ -14,10 +14,14 @@ ha_release: "0.75"
ha_iot_class: "Cloud Polling"
---
The 'magicseaweed' platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice.
The `magicseaweed` platform uses the [Magicseaweed Forecast API](https://magicseaweed.com/developer/forecast-api) as a source for surf forecasting data for the surf spots of your choice.
## {% linkable_title Setup %}
You need an API key which is free but requires [registration](https://magicseaweed.com/developer/sign-up). Magicseaweed is limiting users of the API to 1 spot for the free plan.
## {% linkable_title Configuration %}
To add Magicseaweed forecasts to your installation, add the following to your `configuration.yaml` file:
```yaml

4
source/_components/sensor.melissa.markdown
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.

2
source/_components/sensor.mfi.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: ubiquiti.png
ha_category: Sensor
ha_category: Network
ha_iot_class: "Local Polling"
ha_release: 0.32
---

10
source/_components/sensor.min_max.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: "0.31"
---
@ -18,15 +18,19 @@ The `min_max` sensor platform consumes the state from other sensors to determine
This sensor is an alternative to the [template sensor](/components/sensor.template/)'s `value_template:` to get the average of multiple sensors.
{% raw %}
```yaml
{% raw %}{{ ((float(states.sensor.kitchen_temperature.state) +
{{ ((float(states.sensor.kitchen_temperature.state) +
float(states.sensor.living_room_temperature.state) +
float(states.sensor.office_temperature.state)) / 3) | round(2)
}}{% endraw %}
}}
```
{% endraw %}
Sensors with an unknown state will be ignored in the calculation. If the unit of measurement of the sensors differs, the `min_max` sensor will go to an error state where the value is `UNKNOWN` and unit of measurement is `ERR`.
## {% linkable_title Configuration %}
To enable the `min_max` sensor, add the following lines to your `configuration.yaml`:
```yaml

47
source/_components/sensor.modem_callerid.markdown
View File

@ -14,6 +14,26 @@ ha_iot_class: "Local Polling"
The `modem_callerid` sensor platform uses an available modem for collecting caller ID information. It requires a Hayes AT compatible modem that supports caller ID detection (via AT+VCID=1).
When the sensor detects a new call, its state changes to 'ring' for each ring and 'callerid' when caller id information is received. It returns to 'idle' once ringing stops. The state event includes an attribute payload that includes the time of the call, name and number.
## {% linkable_title Setup %}
To find the path of your USB modem, run:
```bash
$ ls /dev/ttyACM*
```
If Home Assistant (`hass`) runs with another user (e.g., `homeassistant` on Hassbian) give access to the stick with:
```bash
$ 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/).
## {% linkable_title Configuration %}
To enable the sensor, add the following lines to your `configuration.yaml`:
```yaml
@ -22,10 +42,19 @@ sensor:
- platform: modem_callerid
```
Configuration variables:
{% configuration %}
name:
description: Name of the sensor to use in the frontend.
required: false
type: string
default: "`modem_callerid`"
device:
description: The port to use.
required: false
type: string
default: "`/dev/ttyACM0`"
{% endconfiguration %}
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `modem_callerid`.
- **device** (*Optional*): Device port name. Defaults to `/dev/ttyACM0`.
To find the path of your USB modem, run:
@ -37,11 +66,15 @@ 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/).
When the sensor detects a new call, its state changes to 'ring' for each ring and 'callerid' when caller id information is received. It returns to 'idle' once ringing stops. The state event includes an attribute payload that includes the time of the call, name and number.
## {% linkable_title Examples %}
Some example automations:
{% raw %}
```yaml
{% raw %}automation:
automation:
- alias: Notify CallerID
trigger:
platform: state
@ -69,6 +102,6 @@ Some example automations:
action:
service: tts.google_say
data_template:
message: 'Call from {{ states.sensor.modem_callerid.attributes.cid_name }} '{% endraw %}
message: 'Call from {{ states.sensor.modem_callerid.attributes.cid_name }}'
```
{% endraw %}

8
source/_components/sensor.mold_indicator.markdown
View File

@ -8,14 +8,18 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Climate
ha_release: '0.20'
ha_iot_class: "Local Polling"
---
The Mold Indicator sensor component consumes information of two temperature sensors and a humidity sensor to give an indication for possible mold growth in your home. In case of bad ventilation and insulation, the indoor humidity may lead to condensation on cold surfaces as the windows or even walls. Condensation or a high relative humidity near those cold surfaces leads to a higher risk for mold growth. This sensor component estimates the temperature at a pre-calibrated critical point in the room (the coldest surface) and calculates the relative humidity of the air at that point. If the sensor value rises above approximately 70 percent, mold growth might occur and the room should be ventilated. At 100%, the air humidity condensates at the critical point.
The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum. To use the Mold Indicator sensor in your installation, add the following to your `configuration.yaml` file:
The sensor data may be used e.g., to signal bad air quality (too high air humidity) or to automate operation of indoor air humidifiers to keep the indoor humidity at an optimum.
## {% linkable_title Configuration %}
To use the Mold Indicator sensor in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry

5
source/_components/sensor.moon.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Weather
ha_category: Environment
ha_iot_class: "Local Polling"
ha_release: 0.38
---
@ -16,6 +16,8 @@ ha_release: 0.38
The `moon` sensor platform is tracking the moon phases.
## {% linkable_title Configuration %}
To enable the moon sensor, add the following lines to your `configuration.yaml`:
```yaml
@ -23,5 +25,6 @@ To enable the moon sensor, add the following lines to your `configuration.yaml`:
sensor:
- platform: moon
```
This sensor will return one of the following values:
`new_moon`, `waxing_crescent`, `first_quarter`, `waxing_gibbous`, `full_moon`, `waning_gibbous`, `last_quarter` or `waning_crescent` .

4
source/_components/sensor.netatmo_public.markdown
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

28
source/_components/sensor.netgear_lte.markdown
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 %}

2
source/_components/sensor.noaa_tides.markdown
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
---

2
source/_components/sensor.openevse.markdown
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"
---

4
source/_components/sensor.otp.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.49
---
The `otp` sensor generates One-Time Passwords according to [RFC6238](https://tools.ietf.org/html/rfc6238) that is compatible with most OTP generators available, including Google Authenticator. You can use this when building custom security solutions and want to use "rolling codes", that change every 30 seconds.
## {% linkable_title Configuration %}
To enable the OTP sensor, add the following lines to your `configuration.yaml`:
```yaml

4
source/_components/sensor.pocketcasts.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: pocketcasts.png
ha_category: Sensor
ha_category: Multimedia
ha_release: 0.39
ha_iot_class: "Cloud Polling"
---
The `pocketcasts` sensor platform let one monitor the podcasts at [Pocket Casts](https://play.pocketcasts.com/).
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml

2
source/_components/sensor.qnap.markdown
View File

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

2
source/_components/sensor.random.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.32
---

4
source/_components/sensor.ring.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: ring.png
ha_category: Sensor
ha_category: Doorbell
ha_release: "0.40"
ha_iot_class: "Cloud Polling"
---
To get your [Ring.com](https://ring.com/) binary sensors working within Home Assistant, please follow the instructions for the general [Ring component](/components/ring).
## {% linkable_title Configuration %}
Once you have enabled the [Ring component](/components/ring), add the following to your `configuration.yaml` file:
```yaml

16
source/_components/sensor.season.markdown
View File

@ -7,13 +7,13 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: Utility
logo: home-assistant.png
ha_iot_class: "Local Polling"
ha_release: 0.53
---
This sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the users setting in the config file.
The `season` sensor will display the current astronomical or meteorological season (Spring, Summer, Autumn, Winter) based on the user's setting in the configuration file.
All information about how the seasons work was taken from Wikipedia:
@ -21,6 +21,9 @@ All information about how the seasons work was taken from Wikipedia:
- [https://en.wikipedia.org/wiki/Equinox](https://en.wikipedia.org/wiki/Equinox)
- [https://en.wikipedia.org/wiki/Solstice](https://en.wikipedia.org/wiki/Solstice)
## {% linkable_title Configuration %}
To enable the sensor, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
@ -29,6 +32,11 @@ sensor:
type: astronomical
```
Configuration variables:
{% configuration %}
type:
description: "Type of season definition. Options are `meteorological` or `astronomical`."
required: false
type: string
default: astronomical
{% endconfiguration %}
- **type** (*Optional*): Type of season definition. Options are `meteorological` or `astronomical`. Default is `astronomical`.

21
source/_components/sensor.sigfox.markdown
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

10
source/_components/sensor.simulated.markdown
View File

@ -8,16 +8,16 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: 0.65
---
The `simulated` sensor platform provides a simulated sensor that generates a time-varying signal ```V(t)``` given by the [function](https://en.wikipedia.org/wiki/Sine_wave):
The `simulated` sensor platform provides a simulated sensor that generates a time-varying signal `V(t)` given by the [function](https://en.wikipedia.org/wiki/Sine_wave):
```
V(t) = M + A sin((2 pi (t - t_0) / w) + P) + N(s)
```
```text
V(t) = M + A sin((2 pi (t - t_0) / w) + P) + N(s)
```
where:

4
source/_components/sensor.skybell.markdown
View File

@ -8,13 +8,15 @@ comments: false
sharing: true
footer: true
logo: skybell.png
ha_category: Sensor
ha_category: Doorbell
ha_release: 0.56
ha_iot_class: "Cloud Polling"
---
To get your [Skybell.com](https://skybell.com/) sensors working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell).
## {% linkable_title Configuration %}
Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file:
```yaml

2
source/_components/sensor.smappee.markdown
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.

19
source/_components/sensor.socialblade.markdown
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 %}

2
source/_components/sensor.sql.markdown
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
---

8
source/_components/sensor.startca.markdown
View File

@ -8,16 +8,18 @@ comments: false
sharing: true
footer: true
logo: startca.png
ha_category: Sensor
ha_category: Network
ha_release: 0.64
ha_iot_class: "Cloud Polling"
---
Integrate your [Start.ca](https://www.start.ca/) account information into Home Assistant.
You can get your API key from:
## {% linkable_title Setup %}
[Start.ca Usage API](https://www.start.ca/support/usage/api)
You can get your API key from: [Start.ca Usage API](https://www.start.ca/support/usage/api)
## {% linkable_title Configuration %}
To use your Start.ca sensor in your installation, add the following to your `configuration.yaml` file:

4
source/_components/sensor.statistics.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Polling"
ha_release: "0.30"
---
@ -19,6 +19,8 @@ The `statistics` sensor platform consumes the state from other sensors. Besides
If you are running the [recorder](/components/recorder/) component, on startup the data is read from the database. So after a restart of the platform, you will immediately have data available. If you're using the [history](/components/history/) component, this will automatically also start the `recorder` component on startup.
If you are *not* running the `recorder` component, it can take time till the sensor starts to work because a couple of attributes need more than one value to do the calculation.
## {% linkable_title Configuration %}
To enable the statistics sensor, add the following lines to your `configuration.yaml`:
```yaml

4
source/_components/sensor.sytadin.markdown
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

54
source/_components/sensor.tank_utility.markdown
View File

@ -8,37 +8,51 @@ comments: false
sharing: true
footer: true
logo: tank_utility.png
ha_category: Sensor
ha_category: Energy
ha_release: "0.53"
---
Add [Tank Utility](https://www.tankutility.com/) propane tank monitors to Home Assistant.
## {% linkable_title Setup %}
### {% linkable_title Authentication %}
Authentication for the Tank Utility API is performed with the same email and password credentials used at [https://app.tankutility.com](https://app.tankutility.com).
### {% linkable_title Devices %}
Each item in the list of devices is a 24 character string. These values can be found by clicking on the **Usage Reports** link at the bottom of the graph on the [Tank Utility devices page](https://app.tankutility.com/#/devices).
The device item value is the last segment of the URL path, e.g., the URL
[https://app.tankutility.com/#/reports/000000000000000000000000](https://app.tankutility.com/#/reports/000000000000000000000000) would indicate `000000000000000000000000` as a device value.
## {% linkable_title Configuration %}
To enable the component, add the following lines to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: tank_utility
email: EMAIL
password: PASSWORD
email: YOUR_EMAIL_ADDRESS
password: YOUR_PASSWORD
devices:
- 000000000000000000000000
```
Configuration variables:
{% configuration %}
email:
description: "Your [https://app.tankutility.com](https://app.tankutility.com) email address."
required: true
type: string
password:
description: "Your [https://app.tankutility.com](https://app.tankutility.com) password."
required: true
type: string
unit_of_measurement:
description: All devices to monitor.
required: true
type: map
{% endconfiguration %}
* **email** *(Required)*: [https://app.tankutility.com](https://app.tankutility.com) email address
* **password** *(Required)*: [https://app.tankutility.com](https://app.tankutility.com) password
* **devices** *(Required)*: List of devices
Authentication:
Authentication for the Tank Utility API is performed with the same email and password credentials used at
[https://app.tankutility.com](https://app.tankutility.com).
Devices:
Each item in the list of devices is a 24 character string. These values can be found by clicking on the **Usage
Reports** link at the bottom of the graph on the [Tank Utility devices page](https://app.tankutility.com/#/devices).
The device item value is the last segment of the URL path, e.g., the URL
[https://app.tankutility.com/#/reports/000000000000000000000000](https://app.tankutility.com/#/reports/000000000000000000000000)
would indicate `000000000000000000000000` as a device value.

4
source/_components/sensor.teksavvy.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: teksavvy.png
ha_category: Sensor
ha_category: Network
ha_release: 0.62
ha_iot_class: "Cloud Polling"
---
@ -17,6 +17,8 @@ Integrate your [TekSavvy](https://myaccount.teksavvy.com/) account information i
You can get your API key from [TekSavvy My Account](https://myaccount.teksavvy.com/ApiKey/ApiKeyManagement).
## {% linkable_title Configuration %}
To use your TekSavvy sensor in your installation, add the following to your `configuration.yaml` file:
```yaml

2
source/_components/sensor.tradfri.markdown
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

20
source/_components/sensor.uptime.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Pushing"
logo: home-assistant.png
ha_release: 0.56
@ -16,6 +16,8 @@ ha_release: 0.56
The `uptime` sensor platform displays the time since the last Home Assistant restart.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml`:
```yaml
@ -24,10 +26,20 @@ sensor:
- platform: uptime
```
Configuration variables:
{% configuration %}
name:
description: Name to use in the frontend.
required: false
type: string
default: Uptime
unit_of_measurement:
description: "Units for uptime measurement in either `days`, `hours`, or `minutes`."
required: false
type: string
default: days
{% endconfiguration %}
- **name** (*Optional*): Name of the sensor. Defaults to `Uptime`.
- **unit_of_measurement** (*Optional*): Units for uptime measurement in either `days`, `hours`, or `minutes`. Defaults to `days`.
## {% linkable_title Example %}
```yaml
# Example with configuration variables

16
source/_components/sensor.version.markdown
View File

@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Sensor
ha_category: Utility
ha_iot_class: "Local Pushing"
logo: home-assistant.png
ha_release: 0.52
@ -16,6 +16,8 @@ ha_release: 0.52
The `version` sensor platform is displaying the current version of Home Assistant in the frontend.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request:
```yaml
@ -24,9 +26,13 @@ sensor:
- platform: version
```
Configuration variables:
- **name** (*Optional*): Name of the sensor. Defaults to `Current Version`.
{% configuration %}
name:
description: Name to use in the frontend.
required: false
type: string
default: Current Version
{% endconfiguration %}
## {% linkable_title Alternatives %}
@ -58,6 +64,7 @@ sensor:
You might think that a [`rest` sensor](/components/sensor.rest/) could work, too, but it will not as Home Assistant is not ready when the sensor get initialized.
{% raw %}
```yaml
sensor:
- platform: rest
@ -65,3 +72,4 @@ sensor:
name: Current Version
value_template: '{{ value_json.version }}'
```
{% endraw %}

2
source/_components/sensor.whois.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: icann.png
ha_category: Sensor
ha_category: Network
ha_release: "0.57"
ha_iot_class: "Cloud Polling"
---

2
source/_components/sensor.worldtidesinfo.markdown
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
---

4
source/_components/sensor.xiaomi_miio.markdown
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

2
source/_components/skybell.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: skybell.png
ha_category: Hub
ha_category: Doorbell
ha_release: 0.56
ha_iot_class: "Cloud Polling"
---

2
source/_components/sun.markdown
View File

@ -8,7 +8,7 @@ comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Weather
ha_category: Environment
---
The sun component will use your current location to track if the sun is above or below the horizon. The sun can be used within automation as [a trigger with an optional offset to simulate dawn/dusk][automation-trigger].

4
source/_components/switch.rachio.markdown
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

2
source/_components/switch.skybell.markdown
View File

@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling"
To get your [Skybell.com](https://skybell.com/) switches working within Home Assistant, please follow the instructions for the general [Skybell component](/components/skybell).
## {% linkable_title Configuration %}
Once you have enabled the [Skybell component](/components/skybell), add the following to your `configuration.yaml` file:
```yaml