diff --git a/source/_components/asterisk_mbox.markdown b/source/_components/asterisk_mbox.markdown index f040acd99bb..23cb489269f 100644 --- a/source/_components/asterisk_mbox.markdown +++ b/source/_components/asterisk_mbox.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: asterisk.png -ha_category: Other +ha_category: Mailbox ha_iot_class: "Local Push" ha_release: 0.51 --- @@ -19,6 +19,8 @@ To enable the component, a configuration is required in both Home Assistant as w First follow the [Asterisk PBX configuration guide](/docs/asterisk_mbox/) to setup the necessary server on the Asterisk PBX server (this is needed even if Asterisk and Home Assistant are running on the same server) +## {% linkable_title Configuration %} + Once that is complete, add the following entry `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.arest.markdown b/source/_components/binary_sensor.arest.markdown index d18a2d321a7..1cf17934b7f 100644 --- a/source/_components/binary_sensor.arest.markdown +++ b/source/_components/binary_sensor.arest.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: arest.png -ha_category: Binary Sensor +ha_category: DIY ha_iot_class: "Local Polling" ha_release: 0.9 --- @@ -16,6 +16,8 @@ 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 %} + To use your aREST binary sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.bbb_gpio.markdown b/source/_components/binary_sensor.bbb_gpio.markdown index be2a9bd9fb3..f35f488a7ea 100644 --- a/source/_components/binary_sensor.bbb_gpio.markdown +++ b/source/_components/binary_sensor.bbb_gpio.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: beaglebone-black.png -ha_category: Binary Sensor +ha_category: DIY ha_release: 0.37 ha_iot_class: "Local Push" --- The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). +## {% linkable_title Configuration %} + To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.bmw_connected_drive.markdown b/source/_components/binary_sensor.bmw_connected_drive.markdown index 74330ec5635..03a78c80bb6 100755 --- a/source/_components/binary_sensor.bmw_connected_drive.markdown +++ b/source/_components/binary_sensor.bmw_connected_drive.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: bmw.png -ha_category: Binary Sensor +ha_category: Car ha_release: 0.66 --- -The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. +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 e4bc04ac1cb..516abfe6e9a 100644 --- a/source/_components/binary_sensor.digital_ocean.markdown +++ b/source/_components/binary_sensor.digital_ocean.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Local Polling" The `digital_ocean` binary sensor platform allows you to monitor your Digital Ocean droplets. +### {% 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: ```yaml diff --git a/source/_components/binary_sensor.eight_sleep.markdown b/source/_components/binary_sensor.eight_sleep.markdown index cf9f2c52bfd..6811a640dda 100644 --- a/source/_components/binary_sensor.eight_sleep.markdown +++ b/source/_components/binary_sensor.eight_sleep.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: eight_sleep.png -ha_category: Binary Sensor +ha_category: Health ha_release: "0.44" ha_iot_class: "Cloud Polling" --- @@ -16,4 +16,4 @@ 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 [component](/components/eight_sleep/) configuration on how to setup. +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.ffmpeg_motion.markdown b/source/_components/binary_sensor.ffmpeg_motion.markdown index 6635bae9e69..0607a0127af 100644 --- a/source/_components/binary_sensor.ffmpeg_motion.markdown +++ b/source/_components/binary_sensor.ffmpeg_motion.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ffmpeg.png -ha_category: Binary Sensor +ha_category: Image Processing ha_release: 0.27 redirect_from: /components/binary_sensor.ffmpeg/ --- @@ -20,10 +20,12 @@ The `ffmpeg` platform allows you to use any video feed with [FFmpeg](http://www. If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.

-### {% linkable_title Motion %} +## {% linkable_title Motion %} FFmpeg doesn't have a motion detection filter, but can use a scene filter to detect a new scene/motion. You can set how much needs to change in order to detect motion with the option 'changes', the percent value of change between frames. If you want a really small value for 'changes', you can also add a denoise filter. +## {% linkable_title Configuration %} + To add FFmpeg with motion detection to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.ffmpeg_noise.markdown b/source/_components/binary_sensor.ffmpeg_noise.markdown index d68ec7d1630..842be8203e1 100644 --- a/source/_components/binary_sensor.ffmpeg_noise.markdown +++ b/source/_components/binary_sensor.ffmpeg_noise.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ffmpeg.png -ha_category: Binary Sensor +ha_category: Image Processing ha_release: 0.27 --- @@ -19,7 +19,7 @@ The `ffmpeg` platform allows you to use any video or audio feed with [FFmpeg](ht If the `ffmpeg` process is broken, the sensor will be unavailable. To control the ffmpeg process of sensor, use the service *ffmpeg.start*, *ffmpeg.stop*, *ffmpeg.restart*.

-### {% linkable_title Noise %} +## {% linkable_title Configuration %} To add FFmpeg with noise detection to your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/binary_sensor.hydrawise.markdown b/source/_components/binary_sensor.hydrawise.markdown index cd066354673..9ec42c031aa 100644 --- a/source/_components/binary_sensor.hydrawise.markdown +++ b/source/_components/binary_sensor.hydrawise.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: hydrawise_logo.png -ha_category: Binary Sensor +ha_category: Irrigation ha_release: 0.71 ha_iot_class: Cloud Polling --- Before setting up the [Hunter Hydrawise](https://hydrawise.com) binary sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component. +## {% linkable_title Configuration %} + Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.linode.markdown b/source/_components/binary_sensor.linode.markdown index 0ffbddb5817..cf6392993f5 100644 --- a/source/_components/binary_sensor.linode.markdown +++ b/source/_components/binary_sensor.linode.markdown @@ -15,6 +15,8 @@ ha_iot_class: "Cloud Polling" The `linode` binary sensor platform allows you to monitor your Linode nodes. +## {% linkable_title Configuration %} + Add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.mercedesme.markdown b/source/_components/binary_sensor.mercedesme.markdown index e1df898d498..a51f2e85d08 100644 --- a/source/_components/binary_sensor.mercedesme.markdown +++ b/source/_components/binary_sensor.mercedesme.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: mercedesme.png -ha_category: Binary Sensor +ha_category: Car ha_iot_class: "Cloud polling" ha_release: 0.63 --- -The `Mercedes me` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors like windows, doors, lock, tire warnings from within Home Assistant. +The `mercedesme` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors like windows, doors, lock, tire warnings from within Home Assistant. They will be automatically discovered if the Mercedes me component is loaded. diff --git a/source/_components/binary_sensor.mychevy.markdown b/source/_components/binary_sensor.mychevy.markdown index b04312b2ae5..42ce754d87a 100644 --- a/source/_components/binary_sensor.mychevy.markdown +++ b/source/_components/binary_sensor.mychevy.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "MyChevy Binary Sensors" +title: "MyChevy Binary Sensor" description: "Instructions on how to integrate Chevy Bolt binary sensors car into Home Assistant." date: 2017-08-28 17:00 sidebar: true @@ -8,9 +8,14 @@ comments: false sharing: true footer: true logo: chevy.png -ha_category: Binary Sensor +ha_category: Car ha_release: 0.62 ha_iot_class: "Cloud Polling" --- -For configuration instructions, see [main component config](/components/mychevy/). +The `mychevy` binary sensor platform allows you to monitor your Chevy Bolt car from within Home Assistant. + +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.mysensors.markdown b/source/_components/binary_sensor.mysensors.markdown index 6138b927af7..814f79d9b6c 100644 --- a/source/_components/binary_sensor.mysensors.markdown +++ b/source/_components/binary_sensor.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Binary Sensor +ha_category: DIY ha_release: 0.14 ha_iot_class: "Local Push" --- diff --git a/source/_components/binary_sensor.openuv.markdown b/source/_components/binary_sensor.openuv.markdown index 21cd0cb2bc0..0eda9c2426d 100644 --- a/source/_components/binary_sensor.openuv.markdown +++ b/source/_components/binary_sensor.openuv.markdown @@ -8,16 +8,12 @@ comments: false sharing: true footer: true logo: openuv.jpg -ha_category: Binary Sensor +ha_category: Health ha_release: 0.76 ha_iot_class: "Cloud Polling" --- -The `openuv` binary sensor platform allows you to view binary sensor data from -[OpenUV](http://openuv.io). +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. -

-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 ee7a729196a..b34cc955bfa 100644 --- a/source/_components/binary_sensor.pilight.markdown +++ b/source/_components/binary_sensor.pilight.markdown @@ -8,14 +8,14 @@ comments: false sharing: true footer: true logo: pilight.png -ha_category: Binary Sensor +ha_category: DIY ha_release: 0.44 ha_iot_class: "Local Polling" --- The `pilight` binary sensor platform implement the [pilight hub](/components/pilight/) binary sensor functionality. Two type of Pilight binary sensor configuration available. A normal sensor which send the on and off state cyclical and a trigger sensor which send only a trigger when an event happened (for example lots of cheap PIR motion detector). - +## {% linkable_title Configuration %} To enable a Pilight binary sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/binary_sensor.rachio.markdown b/source/_components/binary_sensor.rachio.markdown index 568e9e0c558..c46bf398794 100644 --- a/source/_components/binary_sensor.rachio.markdown +++ b/source/_components/binary_sensor.rachio.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rachio.png -ha_category: Hub +ha_category: Sensor ha_iot_class: "Cloud Push" ha_release: 0.73 --- diff --git a/source/_components/binary_sensor.raincloud.markdown b/source/_components/binary_sensor.raincloud.markdown index b5e1678d53b..5b853e13126 100644 --- a/source/_components/binary_sensor.raincloud.markdown +++ b/source/_components/binary_sensor.raincloud.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raincloud.jpg -ha_category: Binary Sensor +ha_category: Irrigation ha_release: "0.55" ha_iot_class: "Cloud Polling" --- To get your [Melnor RainCloud](https://wifiaquatimer.com) binary sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud). +## {% linkable_title Configuration %} + Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.rainmachine.markdown b/source/_components/binary_sensor.rainmachine.markdown index 175a2d27bba..60cc6d982c3 100644 --- a/source/_components/binary_sensor.rainmachine.markdown +++ b/source/_components/binary_sensor.rainmachine.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainmachine.png -ha_category: Binary Sensor +ha_category: Irrigation ha_iot_class: "Cloud Polling" ha_release: 0.71 --- diff --git a/source/_components/binary_sensor.raspihats.markdown b/source/_components/binary_sensor.raspihats.markdown index 50d031c4574..be5891b19be 100644 --- a/source/_components/binary_sensor.raspihats.markdown +++ b/source/_components/binary_sensor.raspihats.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raspihats.png -ha_category: Binary Sensor +ha_category: DIY ha_release: 0.44 ha_iot_class: "Local Push" --- The `raspihats` binary sensor platform allows you to read sensor values ​​using the digital inputs of the [raspihats](http://www.raspihats.com/) boards. +## {% linkable_title Configuration %} + To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.rpi_gpio.markdown b/source/_components/binary_sensor.rpi_gpio.markdown index a59333d82cb..5b95daed1ca 100644 --- a/source/_components/binary_sensor.rpi_gpio.markdown +++ b/source/_components/binary_sensor.rpi_gpio.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Binary Sensor +ha_category: DIY ha_release: pre 0.7 ha_iot_class: "Local Push" --- The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). +## {% linkable_title Configuration %} + To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.rpi_pfio.markdown b/source/_components/binary_sensor.rpi_pfio.markdown index d02cfaf2dab..29cda1530da 100644 --- a/source/_components/binary_sensor.rpi_pfio.markdown +++ b/source/_components/binary_sensor.rpi_pfio.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Binary Sensor +ha_category: DIY ha_release: 0.45 ha_iot_class: "Local Push" --- The `rpi_pfio` binary sensor platform allows you to read sensor values of the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) . +## {% linkable_title Configuration %} + To use your PiFace Digital I/O module in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/binary_sensor.sleepiq.markdown b/source/_components/binary_sensor.sleepiq.markdown index 0d2170b84c0..3f355cc2780 100644 --- a/source/_components/binary_sensor.sleepiq.markdown +++ b/source/_components/binary_sensor.sleepiq.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sleepiq.png -ha_category: Binary Sensor +ha_category: Health ha_release: 0.29 ha_iot_class: "Local Polling" --- diff --git a/source/_components/binary_sensor.tesla.markdown b/source/_components/binary_sensor.tesla.markdown index c7c1948ae39..4561d8e4c8f 100644 --- a/source/_components/binary_sensor.tesla.markdown +++ b/source/_components/binary_sensor.tesla.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Binary Sensor +ha_category: Car ha_iot_class: "Cloud polling" ha_release: 0.53 --- -The `Tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant. +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. diff --git a/source/_components/bmw_connected_drive.markdown b/source/_components/bmw_connected_drive.markdown index 30c60fa32b7..56432369dd8 100644 --- a/source/_components/bmw_connected_drive.markdown +++ b/source/_components/bmw_connected_drive.markdown @@ -8,11 +8,11 @@ comments: false sharing: true footer: true logo: bmw.png -ha_category: Hub +ha_category: Car ha_release: 0.64 --- -This component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work. +The `bmw_connected_drive` component lets you retrieve data on your BMW vehicle from the BMW Connected Drive portal. You need to have a working BMW Connected Drive account, and a Connected Drive enabled vehicle for this to work. For compatibility with your BMW vehicle check the [bimmer_connected page](https://github.com/m1n3rva/bimmer_connected) on github. diff --git a/source/_components/camera.rpi_camera.markdown b/source/_components/camera.rpi_camera.markdown index 2033dc5d281..b6fc4094c09 100644 --- a/source/_components/camera.rpi_camera.markdown +++ b/source/_components/camera.rpi_camera.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Camera +ha_category: DIY ha_iot_class: "Local Polling" ha_release: 0.17 --- @@ -16,6 +16,8 @@ ha_release: 0.17 The `rpi_camera` platform allows you to integrate the Raspberry Pi camera into Home Assistant. This component uses the application [`raspistill`](https://www.raspberrypi.org/documentation/usage/camera/raspicam/raspistill.md) to store the image from camera. +## {% linkable_title Configuration %} + To enable this camera in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/camera.yi.markdown b/source/_components/camera.yi.markdown index cb8975a86c2..e366ab46e32 100644 --- a/source/_components/camera.yi.markdown +++ b/source/_components/camera.yi.markdown @@ -31,7 +31,7 @@ In order to integrate the camera with Home Assistant, it is necessary to install Once installed, please ensure that you have enabled FTP and Telnet on your device.

