Skip to content

Commit 067eb35

Browse files
committed
Add 'ha_iot_class'
1 parent ebc09db commit 067eb35

File tree

85 files changed

+127
-70
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+127
-70
lines changed

source/_components/android_ip_webcam.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: android_ip_webcam.png
1111
ha_category: Hub
1212
ha_release: "0.40"
13+
ha_iot_class: "Local Polling"
1314
---
1415

1516
The `android_ip_webcam` component turns an Android phone into a network camera with multiple viewing options.

source/_components/binary_sensor.android_ip_webcam.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: android_ip_webcam.png
1111
ha_category: Binary Sensor
1212
ha_release: "0.40"
13+
ha_iot_class: "Local Polling"
1314
---
1415

1516

source/_components/binary_sensor.eight_sleep.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: eight_sleep.png
1111
ha_category: Binary Sensor
1212
ha_release: "0.44"
13+
ha_iot_class: "Cloud Polling"
1314
---
1415

1516

source/_components/binary_sensor.zha.markdown

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ sharing: true
99
footer: true
1010
logo: zigbee.png
1111
ha_category: Binary Sensor
12+
ha_iot_class: "Local Polling"
1213
---
1314

14-
To get your ZigBee binary sensors working with Home Assistant, follow the
15-
instructions for the general [ZigBee Home Automation
16-
component](/components/zha/).
15+
To get your ZigBee binary sensors working with Home Assistant, follow then instructions for the general [ZigBee Home Automationcomponent](/components/zha/).

source/_components/cover.scsgate.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ sharing: true
99
footer: true
1010
logo: bus_scs.png
1111
ha_category: Cover
12+
ha_iot_class: "Local Polling"
1213
---
1314

1415
The SCSGate devices can control motorized covers connected to the BTicino MyHome system.

source/_components/eight_sleep.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: eight_sleep.png
1111
ha_category: Hub
1212
ha_release: "0.44"
13+
ha_iot_class: "Cloud Polling"
1314
---
1415

