-Please note, the `daikin` platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant. BRP069A42 does not support setting of fan speed or fan swing mode. -
- -The platform has been integrated with discovery so all your Daikin AC's climate devices can be automatically discovered. +## {% linkable_title Configuration %} To enable the platform, add the following lines to your `configuration.yaml` file: diff --git a/source/_components/cover.mqtt.markdown b/source/_components/cover.mqtt.markdown old mode 100755 new mode 100644 diff --git a/source/_components/daikin.markdown b/source/_components/daikin.markdown index 84624b5af04..d4b25765958 100644 --- a/source/_components/daikin.markdown +++ b/source/_components/daikin.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: daikin.png -ha_category: Hub +ha_category: Climate ha_release: 0.59 ha_iot_class: "Local Polling" --- @@ -16,11 +16,15 @@ ha_iot_class: "Local Polling" The `daikin` component integrates Daikin air conditioning systems into Home Assistant. -To automatically add all your Daikin devices (ACs and associated sensors) into your Home Assistant installation, add the following to your 'configuration.yaml' file: +## {% linkable_title Supported hardware %} --Please note, the Daikin platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant. -
+**Only** the european versions of Daikin ACs (models BRP069A41, 42, 43, 45). + +The model BRP069A42 does not support setting of fan speed or fan swing mode. + +Please note that some AC devices may report outside temperature only when they are turned on. + +## {% linkable_title Configuration %} To automatically add all your Daikin devices (ACs and associated sensors) into your Home Assistant installation, add the following to your `configuration.yaml` file: @@ -52,7 +56,3 @@ monitored_conditions: description: The current temperature measured outside the house. {% endconfiguration %} --Please note that some AC devices may report outside temperature only when they are turned on. -
- 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/eufy.markdown b/source/_components/eufy.markdown index 60ec2a470dd..e2c00424fd5 100644 --- a/source/_components/eufy.markdown +++ b/source/_components/eufy.markdown @@ -38,17 +38,21 @@ eufy: name: Smart Switch ``` -access_token can be obtained by running: +`access_token can be obtained by running: -``` -curl -H "Content-Type: application/json" -d '{"client_id":"eufyhome-app", "client_Secret":"GQCpr9dSp3uQpsOMgJ4xQ", "email":"USERNAME", "password":"PASSWORD"}' https://home-api.eufylife.com/v1/user/email/login | jq +```bash +$ curl -H "Content-Type: application/json" \ + -d '{"client_id":"eufyhome-app", "client_Secret":"GQCpr9dSp3uQpsOMgJ4xQ", "email":"USERNAME", "password":"PASSWORD"}' \ + https://home-api.eufylife.com/v1/user/email/login \ + | jq ``` -replacing USERNAME and PASSWORD with the Eufy username and password. This will give an access_token. Then run: +replacing USERNAME and PASSWORD with the Eufy username and password. This will give an `access_token`. Then run: -``` -curl -H token:TOKEN -H category:Home https://home-api.eufylife.com/v1/device/list/devices-and-groups | jq +```bash +$ curl -H token:TOKEN -H category:Home \ + https://home-api.eufylife.com/v1/device/list/devices-and-groups | jq ``` -replacing TOKEN with the access_token from the previous command. This will provide the local_code for each device. +replacing TOKEN with the `access_token` from the previous command. This will provide the local_code for each device. diff --git a/source/_components/knx.markdown b/source/_components/knx.markdown index 89e9a0c4129..802b288f4c2 100644 --- a/source/_components/knx.markdown +++ b/source/_components/knx.markdown @@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant: - [Notify](/components/notify.knx) - [Scene](/components/scene.knx) -### {% linkable_title Configuration %} +## {% linkable_title Configuration %} To use your KNX in your installation, add the following lines to your `configuration.yaml` file: @@ -77,8 +77,8 @@ knx: ```yaml knx: - fire_event: True - fire_event_filter: ["1/0/*", "6/2,3,4-6/*"] + fire_event: True + fire_event_filter: ["1/0/*", "6/2,3,4-6/*"] ``` - **fire_event** (*Optional*): If set to True, platform will write all received KNX messages to event bus @@ -105,21 +105,20 @@ KNX component is able to expose time or sensor values to KNX bus. The component ```yaml # Example configuration.yaml entry knx: - expose: - - type: 'temperature' - entity_id: 'sensor.owm_temperature' - address: '0/0/2' - - type: 'time' - address: '0/0/1' - - type: 'datetime' - address: '0/0/23' + expose: + - type: 'temperature' + entity_id: 'sensor.owm_temperature' + address: '0/0/2' + - type: 'time' + address: '0/0/1' + - type: 'datetime' + address: '0/0/23' ``` * **type**: Type of the exposed value. Either time or datetime or any supported type of [KNX Sensor](/components/sensor.knx/) (e.g., "temperature" or "humidity"). * **entity_id**: Entity id of the HASS component to be exposed. Not necessary for types time and datetime. * **address**: KNX group address. - ### {% linkable_title Known issues %} Due to lame multicast support the routing abstraction and the gateway scanner only work with Python >=3.5. 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/light.knx.markdown b/source/_components/light.knx.markdown index 5587f134ecc..4a229b62586 100644 --- a/source/_components/light.knx.markdown +++ b/source/_components/light.knx.markdown @@ -18,6 +18,8 @@ The `knx` light component is used as in interface to switching/light actuators. The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + To use your KNX light in your installation, add the following lines to your `configuration.yaml` file: ```yaml @@ -31,12 +33,14 @@ light: Configuration variables: +- **address** (*Required*): KNX group address for switching the light on and off. - **name** (*Optional*): A name for this device used within Home Assistant. -- **address**: KNX group address for switching the light on and off. - **brightness_address** (Optional): KNX group address for dimming light. - **state_address** (*Optional*): separate KNX group address for retrieving the switch state of the light. - **brightness_state_address** (*Optional*): separate KNX group address for retrieving the dimmed state of the light. - **color_address** (*Optional*): separate KNX group address for setting the color of the light. +- **color_state_address** (*Optional*): separate KNX group address for retrieving the color of the light. Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. For switching/light actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address. + diff --git a/source/_components/light.template.markdown b/source/_components/light.template.markdown old mode 100755 new mode 100644 diff --git a/source/_components/lock.bmw_connected_drive.markdown b/source/_components/lock.bmw_connected_drive.markdown old mode 100755 new mode 100644 diff --git a/source/_components/map.markdown b/source/_components/map.markdown old mode 100755 new mode 100644 diff --git a/source/_components/microsoft_face.markdown b/source/_components/microsoft_face.markdown index d7d8cdc7ed0..2d9cb4318f4 100644 --- a/source/_components/microsoft_face.markdown +++ b/source/_components/microsoft_face.markdown @@ -8,14 +8,18 @@ comments: false sharing: true footer: true logo: microsoft.png -ha_category: Hub +ha_category: Image Processing ha_release: "0.37" --- The `microsoft_face` component platform is the main component for Microsoft Azure Cognitive service [Face](https://www.microsoft.com/cognitive-services/en-us/face-api). All data are stored in your own private instance in the Azure cloud. +## {% linkable_title Setup %} + You need an API key, which is free, but requires an [Azure registration](https://azure.microsoft.com/de-de/free/) using your Microsoft ID. The free resource (*F0*) is limited to 20 requests per minute and 30k requests in a month. If you don't want to use the Azure cloud, you can also get an API key by registering with [cognitive-services](https://www.microsoft.com/cognitive-services/en-us/subscriptions). Please note that all keys on cognitive services must be recreated every 90 days. +## {% linkable_title Configuration %} + To enable the Microsoft Face component, add the following to your `configuration.yaml`: ```yaml diff --git a/source/_components/notify.knx.markdown b/source/_components/notify.knx.markdown index 78945fc3761..4e81f1e2362 100644 --- a/source/_components/notify.knx.markdown +++ b/source/_components/notify.knx.markdown @@ -17,6 +17,8 @@ The `knx` notify platform allows you to send notifications to [KNX](http://www.k The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + To use your KNX switch in your installation, add the following lines to your `configuration.yaml` file: ```yaml @@ -26,5 +28,8 @@ notify: address: '5/1/10' ``` +Configuration variables: + +* **address** (*Required*): KNX group address of the notification. * **name** (*Optional*): A name for this device used within Home Assistant. -* **address**: KNX group address of the notification + 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/remote.harmony.markdown b/source/_components/remote.harmony.markdown old mode 100755 new mode 100644 diff --git a/source/_components/remote.itach.markdown b/source/_components/remote.itach.markdown old mode 100755 new mode 100644 diff --git a/source/_components/remote.markdown b/source/_components/remote.markdown old mode 100755 new mode 100644 diff --git a/source/_components/scene.knx.markdown b/source/_components/scene.knx.markdown index e77b6571811..c9752de20c3 100644 --- a/source/_components/scene.knx.markdown +++ b/source/_components/scene.knx.markdown @@ -16,6 +16,10 @@ The `knx` scenes platform allows you to trigger [KNX](http://www.knx.org) scenes The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + +To use your KNX scence in your installation, add the following to your `configuration.yaml` file: + ```yaml # Example configuration.yaml entry scene: @@ -27,8 +31,7 @@ scene: Configuration variables: +- **address** (*Required*): KNX group address of the binary sensor. +- **scene_number** (*Required*): KNX scene number to be activated. - **name** (*Optional*): A name for this device used within Home Assistant. -- **address**: KNX group address of the binary sensor. -- **scene_number** KNX scene number to be activated. - diff --git a/source/_components/sensor.bloomsky.markdown b/source/_components/sensor.bloomsky.markdown index 61b850de1e1..d2e1ca31a50 100644 --- a/source/_components/sensor.bloomsky.markdown +++ b/source/_components/sensor.bloomsky.markdown @@ -16,6 +16,8 @@ ha_iot_class: "Cloud Polling" The `bloomsky` sensor component allows you to view the measurements made by sensors in the [BloomSky](https://www.bloomsky.com) weather station. This can work in concert with the [BloomSky camera](/components/camera.bloomsky). +## {% linkable_title Configuration %} + To enable these sensors in your installation, set up the [BloomSky component](/components/bloomsky) with your API key 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.daikin.markdown b/source/_components/sensor.daikin.markdown index 250da44a727..5d9ba959592 100644 --- a/source/_components/sensor.daikin.markdown +++ b/source/_components/sensor.daikin.markdown @@ -16,12 +16,8 @@ ha_iot_class: "Local Polling" The `daikin` sensor platform integrates Daikin air conditioning systems into Home Assistant, enabling displaying the following parameters: -- **inside temperature** -- **outside temperature** - --Please note, the `daikin` platform integrates **ONLY the european versions of Daikin ACs (models BRP069A41, 42, 43, 45)** into Home Assistant. -
+- Inside temperature +- Outside temperature ## {% linkable_title Configuration %} @@ -54,6 +50,3 @@ monitored_conditions: description: The current temperature measured outside the house. {% endconfiguration %} -- Please note that some AC devices may report outside temperature only when they are turned on. -
diff --git a/source/_components/sensor.knx.markdown b/source/_components/sensor.knx.markdown index f7e78920229..6e0921c341a 100644 --- a/source/_components/sensor.knx.markdown +++ b/source/_components/sensor.knx.markdown @@ -17,8 +17,26 @@ The `knx` sensor platform allows you to monitor [KNX](http://www.knx.org) sensor The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + To use your KNX sensor in your installation, add the following lines to your `configuration.yaml` file: +```yaml +# Example configuration.yaml entry +sensor: + - platform: knx + name: Heating.Valve1 + address: '2/0/0' +``` + + + +- **address** (*Required*): KNX group address of the sensor. +- **name** (*Optional*): A name for this device used within Home Assistant. +- **type** (*Optional*): "percent", "temperature", "humidity", "illuminance", "brightness", "speed_ms", "current", "power", "electric_current", "electric_potential", "energy", "frequency", "heatflowrate", "phaseanglerad", "phaseangledeg", "powerfactor" or "speed". + +## {% linkable_title Full example %} + ```yaml # Example configuration.yaml entry sensor: @@ -31,8 +49,3 @@ sensor: address: '6/2/1' type: 'temperature' ``` - -- **name** (*Optional*): A name for this device used within Home Assistant. -- **address**: KNX group address of the sensor. -- **type** (Optional): "percent", "temperature", "humidity", "illuminance", "brightness", "speed_ms", "current", "power", "electric_current", "electric_potential", "energy", "frequency", "heatflowrate", "phaseanglerad", "phaseangledeg", "powerfactor" or "speed". - diff --git a/source/_components/sensor.miflora.markdown b/source/_components/sensor.miflora.markdown index 85ad3cd03b5..92d2a4ea4fd 100644 --- a/source/_components/sensor.miflora.markdown +++ b/source/_components/sensor.miflora.markdown @@ -8,7 +8,7 @@ comments: false sharing: true footer: true logo: miflora.png -ha_category: DIY +ha_category: Environment ha_release: 0.29 ha_iot_class: "Local Polling" --- 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.digitalloggers.markdown b/source/_components/switch.digitalloggers.markdown old mode 100755 new mode 100644 diff --git a/source/_components/switch.knx.markdown b/source/_components/switch.knx.markdown index dbddf761518..92c04b6e4c2 100644 --- a/source/_components/switch.knx.markdown +++ b/source/_components/switch.knx.markdown @@ -18,6 +18,8 @@ The `knx` switch component is used as in interface to switching actuators. The `knx` component must be configured correctly, see [KNX Component](/components/knx). +## {% linkable_title Configuration %} + To use your KNX switch in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -26,12 +28,13 @@ switch: name: Kitchen.Coffee address: '1/1/6' ``` + +Configuration variables: + +* **address** (*Required*): KNX group address for switching the switch on/off. * **name** (*Optional*): A name for this device used within Home Assistant. -* **address**: KNX group address for switching the switch on/off -* **state_address**: (*Optional*) separate KNX group address for retrieving the switch state. +* **state_address** (*Optional*): separate KNX group address for retrieving the switch state. Some KNX devices can change their state internally without any messages on the KNX bus, e.g., if you configure a timer on a channel. The optional `state_address` can be used to inform Home Assistant about these state changes. If a KNX message is seen on the bus addressed to the given state address, this will overwrite the state of the switch object. For switching actuators that are only controlled by a single group address and can't change their state internally, you don't have to configure the state address. - - 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/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 3adcbc43c45..5864b32bffb 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -48,7 +48,7 @@ Configuration variables: ## {% linkable_title Platform Services %} -In addition to all of the services provided by the `vacuum` component (`start`, `pause`, `stop`, `return_to_home`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi` platform introduces specific services to access the remote control mode of the robot. These are: +In addition to all of the services provided by the `vacuum` component (`start`, `pause`, `stop`, `return_to_base`, `locate`, `set_fan_speed` and `send_command`), the `xiaomi` platform introduces specific services to access the remote control mode of the robot. These are: - `xiaomi_remote_control_start` - `xiaomi_remote_control_stop` 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 --- diff --git a/source/_docs/authentication/providers.markdown b/source/_docs/authentication/providers.markdown index b672beb0967..728ecb58b2d 100644 --- a/source/_docs/authentication/providers.markdown +++ b/source/_docs/authentication/providers.markdown @@ -27,7 +27,7 @@ To make the transition from API password to authentication system easier, we've ## {% linkable_title Configuring auth providers %}-By configuring your own instead of using the default configuration, you take full responsibility for the authentication of the system. +Home Assistant automatically configures the standard auth providers and you **do not** need to specify `auth_providers` in your `configuration.yaml` file. Specifying `auth_providers` in your configuration will disable all auth providers that are not listed and can reduce your security or create difficulties logging in.
Authentication providers are configured in your `configuration.yaml` under the `homeassistant:` block: diff --git a/source/_docs/autostart/systemd.markdown b/source/_docs/autostart/systemd.markdown index 17211e5ed9d..6b43b19c2e1 100644 --- a/source/_docs/autostart/systemd.markdown +++ b/source/_docs/autostart/systemd.markdown @@ -78,7 +78,7 @@ ExecStopPost=/usr/bin/docker rm -f home-assistant-%i WantedBy=multi-user.target ``` -### Next Steps +### {% linkable_title Next Steps %} You need to reload `systemd` to make the daemon aware of the new configuration. diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown index a3dc6cc91a3..8de3aa169e0 100644 --- a/source/_docs/configuration/customizing-devices.markdown +++ b/source/_docs/configuration/customizing-devices.markdown @@ -10,8 +10,86 @@ footer: true redirect_from: /getting-started/customizing-devices/ --- +## {% linkable_title Changing the entity_id %} + +You can use the UI to change the `entity_id` and friendly name of supported entities. To do this: + +1. Select the entity, either from or from the frontend, or by clicking
next to the entity in the dev-states menu
+2. Click on the cog in the right corner of the entity's dialog
+3. Enter the new name or the new entity ID (remember not to change the domain of the entity - the part before the `.`)
+4. Select *Save*
+
+## {% linkable_title Customizing entities %}
+
By default, all of your devices will be visible and have a default icon determined by their domain. You can customize the look and feel of your front page by altering some of these parameters. This can be done by overriding attributes of specific entities.
+### {% linkable_title Customization using the UI %}
+
+Under the *Configuration* menu you'll find the *Customization* menu. When you select an entity to customize, you'll see all the existing attributes listed and you can customize those, or select an additional supported attribute ([see below](/docs/configuration/customizing-devices/#possible-values)).
+
+#### {% linkable_title Possible values %}
+
+{% configuration customize %}
+friendly_name:
+ description: Name of the entity as displayed in the UI.
+ required: false
+ type: string
+homebridge_name:
+ description: Name of the entity in `HomeBridge`.
+ required: false
+ type: string
+hidden:
+ description: Set to `true` to hide the entity.
+ required: false
+ type: boolean
+ default: False
+homebridge_hidden:
+ description: Set to `true` to hide the entity from `HomeBridge`.
+ required: false
+ type: boolean
+ default: False
+emulated_hue_hidden:
+ description: Set to `true` to hide the entity from `emulated_hue` (this will be deprecated in the near future and should be configured in [`emulated_hue`](/components/emulated_hue)).
+ required: false
+ type: boolean
+ default: False
+entity_picture:
+ description: URL to use as picture for entity.
+ required: false
+ type: string
+icon:
+ description: Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com) ([Cheatsheet](https://materialdesignicons.com/cheatsheet)). Prefix name with `mdi:`, ie `mdi:home`.
+ required: false
+ type: string
+assumed_state:
+ description: For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon.
+ required: false
+ type: boolean
+ default: True
+device_class:
+ description: Sets the class of the device, changing the device state and icon that is displayed on the UI (see below).
+ required: false
+ type: boolean
+initial_state:
+ description: Sets the initial state for automations, `on` or `off`.
+ required: false
+ type: string
+unit_of_measurement:
+ description: Defines the units of measurement, if any.
+ required: false
+ type: string
+{% endconfiguration %}
+
+#### {% linkable_title Device Class %}
+
+Device class is currently supported by the following components:
+
+* [Binary Sensor](/components/binary_sensor/)
+* [Sensor](/components/sensor/)
+* [Cover](/components/cover/)
+
+### {% linkable_title Manual customization %}
+
If you implement `customize`, `customize_domain`, or `customize_glob` you must make sure it is done inside of `homeassistant:` or it will fail.
@@ -53,30 +131,6 @@ homeassistant: homebridge_hidden: true ``` -### {% linkable_title Possible values %} - -| Attribute | Description | -| --------- | ----------- | -| `friendly_name` | Name of the entity. -| `homebridge_name` | Name of the entity in `HomeBridge`. -| `hidden` | Set to `true` to hide the entity. -| `homebridge_hidden` | Set to `true` to hide the entity from `HomeBridge`. -| `emulated_hue_hidden` | Set to `true` to hide the entity from `emulated_hue` (this will be deprecated in the near future and should be configured in [`emulated_hue`](/components/emulated_hue)). -| `entity_picture` | Url to use as picture for entity. -| `icon` | Any icon from [MaterialDesignIcons.com](http://MaterialDesignIcons.com) ([Cheatsheet](https://materialdesignicons.com/cheatsheet)). Prefix name with `mdi:`, ie `mdi:home`. -| `assumed_state` | For switches with an assumed state two buttons are shown (turn off, turn on) instead of a switch. By setting `assumed_state` to `false` you will get the default switch icon. -| `device_class` | Sets the class of the device, changing the device state and icon that is displayed on the UI (see below). -| `initial_state` | Sets the initial state for automations. `on` or `off`. -| `unit_of_measurement` | Defines the units of measurement, if any. - -### {% linkable_title Device Class %} - -Device class is currently supported by the following components: - -* [Binary Sensor](/components/binary_sensor/) -* [Sensor](/components/sensor/) -* [Cover](/components/cover/) - ### {% linkable_title Reloading customize %} Home Assistant offers a service to reload the core configuration while Home Assistant is running called `homeassistant.reload_core_config`. This allows you to change your customize section and see it being applied without having to restart Home Assistant. To call this service, go to the
service developer tools, select the service `homeassistant.reload_core_config` and click "CALL SERVICE".
@@ -84,4 +138,3 @@ Home Assistant offers a service to reload the core configuration while Home Assi
New customize information will be applied the next time the state of the entity gets updated.
- diff --git a/source/_docs/configuration/securing.markdown b/source/_docs/configuration/securing.markdown index 4ed3e20243e..664acbe217b 100644 --- a/source/_docs/configuration/securing.markdown +++ b/source/_docs/configuration/securing.markdown @@ -14,7 +14,7 @@ One major advantage of Home Assistant is that it's not dependent on cloud servic ### {% linkable_title Checklist %} -- [Protect your web interface with a password](/getting-started/basic/#password-protecting-the-web-interface) +- [Choose a strong password](/docs/authentication/). - Secure your host. Sources could be [Red Hat Enterprise Linux 7 Security Guide](https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/pdf/Security_Guide/Red_Hat_Enterprise_Linux-7-Security_Guide-en-US.pdf), [CIS Red Hat Enterprise Linux 7 Benchmark](https://benchmarks.cisecurity.org/tools2/linux/CIS_Red_Hat_Enterprise_Linux_7_Benchmark_v1.0.0.pdf), or the [Securing Debian Manual](https://www.debian.org/doc/manuals/securing-debian-howto/index.en.html). - Restrict network access to your devices. Set `PermitRootLogin no` in your sshd config (usually `/etc/ssh/sshd_config`) and to use SSH keys for authentication instead of passwords. - Don't run Home Assistant as root – consider the Principle of Least Privilege. diff --git a/source/_docs/installation/python.markdown b/source/_docs/installation/python.markdown index a7dda882e25..7f8c01ad421 100644 --- a/source/_docs/installation/python.markdown +++ b/source/_docs/installation/python.markdown @@ -10,6 +10,10 @@ footer: true redirect_from: /getting-started/installation-python/ --- ++If you're running a Linux-based platform, we strongly recommend you follow the instructions for a [virtual environment](/docs/installation/virtualenv/) instead. If you're running on Windows then [see here](/docs/installation/windows/#installing-in-a-python-virtual-environment) instead. +
+ Once Python is installed, execute the following code in a console: ```bash @@ -22,12 +26,10 @@ Running these commands will: - Install Home Assistant - Launch Home Assistant and serve the web interface on [http://localhost:8123](http://localhost:8123) -If you're running a Linux-based platform, we suggest you follow the instructions for a [virtual environment](/docs/installation/virtualenv/) to avoid using `root`. - Video tutorials of this process for various operating systems are available here: - [Windows 10](https://www.youtube.com/watch?v=X27eVvuqwnY) - [macOS](https://www.youtube.com/watch?v=hej6ipN86ls) - [Ubuntu 14.04](https://www.youtube.com/watch?v=SXaAG1lGNH0) -Keep in mind that the used operating systems and the shown software releases may be outdated. +Keep in mind that the operating systems used and the software releases shown may be outdated. diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown index fdaac560c3c..128b122649b 100644 --- a/source/_docs/z-wave/controllers.markdown +++ b/source/_docs/z-wave/controllers.markdown @@ -24,6 +24,7 @@ You need to have a [supported Z-Wave USB stick or module](https://github.com/Ope | Sigma Designs UZB Stick | | | | | Tricklestar | | | | | Vision USB Stick | | | | +| ZWave.me Razberry Board | ✓ | | | | ZWave.me UZB1 | ✓ | | |diff --git a/source/_lovelace/weather-forecast.markdown b/source/_lovelace/weather-forecast.markdown index b92588bd2c2..c636319db9a 100644 --- a/source/_lovelace/weather-forecast.markdown +++ b/source/_lovelace/weather-forecast.markdown @@ -34,3 +34,9 @@ entity: - type: weather-forecast entity: weather.demo_weather_north ``` + +
+ This card works only with platforms that define a `weather` entity. + + E.g., it works with [Dark Sky](https://www.home-assistant.io/components/weather.darksky/) but not [Dark Sky Sensor](https://www.home-assistant.io/components/sensor.darksky/) +
diff --git a/source/_posts/2018-08-29-release-77.markdown b/source/_posts/2018-08-29-release-77.markdown index 84b3c8906d6..d57d9910198 100644 --- a/source/_posts/2018-08-29-release-77.markdown +++ b/source/_posts/2018-08-29-release-77.markdown @@ -81,6 +81,18 @@ You didn't think we would forget about Lovelace, did you? This release include a [light.lifx docs]: /components/light.lifx/ [wemo docs]: /components/wemo/ +## {% linkable_title Release 0.77.3 - September 3 %} + +Frontend changes only: + +- Ask "save login" after hass connected [PR](https://github.com/home-assistant/home-assistant-polymer/pull/1631) [@awarecan] +- Show an error when invalid client id or redirect uri [PR](https://github.com/home-assistant/home-assistant-polymer/pull/1620) [@balloob] +- Disable autocapitalization of username field [PR](https://github.com/home-assistant/home-assistant-polymer/pull/1627) [@timmo001] +- Upgrade MDI icons [PR](https://github.com/home-assistant/home-assistant-polymer/pull/1630) [@balloob] +- Update translations + +[@timmo001]: https://github.com/timmo001 + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. diff --git a/source/cloud/alexa.markdown b/source/cloud/alexa.markdown index 7e140825afd..8e90a4d8eef 100644 --- a/source/cloud/alexa.markdown +++ b/source/cloud/alexa.markdown @@ -10,13 +10,13 @@ footer: true redirect_from: /components/cloud.alexa/ --- -The Alexa integration allows users to control the entities via the [Home Assistant Smart Home skill for Alexa][alexa skill]. This means that you can say things like "Alexa, turn on the kitchen light" to control your local Home Assistant. +The Alexa integration allows users to control the entities via the Home Assistant Smart Home skill for Alexa. This means that you can say things like "Alexa, turn on the kitchen light" to control your local Home Assistant. To use this integration, you need to have: - The cloud component set up. [Learn more](/components/cloud/) - An Alexa enabled device like the Amazon Echo - - Activated the [Home Assistant Smart Home skill for Alexa][alexa skill] + - Activated the Home Assistant Smart Home skill via the Alexa app You can use `configuration.yaml` to configure the entities that are being shown to Alexa and how they are exposed. @@ -110,5 +110,3 @@ Currently, the following domains are available to be used with Alexa: - scene - script (enables/disables) - switch - -[alexa skill]: https://alexa.amazon.com/spa/index.html#skills/dp/B0772J1QKB/?ref=skill_dsk_skb_sr_2 diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 88aac017cc6..1b17327d575 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -77,14 +77,14 @@ A detailed guide about running Hass.io as a virtual machine is available in the [etcher]: https://etcher.io/ [Virtual Appliance]: https://github.com/home-assistant/hassos/blob/dev/Documentation/boards/ova.md [hassos-network]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md -[pi0-w]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi0-w-2.2.img.gz -[pi1]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi-2.2.img.gz -[pi2]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi2-2.2.img.gz -[pi3-32]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi3-2.2.img.gz -[pi3-64]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_rpi3-64-2.2.img.gz +[pi0-w]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi0-w-1.10.img.gz +[pi1]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi-1.10.img.gz +[pi2]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi2-1.10.img.gz +[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi3-1.10.img.gz +[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_rpi3-64-1.10.img.gz [tinker]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_tinker-2.2.img.gz [odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_odroid-c2-2.2.img.gz -[vmdk]: https://github.com/home-assistant/hassos/releases/download/2.2/hassos_ova-2.2.vmdk.gz +[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.10/hassos_ova-1.10.vmdk.gz [linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio [local]: http://hassio.local:8123 [samba]: /addons/samba/ diff --git a/source/images/frontend/entity_box.png b/source/images/frontend/entity_box.png new file mode 100644 index 00000000000..8336a978d98 Binary files /dev/null and b/source/images/frontend/entity_box.png differ