diff --git a/source/_components/august.markdown b/source/_components/august.markdown index 2d079065ec7..9231f7d2f13 100644 --- a/source/_components/august.markdown +++ b/source/_components/august.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: august.png -ha_category: Door bell +ha_category: Doorbell ha_release: "0.64" ha_iot_class: "Cloud Polling" --- diff --git a/source/_components/binary_sensor.august.markdown b/source/_components/binary_sensor.august.markdown index 20d2aec19d0..4af76c345bc 100644 --- a/source/_components/binary_sensor.august.markdown +++ b/source/_components/binary_sensor.august.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: august.png -ha_category: Door bell +ha_category: Doorbell ha_release: "0.64" ha_iot_class: "Cloud Polling" --- @@ -20,3 +20,4 @@ If you have August Doorbell, once you have enabled the [August component](/compo * Doorbell ding sensor * Doorbell motion sensor * Doorbell online sensor + diff --git a/source/_components/binary_sensor.upcloud.markdown b/source/_components/binary_sensor.upcloud.markdown index 6cae22e876c..2723cefa5bf 100644 --- a/source/_components/binary_sensor.upcloud.markdown +++ b/source/_components/binary_sensor.upcloud.markdown @@ -15,6 +15,8 @@ ha_iot_class: Cloud Polling The `upcloud` binary sensor platform allows you to monitor your UpCloud servers. +## {% linkable_title Configuration %} + To use your UpCloud servers, you first have to set up your [UpCloud hub](/components/upcloud/) and then add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/digital_ocean.markdown b/source/_components/digital_ocean.markdown index fd5d744376b..c0dc3175c29 100644 --- a/source/_components/digital_ocean.markdown +++ b/source/_components/digital_ocean.markdown @@ -16,11 +16,11 @@ 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 %} +## {% linkable_title Setup %} Obtain your API key from your [Digital Ocean dashboard](https://cloud.digitalocean.com/settings/api/tokens). -### {% linkable_title Configuration %} +## {% linkable_title Configuration %} To integrate your Digital Ocean droplets with Home Assistant, add the following section to your `configuration.yaml` file: diff --git a/source/_components/doorbird.markdown b/source/_components/doorbird.markdown index 43f30816d94..839a77a2e91 100644 --- a/source/_components/doorbird.markdown +++ b/source/_components/doorbird.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: doorbird.png -ha_category: Hub +ha_category: Doorbell ha_release: "0.54" ha_iot_class: "Local Polling" --- The `doorbird` implementation allows you to integrate your [DoorBird](http://www.doorbird.com/) device in Home Assistant. +## {% linkable_title Configuration %} + To connect your device, add the following to your `configuration.yaml` file: ```yaml @@ -94,4 +96,4 @@ Enabling any monitored condition will delete all registered notification service action: service: light.turn_on entity_id: light.side_entry_porch -``` \ No newline at end of file +``` diff --git a/source/_components/light.blinksticklight.markdown b/source/_components/light.blinksticklight.markdown index d5cc53a99fc..bdd41852704 100644 --- a/source/_components/light.blinksticklight.markdown +++ b/source/_components/light.blinksticklight.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Blinkstick" +title: "Blinkstick Light" description: "Instructions on how to setup Blinkstick lights within Home Assistant." date: 2015-10-08 10:00 sidebar: true diff --git a/source/_components/light.blinkt.markdown b/source/_components/light.blinkt.markdown index 69b72eb1d13..cee02bd7118 100644 --- a/source/_components/light.blinkt.markdown +++ b/source/_components/light.blinkt.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Blinkt!" +title: "Blinkt! Light" description: "Instructions on how to setup Blinkt! RGB LED lights within Home Assistant." date: 2017-04-30 9:00 sidebar: true diff --git a/source/_components/plant.markdown b/source/_components/plant.markdown index 6beaa00557f..df2947e19da 100644 --- a/source/_components/plant.markdown +++ b/source/_components/plant.markdown @@ -8,12 +8,14 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Other +ha_category: Environment ha_release: 0.44 --- This`plant`component lets you merge moisture, conductivity, light intensity, temperature and battery level for a plant into a single UI element. It also supports setting minimum and maximum values for each measurement and will change its state to "problem" if it is not within those limits. +## {% linkable_title Configuration %} + To use your `plant` sensor in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.cert_expiry.markdown b/source/_components/sensor.cert_expiry.markdown index 23682318933..99b0578b76b 100644 --- a/source/_components/sensor.cert_expiry.markdown +++ b/source/_components/sensor.cert_expiry.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: System Monitor +ha_category: Network ha_release: 0.44 ha_iot_class: "depends" --- The `cert_expiry` sensor fetches information from a configured URL and displays the certificate expiry in days. +## {% linkable_title Configuration %} + To add the Certificate Expiry sensor to your installation, add these options to `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.mold_indicator.markdown b/source/_components/sensor.mold_indicator.markdown index 6b337c6967f..e2d870f7924 100644 --- a/source/_components/sensor.mold_indicator.markdown +++ b/source/_components/sensor.mold_indicator.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: home-assistant.png -ha_category: Climate +ha_category: Environment ha_release: '0.20' ha_iot_class: "Local Polling" --- diff --git a/source/_components/sensor.swiss_hydrological_data.markdown b/source/_components/sensor.swiss_hydrological_data.markdown index 44f4d6100bd..c6110b8f7c5 100644 --- a/source/_components/sensor.swiss_hydrological_data.markdown +++ b/source/_components/sensor.swiss_hydrological_data.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: swiss-hydrological-data.png -ha_category: Weather +ha_category: Environment ha_iot_class: "Cloud Polling" ha_release: 0.22 --- @@ -19,33 +19,49 @@ ha_release: 0.22 The `swiss_hydrological_data` sensor will show you details (temperature, level, and discharge) of rivers and lakes in Switzerland. +## {% linkable_title Setup %} + The [station overview](http://www.hydrodaten.admin.ch/en/danger-levels-table.html) contains a list of all available measuring points and will help to determine the ID of station which is needed for the configuration. +## {% linkable_title Configuration %} + To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml # Example configuration.yaml entry sensor: - platform: swiss_hydrological_data - station: STATION_ID + - platform: swiss_hydrological_data + station: STATION_ID ``` -Configuration variables: - -- **name** (*Optional*): Name to use in the frontend. -- **station** (*Required*): The ID of the measurement point. +{% configuration %} +station: + description: The ID of the measurement point. + required: true + type: string +name: + description: Name to use in the frontend. + required: false + type: string + default: +{% endconfiguration %} The hydrological measurings are coming from the [Swiss Federal Office for the Environment (Bundesamt für Umwelt - Abt. Hydrologie)](http://www.hydrodaten.admin.ch) and are updated almost in real-time. +## {% linkable_title Example %} + This sensor contains additional information which an easily accessed by a [template sensor](/components/sensor.template/). +{% raw %} ```yaml # Example configuration.yaml entry sensor: platform: template sensors: discharge: - value_template: '{% raw %}{{ states.sensor.aare.attributes.Discharge }}{% endraw %}' + value_template: '{{ states.sensor.aare.attributes.Discharge }}' friendly_name: 'Discharge' ``` +{% endraw %} + diff --git a/source/_components/sensor.syncthru.markdown b/source/_components/sensor.syncthru.markdown index 19b2e5d1399..f2238dda257 100644 --- a/source/_components/sensor.syncthru.markdown +++ b/source/_components/sensor.syncthru.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: samsung.png -ha_category: Sensor +ha_category: System Monitor ha_iot_class: "Local Polling" ha_release: 0.66 --- diff --git a/source/_components/sensor.tradfri.markdown b/source/_components/sensor.tradfri.markdown index 98d673d16a6..91827191509 100644 --- a/source/_components/sensor.tradfri.markdown +++ b/source/_components/sensor.tradfri.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "IKEA Trådfri sensor" +title: "IKEA Trådfri Sensor" description: "Access and control your ZigBee-based IKEA Trådfri (Tradfri) Sensors." date: 2017-04-12 22.04 sidebar: true diff --git a/source/_components/sensor.upnp.markdown b/source/_components/sensor.upnp.markdown index c9d31bcca21..027d76d9ede 100644 --- a/source/_components/sensor.upnp.markdown +++ b/source/_components/sensor.upnp.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: upnp.png -ha_category: "Other" +ha_category: Network ha_release: 0.48 ha_iot_class: "Local Polling" --- diff --git a/source/_components/switch.acer_projector.markdown b/source/_components/switch.acer_projector.markdown index 70e1ae5499f..7599cd6d96e 100644 --- a/source/_components/switch.acer_projector.markdown +++ b/source/_components/switch.acer_projector.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: acer.png -ha_category: Switch +ha_category: Multimedia ha_iot_class: "Local Polling" ha_release: 0.19 --- @@ -16,6 +16,8 @@ ha_release: 0.19 The `acer_projector` switch platform allows you to control the state of RS232 connected projectors from [Acer](http://www.acer.com). +## {% linkable_title Configuration %} + To use your Acer Projector in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.upcloud.markdown b/source/_components/switch.upcloud.markdown index 98f45d0e68d..bdd03f6af5e 100644 --- a/source/_components/switch.upcloud.markdown +++ b/source/_components/switch.upcloud.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: upcloud.png -ha_category: Switch +ha_category: System Monitor ha_release: 0.65 ha_iot_class: Cloud Polling --- The `upcloud` switch platform allows you to control (start/stop) your UpCloud servers. +## {% linkable_title Configuration %} + To use your UpCloud servers, you first have to set up your [UpCloud hub](/components/upcloud/) and then add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/switch.wake_on_lan.markdown b/source/_components/switch.wake_on_lan.markdown index 161cfcd1b50..c487c602dac 100644 --- a/source/_components/switch.wake_on_lan.markdown +++ b/source/_components/switch.wake_on_lan.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: ethernet.png -ha_category: Switch +ha_category: Network ha_release: 0.16 ha_iot_class: "Local Polling" --- diff --git a/source/_components/upcloud.markdown b/source/_components/upcloud.markdown index dcb15e41fc4..abd6d945431 100644 --- a/source/_components/upcloud.markdown +++ b/source/_components/upcloud.markdown @@ -7,7 +7,7 @@ sidebar: true comments: false sharing: true footer: true -ha_category: Hub +ha_category: System Monitor ha_release: 0.65 logo: upcloud.png ha_iot_class: Cloud Polling @@ -16,8 +16,12 @@ ha_iot_class: Cloud Polling The `upcloud` component allows you to access the information about your [UpCloud](https://www.upcloud.com/) servers from Home Assistant. +## {% linkable_title Setup %} + Set up your API user credentials in your [UpCloud control panel](https://my.upcloud.com/). +## {% linkable_title Configuration %} + To integrate your UpCloud servers with Home Assistant, add the following section to your `configuration.yaml` file: ```yaml diff --git a/source/_components/upnp.markdown b/source/_components/upnp.markdown index 842e3b25ba4..02ba10a72fd 100644 --- a/source/_components/upnp.markdown +++ b/source/_components/upnp.markdown @@ -8,13 +8,13 @@ comments: false sharing: true footer: true logo: upnp.png -ha_category: "Other" +ha_category: Network ha_release: 0.18 --- The `upnp` component enables you to collect network statistics from your router such as bytes in/out and packets in/out. This information is provided by the Internet Gateway Device (IGD) Protocol if enabled on your router. -The IGD automatically creates port forwarding mappings on your router for Home Assistant, exposing your installation to the internet. The mapping will never automatically expire. Upon stopping Home Assistant, the mapping will be removed from your router. +The IGD automatically creates port forwarding mappings on your router for Home Assistant, exposing your installation to the internet. The mapping will never automatically expire. Upon stopping Home Assistant, the mapping will be removed from your router. Please note that UPnP or NAT-PMP needs to be enabled on your router for this component to work. diff --git a/source/_components/wake_on_lan.markdown b/source/_components/wake_on_lan.markdown index 2f7b1d4532d..93787c4aaef 100644 --- a/source/_components/wake_on_lan.markdown +++ b/source/_components/wake_on_lan.markdown @@ -8,13 +8,15 @@ comments: false sharing: true footer: true logo: ethernet.png -ha_category: Utility +ha_category: Network ha_release: "0.49" ha_iot_class: "Local Push" --- The `wake_on_lan` component enables the ability to send _magic packets_ to [Wake on LAN](https://en.wikipedia.org/wiki/Wake-on-LAN) capable devices, to turn them on. +## {% linkable_title Configuration %} + To use this component in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/zeroconf.markdown b/source/_components/zeroconf.markdown index 3d054ea4d59..d1459fdd1b1 100644 --- a/source/_components/zeroconf.markdown +++ b/source/_components/zeroconf.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: avahi.png -ha_category: "Other" +ha_category: Network ha_release: 0.18 ---