1516
The `eight_sleep` component allows Home Assistant to fetch data from your [Eight Sleep](https://eightsleep.com/) smart cover or mattress.

source/_components/enocean.markdown

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
33
title: "EnOcean"
4-
description: "Connect EnOcean devices to home-assistant"
4+
description: "Connect EnOcean devices to Home Assistant"
55
date: 2016-05-25 23:39
66
sidebar: true
77
comments: false
@@ -10,6 +10,7 @@ footer: true
1010
logo: enocean.png
1111
ha_category: Hub
1212
ha_release: 0.21
13+
ha_iot_class: "Local Push"
1314
---
1415

1516
The [EnOcean](https://en.wikipedia.org/wiki/EnOcean) standard is supported by many different vendors. There are switches and sensors of many different kinds, and typically they employ energy harvesting to get power such that no batteries are unnecessary.

source/_components/light.enocean.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: enocean.png
1111
ha_category: Light
1212
ha_release: 0.21
13+
ha_iot_class: "Local Push"
1314
---
1415

1516
An EnOcean light can take many forms. Currently only one type has been tested: Eltako FUD61 dimmer.

source/_components/modbus.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ footer: true
1010
logo: modbus.png
1111
ha_category: Hub
1212
ha_release: pre 0.7
13-
ha_iot_class: "Local Polling"
13+
ha_iot_class: "Local Push"
1414
---
1515

1616

source/_components/notify.nfandroidtv.markdown

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: nfandroidtv.png
1111
ha_category: Notifications
1212
ha_release: 0.32
13+
ha_iot_class: "Local Polling"
1314
---
1415

1516

@@ -22,9 +23,9 @@ To enable the notification platform, add the following to your `configuration.ya
2223
```yaml
2324
# Example configuration.yaml entry
2425
notify:
25-
- platform: nfandroidtv
26-
name: Kitchen
27-
host: 192.168.1.12
26+
- platform: nfandroidtv
27+
name: Kitchen
28+
host: 192.168.1.12
2829
```
2930
3031
Configuration variables:

source/_components/scsgate.markdown

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: bus_scs.png
1111
ha_category: Hub
1212
ha_release: 0.13
13+
ha_iot_class: "Local Polling"
1314
---
1415

1516
The SCSGate component support the [SCSGate](https://translate.google.com/translate?hl=en&sl=it&tl=en&u=http%3A%2F%2Fguidopic.altervista.org%2Feibscsgt%2Finterface.html) device. This a homebrew device allows to interact with the MyHome system from BTicino/Legrande.
@@ -28,7 +29,7 @@ Configuration variables:
2829

2930
### {% linkable_title How to find the scs_id for your devices %}
3031

31-
The SCSGate component relies on the [scsgate](https://github.com/flavio/scsgate) python module.
32+
The SCSGate component relies on the [scsgate](https://github.com/flavio/scsgate) Python module.
3233

3334
This module provides also a command line tool called `scs-monitor`. This program can be used to find the IDs of your lights, switches and roller shutters and produce the YAML snippet to insert into your `configuration.yaml` file.
3435

source/_components/sensor.amcrest.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: amcrest.png
1111
ha_category: Sensor
1212
ha_release: 0.37
13+
ha_iot_class: "Local Polling"
1314
---
1415

1516
The `amcrest` sensor allows you to integrate your [Amcrest](https://amcrest.com/) IP camera in Home Assistant.

source/_components/sensor.android_ip_webcam.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: android_ip_webcam.png
1111
ha_category: Sensor
1212
ha_release: "0.40"
13+
ha_iot_class: "Local Polling"
1314
---
1415

1516

source/_components/sensor.apcupsd.markdown

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: page
3-
title: APCUPSd Sensor
3+
title: "APCUPSd Sensor"
44
description: "Instructions on how to set up APCUPSd sensors within Home Assistant."
55
date: 2016-02-10 18:28
66
sidebar: true
@@ -10,6 +10,7 @@ footer: true
1010
logo: apcupsd.png
1111
ha_release: 0.13
1212
ha_category: System Monitor
13+
ha_iot_class: "Local Polling"
1314
---
1415

1516
The `apcupsd` sensor platform allows you to monitor a UPS (battery backup) by using data from the [apcaccess](http://linux.die.net/man/8/apcaccess) command.

source/_components/sensor.api_stream.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: home-assistant.png
1111
ha_category: Sensor
1212
ha_release: 0.33
13+
ha_iot_class: "Local Push"
1314
---
1415

1516
The `api_stream` sensor platform shows how many clients are connected to the stream API

source/_components/sensor.arwn.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ sharing: true
99
footer: true
1010
ha_category: Sensor
1111
ha_release: 0.31
12+
ha_iot_class: "Local Polling"
1213
---
1314

1415
The `arwn` sensor platform is a client for the [Ambient Radio Weather Network](http://github.com/sdague/arwn) project. This collects weather station data and makes it available in an MQTT subtree.

source/_components/sensor.blink.markdown

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,9 @@ footer: true
1010
logo: blink.png
1111
ha_category: Sensor
1212
ha_release: "0.40"
13+
ha_iot_class: "Cloud Polling"
1314
---
1415

1516
<p class='note'>
1617
To get your Blink sensors working with Home Assistant, follow the instructions for the general [Blink component](/components/blink/).
17-
</p>
18+
</p>

source/_components/sensor.bom.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: bom.png
1111
ha_category: Weather
1212
ha_release: 0.29
13+
ha_iot_class: "Cloud Polling"
1314
---
1415

1516
The `bom` sensor platform uses the [Australian Bureau of Meteorology (BOM)](http://www.bom.gov.au) as a source for current (half-hourly) meteorological data.

source/_components/sensor.broadlink.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: broadlink.png
1111
ha_category: Sensor
1212
ha_release: 0.35
13+
ha_iot_class: "Local Polling"
1314
---
1415

1516

source/_components/sensor.cert_expiry.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: home-assistant.png
1111
ha_category: System Monitor
1212
ha_release: 0.44
13+
ha_iot_class: "depends"
1314
---
1415

1516
The `cert_expiry` sensor fetches information from a configured URL and displays the certificate expiry in days.

source/_components/sensor.darksky.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ ha_category: Weather
1212
featured: true
1313
ha_release: 0.30
1414
redirect_from: /components/sensor.forecast/
15+
ha_iot_class: "Cloud Polling"
1516
---
1617

1718
The `darksky` platform uses the [Dark Sky](https://darksky.net/) web service as a source for meteorological data for your location. The location is based on the `longitude` and `latitude` coordinates configured in your `configuration.yaml` file. The coordinates are auto-detected but to take advantage of the hyper-local weather reported by Dark Sky, you can refine them down to your exact home address. GPS coordinates can be found by using [Google Maps](https://www.google.com/maps) and clicking on your home or [Openstreetmap](http://www.openstreetmap.org/).

source/_components/sensor.dovado.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
ha_category: System Monitor
1111
logo: dovado.png
1212
ha_release: 0.32
13+
ha_iot_class: "Local Polling"
1314
---
1415

1516
The `dovado` platform let you monitor your router from [Dovado](http://www.dovado.com/)

source/_components/sensor.dweet.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: dweet.png
1111
ha_category: Sensor
1212
ha_release: "0.10"
13+
ha_iot_class: "Cloud Polling"
1314
---
1415

1516
The `dweet` sensor platform allows you to get details from your devices which are publishing their values to [Dweet.io](https://dweet.io/).

source/_components/sensor.eddystone_temperature.markdown

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,18 @@ All beacons that support the Eddystone protocol, have a temperature sensor and c
1919
## Requirements
2020

2121
As this platform uses `bluez` to scan for Bluetooth LE devices **a Linux OS with bluez installed** is required. In addition to that, the `libbluetooth` headers need to be installed:
22-
```shell
22+
23+
```bash
2324
$ sudo apt-get install libbluetooth-dev
2425
```
2526

2627
Scanning for Bluetooth LE devices also requires special permissions. To grant these to the python executable execute the following:
27-
```shell
28+
29+
```bash
2830
$ sudo apt-get install libcap2-bin
2931
$ sudo setcap 'cap_net_raw,cap_net_admin+eip' $(readlink -f $(which python3))
3032
```
3133

32-
## Configuration
33-
3434
To use your Eddystone beacon in your installation, add the following to your `configuration.yaml` file:
3535

3636
```yaml
@@ -42,16 +42,14 @@ sensor:
4242
living_room:
4343
namespace: "112233445566778899AA"
4444
instance: "000000000001"
45-
name: "Living Room" # optional
4645
kitchen:
4746
namespace: "112233445566778899AA"
4847
instance: "000000000002"
49-
name: "Kitchen" # optional
5048
```
5149
Configuration variables:
5250
- **bt_device_id** (*Optional*): The id of the bluetooth device that should be used for scanning (hci*X*). You can find the correct one using `hcitool dev` (default: 0).
5351
- **beacons** array (*Required*): The beacons that should be monitored.
5452
- **[entry]** (*Required*): Name of the beacon.
5553
- **namespace** (*Required*): Namespace ID of the beacon in hexadecimal notation. Must be exactly 20 characters (10 bytes) long.
56-
- **namespace** (*Required*): Instance ID of the beacon in hexadecimal notation. Must be exactly 12 characters (6 bytes) long.
54+
- **instance** (*Required*): Instance ID of the beacon in hexadecimal notation. Must be exactly 12 characters (6 bytes) long.
5755
- **name** (*Optional*): Friendly name of the beacon.

source/_components/sensor.eight_sleep.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: eight_sleep.png
1111
ha_category: Sensor
1212
ha_release: "0.44"
13+
ha_iot_class: "Cloud Polling"
1314
---
1415

1516

source/_components/sensor.enocean.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: enocean.png
1111
ha_category: Sensor
1212
ha_release: 0.21
13+
ha_iot_class: "Local Push"
1314
---
1415

1516

source/_components/sensor.fastdotcom.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ logo: fastdotcom.png
1111
ha_category: System Monitor
1212
featured: false
1313
ha_release: 0.26
14+
ha_iot_class: "Cloud Polling"
1415
---
1516

1617
The `fastdotcom` sensor component uses the [Fast.com](https://fast.com/) web service to measure network bandwidth performance.

source/_components/sensor.fedex.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: fedex.png
1111
ha_category: Sensor
1212
ha_release: 0.39
13+
ha_iot_class: "Cloud Polling"
1314
---
1415

1516
The `fedex` platform allows one to track deliveries by [FedEx](http://www.fedex.com/). To use this sensor, you need a [FedEx Delivery Manager](https://www.fedex.com/us/delivery/) account.

source/_components/sensor.gpsd.markdown

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ Jul 16 09:30:33 laptop019 gpsdctl[5305]: reached a running gpsd
3333
To check if your setup is working, connect to port 2947 on the host where `gpsd` is running with `telnet`. This may need adjustments to your firewall.
3434

3535
```bash
36-
3736
$ telnet localhost 2947
3837
Trying 127.0.0.1...
3938
Connected to localhost.

source/_components/sensor.haveibeenpwned.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: haveibeenpwned.png
1111
ha_category: Sensor
1212
ha_release: 0.31
13+
ha_iot_class: "Cloud Polling"
1314
---
1415

1516
The `haveibeenpwned` sensor platform creates sensors that check for breached email accounts on [haveibeenpwned](https://haveibeenpwned.com).

source/_components/sensor.http.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: http.png
1111
ha_category: Sensor
1212
ha_release: pre 0.7
13+
ha_iot_class: "Local Push"
1314
---
1415

1516
The URL for a sensor looks like the example below:

source/_components/sensor.influxdb.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: influxdb.png
1111
ha_category: Sensor
1212
ha_release: 0.32
13+
ha_iot_class: "depends"
1314
---
1415

1516
The `influxdb` sensor allows you to use values from an [InfluxDB](https://influxdb.com/) database to populate a sensor state. This can be use to present statistic about home_assistant sensors if used with the `influxdb` history component. It can also be used with an external data source.

source/_components/sensor.knx.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: knx.png
1111
ha_category: DIY
1212
ha_release: 0.29
13+
ha_iot_class: "Local Push"
1314
---
1415

1516
The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensors.

source/_components/sensor.metoffice.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: metoffice.jpg
1111
ha_category: Weather
1212
ha_release: 0.42
13+
ha_iot_class: "Cloud Polling"
1314
---
1415

1516
The `metoffice` sensor platform uses the Met Office's [DataPoint API][datapoint] for weather data.

source/_components/sensor.mfi.markdown

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ sharing: true
99
footer: true
1010
logo: ubiquiti.png
1111
ha_category: Sensor
12+
ha_iot_class: "Local Polling"
13+
ha_release: 0.32
1214
---
1315

1416

@@ -19,13 +21,10 @@ To add this platform to your installation, add the following to your `configurat
1921
```yaml
2022
# Example configuration.yaml entry
2123
sensor:
22-
platform: mfi
23-
host: IP_ADDRESS
24-
port: PORT
25-
username: USERNAME
26-
password: PASSWORD
27-
ssl: true
28-
verify_ssl: true
24+
- platform: mfi
25+
host: IP_ADDRESS
26+
username: USERNAME
27+
password: PASSWORD
2928
```
3029
3130
Configuration variables:

source/_components/sensor.mhz19.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: mhz19_logo.png
1111
ha_category: Sensor
1212
ha_release: 0.27
13+
ha_iot_class: "Local Polling"
1314
---
1415

1516
The MH-Z19 is a small nondispersive infrared sensor that can measure CO2 level. High CO2 levels can lead to drowsiness, poor concentration, loss of attention or increased heart rate. The CO2 level outside is around 400ppm, but inside levels can reach between 1000 and 5000 ppm. High CO2 levels indicate that you should increase ventilation.
@@ -19,6 +20,7 @@ Check out the [Open Home Automation web site](https://www.open-homeautomation.co
1920
To use this sensor in your installation, add the following to your `configuration.yaml` file:
2021

2122
```yaml
23+
# Example configuration.yaml entry
2224
sensor:
2325
- platform: mhz19
2426
serial_device: /dev/tty.SLAB_USBtoUART

0 commit comments

Comments
 (0)