It might be necessary to install additional packages: $ sudo apt-get install libxslt-dev libxml2-dev python3-lxml
If you are working with the All-in-One installation, you may also need to execute also within your virtual environment the command pip install lxml; be patient this will take a while.
-Low `max_interval` may cause battery drainage as it wakes up your device to get the current location. +This may cause battery drainage as it wakes up your device to get the current location.
@@ -50,7 +48,7 @@ To disable the drainage of the battery, a dynamic interval is being used for eac 2 Factor Authentication is the improved version of 2 Steps Authentication, this is still not supported by the pyicloud library. Therefore it's not possible to use it with the device_tracker yet. 4 services are available for this component: -- **icloud_update**: This service can be used to ask for an update of a certain iDevice. The `account_name` and `device_name` are optional. Request will result in new Home Assistant [state_changed](/docs/configuration/events/#event-state_changed) event describing current iphone location. Can be used in automations when manual location update is needed, e.g. to check if anyone is home when door's been opened. +- **icloud_update**: This service can be used to ask for an update of a certain iDevice. The `account_name` and `device_name` are optional. - **icloud_lost_iphone**: This service will play the Lost iPhone sound on a certain iDevice. The `account_name` and `device_name` are optional. - **icloud_set_interval**: This service will change the dynamic interval of an iDevice. The `account_name` and `device_name` are optional. If `interval` is used in the service_data, the iDevice will be updated with that new interval. That interval will be fixed until the iDevice changes zone or if this service is called again. If `interval` isn't used in the service_data, the interval for that iDevice will revert back to its default dynamic interval based on its current zone, its distance towards home and its battery level. - **icloud_reset_account**: This service can be used to reset an iCloud account. This is helpful when not all devices are being found by the component or if you have added a new iDevice to your account. The `account_name` is optional. diff --git a/source/_components/discoverable.markdown b/source/_components/discoverable.markdown index 12c170a1ee..49e9f82111 100644 --- a/source/_components/discoverable.markdown +++ b/source/_components/discoverable.markdown @@ -23,7 +23,7 @@ for state in hass.states(): To enable `discovery` in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry discoverable: expose_password: yes ``` diff --git a/source/_components/fan.mqtt.markdown b/source/_components/fan.mqtt.markdown index 45fa55d41b..94a02b1a9e 100644 --- a/source/_components/fan.mqtt.markdown +++ b/source/_components/fan.mqtt.markdown @@ -15,8 +15,6 @@ ha_iot_class: depends The `mqtt` fan platform lets you control your MQTT enabled fans. -## {% linkable_title Configuration %} - In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT fan will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the fan will be `false` / `off`. When a `state_topic` is not available, the fan will work in optimistic mode. In this mode, the fan will immediately change state after every command. Otherwise, the fan will wait for state confirmation from the device (message from `state_topic`). @@ -26,7 +24,7 @@ Optimistic mode can be forced even if a `state_topic` is available. Try to enabl To enable MQTT fans in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry fan: - platform: mqtt command_topic: "bedroom_fan/on/set" @@ -157,7 +155,7 @@ In this section you find some real life examples of how to use this fan. The example below shows a full configuration for a MQTT fan. ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry fan: - platform: mqtt name: "Bedroom Fan" diff --git a/source/_components/fritzbox.markdown b/source/_components/fritzbox.markdown index a5ca0a5f68..351f63e35d 100644 --- a/source/_components/fritzbox.markdown +++ b/source/_components/fritzbox.markdown @@ -35,21 +35,21 @@ fritzbox: ``` {% configuration %} -devices: - description: A list of Fritzbox devices. - required: true - type: map - keys: - host: - description: The hostname or IP address of the Fritzbox. - required: true - type: optional - username: - description: The username for Smart Home access. - required: true - type: string - password: - description: The password of the user. - required: true - type: string + devices: + description: A list of Fritzbox devices. + required: true + type: map + keys: + host: + description: The hostname or IP address of the Fritzbox. + required: true + type: optional + username: + description: The username for Smart Home access. + required: true + type: string + password: + description: The password of the user. + required: true + type: string {% endconfiguration %} diff --git a/source/_components/juicenet.markdown b/source/_components/juicenet.markdown index 74cc2fdb89..5df8b274e6 100644 --- a/source/_components/juicenet.markdown +++ b/source/_components/juicenet.markdown @@ -15,12 +15,10 @@ ha_release: 0.47 The `juicenet` sensor platform pulls data from a [JuiceNet](https://emotorwerks.com/products/juicenet/) charging station equipped with a wifi connection. It will access and make available all of the devices attached to your account. -## {% linkable_title Configuration %} - To enable the platform in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry juicenet: access_token: ACCESS_TOKEN ``` diff --git a/source/_components/light.mochad.markdown b/source/_components/light.mochad.markdown index 9721e9d6c9..fdd288113f 100644 --- a/source/_components/light.mochad.markdown +++ b/source/_components/light.mochad.markdown @@ -11,14 +11,13 @@ ha_category: Light ha_release: 0.51 --- -The `mochad` light platform lets you control an X10 enabled dimmer/light device. - - +The `mochad` light platform lets you control an X10 enabled dimmer/light +device. To enable this sensor, you first have to set up the [mochad component](/components/mochad/) and then add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry light: - platform: mochad devices: diff --git a/source/_components/light.mqtt.markdown b/source/_components/light.mqtt.markdown index e92f859fb7..7678e5c9b0 100644 --- a/source/_components/light.mqtt.markdown +++ b/source/_components/light.mqtt.markdown @@ -14,8 +14,6 @@ ha_iot_class: depends The `mqtt` light platform lets you control your MQTT enabled lights. It supports setting brightness, color temperature, effects, flashing, on/off, RGB colors, transitions, XY colors and white values. -## {% linkable_title Configuration %} - In an ideal scenario, the MQTT device will have a state topic to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT light will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`. When a state topic is not available, the light will work in optimistic mode. In this mode, the light will immediately change state after every command. Otherwise, the light will wait for state confirmation from the device (message from `state_topic`). @@ -23,7 +21,7 @@ When a state topic is not available, the light will work in optimistic mode. In Optimistic mode can be forced, even if the `state_topic` is available. Try to enable it, if experiencing incorrect light operation. ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry light: - platform: mqtt command_topic: "office/rgb1/light/switch" @@ -209,7 +207,7 @@ To enable a light with brightness and RGB support in your installation, add the {% raw %} ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry light: - platform: mqtt name: "Office Light RGB" @@ -234,7 +232,7 @@ light: To enable a light with brightness (no RGB version) in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry light: - platform: mqtt name: "Office light" @@ -253,7 +251,7 @@ light: To enable a light that sends only brightness topics to turn it on, add the following to your `configuration.yaml` file. The `command_topic` is only used to send an off command in this case: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry light: - platform: mqtt name: "Brightness light" diff --git a/source/_components/lock.mqtt.markdown b/source/_components/lock.mqtt.markdown index ff8eb05170..b0669cfb7f 100644 --- a/source/_components/lock.mqtt.markdown +++ b/source/_components/lock.mqtt.markdown @@ -24,7 +24,7 @@ Optimistic mode can be forced, even if state topic is available. Try to enable i To enable MQTT locks in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry lock: - platform: mqtt command_topic: "home/frontdoor/set" diff --git a/source/_components/maxcube.markdown b/source/_components/maxcube.markdown index 7439d2d19f..69713a6469 100644 --- a/source/_components/maxcube.markdown +++ b/source/_components/maxcube.markdown @@ -58,9 +58,4 @@ maxcube: required: false type: int default: 62910 - scan_interval: - description: The update interval in seconds - required: false - type: int - default: 300 {% endconfiguration %} diff --git a/source/_components/media_player.onkyo.markdown b/source/_components/media_player.onkyo.markdown index 19854cfe60..13a50152dc 100644 --- a/source/_components/media_player.onkyo.markdown +++ b/source/_components/media_player.onkyo.markdown @@ -39,10 +39,6 @@ name: description: Name of the device. (*Required if host is specified*) required: false type: string -max_volume: - description: Maximum volume. Defaults to 80. - required: false - type: number sources: description: A list of mappings from source to source name. Valid sources can be found below. A default list will be used if no source mapping is specified. required: false diff --git a/source/_components/mochad.markdown b/source/_components/mochad.markdown index bf0617cefb..df42020a21 100644 --- a/source/_components/mochad.markdown +++ b/source/_components/mochad.markdown @@ -13,8 +13,6 @@ ha_release: 0.32 The `mochad` component is the main component to integrate all X10 platforms being controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this component you will have to setup your X10 devices separately. -## {% linkable_title Configuration %} - To integrate your Mochad units with Home Assistant, add the following section to your `configuration.yaml` file: ```yaml @@ -22,20 +20,10 @@ To integrate your Mochad units with Home Assistant, add the following section to mochad: ``` -{% configuration %} -host: - description: The host that mochad is running on. - required: false - type: string - default: localhost -port: - description: The port that mochad is running on. - required: false - type: int - default: 1099 -{% endconfiguration %} +Configuration variables: -## {% linkable_title Example %} +- **host** (*Optional*): The host that mochad is running on. Defaults to `localhost`. +- **port** (*Optional*): The port that mochad is running on. Defaults to `1099`. A full configuration sample could look like the one below: diff --git a/source/_components/modbus.markdown b/source/_components/modbus.markdown index dcccf0ede6..30a2b62382 100644 --- a/source/_components/modbus.markdown +++ b/source/_components/modbus.markdown @@ -16,8 +16,6 @@ ha_iot_class: "Local Push" [Modbus](http://www.modbus.org/) is a serial communication protocol to control PLCs (Programmable logic controller). It currently supports sensors and switches which can be controlled over serial, TCP, and UDP connections. -## {% linkable_title Configuration %} - To add modbus to your installation, add the following to your `configuration.yaml` file: For a network connection: diff --git a/source/_components/pilight.markdown b/source/_components/pilight.markdown index 45e9832381..2e7e1b0150 100644 --- a/source/_components/pilight.markdown +++ b/source/_components/pilight.markdown @@ -19,8 +19,6 @@ This pilight hub connects to the [pilight-daemon](https://manual.pilight.org/pro The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other components (e.g., automation). Additionally a send service is provided to send RF codes. -## {% linkable_title Configuration %} - To integrate pilight into Home Assistant, add the following section to your `configuration.yaml` file: ```yaml diff --git a/source/_components/remember_the_milk.markdown b/source/_components/remember_the_milk.markdown index 70abbed77e..62d7deab2a 100644 --- a/source/_components/remember_the_milk.markdown +++ b/source/_components/remember_the_milk.markdown @@ -51,7 +51,7 @@ Configuration variables: ### {% linkable_title Step 2: registering your account %} -After saving the configuration, you need to (re-)start Home Assistant. On the first start you will notice a new "Configuration" panel appearing on the Home Assistant page. After opening the configuration page, follow the link "Remember The Milk login". This will take you to a login page where you have to log in with your normal Remember The Milk credentials. This will authorize Home Assistant to access your Remember The Milk account. +After saving the configuration, you need to (re-)start Home Assistant. On the first start you will notice a new "Configuration" panel appearing on the Home Assistant page. After opening the configuration page, follow the link "Remember The Milk login". This will take you to a login page where you have to log in with your normal Rember The Milk credentials. This will authorize Home Assistant to access your Remember The Milk account. After that click on the "login completed" button. This will tell Home Assistant that you have completed the login process on the Remember The Milk page and Home Assistant should try to register with this account. diff --git a/source/_components/sensor.fritzbox_callmonitor.markdown b/source/_components/sensor.fritzbox_callmonitor.markdown index dd57677a9c..85643e2dff 100644 --- a/source/_components/sensor.fritzbox_callmonitor.markdown +++ b/source/_components/sensor.fritzbox_callmonitor.markdown @@ -14,11 +14,10 @@ ha_iot_class: "Local Polling" --- -The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing` or `talking` with the phone numbers involved contained in the state attributes. +The `fritzbox_callmonitor` sensor monitors the call monitor exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers +on TCP port 1012. It will assume the values `idle`, `ringing`, `dialing`, or `talking` with the phone numbers involved contained in the state attributes. It can also access the internal phone book of the router to look up the names corresponding to the phone numbers and store them in the state attributes. -## {% linkable_title Configuration %} - To activate the call monitor on your Fritz!Box, dial #96\*5\* from any phone connected to it. To use the Fritz!Box call monitor in your installation, add the following to your `configuration.yaml` file: @@ -45,7 +44,7 @@ Configuration variables: The example below shows a full configuration for a call monitor with phone book support. ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: fritzbox_callmonitor name: Phone @@ -62,9 +61,8 @@ sensor: This example shows how to send notifications whenever the sensor's state changes. You will get notified both when you receive a call and also when a call is placed. -{% raw %} ```yaml -# Example configuration.yaml entry. +# Example configuration.yml entry. automation: - alias: "Notify about phone state" trigger: @@ -75,7 +73,7 @@ automation: data: title: "Phone" message: >- - {% if is_state("sensor.phone", "idle") %} + {% raw %}{% if is_state("sensor.phone", "idle") %} Phone is idle {% elif is_state("sensor.phone", "dialing") %} Calling {{ states.sensor.phone.attributes.to_name }} ({{ states.sensor.phone.attributes.to }}) @@ -83,6 +81,5 @@ automation: Incoming call from {{ states.sensor.phone.attributes.from_name }} ({{ states.sensor.phone.attributes.from }}) {% else %} Talking to {{ states.sensor.phone.attributes.with_name }} ({{ states.sensor.phone.attributes.with }}) - {% endif %} + {% endif %}{% endraw %} ``` -{% endraw %} diff --git a/source/_components/sensor.gitter.markdown b/source/_components/sensor.gitter.markdown index 72f3c4b7dc..a114887f97 100644 --- a/source/_components/sensor.gitter.markdown +++ b/source/_components/sensor.gitter.markdown @@ -15,27 +15,19 @@ ha_release: 0.47 This `gitter` sensor allows one to monitor a [Gitter.im](https://gitter.im) chatroom for unread messages. -## {% linkable_title Configuration %} - Visit [Gitter Developer Apps](https://developer.gitter.im/apps) to retrieve your "Personal Access Token". To use a Gitter sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: gitter api_key: YOUR_API_TOKEN ``` -{% configuration %} -api_key: - description: Your Gitter.im API token. - required: true - type: string -room: - description: Gitter room to monitor. - required: false - type: string - default: home-assistant/home-assistant -{% endconfiguration %} +Configuration variables: + +- **api_key** (*Required*): Your Gitter.im API token. +- **room** (*Optional*): Gitter room to monitor. Defaults to `home-assistant/home-assistant` + diff --git a/source/_components/sensor.modbus.markdown b/source/_components/sensor.modbus.markdown index 5868888488..a94d711fda 100644 --- a/source/_components/sensor.modbus.markdown +++ b/source/_components/sensor.modbus.markdown @@ -16,12 +16,10 @@ ha_iot_class: "Local Push" The `modbus` sensor allows you to gather data from [Modbus](http://www.modbus.org/) registers. -## {% linkable_title Configuration %} - To use your Modbus sensors in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: platform: modbus registers: diff --git a/source/_components/sensor.mqtt.markdown b/source/_components/sensor.mqtt.markdown index 0b44200064..b6e5c4b0d2 100644 --- a/source/_components/sensor.mqtt.markdown +++ b/source/_components/sensor.mqtt.markdown @@ -16,12 +16,10 @@ ha_iot_class: depends This `mqtt` sensor platform uses the MQTT message payload as the sensor value. If messages in this `state_topic` are published with *RETAIN* flag, the sensor will receive an instant update with last known value. Otherwise, the initial state will be undefined. -## {% linkable_title Configuration %} - To use your MQTT sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: mqtt state_topic: "home/bedroom/temperature" @@ -99,17 +97,17 @@ In this section you find some real life examples of how to use this sensor. ### {% linkable_title JSON attributes configuration %} -The example sensor below shows a configuration example which uses JSON in the state topic to add extra attributes. It also makes use of the availability topic. Attributes can then be extracted in [Templates](/docs/configuration/templating/#attributes). For example, to extract the `ClientName` attribute from the sensor below, use a template similar to: {% raw %}`{{ state_attr('sensor.bs_rssi', 'ClientName') }}`{% endraw %}. +The example sensor below shows a configuration example which uses JSON in the state topic to add extra attributes. It also makes use of the availability topic. Attributes can then be extracted in [Templates](configuration/templating/#attributes); Example to extract data from the sensor below {% raw %}'{{ states.sensor.bs_client_name.attributes.ClientName }}'{% endraw %}. {% raw %} ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: mqtt - name: "BS RSSI" state_topic: "HUISHS/BunnyShed/NodeHealthJSON" - unit_of_measurement: 'dBm' - value_template: "{{ value_json.RSSI }}" + name: "BS RSSI" + unit_of_measurement: "dBm" + value_template: '{{ value_json.RSSI }}' availability_topic: "HUISHS/BunnyShed/status" payload_available: "online" payload_not_available: "offline" @@ -125,7 +123,7 @@ sensor: ### {% linkable_title Get battery level %} -If you are using the [OwnTracks](/components/device_tracker.owntracks/) and enable the reporting of the battery level then you can use a MQTT sensor to keep track of your battery. A regular MQTT message from OwnTracks looks like this: +If you are using the [Owntracks](/components/device_tracker.owntracks/) and enable the reporting of the battery level then you can use a MQTT sensor to keep track of your battery. A regular MQTT message from Owntracks looks like this: ```bash owntracks/tablet/tablet {"_type":"location","lon":7.21,"t":"u","batt":92,"tst":144995643,"tid":"ta","acc":27,"lat":46.12} @@ -135,13 +133,13 @@ Thus the trick is extracting the battery level from the payload. {% raw %} ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: mqtt - name: "Battery Tablet" state_topic: "owntracks/tablet/tablet" - unit_of_measurement: '%' - value_template: "{{ value_json.batt }}" + name: "Battery Tablet" + unit_of_measurement: "%" + value_template: '{{ value_json.batt }}' ``` {% endraw %} @@ -161,18 +159,18 @@ Then use this configuration example to extract the data from the payload: {% raw %} ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: mqtt - name: "Temperature" - state_topic: "office/sensor1" + state_topic: 'office/sensor1' + name: 'Temperature' unit_of_measurement: '°C' - value_template: "{{ value_json.temperature }}" + value_template: '{{ value_json.temperature }}' - platform: mqtt - name: "Humidity" - state_topic: "office/sensor1" + state_topic: 'office/sensor1' + name: 'Humidity' unit_of_measurement: '%' - value_template: "{{ value_json.humidity }}" + value_template: '{{ value_json.humidity }}' ``` {% endraw %} @@ -197,10 +195,10 @@ The configuration will look like the example below: {% raw %} ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: mqtt - name: "Brightness" - state_topic: "home/bathroom/analog/brightness" + state_topic: 'home/bathroom/analog/brightness' + name: Brightness ``` {% endraw %} diff --git a/source/_components/sensor.mqtt_room.markdown b/source/_components/sensor.mqtt_room.markdown index 96aaa9dc7d..598dafefb1 100644 --- a/source/_components/sensor.mqtt_room.markdown +++ b/source/_components/sensor.mqtt_room.markdown @@ -16,8 +16,6 @@ ha_iot_class: depends The `mqtt_room` sensor platform allows you to detect the indoor location of devices using MQTT clients. -## {% linkable_title Configuration %} - To use this device tracker in your installation, add the following to your `configuration.yaml` file: ```yaml diff --git a/source/_components/sensor.mvglive.markdown b/source/_components/sensor.mvglive.markdown index 7d613d8598..16ee5f4a5e 100644 --- a/source/_components/sensor.mvglive.markdown +++ b/source/_components/sensor.mvglive.markdown @@ -16,8 +16,6 @@ ha_iot_class: "Cloud Polling" The `mvglive` sensor will give you the departure time of the next bus, tram, subway, or train at the next station or stop in the Munich public transport network. Additional details such as the line number and destination are present in the attributes. -## {% linkable_title Configuration %} - To enable this sensor, add the following lines to your `configuration.yaml` file: ```yaml @@ -44,7 +42,7 @@ Configuration variables: The example below shows a full configuration with three sensors that showcase the various configuration options. ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: mvglive nextdeparture: diff --git a/source/_components/sensor.openevse.markdown b/source/_components/sensor.openevse.markdown index e9df04e8da..04568f0459 100644 --- a/source/_components/sensor.openevse.markdown +++ b/source/_components/sensor.openevse.markdown @@ -16,12 +16,10 @@ ha_iot_class: "Local Polling" This `openevse` sensor platform pulls data from an [OpenEVSE](https://www.openevse.com/) Charging station equipped with an ESP8266-based wifi connection. -## {% linkable_title Configuration %} - To enable this sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: openevse host: IP_ADDRESS diff --git a/source/_components/sensor.pilight.markdown b/source/_components/sensor.pilight.markdown index 2a33cc2a1d..cae336b6d8 100644 --- a/source/_components/sensor.pilight.markdown +++ b/source/_components/sensor.pilight.markdown @@ -16,12 +16,10 @@ ha_iot_class: depends This `pilight` sensor platform for 433 MHz devices uses a value in the message payload as the sensor value. Unique identifiers (e.g., _uuid_) can be set to distinguish between multiple pilight devices. To use a pilight sensor the pilight Home Assistant hub has to be set up. -## {% linkable_title Configuration %} - To use your sensor via pilight, make sure it is [supported](https://wiki.pilight.org/doku.php/protocols) and add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: pilight variable: temperature diff --git a/source/_components/sensor.qnap.markdown b/source/_components/sensor.qnap.markdown index 3814f37bd0..66dd99404b 100644 --- a/source/_components/sensor.qnap.markdown +++ b/source/_components/sensor.qnap.markdown @@ -16,12 +16,10 @@ ha_iot_class: "Local Polling" This `qnap` sensor allows getting various statistics from your [QNAP NAS](https://www.qnap.com/en-us/). -## {% linkable_title Configuration %} - To use the `qnap` sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: qnap host: IP_ADDRESS_OF_QNAP_NAS diff --git a/source/_components/sensor.radarr.markdown b/source/_components/sensor.radarr.markdown index 94a4665548..42294c8628 100644 --- a/source/_components/sensor.radarr.markdown +++ b/source/_components/sensor.radarr.markdown @@ -15,12 +15,10 @@ ha_release: 0.47 This `radarr` sensor platform pulls data from a given [Radarr](https://radarr.video/) instance. -## {% linkable_title Configuration %} - To use your Radarr sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: radarr api_key: YOUR_API_KEY diff --git a/source/_components/sensor.sonarr.markdown b/source/_components/sensor.sonarr.markdown index 13a4944fea..0257c70b55 100644 --- a/source/_components/sensor.sonarr.markdown +++ b/source/_components/sensor.sonarr.markdown @@ -16,12 +16,10 @@ ha_iot_class: "Local Polling" This `sonarr` sensor platform pulls data from a given [Sonarr](https://sonarr.tv/) instance. -## {% linkable_title Configuration %} - To use your Sonarr sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: sonarr api_key: YOUR_API_KEY diff --git a/source/_components/sensor.synologydsm.markdown b/source/_components/sensor.synologydsm.markdown index 0b4b4ba197..d9f4dddf51 100644 --- a/source/_components/sensor.synologydsm.markdown +++ b/source/_components/sensor.synologydsm.markdown @@ -16,12 +16,10 @@ ha_iot_class: "Local Polling" The `synologydsm` sensor platform allows getting various statistics from your [Synology NAS](https://www.synology.com). -## {% linkable_title Configuration %} - To use the `synologydsm` sensor in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry sensor: - platform: synologydsm host: IP_ADDRESS_OF_SYNOLOGY_NAS @@ -35,7 +33,7 @@ sensor: Configuration variables: -- **host** (*Required*): The IP address of the Synology NAS to monitor. +- **host** (*Required*): The IP address of the Synology NAS to monitor - **port** (*Optional*): The port number on which the Synology NAS is reachable. Defaults to `5000`. - **username** (*Required*): An user to connect to the Synology NAS (a separate account is advised, see the Separate User Configuration section below for details). - **password** (*Required*): The password of the user to connect to the Synology NAS. diff --git a/source/_components/sensor.waze_travel_time.markdown b/source/_components/sensor.waze_travel_time.markdown index db3e3f0418..2440930b9f 100644 --- a/source/_components/sensor.waze_travel_time.markdown +++ b/source/_components/sensor.waze_travel_time.markdown @@ -48,12 +48,4 @@ name: required: false default: "Waze Travel Time" type: string -incl_filter: - description: A substring that has to be present in the description of the selected route (a simple case-insensitive matching). - required: false - type: string -excl_filter: - description: A substring that has to be NOT present in the description of the selected route (a simple case-insensitive matching). - required: false - type: string {% endconfiguration %} diff --git a/source/_components/switch.fritzdect.markdown b/source/_components/switch.fritzdect.markdown index 380deebdaf..cceeffaef3 100644 --- a/source/_components/switch.fritzdect.markdown +++ b/source/_components/switch.fritzdect.markdown @@ -35,21 +35,11 @@ switch: password: YOUR_PASSWORD ``` -{% configuration %} -username: - description: The username for your Fritz!Box. - required: true - type: string -password: - description: The password for your Fritz!Box. - required: true - type: string -host: - description: The IP address/hostname of your Fritz!Box. - required: false - type: string - default: fritz.box -{% endconfiguration %} +Configuration variables: + +- **username** (*Required*): The username for your Fritz!Box. +- **password** (*Required*): The password for your Fritz!Box. +- **host** (*Optional*): The IP address/hostname of your Fritz!Box. Defaults to `fritz.box`. It is recommended to create a dedicated user for Home Assistant and only allow access to "Smart Home". diff --git a/source/_components/switch.mochad.markdown b/source/_components/switch.mochad.markdown index a1d7569ec1..5ffbdb3bf2 100644 --- a/source/_components/switch.mochad.markdown +++ b/source/_components/switch.mochad.markdown @@ -14,12 +14,10 @@ ha_release: 0.32 The `mochad` switch platform lets you control an X10 enabled switch device. -## {% linkable_title Configuration %} - To enable this sensor, you first have to set up the [mochad component](/components/mochad/) and then add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry switch: - platform: mochad devices: @@ -33,5 +31,3 @@ Configuration variables: - **name** (*Optional*): The name of the switch. Default is: x10_switch_dev_*address*. - **comm_type** (*Optional*): pl (powerline) or rf (radio frequency). Default is pl. - - diff --git a/source/_components/switch.modbus.markdown b/source/_components/switch.modbus.markdown index 3bf176c125..201e7b5daa 100644 --- a/source/_components/switch.modbus.markdown +++ b/source/_components/switch.modbus.markdown @@ -16,12 +16,10 @@ ha_iot_class: "Local Push" The `modbus` switch platform allows you to control [Modbus](http://www.modbus.org/) coils or registers. -## {% linkable_title Configuration %} - To use your Modbus switches in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry switch: platform: modbus slave: 1 diff --git a/source/_components/switch.mqtt.markdown b/source/_components/switch.mqtt.markdown index 295ae106db..d440902e7e 100644 --- a/source/_components/switch.mqtt.markdown +++ b/source/_components/switch.mqtt.markdown @@ -15,8 +15,6 @@ ha_iot_class: depends The `mqtt` switch platform lets you control your MQTT enabled switches. -## {% linkable_title Configuration %} - In an ideal scenario, the MQTT device will have a `state_topic` to publish state changes. If these messages are published with a `RETAIN` flag, the MQTT switch will receive an instant state update after subscription, and will start with the correct state. Otherwise, the initial state of the switch will be `false` / `off`. When a `state_topic` is not available, the switch will work in optimistic mode. In this mode, the switch will immediately change state after every command. Otherwise, the switch will wait for state confirmation from the device (message from `state_topic`). @@ -26,7 +24,7 @@ Optimistic mode can be forced, even if the `state_topic` is available. Try to en To enable this switch in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry switch: - platform: mqtt command_topic: "home/bedroom/switch1/set" @@ -108,7 +106,7 @@ In this section you will find some real life examples of how to use this sensor. The example below shows a full configuration for a switch. ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry switch: - platform: mqtt name: "Bedroom Switch" @@ -142,7 +140,7 @@ The configuration will look like the example below: {% raw %} ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry switch: - platform: mqtt name: bathroom diff --git a/source/_components/switch.pilight.markdown b/source/_components/switch.pilight.markdown index ca2c837986..ffeeb1a947 100644 --- a/source/_components/switch.pilight.markdown +++ b/source/_components/switch.pilight.markdown @@ -19,8 +19,6 @@ Additionally, RF commands can be defined that trigger this switch to turn on and To be really sure that Home Assistant knows the actual state of your device it is recommended to use the RF remote with codes unknown to any of your 433 MHz devices. Thus you use the remote to trigger this switch to send the correct RF code to the device. -## {% linkable_title Configuration %} - To define a Pilight switch, add the following lines to your `configuration.yaml`: ```yaml diff --git a/source/_components/switch.wake_on_lan.markdown b/source/_components/switch.wake_on_lan.markdown index 161cfcd1b5..f30f120134 100644 --- a/source/_components/switch.wake_on_lan.markdown +++ b/source/_components/switch.wake_on_lan.markdown @@ -15,8 +15,6 @@ ha_iot_class: "Local Polling" The `wake_on_lan` (WOL) switch platform allows you to turn on a [WOL](https://en.wikipedia.org/wiki/Wake-on-LAN) enabled computer. -## {% linkable_title Configuration %} -
The WOL switch can only turn on your computer and monitor the state. There is no universal way to turn off a computer remotely. The `turn_off` variable is there to help you call a script when you have figured out how to remotely turn off your computer. See below for suggestions on how to do this. @@ -25,7 +23,7 @@ See below for suggestions on how to do this. To enable this switch in your installation, add the following to your `configuration.yaml` file: ```yaml -# Example configuration.yaml entry +# Example configuration.yml entry switch: - platform: wake_on_lan mac_address: "00-01-02-03-04-05" @@ -44,8 +42,7 @@ Configuration variables: Here are some real life examples of how to use the **turn_off** variable. ### {% linkable_title Suspending Linux %} - -Suggested recipe for letting the `turn_off` script suspend a Linux computer (the **target**) +Suggested recipe for letting the turn_off script suspend a Linux computer (the **target**) from Home Assistant running on another Linux computer (the **server**). 1. On the **server**, log in as the user account Home Assistant is running under. (I'm using `hass` in this example) diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 9fa8cbe3da..c8f9f7c872 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -127,7 +127,7 @@ The following table shows the units of measurement for each attribute:
As per [python-miio issue 185](https://github.com/rytilahti/python-miio/issues/185) the Mi-Home app no longer stores the token within the database (it's retrieved from Xiaomi servers from version 5.0.31+). Currently the only known fix is to uninstall, then install a downgraded version of the apk. Apkmirror is a trusted source for older versions of the app. [Mi-Home version 5.0.0](https://www.apkmirror.com/apk/xiaomi-inc/mihome/mihome-5-0-0-release/) is confirmed as working for the following Android methods. -This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum, Mi Robot 2 (Roborock) Vacuum, Xiaomi Philips Lights and Xiaomi IR Remote. The Xiaomi Gateway uses another security method and requires a `key` (16 alphanumeric chars), which can be obtained +This token (32 hexadecimal characters) is required for the Xiaomi Mi Robot Vacuum, Xiaomi Philips Lights and Xiaomi IR Remote. The Xiaomi Gateway uses another security method and requires a `key` (16 alphanumeric chars), which can be obtained easily via a hidden menu item at the Mi-Home app or using the `miio` command line tool.
@@ -203,7 +203,7 @@ To fetch the token follow these instructions depending on your mobile phone plat 6. Download the 'ADB Backup Extractor' from [here](https://sourceforge.net/projects/adbextractor/files/latest/download) 7. Extract the data from the backup: `java -jar Android\ Backup\ Utilities/Android\ Backup\ Extractor/android-backup-extractor-20171005-bin/abe.jar unpack backup.ab unpacked.tar` (enter the password, if prompted) 8. Untar the unpacked data: `tar -xvf unpacked.tar` -9. `sqlite3 apps/com.xiaomi.smarthome/db/miio2.db 'select token from devicerecord where name like "%Vacuum%";'` returns the token for your Xiaomi vacuum bot. +9. `sqlite3 apps/com.xiaomi.smarthome/db/miio2.db 'select token from devicerecord where name = "Mi Robot Vacuum";'` returns the token for your Xiaomi vacuum bot. #### {% linkable_title Linux and Android (rooted!) %} @@ -245,7 +245,7 @@ To fetch the token follow these instructions depending on your mobile phone plat 8. Install [DB Browser for SQLite](http://sqlitebrowser.org/). 9. Open DB Browser and load the `.sqlite` file you saved from your backup. 10. Click on the `Execute SQL` tab. -11. Input and run this query: `SELECT ZTOKEN FROM ZDEVICE WHERE ZNAME LIKE "%Vacuum%"` +11. Input and run this query: `SELECT ZTOKEN FROM ZDEVICE WHERE ZNAME = "Mi Robot Vacuum"` 12. Copy the returned 32-digit hexadecimal string to your clipboard. 13. Open `Terminal` and execute this command: `echo '0: