mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Move to Network category (#6181)
* Move to Network category * Update category and other fixes
This commit is contained in:
Fabian Affolter
GitHub
parent
a1277a8cb6
commit
95546aa3fc
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
---
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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 %}
|
||||
|
||||
@ -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
|
||||
---
|
||||
|
||||
@ -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
|
||||
---
|
||||
|
||||
@ -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:
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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 %}
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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.
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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,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
|
||||
|
||||
@ -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:
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
---
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
---
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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"
|
||||
---
|
||||
|
||||
@ -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
|
||||
---
|
||||
|
||||
@ -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`.
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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 %}
|
||||
|
||||
@ -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"
|
||||
---
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user