-Currently, version 0.1.4-beta2 of the custom firmware is the highest supported. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files. +Currently, version 0.1.4-beta2 of the custom firmware is the highest supported without having to make additional modifications. Firmwares higher than this version use [Pure-FTPd](https://www.pureftpd.org/project/pure-ftpd), which has a bug that prevents FFmpeg from correctly rendering video files. To use higher firmware versions you must also follow [this workaround](https://github.com/shadow-1/yi-hack-v3/issues/129#issuecomment-361723075) to revert back to ftpd.

diff --git a/source/_components/climate.mysensors.markdown b/source/_components/climate.mysensors.markdown index 6f5379449b0..f7cc81bec3e 100644 --- a/source/_components/climate.mysensors.markdown +++ b/source/_components/climate.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Climate +ha_category: DIY ha_release: 0.29 ha_iot_class: "Local Push" --- diff --git a/source/_components/climate.tesla.markdown b/source/_components/climate.tesla.markdown index 1d5720f65a9..282f7615702 100644 --- a/source/_components/climate.tesla.markdown +++ b/source/_components/climate.tesla.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Climate +ha_category: Car ha_iot_class: "Cloud push" ha_release: 0.53 --- -The `Tesla` climate platform allows you to control your [Tesla](https://www.tesla.com/) climate from within Home Assistant. +The `tesla` climate platform allows you to control your [Tesla](https://www.tesla.com/) climate from within Home Assistant. The climate platform will be automatically configured if Tesla component is configured. diff --git a/source/_components/coinbase.markdown b/source/_components/coinbase.markdown index f5d657ab4fb..bbe82837d40 100644 --- a/source/_components/coinbase.markdown +++ b/source/_components/coinbase.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "coinbase" +title: "Coinbase" description: "Instructions for how to add Coinbase sensors to Home Assistant." date: 2017-12-08 17:54 sidebar: true @@ -8,6 +8,7 @@ comments: false sharing: true footer: true logo: coinbase.png +ha_category: Finance ha_release: 0.61 ha_iot_class: "Cloud Polling" --- @@ -17,6 +18,8 @@ The `coinbase` component lets you access account balances and exchange rates fro You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the component to access relevant data. +## {% linkable_title Configuration %} + To set it up, add the following information to your `configuration.yaml` file: ```yaml diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown index f181d4755a7..123ebee79d9 100644 --- a/source/_components/counter.markdown +++ b/source/_components/counter.markdown @@ -44,7 +44,7 @@ Increments the counter with 1 or the given value for the steps. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. | +| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | #### {% linkable_title Service `counter.decrement` %} @@ -52,7 +52,7 @@ Decrements the counter with 1 or the given value for the steps. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. | +| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | #### {% linkable_title Service `counter.reset` %} @@ -60,7 +60,7 @@ With this service the counter is reset to its initial value. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | -| `entity_id` | no | Name of the entity to take action, e.g., `counter.count0`. | +| `entity_id` | no | Name of the entity to take action, e.g., `counter.my_custom_counter`. | ### {% linkable_title Use the service %} @@ -69,7 +69,7 @@ Select serv ```json { - "entity_id": "counter.count0" + "entity_id": "counter.my_custom_counter" } ``` diff --git a/source/_components/cover.mysensors.markdown b/source/_components/cover.mysensors.markdown index b4ded3e1b4b..2731b5c9a3c 100644 --- a/source/_components/cover.mysensors.markdown +++ b/source/_components/cover.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Cover +ha_category: DIY ha_release: "0.30" ha_iot_class: "Local Push" --- diff --git a/source/_components/cover.opengarage.markdown b/source/_components/cover.opengarage.markdown index 2ac83c83bc9..d9327afa2a6 100644 --- a/source/_components/cover.opengarage.markdown +++ b/source/_components/cover.opengarage.markdown @@ -8,12 +8,14 @@ comments: false sharing: true footer: true logo: opengarage.png -ha_category: Cover +ha_category: DIY ha_release: 0.44 --- The `opengarage` cover platform lets you control the open-source [OpenGarage.io](https://opengarage.io/) device through Home Assistant. +## {% linkable_title Configuration %} + To enable OpenGarage Covers in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -87,7 +89,7 @@ sensor: {% endif %} {% else %} n/a - {% endif %}/api/automatic/callback`. (Example: `http://hassio.local:8123/api/automatic/callback`) Note that this URL only needs to be accessible from the browser you use to perform the authentication. Home Assistant can also take advantage of `scope:current_location` if available. This will allow Home Assistant to receive periodic location updates during a trip. In order to use this functionality, you must request the scope for your application from Automatic. Once `scope:current_location` is available, change `current_location` to `true` in your configuration.yaml. +## {% linkable_title Configuration %} + Once your developer account is created, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/device_tracker.bmw_connected_drive.markdown b/source/_components/device_tracker.bmw_connected_drive.markdown index 4f390c5fa3a..53da0530db1 100644 --- a/source/_components/device_tracker.bmw_connected_drive.markdown +++ b/source/_components/device_tracker.bmw_connected_drive.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: bmw.png -ha_category: Presence Detection +ha_category: Car ha_release: 0.64 --- -The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. +The `bmw_connected_drive` device tracker platform allows you to import data on your BMW into Home Assistant. The device tracker platform will be automatically configured if the `bmw_connected_drive` component is configured. diff --git a/source/_components/device_tracker.mercedesme.markdown b/source/_components/device_tracker.mercedesme.markdown index ad59c95e0d5..3707d5ca1cd 100644 --- a/source/_components/device_tracker.mercedesme.markdown +++ b/source/_components/device_tracker.mercedesme.markdown @@ -8,11 +8,11 @@ comments: false sharing: true footer: true logo: mercedesme.png -ha_category: Presence Detection +ha_category: Car ha_release: 0.63 --- -The `Mercedes me` platform allows you to get data about the location of your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) car within Home Assistant. +The `mercedesme` platform allows you to get data about the location of your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) car within Home Assistant. The device tracker platform will be automatically configured if Mercedes me component is configured. diff --git a/source/_components/device_tracker.mysensors.markdown b/source/_components/device_tracker.mysensors.markdown index 5366c68ea78..0a886e1a2c6 100644 --- a/source/_components/device_tracker.mysensors.markdown +++ b/source/_components/device_tracker.mysensors.markdown @@ -8,8 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Presence Detection -featured: false +ha_category: DIY ha_release: "0.38" ha_iot_class: "Local Push" --- diff --git a/source/_components/device_tracker.ritassist.markdown b/source/_components/device_tracker.ritassist.markdown index 255d17fe79a..a0b8f1ab548 100644 --- a/source/_components/device_tracker.ritassist.markdown +++ b/source/_components/device_tracker.ritassist.markdown @@ -8,17 +8,19 @@ comments: false sharing: true footer: true logo: ritassist.png -ha_category: Presence Detection +ha_category: Car ha_iot_class: Cloud Polling ha_release: 0.76 --- -This platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map. +The `ritassist` device tracker platform allows you to integrate your vehicles equipped with [RitAssist](https://ritassist.nl/) or [FleetGO](https://fleetgo.com) hardware into Home Assistant. It allows you to see certain details about your vehicle, but also shows your vehicle on the map. + +## {% linkable_title Setup %} -## API key To use this component, you need an **API key** and **API secret**, which can be requested by contacting [info@fleetgo.com](mailto:info@fleetgo.com?subject=API%20Key). -## Configuration +## {% linkable_title Configuration %} + To use this device tracker in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -58,7 +60,7 @@ include: See the [device tracker component page](/components/device_tracker/) for instructions on how to configure the people to be tracked. -## Available Attributes +## {% linkable_title Available attributes %} | Attribute | Description | |---|---| diff --git a/source/_components/device_tracker.tesla.markdown b/source/_components/device_tracker.tesla.markdown index affbe9a1a85..e9cb8b34c04 100644 --- a/source/_components/device_tracker.tesla.markdown +++ b/source/_components/device_tracker.tesla.markdown @@ -8,11 +8,11 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Presence Detection +ha_category: Car ha_release: 0.53 --- -The `Tesla` platform allows you to get data about the location of your [Tesla](https://www.tesla.com/) car within Home Assistant. +The `tesla` platform allows you to get data about the location of your [Tesla](https://www.tesla.com/) car within Home Assistant. The device tracker platform will be automatically configured if Tesla component is configured. diff --git a/source/_components/device_tracker.volvooncall.markdown b/source/_components/device_tracker.volvooncall.markdown index f4de42f5011..0177adf5ded 100644 --- a/source/_components/device_tracker.volvooncall.markdown +++ b/source/_components/device_tracker.volvooncall.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: volvo.png -ha_category: Presence Detection +ha_category: Car ha_release: "0.30" --- diff --git a/source/_components/digital_ocean.markdown b/source/_components/digital_ocean.markdown index 4554819ee2a..fd5d744376b 100644 --- a/source/_components/digital_ocean.markdown +++ b/source/_components/digital_ocean.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Hub +ha_category: System Monitor ha_release: "0.30" logo: digital_ocean.png ha_iot_class: "Local Polling" @@ -16,8 +16,12 @@ ha_iot_class: "Local Polling" The `digital_ocean` component allows you to access the information about your [Digital Ocean](https://www.digitalocean.com/) droplets from Home Assistant. +### {% linkable_title Setup %} + Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitalocean.com/settings/api/tokens). +### {% linkable_title Configuration %} + To integrate your Digital Ocean droplets with Home Assistant, add the following section to your `configuration.yaml` file: ```yaml diff --git a/source/_components/eight_sleep.markdown b/source/_components/eight_sleep.markdown index 3a455d4ab50..74df0d234eb 100644 --- a/source/_components/eight_sleep.markdown +++ b/source/_components/eight_sleep.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: eight_sleep.png -ha_category: Hub +ha_category: Health ha_release: "0.44" ha_iot_class: "Cloud Polling" --- @@ -17,7 +17,7 @@ The `eight_sleep` component allows Home Assistant to fetch data from your [Eight ## {% linkable_title Configuration %} -It's setup utilizing 'Sensor' components to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' component to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed. +It's setup utilizing 'Sensor' platform to convey the current state of your bed and results of your sleep sessions and a 'Binary Sensor' platform to indicate your presence in the bed. A service is also provided to set the heating level and duration of the bed. You must have at least two sleep sessions recorded in the Eight Sleep app prior to setting up the Home Assistant component. diff --git a/source/_components/ffmpeg.markdown b/source/_components/ffmpeg.markdown index 56fd9779aed..38034e4e06a 100644 --- a/source/_components/ffmpeg.markdown +++ b/source/_components/ffmpeg.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ffmpeg.png -ha_category: Hub +ha_category: Image Processing --- The `ffmpeg` component allows other Home Assistant components to process video and audio streams. This component supports all FFmpeg versions since 3.0.0; if you have an older version, please update. @@ -21,6 +21,8 @@ You need the `ffmpeg` binary in your system path. On Debian 8 or Raspbian (Jessi If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.

+## {% linkable_title Configuration %} + To set it up, add the following information to your `configuration.yaml` file: ```yaml diff --git a/source/_components/hydrawise.markdown b/source/_components/hydrawise.markdown index 3c29b449166..f45b1255bdc 100644 --- a/source/_components/hydrawise.markdown +++ b/source/_components/hydrawise.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: hydrawise_logo.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.71 ha_iot_class: Cloud Polling --- The `hydrawise` component allows you to integrate your [Hunter Hydrawise](https://hydrawise.com) Wi-Fi irrigation controller system in Home Assistant. +## {% linkable_title Configuration %} + To enable it, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/image_processing.opencv.markdown b/source/_components/image_processing.opencv.markdown index 9e485ec6c30..06fc9061fd1 100644 --- a/source/_components/image_processing.opencv.markdown +++ b/source/_components/image_processing.opencv.markdown @@ -17,6 +17,8 @@ ha_release: 0.47 Some pre-defined classifiers can be found [here](https://github.com/opencv/opencv/tree/master/data). +## {% linkable_title Configuration %} + To setup OpenCV with Home Assistant, add the following section to your `configuration.yaml` file: ```yaml diff --git a/source/_components/light.blinksticklight.markdown b/source/_components/light.blinksticklight.markdown index c11da280aca..d5cc53a99fc 100644 --- a/source/_components/light.blinksticklight.markdown +++ b/source/_components/light.blinksticklight.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: blinkstick.png -ha_category: Light +ha_category: DIY ha_release: 0.7.5 ha_iot_class: "Local Polling" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `blinkstick` platform lets you control your [Blinkstick](https://www.blinkstick.com/) lights from within Home Assistant. +## {% linkable_title Configuration %} + To add blinkstick to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -23,10 +25,18 @@ To add blinkstick to your installation, add the following to your `configuration light: - platform: blinksticklight serial: BS000795-1.1 - name: Living Room ``` -Configuration variables: +{% configuration %} +serial: + description: The serial number of your stick. + required: true + default: 640 + type: string +name: + description: Name of the stick. + required: false + type: string + default: Blinkstick +{% endconfiguration %} -- **serial** (*Required*): The serial number of your stick. -- **name** (*Required*): Name of the stick. diff --git a/source/_components/light.blinkt.markdown b/source/_components/light.blinkt.markdown index ad2d6200f87..69b72eb1d13 100644 --- a/source/_components/light.blinkt.markdown +++ b/source/_components/light.blinkt.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Light +ha_category: DIY ha_iot_class: "Local Push" ha_release: 0.44 --- The `blinkt` light platform lets you control the [Blinkt!](https://shop.pimoroni.com/products/blinkt) board, featuring eight super-bright RGB LEDs. +## {% linkable_title Configuration %} + To enable `blinkt` in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -22,3 +24,4 @@ To enable `blinkt` in your installation, add the following to your `configuratio light: - platform: blinkt ``` + diff --git a/source/_components/light.mysensors.markdown b/source/_components/light.mysensors.markdown index 5f91aa43fe1..4e62f705bcd 100644 --- a/source/_components/light.mysensors.markdown +++ b/source/_components/light.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Light +ha_category: DIY ha_release: 0.13 ha_iot_class: "Local Push" --- diff --git a/source/_components/light.piglow.markdown b/source/_components/light.piglow.markdown index c2664af84cf..919dbc298d6 100644 --- a/source/_components/light.piglow.markdown +++ b/source/_components/light.piglow.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Light +ha_category: DIY ha_release: 0.37 ha_iot_class: "Local Polling" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `piglow` platform lets you control the [Piglow](https://shop.pimoroni.com/products/piglow) lights on your Raspberry Pi from within Home Assistant. +## {% linkable_title Configuration %} + To add piglow to your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/light.rpi_gpio_pwm.markdown b/source/_components/light.rpi_gpio_pwm.markdown index 7202b82297c..1ea0438332d 100644 --- a/source/_components/light.rpi_gpio_pwm.markdown +++ b/source/_components/light.rpi_gpio_pwm.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "PWM LED" +title: "PWM LED Light" description: "Instructions on how to setup PWM LEDs within Home Assistant." date: 2017-04-04 13:00 sidebar: true @@ -8,7 +8,7 @@ layout: page comments: false sharing: true footer: true -ha_category: Light +ha_category: DIY ha_iot_class: "Local Push" ha_release: 0.43 logo: raspberry-pi.png @@ -18,6 +18,8 @@ The `rpi_gpio_pwm` platform allows to control multiple lights using pulse-width For controlling the GPIOs, the platform connects to the [pigpio-daemon](http://abyz.co.uk/rpi/pigpio/pigpiod.html), which must be running. On Raspbian Jessie 2016-05-10 or newer the `pigpio` library is already included. On other operating systems it needs to be installed first (see [installation instructions](https://github.com/soldag/python-pwmled#installation)). +## {% linkable_title Configuration %} + To enable this platform, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/light.sensehat.markdown b/source/_components/light.sensehat.markdown index 7c7a4d0b378..30d9eb88c8d 100644 --- a/source/_components/light.sensehat.markdown +++ b/source/_components/light.sensehat.markdown @@ -8,20 +8,20 @@ comments: false sharing: true footer: true logo: sense-hat.png -ha_category: Light +ha_category: DIY ha_iot_class: "Assumed State" ha_release: 0.44 --- The `sensehat` light platform lets you control the [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) board's 8x8 RGB LED matrix on your Raspberry Pi from within Home Assistant. -To add `sensehat` to your installation, add the following to your `configuration.yaml` file: +## {% linkable_title Configuration %} + +To add `sensehat` light to your installation, add the following to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry light: - platform: sensehat - name: SenseHAT + - platform: sensehat ``` -For setting up the Sense HAT sensors, please see the [Sense HAT sensor component](/components/sensor.sensehat/). diff --git a/source/_components/linode.markdown b/source/_components/linode.markdown index 623132c0448..581f4822c16 100644 --- a/source/_components/linode.markdown +++ b/source/_components/linode.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Hub +ha_category: System Monitor logo: linode.png ha_release: 0.57 ha_iot_class: "Cloud Polling" @@ -15,12 +15,17 @@ ha_iot_class: "Cloud Polling" The `linode` component allows you to access the information about your [Linode](https://linode.com) systems from Home Assistant. +## {% linkable_title sETUP %} + Obtain your oAuth2 Access Token from Linode account. -* -* Log in -* Select API Tokens -* Create a Personal Access Token, -* Assigned scope (Please choose the least possible access required.) + +* +* Log in +* Select API Tokens +* Create a Personal Access Token, +* Assigned scope (Please choose the least possible access required.) + +## {% linkable_title Configuration %} To integrate Linode with Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/lock.bmw_connected_drive.markdown b/source/_components/lock.bmw_connected_drive.markdown index 4c6c7a2edcf..262b2ffb473 100755 --- a/source/_components/lock.bmw_connected_drive.markdown +++ b/source/_components/lock.bmw_connected_drive.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: bmw.png -ha_category: Lock +ha_category: Car ha_release: 0.66 --- -The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. +The `bmw_connected_drive` lock platform allows you to import data on your BMW into Home Assistant. The lock will be automatically configured if `bmw_connected_drive` component is configured. diff --git a/source/_components/lock.tesla.markdown b/source/_components/lock.tesla.markdown index 9708ea52205..bc050bf8b4a 100644 --- a/source/_components/lock.tesla.markdown +++ b/source/_components/lock.tesla.markdown @@ -8,13 +8,13 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Lock +ha_category: Car ha_iot_class: "Cloud Push" ha_release: 0.53 --- -The `Tesla` platform allows you to control your [Tesla](https://www.tesla.com/) door lock from within Home Assistant. +The `tesla` platform allows you to control your [Tesla](https://www.tesla.com/) door lock from within Home Assistant. -The lock platform will be automatically configured if Tesla component is configured. +The lock platform will be automatically configured if `tesla` component is configured. For more configuration information see the [Tesla component](/components/tesla/) documentation. diff --git a/source/_components/mercedesme.markdown b/source/_components/mercedesme.markdown index db5774c5183..c533bc7f2bb 100644 --- a/source/_components/mercedesme.markdown +++ b/source/_components/mercedesme.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mercedesme.png -ha_category: Hub +ha_category: Car ha_release: 0.63 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/mychevy.markdown b/source/_components/mychevy.markdown index 15a6b88ff19..a737ba764a4 100644 --- a/source/_components/mychevy.markdown +++ b/source/_components/mychevy.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: chevy.png -ha_category: Hub +ha_category: Car ha_release: 0.62 ha_iot_class: "Cloud Polling" --- -The `MyChevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using selenium to log in as your user, and screen scrape the data provided. GM does not make it easy to sign up for any official development program, so this provides a workaround to get access to your data. +The `mychevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using selenium to log in as your user and screen scrape the data provided. GM does not make it easy to sign up for any official development program, so this provides a workaround to get access to your data. This component provides the following platforms: @@ -33,21 +33,21 @@ mychevy: {% configuration %} username: - description: The email address associated with your my.chevrolet account. - required: true - type: string + description: The email address associated with your my.chevrolet account. + required: true + type: string password: - description: The password for your given my.chevrolet account. - required: true - type: string + description: The password for your given my.chevrolet account. + required: true + type: string {% endconfiguration %} -#### {% linkable_title Installation %} +### {% linkable_title Installation %} -Because this uses selenium behind the scenes, installation is more complicated than merely pip install. See the [installation instructions](https://github.com/sdague/mychevy). +Because this uses selenium behind the scenes, installation is more complicated than merely `pip` install. See the [installation instructions](https://github.com/sdague/mychevy). -#### {% linkable_title Limitations %} +### {% linkable_title Limitations %} The architecture of the GM automotive networking imposes some limitations on the functionality of the component. diff --git a/source/_components/mycroft.markdown b/source/_components/mycroft.markdown index 9754096be00..827ecccaf18 100644 --- a/source/_components/mycroft.markdown +++ b/source/_components/mycroft.markdown @@ -14,18 +14,21 @@ ha_release: 0.53 [Mycroft](https://mycroft.ai) is an open source voice assistant that allows you to send notifications and more to Mycroft from Home Assistant. +## {% linkable_title Configuration %} + +To use Mycroft in your installation, add the following to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry mycroft: host: 0.0.0.0 ``` -`host` is your IP address of your mycroft instance. Once you have added your host to your `configuration.yaml` file, restart your Home Assistant server. This will load up the Mycroft component and make a service available to notify on Mycroft and more eventually. +{% configuration %} +host: + description: The IP address of your Mycroft instance. + required: true + type: string +{% endconfiguration %} -The `mycroft` notification platform allows you to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/). - -To use this notification platform you simply need to input into the configuration that mycroft is your notification platform like seen above. - - -To use notifications, please see the [getting started with automation page](/getting-started/automation/). diff --git a/source/_components/mysensors.markdown b/source/_components/mysensors.markdown index 3cd360e2d26..97a48746a27 100644 --- a/source/_components/mysensors.markdown +++ b/source/_components/mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Hub +ha_category: DIY featured: true ha_iot_class: "Local Push" --- diff --git a/source/_components/notify.mailgun.markdown b/source/_components/notify.mailgun.markdown index 9e98d180524..93695c7e458 100644 --- a/source/_components/notify.mailgun.markdown +++ b/source/_components/notify.mailgun.markdown @@ -22,8 +22,7 @@ The Mailgun notification service allows you to send emails via Mailgun's REST AP # Example configuration.yaml entry mailgun: domain: mg.example.com - api_key: token-XXXXXXXXX - sandbox: False + api_key: XXXXXXXXXXXXXX notify: - name: mailgun @@ -33,11 +32,11 @@ notify: Configuration variables: -- **domain** (*Optional*): This is the domain name to be used when sending out mail. Defaults to the first custom domain you have set up. -- **sandbox** (*Optional*): Whether to use the sandboxed domain for outgoing mail. The `domain` item takes precedence over this. Defaults to `False`. -- **token** (*Required*): This is the API token that has been generated in your Mailgun account. +- **domain** (*Required*): This is the domain name to be used when sending out mail. +- **sandbox** (*Deprecated*): If a sandboxed domain is used, specify it in `domain`. Defaults to `False`. +- **api_key** (*Required*): This is the API Key that has been generated in your Mailgun account. - **recipient** (*Required*): The email address of the recipient. -- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is outgoint mail domain, as defined by the `domain` and `sanbox` configuration entries. +- **sender** (*Optional*): The sender's email address. Defaults to `hass@DOMAIN`, where `DOMAIN` is the outgoing mail domain, as defined by the `domain` configuration entry. ## {% linkable_title Example automation %} diff --git a/source/_components/notify.mycroft.markdown b/source/_components/notify.mycroft.markdown index 81917884998..d868b43331a 100644 --- a/source/_components/notify.mycroft.markdown +++ b/source/_components/notify.mycroft.markdown @@ -12,4 +12,9 @@ ha_category: Notifications ha_release: "0.53" --- -Please see the main [Mycroft Component](/components/mycroft) +The `mycroft` notification platform allows you to deliver notifications from Home Assistant to [Mycroft AI](https://mycroft.ai/). + +Please check the [`mycroft` component](/components/mycroft/) for details. + +To use notifications, please see the [getting started with automation page](/getting-started/automation/). + diff --git a/source/_components/notify.mysensors.markdown b/source/_components/notify.mysensors.markdown index 3dab5bc10dd..085f9b87cfc 100644 --- a/source/_components/notify.mysensors.markdown +++ b/source/_components/notify.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Notifications +ha_category: DIY ha_release: 0.36 ha_iot_class: "Local Push" --- diff --git a/source/_components/notify.rest.markdown b/source/_components/notify.rest.markdown index 4d1d83c5813..d46ca8e932d 100644 --- a/source/_components/notify.rest.markdown +++ b/source/_components/notify.rest.markdown @@ -29,7 +29,7 @@ Configuration variables: - **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. - **resource** (*Required*): The resource or endpoint that will receive the value. -- **method** (*Optional*): The method of the request. Default is GET. +- **method** (*Optional*): The method of the request. Default is `GET`. Other valid options are `POST` or `POST_JSON`. - **headers** (*Optional*): The headers for the request. - **message_param_name** (*Optional*): Parameter name for the message. Defaults to `message`. - **title_param_name** (*Optional*): Parameter name for the title. Defaults to none. diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown index 69e22a94e60..a4893d35c97 100644 --- a/source/_components/openuv.markdown +++ b/source/_components/openuv.markdown @@ -8,23 +8,19 @@ comments: false sharing: true footer: true logo: openuv.jpg -ha_category: Hub +ha_category: Health ha_release: 0.76 ha_iot_class: "Cloud Polling" --- -The `openuv` component displays UV and Ozone data from -[openuv.io](http://openuv.io). +The `openuv` component displays UV and Ozone data from [openuv.io](http://openuv.io). ## {% linkable_title Generating an API Key %} To generate an API key, [simply log in to the OpenUV website](https://www.openuv.io/auth/google).

-The "Limited" plan (which is what new users are given by default) is limited to -500 API requests per day. In order to leave a buffer, the `openuv` component -queries the API every 30 minutes by default. This value can be modifed (via the -`scan_interval` key), but please note that over-running the API will require +The "Limited" plan (which is what new users are given by default) is limited to 500 API requests per day. In order to leave a buffer, the `openuv` component queries the API every 30 minutes by default. This value can be modifed (via the `scan_interval` key), but please note that over-running the API will require you to upgrade to a paid plan (and may disable your access in the meantime).

@@ -38,9 +34,7 @@ openuv: api_key: YOUR_OPENUV_API_KEY ``` -To configure additional functionality, add configuration options beneath -a `binary_sensor` and/or `sensor` key within the `openuv` section of -`configuration.yaml` as below: +To configure additional functionality, add configuration options beneath a `binary_sensor` and/or `sensor` key within the `openuv` section of `configuration.yaml` as below: ```yaml openuv: @@ -87,8 +81,7 @@ sensors: ### {% linkable_title `uv_protection_window` %} -This sensor displays `true` if UV protection (sunscreen, etc.) is recommended -at the current date and time; displays `false` otherwise. +This sensor displays `true` if UV protection (sunscreen, etc.) is recommended at the current date and time; displays `false` otherwise. ## {% linkable_title Sensor Types %} @@ -102,19 +95,15 @@ This sensor displays the current UV index. ### {% linkable_title `current_uv_level` %} -This sensor displays the level of current UV index, which is calculated based -on [UV Index Levels & Colors](https://www.openuv.io/kb/uv-index-levels-colors). +This sensor displays the level of current UV index, which is calculated based on [UV Index Levels & Colors](https://www.openuv.io/kb/uv-index-levels-colors). ### {% linkable_title `max_uv_index` %} -This sensor displays the maximum UV index that will be encountered that day (at -solar noon). +This sensor displays the maximum UV index that will be encountered that day (at solar noon). ### {% linkable_title `safe_exposure_time_type_X` %} -These sensors display the approximate number of minutes a particular skin type -can be exposed to the sun before burning/tanning starts. Each sensor depicts -a skin type based on the +These sensors display the approximate number of minutes a particular skin type can be exposed to the sun before burning/tanning starts. Each sensor depicts a skin type based on the [Fitzpatrick scale](https://en.wikipedia.org/wiki/Fitzpatrick_scale): * Skin Type I @@ -125,7 +114,5 @@ a skin type based on the * Skin Type VI

-The above guidelines constitude estimates and are intended to help informed -decision making. They should not replace analysis, advice, or diagnosis from a -trained medical professional. +The above guidelines constitude estimates and are intended to help informed decision making. They should not replace analysis, advice, or diagnosis from a trained medical professional.

diff --git a/source/_components/pilight.markdown b/source/_components/pilight.markdown index 45e98323815..05b3ce1fbec 100644 --- a/source/_components/pilight.markdown +++ b/source/_components/pilight.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: pilight.png -ha_category: Hub +ha_category: DIY ha_release: 0.26 ha_iot_class: "Local Push" --- diff --git a/source/_components/rainbird.markdown b/source/_components/rainbird.markdown index 413a612fdc5..187173c1f78 100644 --- a/source/_components/rainbird.markdown +++ b/source/_components/rainbird.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: rainbird.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.61 ha_iot_class: "Local Polling" --- This `rainbird` component allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. +## {% linkable_title Configuration %} + To enable it, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/raincloud.markdown b/source/_components/raincloud.markdown index 3eb377e0468..b73766cac17 100644 --- a/source/_components/raincloud.markdown +++ b/source/_components/raincloud.markdown @@ -8,12 +8,14 @@ comments: false sharing: true footer: true logo: raincloud.jpg -ha_category: Hub +ha_category: Irrigation ha_release: 0.55 --- The `raincloud` component allows you to integrate your [Melnor RainCloud](https://wifiaquatimer.com) sprinkler system in Home Assistant. +## {% linkable_title Configuration %} + To enable it, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/rainmachine.markdown b/source/_components/rainmachine.markdown index 42027fe9182..7bb254ef5d3 100644 --- a/source/_components/rainmachine.markdown +++ b/source/_components/rainmachine.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainmachine.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.69 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.arest.markdown b/source/_components/sensor.arest.markdown index 4f7c68732fc..4bb0a11ad78 100644 --- a/source/_components/sensor.arest.markdown +++ b/source/_components/sensor.arest.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: arest.png -ha_category: Sensor +ha_category: DIY ha_iot_class: "Local Polling" ha_release: pre 0.7 --- @@ -16,6 +16,8 @@ ha_release: pre 0.7 The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. +## {% linkable_title Configuration %} + To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.bh1750.markdown b/source/_components/sensor.bh1750.markdown index 4910cdfba0a..b7bae73cf1e 100644 --- a/source/_components/sensor.bh1750.markdown +++ b/source/_components/sensor.bh1750.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_release: 0.48 ha_iot_class: "Local Push" --- @@ -20,6 +20,7 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) +## {% linkable_title Configuration %} To use your BH1750 sensor in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.bme280.markdown b/source/_components/sensor.bme280.markdown index 7dd524405a3..7887aff3dde 100644 --- a/source/_components/sensor.bme280.markdown +++ b/source/_components/sensor.bme280.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_release: 0.48 ha_iot_class: "Local Push" --- @@ -20,6 +20,8 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) +## {% linkable_title Configuration %} + To use your BME280 sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.bme680.markdown b/source/_components/sensor.bme680.markdown index d2496dd8a33..b32f23ab5d7 100644 --- a/source/_components/sensor.bme680.markdown +++ b/source/_components/sensor.bme680.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_release: 0.62 ha_iot_class: "Local Push" --- diff --git a/source/_components/sensor.bmw_connected_drive.markdown b/source/_components/sensor.bmw_connected_drive.markdown index 083e5124a69..9100fb4b71b 100644 --- a/source/_components/sensor.bmw_connected_drive.markdown +++ b/source/_components/sensor.bmw_connected_drive.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: bmw.png -ha_category: Sensor +ha_category: Car ha_release: 0.64 --- -The `bmw_connected_drive` platform allows you to import data on your BMW into Home Assistant. +The `bmw_connected_drive` sensor platform allows you to import data on your BMW into Home Assistant. The sensors will be automatically configured if the `bmw_connected_drive` component is configured. diff --git a/source/_components/sensor.citybikes.markdown b/source/_components/sensor.citybikes.markdown index 7b4aced03ac..c23e5783aaa 100644 --- a/source/_components/sensor.citybikes.markdown +++ b/source/_components/sensor.citybikes.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "CityBikes API sensor" +title: "CityBikes Sensor" description: "Instructions on how to integrate data from the CityBikes API into Home Assistant." date: 2017-06-25 14:20 sidebar: true @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: citybikes.png -ha_category: Sensor +ha_category: Transport ha_release: 0.49 --- The `citybikes` sensor platform monitors bike availability at bike sharing stations in a chosen area. The data is provided by [CityBikes](https://citybik.es/#about), which supports bike sharing systems all around the world. +## {% linkable_title Configuration %} + To enable it, add the following lines to your `configuration.yaml`: ```yaml @@ -33,6 +35,8 @@ Configuration options: - **radius** (*Optional*): The radius (in meters or feet, depending on the Home Assistant configuration) around the monitored location. Only stations closer than this distance will be monitored. - **stations** array (*Optional*): A list of specific stations to monitor. The list should contain station `ID`s or `UID`s, which can be obtained from the CityBikes API. +## {% linkable_title Example %} + Additional configuration samples: ```yaml diff --git a/source/_components/sensor.coinbase.markdown b/source/_components/sensor.coinbase.markdown index c506d823417..537b10f9973 100644 --- a/source/_components/sensor.coinbase.markdown +++ b/source/_components/sensor.coinbase.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: coinbase.png -ha_category: Sensor +ha_category: Finance ha_release: 0.61 --- diff --git a/source/_components/sensor.eight_sleep.markdown b/source/_components/sensor.eight_sleep.markdown index 2d78d94f705..23e4ce46ed2 100644 --- a/source/_components/sensor.eight_sleep.markdown +++ b/source/_components/sensor.eight_sleep.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: eight_sleep.png -ha_category: Sensor +ha_category: Health ha_release: "0.44" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.envirophat.markdown b/source/_components/sensor.envirophat.markdown index 9863a4ab3b5..0e41d737225 100644 --- a/source/_components/sensor.envirophat.markdown +++ b/source/_components/sensor.envirophat.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_iot_class: "Local Polling" ha_release: 0.44 --- diff --git a/source/_components/sensor.fedex.markdown b/source/_components/sensor.fedex.markdown index acbdf251d62..00e8a6c1b62 100644 --- a/source/_components/sensor.fedex.markdown +++ b/source/_components/sensor.fedex.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: fedex.png -ha_category: Sensor +ha_category: Postal Service ha_release: 0.39 ha_iot_class: "Cloud Polling" --- 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. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.fints.markdown b/source/_components/sensor.fints.markdown index 79351f765e3..e871ba3cb97 100644 --- a/source/_components/sensor.fints.markdown +++ b/source/_components/sensor.fints.markdown @@ -7,14 +7,16 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor -ha_release: 0.70 +ha_category: Finance +ha_release: "0.70" ha_iot_class: "Local Push" logo: home-assistant.png --- With the FinTS sensor, you can fetch your account information from your bank. This only works with banks that support the FinTS (aka. HBCI) standard. The FinTS standard used by many German banks. So if you do not have a German bank account, this will most likely not work for you. To find out if your bank supports FinTS, check the bank's website or call their hotline. +## {% linkable_title Configuration %} + For each account you have with the bank, a separate sensor is created. If you have several accounts with a bank, you can select which ones you want to have, and you can also give the accounts a name. {% raw %} @@ -70,5 +72,4 @@ To find out the configuration for your bank, check their website or call their h description: (optional) Use this field to give the account a meaningful name. required: false type: string - {% endconfiguration %} diff --git a/source/_components/sensor.htu21d.markdown b/source/_components/sensor.htu21d.markdown index a485fb0c382..fbb513aef4a 100644 --- a/source/_components/sensor.htu21d.markdown +++ b/source/_components/sensor.htu21d.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Sensor +ha_category: DIY ha_release: 0.48 ha_iot_class: "Local Push" --- @@ -20,6 +20,8 @@ Tested devices: - [Raspberry Pi](https://www.raspberrypi.org/) +## {% linkable_title Configuration %} + To use your HTU21D sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.hydrawise.markdown b/source/_components/sensor.hydrawise.markdown index ed1fbd52e5e..6268b188504 100644 --- a/source/_components/sensor.hydrawise.markdown +++ b/source/_components/sensor.hydrawise.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: hydrawise_logo.png -ha_category: Sensor +ha_category: Irrigation ha_release: 0.71 ha_iot_class: Cloud Polling --- Before setting up the [Hunter Hydrawise](https://hydrawise.com) sensors please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component. +## {% linkable_title Configuration %} + Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.imap.markdown b/source/_components/sensor.imap.markdown index a3b9af23b29..f09956e9648 100644 --- a/source/_components/sensor.imap.markdown +++ b/source/_components/sensor.imap.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: smtp.png -ha_category: Sensor +ha_category: Mailbox ha_release: 0.25 ha_iot_class: "Cloud Push" --- @@ -16,6 +16,8 @@ ha_iot_class: "Cloud Push" The `imap` sensor platform is observing your [IMAP server](https://en.wikipedia.org/wiki/Internet_Message_Access_Protocol) and reporting the amount of unread emails. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.imap_email_content.markdown b/source/_components/sensor.imap_email_content.markdown index 22212426f6a..e67340b7ef7 100644 --- a/source/_components/sensor.imap_email_content.markdown +++ b/source/_components/sensor.imap_email_content.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: smtp.png -ha_category: Sensor +ha_category: Mailbox ha_iot_class: "Local Polling" ha_release: 0.25 --- @@ -16,6 +16,8 @@ ha_release: 0.25 The `imap_email_content` sensor platform will read emails from an IMAP email server and report them as a state change within Home Assistant. This is useful if you have a device that only reports its state via email. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.mercedesme.markdown b/source/_components/sensor.mercedesme.markdown index da5fd9ba453..205955639dc 100644 --- a/source/_components/sensor.mercedesme.markdown +++ b/source/_components/sensor.mercedesme.markdown @@ -8,12 +8,12 @@ comments: false sharing: true footer: true logo: mercedesme.png -ha_category: Sensor +ha_category: Car ha_iot_class: "Cloud Push" ha_release: 0.63 --- -The `Mercedes me` platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors from within Home Assistant. +The `mercedesme` sensor platform allows you to get data from your [Mercedes me connected car](https://www.mercedes-benz.com/en/mercedes-me/) sensors from within Home Assistant. The sensor platform will be automatically configured if Mercedes me component is configured. diff --git a/source/_components/sensor.mhz19.markdown b/source/_components/sensor.mhz19.markdown index 25cd6405ce7..142eeed155f 100644 --- a/source/_components/sensor.mhz19.markdown +++ b/source/_components/sensor.mhz19.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mhz19_logo.png -ha_category: Sensor +ha_category: DIY ha_release: 0.27 ha_iot_class: "Local Polling" --- @@ -17,6 +17,8 @@ The MH-Z19 is a small non-dispersive infrared sensor that can measure CO2 level. Check out the [Open Home Automation web site](https://www.open-homeautomation.com/2016/08/24/monitor-co2-levels-in-your-house/) for a quick guide how to connect the sensor to your PC or Raspberry Pi. +## {% linkable_title Configuration %} + To use this sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.mopar.markdown b/source/_components/sensor.mopar.markdown index 65146841838..ab620c56d9e 100644 --- a/source/_components/sensor.mopar.markdown +++ b/source/_components/sensor.mopar.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mopar.png -ha_category: Sensor +ha_category: Car featured: false ha_release: 0.53 ha_iot_class: "Cloud Polling" @@ -19,8 +19,12 @@ The `mopar` sensor provides the following for owners of FCA vehicles with a uCon - Sensor per vehicle with vehicle health report and other meta-data - Service for remote commands: Lock/unlock, Engine on/off, Horn & lights +## {% linkable_title Setup %} + Be sure you have a [mopar.com](http://mopar.com) account with your vehicle(s) registered by VIN. You must also have a current uConnect subscription. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`. ```yaml @@ -42,7 +46,7 @@ password: required: true type: string pin: - description: v + description: The pin for your account. required: true type: string {% endconfiguration %} diff --git a/source/_components/sensor.mychevy.markdown b/source/_components/sensor.mychevy.markdown index 03b3146f5f9..33747f5aab1 100644 --- a/source/_components/sensor.mychevy.markdown +++ b/source/_components/sensor.mychevy.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "MyChevy Sensors" +title: "MyChevy Sensor" description: "Instructions on how to integrate Chevy Bolt sensors car into Home Assistant." date: 2017-08-28 17:00 sidebar: true @@ -8,9 +8,15 @@ comments: false sharing: true footer: true logo: chevy.png -ha_category: Sensor +ha_category: Car ha_release: 0.62 ha_iot_class: "Cloud Polling" --- -For configuration instructions, see [main component config](/components/mychevy/). + +The `mychevy` sensor platform allows you to monitor your Chevy Bolt car from within Home Assistant. + +The 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/sensor.mysensors.markdown b/source/_components/sensor.mysensors.markdown index a6e8657014a..ae77bb096eb 100644 --- a/source/_components/sensor.mysensors.markdown +++ b/source/_components/sensor.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Sensor +ha_category: DIY featured: false ha_iot_class: "Local Push" --- diff --git a/source/_components/sensor.nsw_fuel_station.markdown b/source/_components/sensor.nsw_fuel_station.markdown index 5ebdb8fc51e..9a560f322c3 100644 --- a/source/_components/sensor.nsw_fuel_station.markdown +++ b/source/_components/sensor.nsw_fuel_station.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Fuel +ha_category: Car ha_release: 0.72 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.opensky.markdown b/source/_components/sensor.opensky.markdown index cf16befa77e..39bbb600b4b 100644 --- a/source/_components/sensor.opensky.markdown +++ b/source/_components/sensor.opensky.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: opensky.png -ha_category: Sensor +ha_category: Transport featured: false ha_release: 0.43 ha_iot_class: "Cloud Polling" @@ -16,9 +16,9 @@ ha_iot_class: "Cloud Polling" The `opensky` sensor allows one to track overhead flights in a given region. It uses crowd-sourced data from the [OpenSky Network](https://opensky-network.org/) public API. It will also fire Home Assistant events when flights enter and exit the defined region. -## Configuration +## {% linkable_title Configuration %} -To enable this sensor, add the following lines to your `configuration.yaml`. +To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml sensor: @@ -28,24 +28,24 @@ sensor: Configuration options for the OpenSky Network sensor: -- **radius** (*Required*): Radius of region to monitor, in kilometers -- **latitude** (*Optional*): Region latitude (defaults to home zone latitude) -- **longitude** (*Optional*): Region longitude (defaults to home zone longitude) -- **altitude** (*Optional*): The maximum altitude(in meters) for planes to be detected in, 0 sets it to unlimited (defaults to 0) -- **name** (*Optional*): Sensor name (defaults to `opensky`) +- **radius** (*Required*): Radius of region to monitor, in kilometers. +- **latitude** (*Optional*): Region latitude. Defaults to home zone latitude. +- **longitude** (*Optional*): Region longitude. Defaults to home zone longitude. +- **altitude** (*Optional*): The maximum altitude (in meters) for planes to be detected in, 0 sets it to unlimited. Defaults to 0). +- **name** (*Optional*): Sensor name. Defaults to opensky. -## Events +## {% linkable_title Events %} -- **opensky_entry**: Fired when a flight enters the region -- **opensky_exit**: Fired when a flight exits the region +- **opensky_entry**: Fired when a flight enters the region. +- **opensky_exit**: Fired when a flight exits the region. Both events have two attributes: -- **sensor**: Name of `opensky` sensor that fired the event -- **callsign**: Callsign of the flight -- **altitude**: Altitude of the flight in meters +- **sensor**: Name of `opensky` sensor that fired the event. +- **callsign**: Callsign of the flight. +- **altitude**: Altitude of the flight in meters. -To receive notifications of the entering flights, add the following lines to your `configuration.yaml`. +To receive notifications of the entering flights, add the following lines to your `configuration.yaml` file: {% raw %} ```yaml diff --git a/source/_components/sensor.openuv.markdown b/source/_components/sensor.openuv.markdown index f777be94262..61240520043 100644 --- a/source/_components/sensor.openuv.markdown +++ b/source/_components/sensor.openuv.markdown @@ -8,16 +8,12 @@ comments: false sharing: true footer: true logo: openuv.jpg -ha_category: Sensor +ha_category: Health ha_release: 0.76 ha_iot_class: "Cloud Polling" --- -The `openuv` sensor platform allows you to view sensor data from -[OpenUV](http://openuv.io). +The `openuv` sensor platform allows you to view sensor data from [OpenUV](http://openuv.io). + +You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, sensors will automatically appear. -

-You must have the [OpenUV component](/components/openuv/) configured to use -this platform. After configuring that component, sensors will automatically -appear. -

diff --git a/source/_components/sensor.pilight.markdown b/source/_components/sensor.pilight.markdown index 2a33cc2a1dd..a78f5a1d391 100644 --- a/source/_components/sensor.pilight.markdown +++ b/source/_components/sensor.pilight.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: pilight.png -ha_category: Sensor +ha_category: DIY ha_release: 0.31 ha_iot_class: depends --- diff --git a/source/_components/sensor.postnl.markdown b/source/_components/sensor.postnl.markdown index 3fa41230239..0510b0dd14b 100644 --- a/source/_components/sensor.postnl.markdown +++ b/source/_components/sensor.postnl.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: postnl.png -ha_category: Sensor +ha_category: Postal Service ha_release: 0.69 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.radarr.markdown b/source/_components/sensor.radarr.markdown index 94a46655485..8795896f9e7 100644 --- a/source/_components/sensor.radarr.markdown +++ b/source/_components/sensor.radarr.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: radarr.png -ha_category: Sensor +ha_category: Downloading ha_release: 0.47 --- diff --git a/source/_components/sensor.rainbird.markdown b/source/_components/sensor.rainbird.markdown index 750c2874979..4c523a82c48 100644 --- a/source/_components/sensor.rainbird.markdown +++ b/source/_components/sensor.rainbird.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: rainbird.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.61 ha_iot_class: "Local Polling" --- This `rainbird` sensor allows interacting with [LNK WiFi](http://www.rainbird.com/landscape/products/controllers/LNK-WiFi.htm) module of the Rain Bird Irrigation system in Home Assistant. +## {% linkable_title Configuration %} + Once you have enabled the [Rain Bird component](/components/rainbird), add the following to your `configuration.yaml` file to enable the rain sensor: ```yaml diff --git a/source/_components/sensor.raincloud.markdown b/source/_components/sensor.raincloud.markdown index 381599c785e..9435f1a7782 100644 --- a/source/_components/sensor.raincloud.markdown +++ b/source/_components/sensor.raincloud.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raincloud.jpg -ha_category: Sensor +ha_category: Irrigation ha_release: "0.55" ha_iot_class: "Cloud Polling" --- To get your [Melnor RainCloud](https://wifiaquatimer.com) sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud). +## {% linkable_title Configuration %} + Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.rainmachine.markdown b/source/_components/sensor.rainmachine.markdown index 7df129ab2b6..4db41b38eaf 100644 --- a/source/_components/sensor.rainmachine.markdown +++ b/source/_components/sensor.rainmachine.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainmachine.png -ha_category: Sensor +ha_category: Irrigation ha_iot_class: "Cloud Polling" ha_release: 0.71 --- diff --git a/source/_components/sensor.random.markdown b/source/_components/sensor.random.markdown index cbe6049cf30..b56d1f3d591 100644 --- a/source/_components/sensor.random.markdown +++ b/source/_components/sensor.random.markdown @@ -18,7 +18,7 @@ The `random` sensor platform is creating random sensor values (integers) out of ## {% linkable_title Configuration %} -To enable the random sensor, add the following lines to your `configuration.yaml`: +To enable the random sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry diff --git a/source/_components/sensor.sense.markdown b/source/_components/sensor.sense.markdown index e13e45dd937..f894c5312e2 100644 --- a/source/_components/sensor.sense.markdown +++ b/source/_components/sensor.sense.markdown @@ -15,6 +15,9 @@ ha_release: 0.65 Integrate your [Sense](https://sense.com) meter information into Home Assistant. + +## {% linkable_title Configuration %} + To enable this sensor in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -31,9 +34,9 @@ sensor: ``` Two types of sensors can be monitored and will be created with the following names: + - **Active Usage/Production**: Current active power usage/production in Watts. Updated every 30 seconds. - **Daily Usage/Production**: Daily power usage/production in kWh. Updated every 5 minutes. -- ... Weekly, Monthly and Yearly variants are also available. @@ -52,23 +55,23 @@ monitored_conditions: type: list keys: active_usage: - description: The current power usage in W + description: The current power usage in W. active_production: - description: The current solar production in W + description: The current solar production in W. daily_usage: - description: Total power used for current day in kWh + description: Total power used for current day in kWh. daily_production: - description: Total power produced for current day in kWh + description: Total power produced for current day in kWh. weekly_usage: - description: Total power used for current week in kWh + description: Total power used for current week in kWh. weekly_production: - description: Total power produced for current week in kWh + description: Total power produced for current week in kWh. monthly_usage: - description: Total power used for current month in kWh + description: Total power used for current month in kWh. monthly_production: - description: Total power produced for current month in kWh + description: Total power produced for current month in kWh. yearly_usage: - description: Total power used for current year in kWh + description: Total power used for current year in kWh. yearly_production: - description: Total power produced for current year in kWh + description: Total power produced for current year in kWh. {% endconfiguration %} diff --git a/source/_components/sensor.sensehat.markdown b/source/_components/sensor.sensehat.markdown index 640ea7b1a52..a2236c2fb5f 100644 --- a/source/_components/sensor.sensehat.markdown +++ b/source/_components/sensor.sensehat.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sense-hat.png -ha_category: Sensor +ha_category: DIY ha_release: 0.35 ha_iot_class: "Local Push" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Push" The `sensehat` sensor platform allows you to display information collected by a [Sense HAT](https://www.raspberrypi.org/products/sense-hat/) add-on board for Raspberry Pi. +## {% linkable_title Configuration %} + To add this platform to your installation, add the following to your `configuration.yaml` file: ```yaml @@ -23,9 +25,9 @@ To add this platform to your installation, add the following to your `configurat sensor: - platform: sensehat display_options: - - temperature - - humidity - - pressure + - temperature + - humidity + - pressure ``` Configuration variables: diff --git a/source/_components/sensor.sleepiq.markdown b/source/_components/sensor.sleepiq.markdown index 6740af6ab83..616c54e56ba 100644 --- a/source/_components/sensor.sleepiq.markdown +++ b/source/_components/sensor.sleepiq.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sleepiq.png -ha_category: Sensor +ha_category: Health ha_release: 0.29 ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.sonarr.markdown b/source/_components/sensor.sonarr.markdown index 13a4944feaa..93b070adcee 100644 --- a/source/_components/sensor.sonarr.markdown +++ b/source/_components/sensor.sonarr.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: sonarr.png -ha_category: Sensor +ha_category: Downloading ha_release: 0.34 ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.spotcrime.markdown b/source/_components/sensor.spotcrime.markdown index b36d01b4b46..73bda02a894 100644 --- a/source/_components/sensor.spotcrime.markdown +++ b/source/_components/sensor.spotcrime.markdown @@ -7,15 +7,19 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: Social ha_release: 0.65 ha_iot_class: "Cloud Polling" --- The `spotcrime` sensor allows one to track reported incidents occurring in a given area. Incidents include anything reported to [Spot Crime](http://spotcrime.com). Your regional emergency services may or may not report data. The sensor defaults to counting incidents within one day, but can be customized via configuration.yaml. +## {% linkable_title Setup %} + You will need to request an API key from [Spotcrime](mailto:pyrrhus@spotcrime.com). +## {% 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. 0.01 = 1 mile. ```yaml diff --git a/source/_components/sensor.ted5000.markdown b/source/_components/sensor.ted5000.markdown index 20e94ba3e8d..1dd451255c7 100644 --- a/source/_components/sensor.ted5000.markdown +++ b/source/_components/sensor.ted5000.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ted.png -ha_category: Sensor +ha_category: Energy ha_release: "0.30" ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.temper.markdown b/source/_components/sensor.temper.markdown index 09626f0984e..65fd75fd725 100644 --- a/source/_components/sensor.temper.markdown +++ b/source/_components/sensor.temper.markdown @@ -7,13 +7,15 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Sensor +ha_category: DIY ha_iot_class: "Local Push" ha_release: pre 0.7 --- This `temper` sensor platform allows you to get the current temperature from a TEMPer device. +## {% linkable_title Configuration %} + To use your TEMPer sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.tesla.markdown b/source/_components/sensor.tesla.markdown index 262a18910e2..1b9dfcca155 100644 --- a/source/_components/sensor.tesla.markdown +++ b/source/_components/sensor.tesla.markdown @@ -8,13 +8,13 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Sensor +ha_category: Car ha_iot_class: "Cloud Push" ha_release: 0.53 --- -The `Tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant. +The `tesla` platform allows you to get data from your [Tesla](https://www.tesla.com/) sensors from within Home Assistant. -The sensor platform will be automatically configured if Tesla component is configured. +The sensor platform will be automatically configured if `tesla` component is configured. For more configuration information see the [Tesla component](/components/tesla/) documentation. diff --git a/source/_components/sensor.torque.markdown b/source/_components/sensor.torque.markdown index 38379ccd675..91d45e4d7b9 100644 --- a/source/_components/sensor.torque.markdown +++ b/source/_components/sensor.torque.markdown @@ -8,14 +8,15 @@ comments: false sharing: true footer: true logo: torque.png -ha_category: Transport +ha_category: Car ha_release: "0.10" ha_iot_class: "Cloud Polling" --- The `torque` platform will allow you to monitor [Torque](http://torque-bhp.com/) data relayed from a Bluetooth OBD2 stick via the Torque mobile application. -## {% linkable_title Configuration %} +## {% linkable_title Setup %} + To use Torque sensors with your installation, you must configure both the Torque mobile application and Home Assistant. ### {% linkable_title Torque application %} @@ -34,7 +35,7 @@ Under the **Realtime Web Upload** header: - Enter an email address in **User Email Address**. - Optionally set the **Web Logging Interval**. The 2-second default may quickly fill up the Home Assistant history database. -### {% linkable_title Home Assistant %} +### {% linkable_title Configuration %} Add the following to your `configuration.yaml` file: diff --git a/source/_components/sensor.trafikverket_weatherstation.markdown b/source/_components/sensor.trafikverket_weatherstation.markdown index ebbb7724a55..152d95316ac 100644 --- a/source/_components/sensor.trafikverket_weatherstation.markdown +++ b/source/_components/sensor.trafikverket_weatherstation.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: trafikverket.png -ha_category: Sensor +ha_category: Weather ha_release: 0.66.0 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.ups.markdown b/source/_components/sensor.ups.markdown index 6e1989bfe22..fe1ae61a91a 100644 --- a/source/_components/sensor.ups.markdown +++ b/source/_components/sensor.ups.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: ups.png -ha_category: Sensor +ha_category: Postal Service ha_release: 0.39 ha_iot_class: "Cloud Polling" --- The `ups` platform allows one to track deliveries by the [UPS](https://www.ups.com/). To use this sensor, you need a [My UPS Account](https://www.ups.com/mychoice). +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/sensor.uscis.markdown b/source/_components/sensor.uscis.markdown index 3d214dc818a..8dbedc2a3cb 100644 --- a/source/_components/sensor.uscis.markdown +++ b/source/_components/sensor.uscis.markdown @@ -3,7 +3,7 @@ layout: page title: USCIS Sensor description: "Instructions on how to set up USCIS within Home Assistant." date: 2018-03-21 08:00 -sidebar: false +sidebar: true comments: false sharing: true footer: true @@ -15,7 +15,9 @@ ha_iot_class: "Cloud Polling" The `uscis` sensor component allows you get updates on your USCIS case using your case/receipt number. The sensor gets the case information from [USCIS Website]( https://egov.uscis.gov/casestatus/landing.do) -## Example for `configuration.yaml` : +## {% linkable_title Configuration %} + +To use your Sonarr sensor in your installation, add the following to your `configuration.yaml` file: ```yaml sensor: @@ -25,7 +27,7 @@ sensor: ``` {% configuration %} -friendly_name: +name: description: Name of the sensor in Home Assistant. required: false default: USCIS diff --git a/source/_components/sensor.usps.markdown b/source/_components/sensor.usps.markdown index 46244107308..89d7029a0a8 100644 --- a/source/_components/sensor.usps.markdown +++ b/source/_components/sensor.usps.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: usps.png -ha_category: Sensor +ha_category: Postal Service ha_release: 0.36 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/sensor.yahoo_finance.markdown b/source/_components/sensor.yahoo_finance.markdown index 0e8d12c0fbe..937dc442b44 100644 --- a/source/_components/sensor.yahoo_finance.markdown +++ b/source/_components/sensor.yahoo_finance.markdown @@ -20,6 +20,8 @@ ha_release: 0.29 The `yahoo_finance` platform uses [Yahoo Finance](https://finance.yahoo.com/) to monitor the stock market. +## {% linkable_title Configuration %} + To enable the `yahoo_finance` platform, add the following lines to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sleepiq.markdown b/source/_components/sleepiq.markdown index a3efeaa0a0c..bb006c23cdc 100644 --- a/source/_components/sleepiq.markdown +++ b/source/_components/sleepiq.markdown @@ -8,15 +8,19 @@ comments: false sharing: true footer: true logo: sleepiq.png -ha_category: Hub +ha_category: Health ha_release: 0.29 ha_iot_class: "Local Polling" --- The SleepIQ implementation lets you view sensor data from [SleepIQ by SleepNumber](http://www.sleepnumber.com/sn/en/sleepiq-sleep-tracker). In particular, it lets you see the occupancy and current SleepNumber (ie current firmness) of each side of a SleepNumber bed. +## {% linkable_title Setup %} + You will need an account on [SleepIQ](https://sleepiq.sleepnumber.com/) to use this component. +## {% linkable_title Configuration %} + To set it up, add the following information to your `configuration.yaml` file: ```yaml diff --git a/source/_components/spaceapi.markdown b/source/_components/spaceapi.markdown index eaf817cb351..bd5c356c337 100644 --- a/source/_components/spaceapi.markdown +++ b/source/_components/spaceapi.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: spaceapi.png -ha_category: Other +ha_category: Social ha_release: "0.70" --- diff --git a/source/_components/switch.arest.markdown b/source/_components/switch.arest.markdown index e0b63695371..a6a61d7ae98 100644 --- a/source/_components/switch.arest.markdown +++ b/source/_components/switch.arest.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: arest.png -ha_category: Switch +ha_category: DIY ha_iot_class: "Local Polling" ha_release: 0.16 --- The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with an Ethernet/Wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework. +## {% linkable_title Configuration %} + To use your aREST enabled device with pins in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.bbb_gpio.markdown b/source/_components/switch.bbb_gpio.markdown index 7b02e6a927b..fc41a25db14 100644 --- a/source/_components/switch.bbb_gpio.markdown +++ b/source/_components/switch.bbb_gpio.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: beaglebone-black.png -ha_category: Switch +ha_category: DIY ha_release: 0.36 ha_iot_class: "Local Push" --- The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). +## {% linkable_title Configuration %} + To use yourBeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.digital_ocean.markdown b/source/_components/switch.digital_ocean.markdown index e17a74ab35c..dc59db6f96e 100644 --- a/source/_components/switch.digital_ocean.markdown +++ b/source/_components/switch.digital_ocean.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: digital_ocean.png -ha_category: Switch +ha_category: System Monitor ha_release: "0.30" ha_iot_class: "Local Polling" --- The `digital_ocean` switch platform allows you to control (start/stop) your Digital Ocean droplets. +### {% 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: ```yaml diff --git a/source/_components/switch.digitalloggers.markdown b/source/_components/switch.digitalloggers.markdown index c0c2272d172..01fc3f88190 100755 --- a/source/_components/switch.digitalloggers.markdown +++ b/source/_components/switch.digitalloggers.markdown @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `digitalloggers` switch platform allows you to control the state of your [Digital Loggers](http://www.digital-loggers.com/dinfaqs.html) switches. +### {% linkable_title Configuration %} + To use your digitalloggers switch in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.homekit_controller.markdown b/source/_components/switch.homekit_controller.markdown index 43bf3be57b1..d4b50659595 100644 --- a/source/_components/switch.homekit_controller.markdown +++ b/source/_components/switch.homekit_controller.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: apple-homekit.png -ha_category: Light +ha_category: Switch ha_iot_class: "Local Polling" ha_release: 0.68 --- diff --git a/source/_components/switch.hydrawise.markdown b/source/_components/switch.hydrawise.markdown index b1ebab81998..b2e826b663b 100644 --- a/source/_components/switch.hydrawise.markdown +++ b/source/_components/switch.hydrawise.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: hydrawise_logo.png -ha_category: Switch +ha_category: Irrigation ha_release: 0.71 ha_iot_class: Cloud Polling --- Before setting up the [Hunter Hydrawise](https://hydrawise.com) switches please follow the instructions for setting up the [Hydrawise hub](/components/hydrawise) component. +## {% linkable_title Configuration %} + Once you have enabled the `hydrawise` component, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.mysensors.markdown b/source/_components/switch.mysensors.markdown index a0fffa84e36..91d5c2e17aa 100644 --- a/source/_components/switch.mysensors.markdown +++ b/source/_components/switch.mysensors.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: mysensors.png -ha_category: Switch +ha_category: DIY featured: false ha_iot_class: "Local Push" --- diff --git a/source/_components/switch.pilight.markdown b/source/_components/switch.pilight.markdown index ca2c837986d..d70f748cfa5 100644 --- a/source/_components/switch.pilight.markdown +++ b/source/_components/switch.pilight.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: pilight.png -ha_category: Switch +ha_category: DIY ha_release: 0.26 ha_iot_class: "Local Polling" --- diff --git a/source/_components/switch.rainbird.markdown b/source/_components/switch.rainbird.markdown index 673c4d19287..12b2f1019d4 100644 --- a/source/_components/switch.rainbird.markdown +++ b/source/_components/switch.rainbird.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainbird.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.57 ha_iot_class: "Local Polling" --- diff --git a/source/_components/switch.raincloud.markdown b/source/_components/switch.raincloud.markdown index 2e2af72de81..2844b924aed 100644 --- a/source/_components/switch.raincloud.markdown +++ b/source/_components/switch.raincloud.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raincloud.jpg -ha_category: Switch +ha_category: Irrigation ha_release: "0.55" ha_iot_class: "Cloud Polling" --- To get your [Melnor RainCloud](https://wifiaquatimer.com) binary sensors working within Home Assistant, please follow the instructions for the general [Raincloud component](/components/raincloud). +## {% linkable_title Configuration %} + Once you have enabled the [Raincloud component](/components/raincloud), add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.rainmachine.markdown b/source/_components/switch.rainmachine.markdown index 51cba578c1e..982220ccacb 100644 --- a/source/_components/switch.rainmachine.markdown +++ b/source/_components/switch.rainmachine.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: rainmachine.png -ha_category: Switch +ha_category: Irrigation ha_iot_class: "Cloud Polling" ha_release: 0.51 --- diff --git a/source/_components/switch.raspihats.markdown b/source/_components/switch.raspihats.markdown index f31a33edaac..c1f65847dc3 100644 --- a/source/_components/switch.raspihats.markdown +++ b/source/_components/switch.raspihats.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspihats.png -ha_category: Switch +ha_category: DIY ha_release: 0.45 ha_iot_class: "Local Push" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Push" The `raspihats` switch platform allows you to control the digital outputs of your [raspihats](http://www.raspihats.com/) boards. +## {% linkable_title Configuration %} + To use your raspihats boards in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.rpi_gpio.markdown b/source/_components/switch.rpi_gpio.markdown index 5b3a888e240..f6d62a4935b 100644 --- a/source/_components/switch.rpi_gpio.markdown +++ b/source/_components/switch.rpi_gpio.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Switch +ha_category: DIY ha_release: pre 0.7 ha_iot_class: "Local Push" --- @@ -16,6 +16,8 @@ ha_iot_class: "Local Push" The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). +## {% linkable_title Configuration %} + To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.rpi_pfio.markdown b/source/_components/switch.rpi_pfio.markdown index 30498f7d990..57f4ba2a6dc 100644 --- a/source/_components/switch.rpi_pfio.markdown +++ b/source/_components/switch.rpi_pfio.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Switch +ha_category: DIY ha_release: 0.45 ha_iot_class: "Local Polling" --- The `rpi_pfio` switch platform allows you to control the [PiFace Digital I/O](http://www.piface.org.uk/products/piface_digital/) module. +## {% linkable_title Configuration %} + To use your PiFace Digital I/O module in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.rpi_rf.markdown b/source/_components/switch.rpi_rf.markdown index b9813ceb560..43d2e5a30d5 100644 --- a/source/_components/switch.rpi_rf.markdown +++ b/source/_components/switch.rpi_rf.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: Switch +ha_category: DIY ha_release: 0.19 ha_iot_class: "Assumed state" --- @@ -19,6 +19,8 @@ The `rpi_rf` switch platform allows you to control devices over 433/315MHz LPD/S Interoperable with codes sniffed via [the rpi-rf module](https://pypi.python.org/pypi/rpi-rf) or [rc-switch](https://github.com/sui77/rc-switch). For more info see the PyPi module description: [rpi-rf](https://pypi.python.org/pypi/rpi-rf). +## {% linkable_title Configuration %} + To enable, add the following to your `configuration.yaml`: ```yaml diff --git a/source/_components/switch.tesla.markdown b/source/_components/switch.tesla.markdown index 2ded4d7d100..5b184f2fa46 100644 --- a/source/_components/switch.tesla.markdown +++ b/source/_components/switch.tesla.markdown @@ -8,13 +8,13 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Switch +ha_category: Car ha_iot_class: "Cloud Push" ha_release: 0.54 --- -The `Tesla` platform allows you to control your [Tesla](https://www.tesla.com/) charger (enable/disable charging, max range switch) from within Home Assistant. +The `tesla` platform allows you to control your [Tesla](https://www.tesla.com/) charger (enable/disable charging, max range switch) from within Home Assistant. -The switch platform will be automatically configured if Tesla component is configured. +The switch platform will be automatically configured if the `tesla` component is configured. -For more configuration information see the [Tesla component](/components/tesla/) documentation. +For more configuration information see the [`tesla` component](/components/tesla/) documentation. diff --git a/source/_components/switch.volvooncall.markdown b/source/_components/switch.volvooncall.markdown index f4de42f5011..0177adf5ded 100644 --- a/source/_components/switch.volvooncall.markdown +++ b/source/_components/switch.volvooncall.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: volvo.png -ha_category: Presence Detection +ha_category: Car ha_release: "0.30" --- diff --git a/source/_components/switch.vultr.markdown b/source/_components/switch.vultr.markdown index 087be7fe925..c02e5273b1e 100644 --- a/source/_components/switch.vultr.markdown +++ b/source/_components/switch.vultr.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: vultr.png -ha_category: Switch +ha_category: System Monitor ha_release: "0.58" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/tesla.markdown b/source/_components/tesla.markdown index 8673396fc68..f912af94f82 100644 --- a/source/_components/tesla.markdown +++ b/source/_components/tesla.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: tesla.png -ha_category: Hub +ha_category: Car ha_release: 0.53 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/usps.markdown b/source/_components/usps.markdown index 3a7c9a06abe..a95efd919ab 100644 --- a/source/_components/usps.markdown +++ b/source/_components/usps.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: usps.png -ha_category: Hub +ha_category: Postal Service ha_release: 0.52 ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/volvooncall.markdown b/source/_components/volvooncall.markdown index 6482d372ccf..8160d19882f 100644 --- a/source/_components/volvooncall.markdown +++ b/source/_components/volvooncall.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: volvo.png -ha_category: Hub +ha_category: Car ha_release: 0.39 ha_iot_class: "Cloud Polling" --- -The `volvooncall` platform offers integration with the [Volvo On Call](http://www.volvocars.com/intl/own/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level. +The `volvooncall` component offers integration with the [Volvo On Call](http://www.volvocars.com/intl/own/connectivity/volvo-on-call) cloud service and offers presence detection as well as sensors such as odometer and fuel level. + +## {% linkable_title Configuration %} To use Volvo On Call in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/vultr.markdown b/source/_components/vultr.markdown index 187ddaab3f3..98051d2038c 100644 --- a/source/_components/vultr.markdown +++ b/source/_components/vultr.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true featured: false -ha_category: Hub +ha_category: System Monitor ha_release: "0.58" logo: vultr.png ha_iot_class: "Cloud Polling" diff --git a/source/_components/waterfurnace.markdown b/source/_components/waterfurnace.markdown index 2555b1fb804..15a88eb8565 100644 --- a/source/_components/waterfurnace.markdown +++ b/source/_components/waterfurnace.markdown @@ -8,13 +8,12 @@ comments: false sharing: true footer: true logo: waterfurnace.png -ha_category: Hub +ha_category: Irrigation ha_release: 0.62 ha_iot_class: "Cloud Polling" --- -The `waterfurnace` component communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your -system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable. +The `waterfurnace` component communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable. The sensors provided include: diff --git a/source/_components/zabbix.markdown b/source/_components/zabbix.markdown index e4630839993..bda90be47f7 100644 --- a/source/_components/zabbix.markdown +++ b/source/_components/zabbix.markdown @@ -16,6 +16,8 @@ ha_iot_class: "Local Polling" The `zabbix` component is the main component to connect to a [Zabbix](http://www.zabbix.com/) monitoring instance via the Zabbix API. +## {% linkable_title Configuration %} + To set the Zabbix component up, add the following information to your `configuration.yaml` file: ```yaml diff --git a/source/_docs/installation/hassbian.markdown b/source/_docs/installation/hassbian.markdown index 9c12947cd46..9fdcd566a0a 100644 --- a/source/_docs/installation/hassbian.markdown +++ b/source/_docs/installation/hassbian.markdown @@ -23,4 +23,5 @@ When instructions tell you to activate the virtual environment to install a Pyth ```bash $ sudo -u homeassistant -H -s -$ source /srv/homeassistant/bin/activate``` +$ source /srv/homeassistant/bin/activate +``` diff --git a/source/_docs/z-wave/device-specific.markdown b/source/_docs/z-wave/device-specific.markdown index bb84afca590..add87e6abdc 100644 --- a/source/_docs/z-wave/device-specific.markdown +++ b/source/_docs/z-wave/device-specific.markdown @@ -49,7 +49,7 @@ $ echo -e -n "\x01\x08\x00\xF2\x51\x01\x01\x05\x01\x50" > /dev/serial/by-id/usb- You need to disable the on-board Bluetooth since the board requires the use of the hardware UART (and there's only one on the Pi3). You do this by adding the following to the end of `/boot/config.txt`: -``` +```text dtoverlay=pi3-disable-bt ``` @@ -59,7 +59,24 @@ Then disable the Bluetooth modem service: $ sudo systemctl disable hciuart ``` -Finally, reboot to make those changes active. It's been reported that this is also required on the Pi2. +Once Bluetooth is off, enable the serial interface via the `raspi-config` tool. After reboot run: + +```bash +$ sudo systemctl mask serial-getty@ttyAMA0.service +``` + +so that your serial interface looks like: + +```text +crw-rw---- 1 root dialout 204, 64 Sep 2 14:38 /dev/ttyAMA0 +``` +at this point simply add your user (homeassistant) to the dialout group: + +```bash +$ sudo usermod -a -G dialout homeassistant +``` + +Finally, reboot again to make those changes active. It's has been tested on hassbian and has been reported that this is also required on the Pi2.

If you've installed the Z-Way software, you'll need to ensure you disable it before you install Home Assistant or you won't be able to access the board. Do this with `sudo /etc/init.d/z-way-server stop; sudo update-rc.d z-way-server disable`. diff --git a/source/_docs/z-wave/installation.markdown b/source/_docs/z-wave/installation.markdown index 586f319a68a..a118d2c97ce 100644 --- a/source/_docs/z-wave/installation.markdown +++ b/source/_docs/z-wave/installation.markdown @@ -103,7 +103,7 @@ device_config / device_config_domain / device_config_glob: type: integer default: 2 invert_openclose_buttons: - description: Inverts function of the open and close buttons for the cover domain. + description: Inverts function of the open and close buttons for the cover domain. This will not invert the positon and state reporting. required: false type: boolean default: False