mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 17:27:19 +00:00
Remove empty lines and trailing spaces (#6978)
Add missing titles and empty lines Fix variable type and missing defaults
This commit is contained in:
Jorim Tielemans
Fabian Affolter
parent
7eace6c371
commit
a52f37c913
@ -13,5 +13,5 @@ ha_release: 0.36
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `bbb_gpio` component is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding pages.
|
||||
|
||||
The `bbb_gpio` component is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant.
|
||||
There is no setup needed for the component itself, for the platforms please check their corresponding pages.
|
||||
|
||||
@ -13,10 +13,9 @@ ha_release: "0.40"
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `android_ip_webcam` binary sensor platform lets you observe the motion state of [Android IP webcam](https://play.google.com/store/apps/details?id=com.pas.webcam) sensors through Home Assistant.
|
||||
|
||||
Devices will be configured automatically. Please refer to the [component](/components/android_ip_webcam/) configuration on how to setup.
|
||||
Devices will be configured automatically. Please refer to the [Android IP webcam](/components/android_ip_webcam/) configuration on how to setup.
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
|
||||
@ -13,7 +13,6 @@ ha_iot_class: "Local Polling"
|
||||
ha_release: 0.9
|
||||
---
|
||||
|
||||
|
||||
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
@ -62,5 +61,5 @@ binary_sensor:
|
||||
```
|
||||
|
||||
<p class='note'>
|
||||
This sensor is not suitable for fast state changes because there is a high possibility that the change took place between two update cycle.
|
||||
This sensor is not suitable for fast state changes because there is a high possibility that the change took place between two update cycle.
|
||||
</p>
|
||||
|
||||
@ -20,4 +20,3 @@ If you have August Doorbell, once you have enabled the [August component](/compo
|
||||
* Doorbell ding sensor
|
||||
* Doorbell motion sensor
|
||||
* Doorbell online sensor
|
||||
|
||||
|
||||
@ -14,4 +14,4 @@ ha_release: "0.40"
|
||||
|
||||
<p class='note'>
|
||||
To get your Blink binary sensors working with Home Assistant, follow the instructions for the general [Blink component](/components/blink/).
|
||||
</p>
|
||||
</p>
|
||||
|
||||
@ -12,7 +12,6 @@ ha_category: Car
|
||||
ha_release: 0.66
|
||||
---
|
||||
|
||||
|
||||
The `bmw_connected_drive` binary sensor platform allows you to import data on your BMW into Home Assistant.
|
||||
|
||||
The binary sensors will be automatically configured if `bmw_connected_drive` component is configured.
|
||||
|
||||
@ -15,7 +15,7 @@ ha_iot_class: "Local Polling"
|
||||
|
||||
The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets.
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your Digital Ocean droplets, you first have to set up your [Digital Ocean hub](/components/digital_ocean/) and then add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -34,4 +34,3 @@ droplets:
|
||||
required: true
|
||||
type: list
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ ha_category: Binary Sensor
|
||||
ha_iot_class: "Polling"
|
||||
---
|
||||
|
||||
The `egardia` platform allows you to get data from your [Egardia](http://www.egardia.com)/[Woonveilig](http://www.woonveilig.nl) binary sensors from within Home Assistant.
|
||||
The `egardia` platform allows you to get data from your [Egardia](http://www.egardia.com)/[Woonveilig](http://www.woonveilig.nl) binary sensors from within Home Assistant.
|
||||
Currently only door contacts are supported. IR sensors are not supported and will probably never be since their status cannot be read outside of the alarm control panel. Smoke sensors and others might be added but currently are not supported.
|
||||
|
||||
You will need to set up your [Egardia hub](/components/egardia/).
|
||||
|
||||
@ -13,7 +13,6 @@ ha_release: "0.44"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `eight_sleep` binary sensor platform lets you observe the presence state of a [Eight Sleep](https://eightsleep.com/) cover/mattress through Home Assistant.
|
||||
|
||||
Devices will be configured automatically. Please refer to the [`eight_sleep` component](/components/eight_sleep/) configuration on how to setup.
|
||||
|
||||
@ -13,14 +13,16 @@ ha_release: 0.21
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
This can typically be one of those batteryless wall switches.
|
||||
Tested with:
|
||||
This can typically be one of those batteryless wall switches.
|
||||
Tested with:
|
||||
|
||||
- Eltako FT55 which uses the EnOcean PTM 215 module
|
||||
- [TRIO2SYS Wall switches](http://www.trio2sys.fr/index.php/fr/produits-enocean-sans-fil-sans-pile-interoperable/emetteur-sans-fils-sans-pile-interoperable-enocean) which uses the EnOcean PTM210 DB module
|
||||
|
||||
All switches using theses modules are expected to work. Other devices will most likely not work without changing the Home Assistant code.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use your EnOcean device, you first have to set up your [EnOcean hub](/components/enocean/) and then add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
@ -38,8 +40,8 @@ id:
|
||||
name:
|
||||
description: An identifier for the switch in the frontend.
|
||||
required: false
|
||||
default: EnOcean binary sensor
|
||||
type: string
|
||||
default: EnOcean binary sensor
|
||||
device_class:
|
||||
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
|
||||
required: false
|
||||
@ -53,6 +55,8 @@ EnOcean binary sensors only generate 'button_pressed' events. The event data has
|
||||
- **which**: Always `0` when using the single rocket. `0` or `1` when using the dual rocket switch.
|
||||
- **onoff**: `0` or `1` for either side of the rocket.
|
||||
|
||||
## {% linkable_title Automation example %}
|
||||
|
||||
Sample automation to switch lights on and off:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -13,8 +13,8 @@ ha_category: Binary Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `envisalink` platform allows you to get data from your [Envisalink](http://www.eyezon.com/) binary sensors from within Home Assistant.
|
||||
The `envisalink` platform allows you to get data from your [Envisalink](http://www.eyezon.com/) binary sensors from within Home Assistant.
|
||||
|
||||
Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone.
|
||||
|
||||
|
||||
The requirement is that you have setup your [Envisalink hub](/components/envisalink/).
|
||||
|
||||
@ -15,7 +15,7 @@ ha_release: 0.35
|
||||
|
||||
The `flic` platform allows you to receive click events from [flic](https://flic.io) smart buttons.
|
||||
|
||||
The platform does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine.
|
||||
The platform does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine.
|
||||
|
||||
#### {% linkable_title Service setup %}
|
||||
|
||||
|
||||
@ -61,6 +61,8 @@ and has been confirmed to work with the following models:
|
||||
- DS-2CD2142FWD-I
|
||||
- DS-2CD2155FWD-IS
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this sensor,
|
||||
add the following lines are required in your `configuration.yaml` file:
|
||||
|
||||
@ -123,6 +125,8 @@ customize:
|
||||
default: 5
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Supported types %}
|
||||
|
||||
Supported sensor/event types are:
|
||||
|
||||
- Motion
|
||||
@ -142,6 +146,8 @@ Supported sensor/event types are:
|
||||
- Face Detection
|
||||
- Scene Change Detection
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
Example of a configuration in your `configuration.yaml`
|
||||
that utilizes the customize options for a camera:
|
||||
|
||||
|
||||
@ -13,7 +13,6 @@ ha_release: 0.59
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
|
||||
The `hive` binary sensor component integrates your Hive sensors into Home Assistant.
|
||||
|
||||
The platform supports the following Hive products:
|
||||
@ -21,9 +20,6 @@ The platform supports the following Hive products:
|
||||
- Hive Window or Door Sensor
|
||||
- Hive Motion Sensor
|
||||
|
||||
|
||||
<p class='note'>
|
||||
Full configuration details can be found on the main [Hive component](/components/hive/) page.
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
@ -13,7 +13,6 @@ ha_release: 0.23
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
|
||||
The `homematic` binary sensor platform lets you observe the state changes of binary [Homematic](http://www.homematic.com/) sensors through Home Assistant.
|
||||
|
||||
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.
|
||||
Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic.
|
||||
|
||||
@ -27,6 +27,8 @@ be found in the IHC project and setup as binary sensors:
|
||||
- Dataline gas detector
|
||||
- Dataline light sensor
|
||||
|
||||
## {% linkable_title Manual configuration %}
|
||||
|
||||
To manually configure IHC Binary Sensors
|
||||
insert this section in your configuration:
|
||||
|
||||
|
||||
@ -13,9 +13,9 @@ ha_iot_class: "Local Push"
|
||||
ha_version: 0.77
|
||||
---
|
||||
|
||||
The `insteon` binary sensor platform lets you control your sensors through
|
||||
The `insteon` binary sensor platform lets you control your sensors through
|
||||
an INSTEON Modem (PLM and Hub) device connected directly to your system on a
|
||||
USB, serial port or TCPIP connection. To add support, set up the primary
|
||||
[insteon] component.
|
||||
|
||||
[insteon]: /components/insteon/
|
||||
[insteon]: /components/insteon/
|
||||
|
||||
@ -21,6 +21,8 @@ This means that ISS is 10° above the horizon of your home.
|
||||
You can check in the attributes of the sensor to see the timestamp for the next
|
||||
rise of the station, its current coordinates, and the number of people in space.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To add ISS binary sensor to your installation,
|
||||
add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -31,11 +33,16 @@ binary_sensor:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
name:
|
||||
description: The name for this sensor in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
default: ISS
|
||||
show_on_map:
|
||||
description: Option to show the position of the ISS on the map.
|
||||
required: optional
|
||||
type: boolean
|
||||
default: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
<p class='note warning'>
|
||||
|
||||
@ -14,5 +14,5 @@ ha_release: pre 0.7
|
||||
---
|
||||
|
||||
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) binary sensors from within Home Assistant.
|
||||
|
||||
|
||||
They will be automatically discovered if the `isy994` component is loaded.
|
||||
|
||||
@ -18,4 +18,3 @@ The `konnected` binary sensor allows you to monitor wired door sensors, window s
|
||||
See the [`konnected`](/components/konnected/) component for configuration and setup instructions.
|
||||
|
||||
This component supports all of the built-in device classes of the generic [Binary Sensor](/components/binary_sensor/) component.
|
||||
|
||||
|
||||
@ -18,4 +18,3 @@ The `mychevy` binary sensor platform allows you to monitor your Chevy Bolt car f
|
||||
The binary sensor platform will be automatically configured if the `mychevy` component is configured.
|
||||
|
||||
For configuration instructions, see the [`mychevy` component](/components/mychevy/) documentation.
|
||||
|
||||
|
||||
@ -13,7 +13,6 @@ ha_iot_class: "Local Polling"
|
||||
ha_release: 0.45
|
||||
---
|
||||
|
||||
|
||||
The `mystrom` binary sensor platform allows you to use [myStrom Wifi Buttons](https://mystrom.ch/wifi-button/) with Home Assistant. The myStrom Wifi Buttons support three and the myStrom WiFi Button + four different push pattern:
|
||||
|
||||
- `single`: Short push (approx. 1/2 seconds)
|
||||
|
||||
@ -13,13 +13,14 @@ ha_release: pre 0.7
|
||||
ha_iot_class: "Cloud Push"
|
||||
---
|
||||
|
||||
|
||||
The `nest` binary sensor platform lets you monitor various states of your [Nest](https://nest.com) devices.
|
||||
|
||||
<p class='note'>
|
||||
You must have the [Nest component](/components/nest/) configured to use these sensors. The binary sensors will be setup if the `nest` component is configured and the required configuration for the `nest binary sensor` is set.
|
||||
</p>
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable binary sensors and customize which sensors are setup, you can extend the [Nest component](/components/nest/) configuration in your `configuration.yaml` file with the following settings:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -12,12 +12,12 @@ ha_category: Binary Sensor
|
||||
ha_release: 0.31
|
||||
---
|
||||
|
||||
### {% linkable_title Basic Configuration %}
|
||||
|
||||
The `netatmo` binary sensor platform is consuming the information provided by a
|
||||
[Netatmo](https://www.netatmo.com) camera.
|
||||
This component allows you to get the latest event seen by the camera.
|
||||
|
||||
### {% linkable_title Basic Configuration %}
|
||||
|
||||
To enable the Netatmo binary sensor, you have to set up
|
||||
[netatmo](/components/netatmo/),
|
||||
this will use discovery to add your binary sensor.
|
||||
|
||||
@ -16,4 +16,3 @@ ha_iot_class: "Cloud Polling"
|
||||
The `openuv` binary sensor platform allows you to view binary sensor data from [OpenUV](http://openuv.io).
|
||||
|
||||
You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, binary sensors will automatically appear.
|
||||
|
||||
|
||||
@ -67,6 +67,8 @@ reset_delay_sec:
|
||||
default: 30
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Full example %}
|
||||
|
||||
A full configuration example could look like this:
|
||||
|
||||
```yaml
|
||||
|
||||
@ -13,7 +13,6 @@ ha_release: 0.43
|
||||
ha_qa_scale: internal
|
||||
---
|
||||
|
||||
|
||||
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 %}
|
||||
@ -26,6 +25,7 @@ binary_sensor:
|
||||
- platform: ping
|
||||
host: 192.168.0.1
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The IP address or hostname of the system you want to track.
|
||||
@ -40,10 +40,10 @@ name:
|
||||
description: Let you overwrite the name of the device.
|
||||
required: false
|
||||
type: string
|
||||
default: "`Ping Binary sensor`"
|
||||
default: Ping Binary sensor
|
||||
{% endconfiguration %}
|
||||
|
||||
The sensor exposes the different round trip times values measured by `ping` as attributes:
|
||||
The sensor exposes the different round trip times values measured by `ping` as attributes:
|
||||
|
||||
- `round trip time mdev`
|
||||
- `round trip time avg`
|
||||
@ -64,4 +64,3 @@ binary_sensor:
|
||||
<p class='note'>
|
||||
When run on Windows systems, the round trip time attributes are rounded to the nearest millisecond and the mdev value is unavailable.
|
||||
</p>
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ ha_release: 0.71
|
||||
---
|
||||
|
||||
The `rainmachine` binary sensor platform allows you to view crucial sensor data
|
||||
within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
|
||||
within a [RainMachine smart Wi-Fi sprinkler controller](http://www.rainmachine.com/).
|
||||
|
||||
<p class='note'>
|
||||
You must have the [RainMachine component](https://www.home-assistant.io/components/rainmachine/)
|
||||
|
||||
@ -31,5 +31,5 @@ name:
|
||||
description: Name to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
default: Random Binary Sensor
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
@ -33,6 +33,8 @@ The JSON messages can contain different values like `1`, `"1"`,
|
||||
}
|
||||
```
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this sensor,
|
||||
add the following lines to your `configuration.yaml` file for a GET request:
|
||||
|
||||
|
||||
@ -13,8 +13,8 @@ ha_category: Binary Sensor
|
||||
ha_iot_class: "Local Push"
|
||||
---
|
||||
|
||||
The `spc` platform allows you to get data from your [Vanderbilt SPC](http://www.spc-intruder-detection.com/ssp-spc/) binary sensors from within Home Assistant.
|
||||
The `spc` platform allows you to get data from your [Vanderbilt SPC](http://www.spc-intruder-detection.com/ssp-spc/) binary sensors from within Home Assistant.
|
||||
|
||||
Check the [type/class](/components/binary_sensor/) list for a possible visualization of your zone. Currently motion, smoke and door sensors are supported.
|
||||
|
||||
|
||||
The requirement is that you have setup your [SPC hub](/components/spc/).
|
||||
|
||||
@ -14,7 +14,9 @@ ha_release: 0.47
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `tapsaff` binary sensor provides the 'Taps Aff' status for a given location within the UK using [Taps Aff](http://www.taps-aff.co.uk).
|
||||
The `tapsaff` binary sensor provides the 'Taps Aff' status for a given location within the UK using [Taps Aff](http://www.taps-aff.co.uk).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml`:
|
||||
|
||||
@ -33,6 +35,6 @@ location:
|
||||
name:
|
||||
description: The name to use when displaying this sensor.
|
||||
required: false
|
||||
default: Taps Aff
|
||||
type: string
|
||||
default: Taps Aff
|
||||
{% endconfiguration %}
|
||||
|
||||
@ -13,4 +13,3 @@ featured: false
|
||||
---
|
||||
|
||||
Integrates Telldus Live binary sensors into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions.
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ ha_release: 0.53
|
||||
---
|
||||
|
||||
The `tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant.
|
||||
|
||||
|
||||
They will be automatically discovered if the Tesla component is loaded.
|
||||
|
||||
For more configuration information see the [Tesla component](/components/tesla/) documentation.
|
||||
|
||||
@ -14,7 +14,6 @@ ha_release: 0.34
|
||||
ha_qa_scale: internal
|
||||
---
|
||||
|
||||
|
||||
The `threshold` binary sensor platform observes the state of another sensor. If the value is below (`lower`) or higher (`upper`) than the given threshold then state of the threshold sensor is changed. It support also a range if `lower` and `upper` are given.
|
||||
|
||||
If the sensor is configured with no hysteresis and the sensor value is equal to the threshold, the sensor is turned off since it is not `lower` or `upper` with respect to the threshold.
|
||||
@ -61,6 +60,5 @@ name:
|
||||
description: Name of the sensor to use in the frontend.
|
||||
required: false
|
||||
type: string
|
||||
default:
|
||||
default: Threshold
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user