-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.
diff --git a/source/_components/binary_sensor.august.markdown b/source/_components/binary_sensor.august.markdown index 4af76c345bc..9b25dd4a390 100644 --- a/source/_components/binary_sensor.august.markdown +++ b/source/_components/binary_sensor.august.markdown @@ -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 - diff --git a/source/_components/binary_sensor.blink.markdown b/source/_components/binary_sensor.blink.markdown index e8ef5640442..f0068b9d131 100644 --- a/source/_components/binary_sensor.blink.markdown +++ b/source/_components/binary_sensor.blink.markdown @@ -14,4 +14,4 @@ ha_release: "0.40"To get your Blink binary sensors working with Home Assistant, follow the instructions for the general [Blink component](/components/blink/). -
\ No newline at end of file + diff --git a/source/_components/binary_sensor.bmw_connected_drive.markdown b/source/_components/binary_sensor.bmw_connected_drive.markdown index 03a78c80bb6..e93a570681f 100644 --- a/source/_components/binary_sensor.bmw_connected_drive.markdown +++ b/source/_components/binary_sensor.bmw_connected_drive.markdown @@ -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. diff --git a/source/_components/binary_sensor.digital_ocean.markdown b/source/_components/binary_sensor.digital_ocean.markdown index 516abfe6e9a..d4e6c15cb62 100644 --- a/source/_components/binary_sensor.digital_ocean.markdown +++ b/source/_components/binary_sensor.digital_ocean.markdown @@ -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 %} - diff --git a/source/_components/binary_sensor.egardia.markdown b/source/_components/binary_sensor.egardia.markdown index d418559f8e9..4d60ded1886 100644 --- a/source/_components/binary_sensor.egardia.markdown +++ b/source/_components/binary_sensor.egardia.markdown @@ -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/). diff --git a/source/_components/binary_sensor.eight_sleep.markdown b/source/_components/binary_sensor.eight_sleep.markdown index 6811a640dda..4aaa5d3b81d 100644 --- a/source/_components/binary_sensor.eight_sleep.markdown +++ b/source/_components/binary_sensor.eight_sleep.markdown @@ -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. diff --git a/source/_components/binary_sensor.enocean.markdown b/source/_components/binary_sensor.enocean.markdown index ff59c3f8e06..9414cf563b7 100644 --- a/source/_components/binary_sensor.enocean.markdown +++ b/source/_components/binary_sensor.enocean.markdown @@ -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 diff --git a/source/_components/binary_sensor.envisalink.markdown b/source/_components/binary_sensor.envisalink.markdown index 52735a8dbfd..13abe44ef1b 100644 --- a/source/_components/binary_sensor.envisalink.markdown +++ b/source/_components/binary_sensor.envisalink.markdown @@ -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/). diff --git a/source/_components/binary_sensor.flic.markdown b/source/_components/binary_sensor.flic.markdown index 31eacc4d866..dd70d2eb4cd 100644 --- a/source/_components/binary_sensor.flic.markdown +++ b/source/_components/binary_sensor.flic.markdown @@ -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 %} diff --git a/source/_components/binary_sensor.hikvision.markdown b/source/_components/binary_sensor.hikvision.markdown index b3d892b437a..1a9dd7ce26f 100644 --- a/source/_components/binary_sensor.hikvision.markdown +++ b/source/_components/binary_sensor.hikvision.markdown @@ -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: diff --git a/source/_components/binary_sensor.hive.markdown b/source/_components/binary_sensor.hive.markdown index 49486d62d76..c39ea49f7c8 100644 --- a/source/_components/binary_sensor.hive.markdown +++ b/source/_components/binary_sensor.hive.markdown @@ -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 -Full configuration details can be found on the main [Hive component](/components/hive/) page.
- - diff --git a/source/_components/binary_sensor.homematic.markdown b/source/_components/binary_sensor.homematic.markdown index 5155aedeea1..f237976a094 100644 --- a/source/_components/binary_sensor.homematic.markdown +++ b/source/_components/binary_sensor.homematic.markdown @@ -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. \ No newline at end of file +Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic. diff --git a/source/_components/binary_sensor.ihc.markdown b/source/_components/binary_sensor.ihc.markdown index 9340c74aa6b..b05f2e3e8e1 100644 --- a/source/_components/binary_sensor.ihc.markdown +++ b/source/_components/binary_sensor.ihc.markdown @@ -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: diff --git a/source/_components/binary_sensor.insteon.markdown b/source/_components/binary_sensor.insteon.markdown index 67a7b6a4f85..6fb7f1bc9fe 100644 --- a/source/_components/binary_sensor.insteon.markdown +++ b/source/_components/binary_sensor.insteon.markdown @@ -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/ \ No newline at end of file +[insteon]: /components/insteon/ diff --git a/source/_components/binary_sensor.iss.markdown b/source/_components/binary_sensor.iss.markdown index f9b0da08de8..4e57b55a20f 100644 --- a/source/_components/binary_sensor.iss.markdown +++ b/source/_components/binary_sensor.iss.markdown @@ -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 %}diff --git a/source/_components/binary_sensor.isy994.markdown b/source/_components/binary_sensor.isy994.markdown index 2cb7345d0eb..64735b86517 100644 --- a/source/_components/binary_sensor.isy994.markdown +++ b/source/_components/binary_sensor.isy994.markdown @@ -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. diff --git a/source/_components/binary_sensor.konnected.markdown b/source/_components/binary_sensor.konnected.markdown index b530f097158..6fd32d7fbe9 100644 --- a/source/_components/binary_sensor.konnected.markdown +++ b/source/_components/binary_sensor.konnected.markdown @@ -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. - diff --git a/source/_components/binary_sensor.mychevy.markdown b/source/_components/binary_sensor.mychevy.markdown index 42ce754d87a..7ae1881a48a 100644 --- a/source/_components/binary_sensor.mychevy.markdown +++ b/source/_components/binary_sensor.mychevy.markdown @@ -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. - diff --git a/source/_components/binary_sensor.mystrom.markdown b/source/_components/binary_sensor.mystrom.markdown index 99927748043..21b0d76216c 100644 --- a/source/_components/binary_sensor.mystrom.markdown +++ b/source/_components/binary_sensor.mystrom.markdown @@ -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) diff --git a/source/_components/binary_sensor.nest.markdown b/source/_components/binary_sensor.nest.markdown index 3303cabdff4..60315ecb867 100644 --- a/source/_components/binary_sensor.nest.markdown +++ b/source/_components/binary_sensor.nest.markdown @@ -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.
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.
+## {% 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 diff --git a/source/_components/binary_sensor.netatmo.markdown b/source/_components/binary_sensor.netatmo.markdown index 1d396f6966e..8ef50d8737f 100644 --- a/source/_components/binary_sensor.netatmo.markdown +++ b/source/_components/binary_sensor.netatmo.markdown @@ -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. diff --git a/source/_components/binary_sensor.openuv.markdown b/source/_components/binary_sensor.openuv.markdown index 0eda9c2426d..9b93806fa72 100644 --- a/source/_components/binary_sensor.openuv.markdown +++ b/source/_components/binary_sensor.openuv.markdown @@ -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. - diff --git a/source/_components/binary_sensor.pilight.markdown b/source/_components/binary_sensor.pilight.markdown index 85307be3d60..b8ac54c1e97 100644 --- a/source/_components/binary_sensor.pilight.markdown +++ b/source/_components/binary_sensor.pilight.markdown @@ -67,6 +67,8 @@ reset_delay_sec: default: 30 {% endconfiguration %} +## {% linkable_title Full example %} + A full configuration example could look like this: ```yaml diff --git a/source/_components/binary_sensor.ping.markdown b/source/_components/binary_sensor.ping.markdown index 193297cbd88..0a8d1390908 100644 --- a/source/_components/binary_sensor.ping.markdown +++ b/source/_components/binary_sensor.ping.markdown @@ -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:When run on Windows systems, the round trip time attributes are rounded to the nearest millisecond and the mdev value is unavailable.
- diff --git a/source/_components/binary_sensor.rainmachine.markdown b/source/_components/binary_sensor.rainmachine.markdown index 60cc6d982c3..0a3072ad0b6 100644 --- a/source/_components/binary_sensor.rainmachine.markdown +++ b/source/_components/binary_sensor.rainmachine.markdown @@ -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/).You must have the [RainMachine component](https://www.home-assistant.io/components/rainmachine/) diff --git a/source/_components/binary_sensor.random.markdown b/source/_components/binary_sensor.random.markdown index b398a2c9a43..1a17bc91cb4 100644 --- a/source/_components/binary_sensor.random.markdown +++ b/source/_components/binary_sensor.random.markdown @@ -31,5 +31,5 @@ name: description: Name to use in the frontend. required: false type: string + default: Random Binary Sensor {% endconfiguration %} - diff --git a/source/_components/binary_sensor.rest.markdown b/source/_components/binary_sensor.rest.markdown index 7c36530f59a..dbb0cd102cc 100644 --- a/source/_components/binary_sensor.rest.markdown +++ b/source/_components/binary_sensor.rest.markdown @@ -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: diff --git a/source/_components/binary_sensor.spc.markdown b/source/_components/binary_sensor.spc.markdown index 624bebfff2a..86fe817f8ad 100644 --- a/source/_components/binary_sensor.spc.markdown +++ b/source/_components/binary_sensor.spc.markdown @@ -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/). diff --git a/source/_components/binary_sensor.tapsaff.markdown b/source/_components/binary_sensor.tapsaff.markdown index f5a49a352ac..8f7c512487e 100644 --- a/source/_components/binary_sensor.tapsaff.markdown +++ b/source/_components/binary_sensor.tapsaff.markdown @@ -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 %} diff --git a/source/_components/binary_sensor.tellduslive.markdown b/source/_components/binary_sensor.tellduslive.markdown index fc0b988bbf2..8fea7f57c3e 100644 --- a/source/_components/binary_sensor.tellduslive.markdown +++ b/source/_components/binary_sensor.tellduslive.markdown @@ -13,4 +13,3 @@ featured: false --- Integrates Telldus Live binary sensors into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions. - diff --git a/source/_components/binary_sensor.tesla.markdown b/source/_components/binary_sensor.tesla.markdown index 4561d8e4c8f..4d0587f4acd 100644 --- a/source/_components/binary_sensor.tesla.markdown +++ b/source/_components/binary_sensor.tesla.markdown @@ -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. diff --git a/source/_components/binary_sensor.threshold.markdown b/source/_components/binary_sensor.threshold.markdown index a512fff4d2f..f3a0a39bc4e 100644 --- a/source/_components/binary_sensor.threshold.markdown +++ b/source/_components/binary_sensor.threshold.markdown @@ -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 %} -