-If for whatever reason you delete and re-create your ecobee app at ecobee.com such that your developer API key changes, you will need to delete your `/conf/ecobee.conf file`. You will also need to update the `api_key:` in the `configuration.yaml` or `secrets.yaml` file.
+If for whatever reason you delete and re-create your ecobee app at ecobee.com such that your developer API key changes, you will need to delete your `/conf/ecobee.conf file`. You will also need to update the `api_key:` in the `configuration.yaml` or `secrets.yaml` file.
diff --git a/source/_components/fan.xiaomi_miio.markdown b/source/_components/fan.xiaomi_miio.markdown
index 8fc9da321122..e6e1408e27a7 100644
--- a/source/_components/fan.xiaomi_miio.markdown
+++ b/source/_components/fan.xiaomi_miio.markdown
@@ -19,13 +19,13 @@ The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier and
### Air Purifier 2 et al.
-* Power (on, off)
-* Operation modes (auto, silent, favorite, idle)
-* Buzzer (on, off)
-* Child lock (on, off)
-* LED (on, off), LED brightness (bright, dim, off)
-* Favorite Level (0...16)
-* Attributes
+- Power (on, off)
+- Operation modes (auto, silent, favorite, idle)
+- Buzzer (on, off)
+- Child lock (on, off)
+- LED (on, off), LED brightness (bright, dim, off)
+- Favorite Level (0...16)
+- Attributes
- model
- temperature
- humidity
@@ -53,12 +53,12 @@ The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier and
### Air Purifier Pro (zhimi.airpurifier.v6)
-* Power (on, off)
-* Operation modes (auto, silent, favorite)
-* Child lock (on, off)
-* LED (on, off)
-* Favorite Level (0...16)
-* Attributes
+- Power (on, off)
+- Operation modes (auto, silent, favorite)
+- Child lock (on, off)
+- LED (on, off)
+- Favorite Level (0...16)
+- Attributes
- model
- temperature
- humidity
@@ -89,11 +89,11 @@ The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier and
### Air Purifier V3 (zhimi.airpurifier.v3)
-* Power (on, off)
-* Operation modes (auto, silent, favorite, idle, medium, high, strong)
-* Child lock (on, off)
-* LED (on, off)
-* Attributes
+- Power (on, off)
+- Operation modes (auto, silent, favorite, idle, medium, high, strong)
+- Child lock (on, off)
+- LED (on, off)
+- Attributes
- model
- aqi
- mode
@@ -121,13 +121,13 @@ The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier and
### Air Humidifier (zhimi.humidifier.v1)
-* On, Off
-* Operation modes (silent, medium, high)
-* Buzzer (on, off)
-* Child lock (on, off)
-* LED brightness (bright, dim, off)
-* Target humidity (30, 40, 50, 60, 70, 80)
-* Attributes
+- On, Off
+- Operation modes (silent, medium, high)
+- Buzzer (on, off)
+- Child lock (on, off)
+- LED brightness (bright, dim, off)
+- Target humidity (30, 40, 50, 60, 70, 80)
+- Attributes
- model
- temperature
- humidity
@@ -143,14 +143,14 @@ The `xiaomi_miio` fan platform allows you to control the Xiaomi Air Purifier and
### Air Humidifier CA (zhimi.humidifier.ca1)
-* On, Off
-* Operation modes (silent, medium, high, auto)
-* Buzzer (on, off)
-* Child lock (on, off)
-* LED brightness (bright, dim, off)
-* Target humidity (30, 40, 50, 60, 70, 80)
-* Dry mode (on, off)
-* Attributes
+- On, Off
+- Operation modes (silent, medium, high, auto)
+- Buzzer (on, off)
+- Child lock (on, off)
+- LED brightness (bright, dim, off)
+- Target humidity (30, 40, 50, 60, 70, 80)
+- Dry mode (on, off)
+- Attributes
- model
- temperature
- humidity
diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown
index 4ef25974b996..495dcf2283e9 100644
--- a/source/_components/homematic.markdown
+++ b/source/_components/homematic.markdown
@@ -131,8 +131,8 @@ The values of variables are polled from the CCU/Homegear in an interval of 30 se
When HomeMatic devices change their state or some other internal value, the CCU/Homegear sends event messages to Home Assistant. These events are automatically parsed and the entities in Home Assistant are updated. However, you can also manually use these events to trigger automations. Two event-types are available:
-* **homematic.keypress**: For devices with buttons, see information below
-* **homematic.impulse**: For impulse sensors
+- **homematic.keypress**: For devices with buttons, see information below
+- **homematic.impulse**: For impulse sensors
#### {% linkable_title Devices with buttons %}
@@ -171,13 +171,15 @@ It may happen that "your_nice_name" is not resolved correctly; the according mes
### {% linkable_title Services %}
-* *homematic.virtualkey*: Simulate a keypress (or other valid action) on CCU/Homegear with device or virtual keys.
-* *homematic.reconnect*: Reconnect to CCU/Homegear without restarting Home Assistant (useful when CCU has been restarted)
-* *homematic.set_variable_value*: Set the value of a system variable.
-* *homematic.set_device_value*: Control a device manually (even devices without support). Equivalent to setValue-method from XML-RPC.
+- *homematic.virtualkey*: Simulate a keypress (or other valid action) on CCU/Homegear with device or virtual keys.
+- *homematic.reconnect*: Reconnect to CCU/Homegear without restarting Home Assistant (useful when CCU has been restarted)
+- *homematic.set_variable_value*: Set the value of a system variable.
+- *homematic.set_device_value*: Control a device manually (even devices without support). Equivalent to setValue-method from XML-RPC.
#### {% linkable_title Examples %}
-Simulate a button being pressed
+
+Simulate a button being pressed:
+
```yaml
...
action:
@@ -188,7 +190,8 @@ action:
param: PRESS_LONG
```
-Open KeyMatic
+Open KeyMatic:
+
```yaml
...
action:
@@ -199,7 +202,8 @@ action:
param: OPEN
```
-Set boolean variable to true
+Set boolean variable to true:
+
```yaml
...
action:
@@ -215,7 +219,8 @@ action:
If you are familiar with the internals of HomeMatic devices, you can manually set values on the devices. This can serve as a workaround if support for a device is currently not available, or only limited functionality has been implemented.
Using this service provides you direct access to the setValue-method of the primary connection. If you have multiple hosts, you may select the one hosting a specific device by providing the proxy-parameter with a value equivalent to the name you have chosen. In the example configuration from above `rf`, `wired` and `ip` would be valid values.
-Manually turn on a switch actor
+Manually turn on a switch actor:
+
```yaml
...
action:
@@ -227,7 +232,8 @@ action:
value: true
```
-Manually set temperature on thermostat
+Manually set temperature on thermostat:
+
```yaml
...
action:
@@ -239,7 +245,8 @@ action:
value: 23.0
```
-Manually set lock on KeyMatic devices
+Manually set lock on KeyMatic devices:
+
```yaml
...
action:
@@ -247,7 +254,8 @@ action:
entity_id: lock.leq1234567
```
-Manually set unlock on KeyMatic devices
+Manually set unlock on KeyMatic devices:
+
```yaml
...
action:
@@ -259,7 +267,7 @@ action:
When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant will stop getting updates from devices. This may happen after rebooting the CCU for example. Due to the nature of the communication protocol this cannot be handled automatically, so you must call *homematic.reconnect* in this case. That's why it is usually a good idea to check if your HomeMatic components are still updated properly, in order to detect connection losses. This can be done in several ways through an automation:
-* If you have a sensor which you know will be updated frequently (e.g. an outdoor temperature sensor or light sensor) you could set up an automation like this:
+- If you have a sensor which you know will be updated frequently (e.g. an outdoor temperature sensor or light sensor) you could set up an automation like this:
```yaml
automation:
@@ -273,7 +281,8 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi
# Reconnect, if sensor has not been updated for over 3 hours
service: homematic.reconnect
```
-* If you have a CCU you can also create a system variable on the CCU, which stores it's last reboot time. Since Home Assistant can still refresh system variables from the CCU (even after a reboot), this is a pretty reliable way to detect situations where you need to call *homematic.reconnect*. This is how this can be done:
+
+- If you have a CCU you can also create a system variable on the CCU, which stores it's last reboot time. Since Home Assistant can still refresh system variables from the CCU (even after a reboot), this is a pretty reliable way to detect situations where you need to call *homematic.reconnect*. This is how this can be done:
1. Create a string variable **V_Last_Reboot** on the CCU
@@ -309,4 +318,3 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi
action:
service: homematic.reconnect
```
-
diff --git a/source/_components/homematicip_cloud.markdown b/source/_components/homematicip_cloud.markdown
index 19134916b4fb..70f90d77af99 100644
--- a/source/_components/homematicip_cloud.markdown
+++ b/source/_components/homematicip_cloud.markdown
@@ -7,8 +7,9 @@ sidebar: true
comments: false
sharing: true
footer: true
+logo: homematicip_cloud.png
ha_category: Hub
-ha_iot_class: "Cloud Polling"
+ha_iot_class: "Cloud Push"
ha_release: 0.66
featured: false
---
diff --git a/source/_components/image_processing.facebox.markdown b/source/_components/image_processing.facebox.markdown
index 480606b6ea1d..ebb9892aad8a 100644
--- a/source/_components/image_processing.facebox.markdown
+++ b/source/_components/image_processing.facebox.markdown
@@ -87,6 +87,47 @@ Use the `image_processing.detect_face` events to trigger automations, and breako
```
{% endraw %}
+## {% linkable_title Service `facebox_teach_face` %}
+
+The service `facebox_teach_face` can be used to teach Facebox faces.
+
+| Service data attribute | Optional | Description |
+| ---------------------- | -------- | ----------- |
+| `entity_id` | no | Entity ID of Facebox entity.
+| `name` | no | The name to associate with a face.
+| `file_path` | no | The path to the image file.
+
+A valid service data example:
+
+{% raw %}
+```yaml
+{
+ "entity_id": "image_processing.facebox_local_file",
+ "name": "superman",
+ "file_path": "/images/superman_1.jpeg"
+}
+```
+{% endraw %}
+
+An `image_processing.teach_classifier` event is fired for each service call, providing feedback on whether teaching has been successful or unsuccessful. In the unsuccessful case, the `message` field of the `event_data` will contain information on the cause of failure, and a warning is also published in the logs. An automation can be used to receive alerts on teaching, for example, the following automation will send a notification with the teaching image and a message describing the status of the teaching:
+
+```yaml
+- id: '11200961111'
+ alias: Send facebox teaching result
+ trigger:
+ platform: event
+ event_type: image_processing.teach_classifier
+ event_data:
+ classifier: facebox
+ action:
+ service: notify.platform
+ data_template:
+ title: Facebox teaching
+ message: Name {{ trigger.event.data.name }} teaching was successful? {{ trigger.event.data.success }}
+ data:
+ file: ' {{trigger.event.data.file_path}} '
+```
+
## {% linkable_title Optimising resources %}
-[Image processing components](https://www.home-assistant.io/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing.
+[Image processing components](https://www.home-assistant.io/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your config `scan_interval: 10000` (setting the interval to 10,000 seconds), and then call the `image_processing.scan` service when you actually want to perform processing.
diff --git a/source/_components/isy994.markdown b/source/_components/isy994.markdown
index 211917fe5672..1c8331782156 100644
--- a/source/_components/isy994.markdown
+++ b/source/_components/isy994.markdown
@@ -29,6 +29,7 @@ isy994:
username: ISY_USERNAME
password: ISY_PASSWORD
```
+
Configuration variables:
- **host** (*Required*): The host entry should be in full URL format, eg. http://192.168.10.100:80
@@ -69,15 +70,15 @@ automation:
All `isy994_control` events will have an `entity_id` and `control` parameter in its `event_data`. You'll need to refer to ISY994 documentation for the list of every possible control type, but the common ones are:
-- `DON`: On button
-- `DOF`: Off button
-- `DFON`: "Fast On", usually from double-tapping an On button
-- `DFOF`: "Fast Off", usually from double-tapping an Off button
-- `FDUP`: "Fade Up", usually while holding down an On button
-- `FDDOWN`: "Fade Down", usually while holding down an Off button
-- `FDSTOP`: "Fade Stop", when releasing a long-held button
-- `BRT`: "Brighten", from controllers that issue a single command to slightly brighten a light
-- `DIM`: "Dim", from controllers that issue a single command to slightly dim a light
+- `DON`: On button.
+- `DOF`: Off button.
+- `DFON`: "Fast On", usually from double-tapping an On button.
+- `DFOF`: "Fast Off", usually from double-tapping an Off button.
+- `FDUP`: "Fade Up", usually while holding down an On button.
+- `FDDOWN`: "Fade Down", usually while holding down an Off button.
+- `FDSTOP`: "Fade Stop", when releasing a long-held button.
+- `BRT`: "Brighten", from controllers that issue a single command to slightly brighten a light.
+- `DIM`: "Dim", from controllers that issue a single command to slightly dim a light.
### {% linkable_title Insteon Scenes %}
@@ -87,7 +88,7 @@ All Insteon scenes configured in the ISY994 will show up as switches in Home Ass
Using the Programs tab in the controller's Administrative Console, custom devices can be created that will appear natively inside of Home Assistant. Home Assistant will scan the following folders and build the device to the associated domains:
-```
+```text
My Programs
├── HA.binary_sensor
| ├── Movement In House
@@ -125,11 +126,12 @@ My Programs
```
A device is created by creating a directory, with the name for the device, under any of the following root directories:
- * *HA.binary_sensor* will create a binary sensor (see [Customizing Devices](/getting-started/customizing-devices/) to set the sensor class)
- * *HA.cover* will create a cover
- * *HA.fan* will create a fan
- * *HA.lock* will create a lock
- * *HA.switch* will create a switch
+
+- *HA.binary_sensor* will create a binary sensor (see [Customizing Devices](/getting-started/customizing-devices/) to set the sensor class).
+- *HA.cover* will create a cover.
+- *HA.fan* will create a fan.
+- *HA.lock* will create a lock.
+- *HA.switch* will create a switch.
A program, named *status*, is required under the program device directory. A program, named *actions*, is required for all program devices except for binary_sensor. Any other programs in these device directories will be ignored. The *status* program requires that you create a variable with the name of your choice. This variable will store the actual status of the new device and will be updated by the *action* program.
@@ -138,21 +140,23 @@ A program, named *status*, is required under the program device directory. A pro
The *status* program in this directory is what indicates the state of the device:
- * *binary_sensor* on if the clause returns true, otherwise off
- * *cover* closed if the clause returns true, otherwise open
- * *fan* on if the clause returns true, otherwise off
- * *lock* locked if the clause returns true, otherwise unlocked
- * *switch* on if the clause returns true, otherwise off
+
+- *binary_sensor* on if the clause returns true, otherwise off.
+- *cover* closed if the clause returns true, otherwise open.
+- *fan* on if the clause returns true, otherwise off.
+- *lock* locked if the clause returns true, otherwise unlocked.
+- *switch* on if the clause returns true, otherwise off.
diff --git a/source/_components/joaoapps_join.markdown b/source/_components/joaoapps_join.markdown
index c0b94b2eb58b..822a14604bad 100644
--- a/source/_components/joaoapps_join.markdown
+++ b/source/_components/joaoapps_join.markdown
@@ -12,7 +12,6 @@ ha_category: Hub
ha_release: "0.24"
---
-
The `joaoapps_join` component exposes services from [Join](http://joaoapps.com/join). In Home Assistant, the Join features are divided up in two locations, the Join component, and the Join notify platform. The notify platform allows us to send messages to Join devices, the component allows us to access the other special features that Join offers.
In the `configuration.yaml` file you need to provide the api key and device id or name of the target device. You can find your device id and api key [here](https://joinjoaomgcd.appspot.com/).
@@ -57,4 +56,3 @@ The services exposed in the `joaoapps_join` component can be used with the servi
| joaoapps_join/send_url | `{"url":"http://google.com"}` |
| joaoapps_join/send_wallpaper | `{"url":"http://www.planwallpaper.com/static/images/ZhGEqAP.jpg"}` |
| joaoapps_join/send_file | `{"url":"http://download.thinkbroadband.com/5MB.zip"}` |
-
diff --git a/source/_components/juicenet.markdown b/source/_components/juicenet.markdown
index 74cc2fdb890d..0ff22b9908e3 100644
--- a/source/_components/juicenet.markdown
+++ b/source/_components/juicenet.markdown
@@ -12,7 +12,6 @@ ha_category: Hub
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 %}
diff --git a/source/_components/keyboard.markdown b/source/_components/keyboard.markdown
index 00dad71931c5..d1324ae76ae2 100644
--- a/source/_components/keyboard.markdown
+++ b/source/_components/keyboard.markdown
@@ -12,15 +12,14 @@ ha_category: Automation
ha_release: pre 0.7
---
-
The `keyboard` component simulates key presses on the host machine. It currently offers the following Buttons as a Service (BaaS):
- * `keyboard/volume_up`
- * `keyboard/volume_down`
- * `keyboard/volume_mute`
- * `keyboard/media_play_pause`
- * `keyboard/media_next_track`
- * `keyboard/media_prev_track`
+- `keyboard/volume_up`
+- `keyboard/volume_down`
+- `keyboard/volume_mute`
+- `keyboard/media_play_pause`
+- `keyboard/media_next_track`
+- `keyboard/media_prev_track`
To load this component, add the following lines to your `configuration.yaml`:
@@ -33,7 +32,7 @@ keyboard:
You may need to install platform-specific [dependencies for PyUserInput](https://github.com/PyUserInput/PyUserInput#dependencies) in order to use the keyboard component. In most cases this can be done by running:
```bash
-$ pip3 install [package name]
+pip3 install [package name]
```
#### {% linkable_title Windows %}
diff --git a/source/_components/keyboard_remote.markdown b/source/_components/keyboard_remote.markdown
index 24efed9a3c28..f94507ac0e23 100644
--- a/source/_components/keyboard_remote.markdown
+++ b/source/_components/keyboard_remote.markdown
@@ -19,7 +19,6 @@ This component allows you to use one or more keyboards as remote controls. It wi
The `evdev` package is used to interface with the keyboard and thus this is Linux only. It also means you can't use your normal keyboard for this because `evdev` will block it.
-
```yaml
# Example configuration.yaml entry
keyboard_remote:
@@ -47,7 +46,7 @@ keyboard_remote:
type: 'key_up'
```
-or like the following for one keyboard:
+Or like the following for one keyboard:
```yaml
keyboard_remote:
@@ -70,15 +69,18 @@ automation:
service: light.turn_on
entity_id: light.all
```
+
`device_descriptor` or `device_name` may be specificed in the trigger so the automation will be fired only for that keyboard. This is especially useful if you wish to use several bluetooth remotes to control different devices. Omit them to ensure the same key triggers the automation for all keyboards/remotes.
## {% linkable_title Disconnections %}
+
This component manages disconnections and re-connections of the keyboard, for example in the case of a Bluetooth device that turns off automatically to preserve battery.
If the keyboard disconnects, the component will fire an event `keyboard_remote_disconnected`.
When the keyboard reconnects, an event `keyboard_remote_connected` will be fired.
Here's an automation example that plays a sound through a media player whenever the keyboard connects/disconnects:
+
```yaml
automation:
- alias: Keyboard Connected
@@ -104,13 +106,14 @@ automation:
```
## {% linkable_title Permissions %}
+
There might be permissions problems with the event input device file. If this is the case, the user that Home Assistant runs as must be allowed read and write permissions with:
```bash
-$ sudo setfacl -m u:HASS_USER:rw /dev/input/event*
+sudo setfacl -m u:HASS_USER:rw /dev/input/event*
```
-where `HASS_USER` is the user who runs Home Assistant.
+Where `HASS_USER` is the user who runs Home Assistant.
If you want to make this permanent, you can use a udev rule that sets it for all event input devices. Add a file `/etc/udev/rules.d/99-userdev-input.rules` containing:
@@ -118,8 +121,8 @@ If you want to make this permanent, you can use a udev rule that sets it for all
KERNEL=="event*", SUBSYSTEM=="input", RUN+="/usr/bin/setfacl -m u:HASS_USER:rw $env{DEVNAME}"
```
-You can check ACLs permissions with
+You can check ACLs permissions with:
```bash
-$ getfacl /dev/input/event*
+getfacl /dev/input/event*
```
diff --git a/source/_components/kira.markdown b/source/_components/kira.markdown
index b32ae95eac15..0e74ad07b69c 100644
--- a/source/_components/kira.markdown
+++ b/source/_components/kira.markdown
@@ -39,6 +39,7 @@ kira:
```
Configuration variables:
+
- **sensors** (*Optional*): Kira sensors to register
- **name** (*Optional*): Name of this sensor.
- **host** (*Optional*): Bind address for this sensor. 0.0.0.0 is default.
@@ -70,6 +71,7 @@ The first time the Kira component is loaded, `kira_codes.yaml` will be created i
```
Configuration variables:
+
- **name** (*Required*): The name of this code.
- **code** (*Required*): The data for this code (see below).
- **device** (*Optional*): The device this code is associated with. Default is "unknown".
@@ -81,6 +83,7 @@ Some manufacturers (e.g., Samsung) require an IR code to be sent a number of tim
### {% linkable_title Code Types %}
When creating an entry in `kira_codes.yaml`, a few different kinds of codes can be used.
+
- **kira**: This is the native wire protocol used by Kira modules. These can be captured using netcat.
- **pronto**: Pronto codes are supported.
- **nec**: If the device uses NEC IR codes and the manufacturer has published them, they can be used here.
diff --git a/source/_components/konnected.markdown b/source/_components/konnected.markdown
index 8ab60c77e604..4710844aa455 100644
--- a/source/_components/konnected.markdown
+++ b/source/_components/konnected.markdown
@@ -14,7 +14,7 @@ ha_release: "0.70"
The `konnected` component lets you connect wired sensors and switches to a NodeMCU ESP8226 based device running the [open source Konnected software](https://github.com/konnected-io/konnected-security). Reuse the wired sensors and siren from an old or pre-wired alarm system installation and integrate them directly into Home Assistant.
-Visit the [Konnected.io website](https://konnected.io) for more information about the Konnected Alarm Panel board and compatible hardware.
+Visit the [Konnected.io website](https://konnected.io) for more information about the Konnected Alarm Panel board and compatible hardware.
The component currently supports the following device types in Home Assistant:
@@ -45,7 +45,7 @@ konnected:
switches:
- pin: 5
```
-
+
{% configuration %}
access_token:
description: Any random string. This is used to ensure that only those devices which you have configured can authenticate to Home Assistant to change a device state.
@@ -55,7 +55,7 @@ api_host:
description: Override the IP address/host (and port number) of Home Assistant that the Konnected device(s) will use to communicate sensor state updates. If omitted, this is defaulted to the value of `base_url` in the `http` component. If you've set `base_url` to an external hostname, then you'll want to set this value back to your _local_ IP address and port (e.g. `http://192.168.1.101:8123`).
required: false
type: url
- default: value of `base_url`
+ default: value of `base_url`
devices:
description: A list of Konnected devices that you have on your network.
required: true
@@ -71,15 +71,15 @@ devices:
type: list
keys:
pin:
- description: The number corresponding to the _IO index_ of the labeled pin on the NodeMCU dev board. See the [NodeMCU GPIO documentation](https://nodemcu.readthedocs.io/en/master/en/modules/gpio/) for more details. Valid values are 1, 2, 5, 6, 7 and 9.
+ description: The number corresponding to the _IO index_ of the labeled pin on the NodeMCU dev board. See the [NodeMCU GPIO documentation](https://nodemcu.readthedocs.io/en/master/en/modules/gpio/) for more details. Valid values are 1, 2, 5, 6, 7 and 9.
required: exclusive
zone:
description: The number corresponding to the labeled zone on the [Konnected Alarm Panel](https://konnected.io) board. Valid values are 1, 2, 3, 4, 5 and 6.
required: exclusive
type:
description: Any [binary sensor](/components/binary_sensor/) class, typically `door`, `window`, `motion` or `smoke`.
- required: true
- name:
+ required: true
+ name:
description: The name of the device used in the front end.
required: false
default: automatically generated
@@ -89,12 +89,12 @@ devices:
type: list
keys:
pin:
- description: The number corresponding to the _IO index_ of the labeled pin on the NodeMCU dev board. See the [NodeMCU GPIO documentation](https://nodemcu.readthedocs.io/en/master/en/modules/gpio/) for more details. Valid values are 1, 2, 5, 6, 7 and 8.
+ description: The number corresponding to the _IO index_ of the labeled pin on the NodeMCU dev board. See the [NodeMCU GPIO documentation](https://nodemcu.readthedocs.io/en/master/en/modules/gpio/) for more details. Valid values are 1, 2, 5, 6, 7 and 8.
required: exclusive
zone:
description: The number corresponding to the labeled zone on the [Konnected Alarm Panel](https://konnected.io) board or the word `out` to specify the dedicated ALARM/OUT terminal on the Konnected board. Valid values are 1, 2, 3, 4, 5 and out.
required: exclusive
- name:
+ name:
description: The name of the device used in the front end.
required: false
default: automatically generated
@@ -104,7 +104,7 @@ devices:
required: false
{% endconfiguration%}
-#### Configuration Notes
+#### {% linkable_title Configuration Notes %}
- Either **pin** or **zone** is required for each actuator or sensor. Do not use both in the same definition.
- Pin `D8` or the `out` zone will only work when activation is set to high (the default).
@@ -145,12 +145,12 @@ konnected:
Konnected runs on an ESP8266 board with the NodeMCU firmware. It is commonly used with the NodeMCU dev kit WiFi module and optionally Konnected's Alarm Panel hardware. The following table shows the pin mapping between the Konnected hardware labeled zones, the NodeMCU labeled pins and the ESP8266 GPIO pins.
-| Konnected Alarm Panel Zone | NodeMCU pin | IO Index | ESP8266 GPIO |
+| Konnected Alarm Panel Zone | NodeMCU pin | IO Index | ESP8266 GPIO |
|---|---|---|---|
-| 1 | D1 | 1 | GPIO5 |
-| 2 | D2 | 2 | GPIO4 |
+| 1 | D1 | 1 | GPIO5 |
+| 2 | D2 | 2 | GPIO4 |
| 3 | D5 | 5 | GPIO14 |
| 4 | D6 | 6 | GPIO12 |
| 5 | D7 | 7 | GPIO13 |
| 6 | RX | 9 | GPIO3 |
-| ALARM or OUT | D8 | 8 | GPIO15 |
+| ALARM or OUT | D8 | 8 | GPIO15 |
diff --git a/source/_components/light.homematicip_cloud.markdown b/source/_components/light.homematicip_cloud.markdown
index f3c76cf01c84..6ea102daa8dc 100644
--- a/source/_components/light.homematicip_cloud.markdown
+++ b/source/_components/light.homematicip_cloud.markdown
@@ -7,10 +7,10 @@ sidebar: true
comments: false
sharing: true
footer: true
-logo: homematic.png
+logo: homematicip_cloud.png
ha_category: Switch
ha_release: 0.70
-ha_iot_class: "Local Push"
+ha_iot_class: "Cloud Push"
---
The `homematicip_cloud` light platform allows you to control
diff --git a/source/_components/lock.wink.markdown b/source/_components/lock.wink.markdown
index a792e130a8b7..38b37fe9ea0b 100644
--- a/source/_components/lock.wink.markdown
+++ b/source/_components/lock.wink.markdown
@@ -13,13 +13,11 @@ ha_release: 0.9
ha_iot_class: "Cloud Polling"
---
-
The Wink lock platform allows you to control your [Wink](http://www.wink.com/) locks.
The requirement is that you have setup [Wink](/components/wink/).
-
-### Supported lock devices
+### {% linkable_title Supported lock devices %}
- Kwikset
- Schlage
@@ -56,7 +54,7 @@ You can use the service wink/wink_set_lock_alarm_sensitivity to set the alarm se
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
-| `sensitivity` | no | String one of low, medium_low, medium, medium_high, high
+| `sensitivity` | no | String one of low, medium_low, medium, medium_high, high.
| `entity_id` | yes | String or list of strings that point at `entity_id`s of locks.
Example:
@@ -140,7 +138,6 @@ You can use the service wink/wink_add_new_lock_key_code to add a new user code t
| `name` | no | the name of the new key code
| `code` | no | The new code. Must match length of existing codes.
-
Calling service wink/pull_newly_added_wink_devices will add the new key code to Home Assistant. The device will also show up on the next restart of Home Assistant.
diff --git a/source/_components/notify.mastodon.markdown b/source/_components/notify.mastodon.markdown index 2e8327f4c26f..65bdc1e38a48 100644 --- a/source/_components/notify.mastodon.markdown +++ b/source/_components/notify.mastodon.markdown @@ -12,7 +12,6 @@ ha_category: Notifications ha_release: 0.67 --- - The `mastodon` platform uses [MAstodon](https://joinmastodon.org/) to delivery notifications from Home Assistant. Go to **Preferences** in the Mastodon web interface, then to **Development** and create a new application. diff --git a/source/_components/rachio.markdown b/source/_components/rachio.markdown index f50050f514c6..b27edc4017d8 100644 --- a/source/_components/rachio.markdown +++ b/source/_components/rachio.markdown @@ -30,6 +30,8 @@ rachio: api_key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ``` +Follow the instructions on [Rachio Binary Sensor](/components/binary_sensor.rachio/) or [Rachio Switch](/components/switch.rachio/) to add Rachio platforms. + ### {% linkable_title iFrame %} If you would like to see and control more detailed zone information, create an [iFrame](/components/panel_iframe/) that renders the Rachio web app. diff --git a/source/_components/sensor.arlo.markdown b/source/_components/sensor.arlo.markdown index 983388afd041..86f2870fbae8 100644 --- a/source/_components/sensor.arlo.markdown +++ b/source/_components/sensor.arlo.markdown @@ -33,6 +33,20 @@ sensor: - signal_strength ``` +Additionally, for Arlo Baby cameras that have additional sensors, you can add them to the `monitored_conditions` collection: + +```yaml +# Additional sensors available for Arlo Baby cameras +sensor: + - platform: arlo + monitored_conditions: + # ... + - temperature + - humidity + - air_quality +``` + + Configuration variables: - **monitored_conditions** array (*Optional*): Conditions to display in the frontend. The following conditions can be monitored. @@ -41,5 +55,8 @@ Configuration variables: - **total_cameras**: Return the number of recognized and active cameras linked on your Arlo account. - **battery_level**: Return the battery level of your Arlo camera. - **signal_strength**: Return the wireless signal strength of your Arlo camera. + - **temperature**: Return the ambient temperature detected by your Arlo Baby camera. + - **humidity**: Return the ambient relative humidity detected by your Arlo Baby camera. + - **air_quality**: Return the ambient air quality (a reading of volatile organic compounds (VOCs) in parts per million) detected by your Arlo Baby camera. If no **monitored_conditions** are specified, all of above will be enabled by default. diff --git a/source/_components/sensor.efergy.markdown b/source/_components/sensor.efergy.markdown index 7a57d281fb0c..3ffd7d36d778 100644 --- a/source/_components/sensor.efergy.markdown +++ b/source/_components/sensor.efergy.markdown @@ -13,7 +13,6 @@ ha_release: pre 0.7 ha_iot_class: "Cloud Polling" --- - Integrate your [Efergy](https://efergy.com) meter information into Home Assistant. ## {% linkable_title Setup %} @@ -49,15 +48,13 @@ sensor: Configuration variables: - **app_token** (*Required*): The App Token for your account. -- **utc_offset** (*Required*): Some variables (currently only the daily_cost) require that the -negative number of minutes your timezone is ahead/behind UTC time. +- **utc_offset** (*Required*): Some variables (currently only the daily_cost) require that the negative number of minutes your timezone is ahead/behind UTC time. - **monitored_variables** array (*Required*): Variables to monitor. - **type** (*Required*): Name of the variable. - - **instant_readings**: Instant energy consumption. - - **budget**: Monthly budget. - - **cost**: The cost for energy consumption (with the tariff that has been set in Efergy) over a given period. - - **amount**: The amount of energy consumed over a given period. - - **current_values**: This returns the current energy usage of each device on your account, as `efergy_\
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.
pip install lxml; be patient this will take a while.
+
To use the Fritz!Box network monitor in your installation, add the following to your `configuration.yaml` file:
diff --git a/source/_components/sensor.homematicip_cloud.markdown b/source/_components/sensor.homematicip_cloud.markdown
index 7903bc55de0a..0f91b4aa20dd 100644
--- a/source/_components/sensor.homematicip_cloud.markdown
+++ b/source/_components/sensor.homematicip_cloud.markdown
@@ -7,10 +7,10 @@ sidebar: true
comments: false
sharing: true
footer: true
-logo: homematic.png
+logo: homematicip_cloud.png
ha_category: Sensor
ha_release: 0.66
-ha_iot_class: "Local Push"
+ha_iot_class: "Cloud Push"
---
The `homematicip_cloud` sensor platform allows you to control
diff --git a/source/_components/sensor.kwb.markdown b/source/_components/sensor.kwb.markdown
index 8c93feb4dd33..e47d36488f01 100644
--- a/source/_components/sensor.kwb.markdown
+++ b/source/_components/sensor.kwb.markdown
@@ -20,6 +20,7 @@ Direct connection via serial (RS485) or via telnet terminal server is supported.
Since this serial protocol is proprietary and closed, only most temperature sensors and a few control relays are supported, the rest is still WIP (see https://www.mikrocontroller.net/topic/274137).
Direct connection via serial port:
+
```yaml
# Example configuration.yaml entry
- platform: kwb
@@ -30,6 +31,7 @@ Direct connection via serial port:
```
Telnet terminal server with a serial-ethernet converter:
+
```yaml
# Example configuration.yaml entry
- platform: kwb
diff --git a/source/_components/sensor.loopenergy.markdown b/source/_components/sensor.loopenergy.markdown
index a2709b48797f..b3369c6fc520 100644
--- a/source/_components/sensor.loopenergy.markdown
+++ b/source/_components/sensor.loopenergy.markdown
@@ -14,7 +14,6 @@ ha_iot_class: "Cloud Push"
redirect_from: /components/sensor.loop_energy/
---
-
Integrate your [Loop Energy](https://www.your-loop.com/) meter information into Home Assistant. To use this sensor you need the client serial number and secret keys for your devices.
The library used to get the data isn't officially supported and the only way to get the keys is to log into loop energy's website and type a command into your browser console.
diff --git a/source/_components/sensor.pyload.markdown b/source/_components/sensor.pyload.markdown
index 0c5886b63773..4bfd7edf02f4 100644
--- a/source/_components/sensor.pyload.markdown
+++ b/source/_components/sensor.pyload.markdown
@@ -13,7 +13,6 @@ ha_release: 0.58
ha_iot_class: "Local Polling"
---
-
The `pyload` platform allows you to monitor your downloads with [pyLoad](https://pyload.net/) from within Home Assistant and setup automation based on the information.
To enable this sensor, add the following lines to your `configuration.yaml`:
@@ -55,10 +54,8 @@ ssl:
default: false
{% endconfiguration %}
-
If everything is setup correctly, the download speed will show up in the frontend.
@@ -26,7 +25,6 @@ Train departure sensors require three character long `origin` and `destination` To add a single train departure sensor add the following to your `configuration.yaml` file: - ```yaml # Example configuration.yaml entry for a single sensor sensor: @@ -69,17 +67,15 @@ A large amount of information about upcoming departures is available within the next_trains_platform: friendly_name: 'Next train platform' value_template: {% raw %}'{{states.sensor.next_train_to_wat.attributes.next_trains[0].platform}}'{% endraw %} - ``` Bus sensors require as their `origin` a bus stop ATCO code which can be found by browsing OpenStreetMap data as follows: -1. On [OpenStreetMap.org](http://www.openstreetmap.org/) zoom right in on a bus -stop you're interested in -2. Click the layers picker button on the right hand side -3. Tick the 'map data' layer, and wait for clickable objects to load -4. Click the bus stop node to reveal its tags on the left +1. On [OpenStreetMap.org](http://www.openstreetmap.org/) zoom right in on a bus stop you're interested in. +2. Click the layers picker button on the right hand side. +3. Tick the 'map data' layer, and wait for clickable objects to load. +4. Click the bus stop node to reveal its tags on the left. The `destination` must be a valid location in the "direction" field returned by a GET query to `/uk/bus/stop/{atcocode}/live.json` as described in the [API reference webpage](https://developer.transportapi.com/docs?raml=https://transportapi.com/v3/raml/transportapi.raml##bus_information). A bus sensor is added in the following `configuration.yaml` file entry: @@ -116,7 +112,6 @@ And the template sensor for viewing the next bus attributes. next_bus_estimated: friendly_name: 'Next bus estimated' value_template: {% raw %}'{{states.sensor.next_bus_to_wantage.attributes.next_buses[0].estimated}}'{% endraw %} - ``` Powered by [transportAPI](http://www.transportapi.com/) diff --git a/source/_components/sensor.wsdot.markdown b/source/_components/sensor.wsdot.markdown index 3b2e163398ca..268fd900b4fc 100644 --- a/source/_components/sensor.wsdot.markdown +++ b/source/_components/sensor.wsdot.markdown @@ -15,8 +15,7 @@ ha_release: 0.37 The `wsdot` sensor will give you travel time information from the [Washington State Department of Transportation (WSDOT)](http://wsdot.com/). -First, you need to get a free Traveler Information `api_key` from the [WSDOT API webpage](http://wsdot.com/traffic/api/). Just enter your email address to instantly get the key. - +First, you need to get a free Traveler Information `api_key` from the [WSDOT API webpage](http://wsdot.com/traffic/api/). Just enter your email address to instantly get the key. Once you have the code, create `wsdot` sensors by editing your `configuration.yaml` file as follows: @@ -38,11 +37,11 @@ Configuration variables: - **id** (*Required*): Name of the route. - **name** (*Optional*): Name of the route. Default just uses `id`. -Figuring out which Travel Time ID (`id`) is associated with your routes is a bit of a challenge. If you visit `http://wsdot.com/Traffic/api/TravelTimes/TravelTimesREST.svc/GetTravelTimesAsJson?AccessCode=[your_api_key_here]` substituting your `api_key`, you will get a list of all available routes. Search through it and then find the key `TravelTimeID`. That tells you the number you need. +Figuring out which Travel Time ID (`id`) is associated with your routes is a bit of a challenge. If you visit `http://wsdot.com/Traffic/api/TravelTimes/TravelTimesREST.svc/GetTravelTimesAsJson?AccessCode=[your_api_key_here]` substituting your `api_key`, you will get a list of all available routes. Search through it and then find the key `TravelTimeID`. That tells you the number you need. Some common examples include: -``` +```text 73 Issaquah-Seattle (WB PM) 74 Seattle-Issaquah (EB AM) 75 HOV Issaquah-Seattle (WB REV) @@ -78,4 +77,3 @@ Here's an example of the sensor in use:
@@ -119,8 +118,7 @@ in the `_1h_` part of the sensor name with `1` to `36`. e.g., `weather_24h` will ### {% linkable_title Additional examples %} -#### Daily forecast - +#### {% linkable_title Daily forecast %} ```yaml sensor: @@ -152,8 +150,7 @@ group:  -#### Weather overview - +#### {% linkable_title Weather overview %} ```yaml sensor: @@ -190,13 +187,12 @@ group:  -
Note: While the platform is called “wunderground” the sensors will show up in Home Assistant as “PWS” (eg: sensor.pws_weather).
Note that the Weather Underground sensor is added to the entity_registry, so second and subsequent Personal Weather Station ID (pws_id) will have their monitored conditions suffixed with an index number e.g. - - sensor.pws_weather_1d_metric_2 +- sensor.pws_weather_1d_metric_2 Additional details about the API are available [here](https://www.wunderground.com/weather/api/d/docs). diff --git a/source/_components/sensor.xiaomi_miio.markdown b/source/_components/sensor.xiaomi_miio.markdown index 65d1f3780fd1..d67aa622baf6 100644 --- a/source/_components/sensor.xiaomi_miio.markdown +++ b/source/_components/sensor.xiaomi_miio.markdown @@ -17,8 +17,8 @@ The `xiaomi_miio` sensor platform is observing your Xiaomi Mi Air Quality Monito Currently, the supported features are: -* Air Quality Index (AQI) -* Attributes +- Air Quality Index (AQI) +- Attributes - power - charging - battery diff --git a/source/_components/smappee.markdown b/source/_components/smappee.markdown index ce56987f72c2..c91c9d0f59c5 100644 --- a/source/_components/smappee.markdown +++ b/source/_components/smappee.markdown @@ -24,7 +24,6 @@ Info on how to get API access is described in the [smappy wiki](https://github.c To use the `smappee` component in your installation, add the following to your `configuration.yaml` file: - ```yaml # Example configuration.yaml entry smappee: diff --git a/source/_components/switch.homematicip_cloud.markdown b/source/_components/switch.homematicip_cloud.markdown index b943caf6d0c1..aba47287c257 100644 --- a/source/_components/switch.homematicip_cloud.markdown +++ b/source/_components/switch.homematicip_cloud.markdown @@ -7,10 +7,10 @@ sidebar: true comments: false sharing: true footer: true -logo: homematic.png +logo: homematicip_cloud.png ha_category: Switch ha_release: 0.70 -ha_iot_class: "Local Push" +ha_iot_class: "Cloud Push" --- The `homematicip_cloud` switch platform allows you to control diff --git a/source/_components/switch.rachio.markdown b/source/_components/switch.rachio.markdown index 786c35741322..e24fab29faee 100644 --- a/source/_components/switch.rachio.markdown +++ b/source/_components/switch.rachio.markdown @@ -18,7 +18,7 @@ The `rachio` switch platform allows you to toggle zones connected to your [Rachi Once configured, a switch will be added for every zone that is enabled on every controller in the account provided, as well as a switch to toggle each controller's standby mode.- You must have the [Rachio component](/components/rachio/) configured to use this switch. +You must have the [Rachio component](/components/rachio/) configured to use this switch.
To add this platform to your installation, add the following to your `configuration.yaml` file: @@ -44,7 +44,6 @@ In this section, you find some real-life examples of how to use this switch. ### {% linkable_title `groups.yaml` example %} - ```yaml irrigation: name: Irrigation diff --git a/source/_components/switch.tuya.markdown b/source/_components/switch.tuya.markdown new file mode 100644 index 000000000000..6f081aee6cde --- /dev/null +++ b/source/_components/switch.tuya.markdown @@ -0,0 +1,23 @@ +--- +layout: page +title: "Tuya Switch" +description: "Instructions on how to setup the Tuya switch within Home Assistant." +date: 2018-07-09 09:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: tuya.png +ha_category: Switch +ha_iot_class: "Cloud Polling" +ha_release: 0.74 +--- + + +The `tuya` switch platform allows you to control your [Tuya Smart](https://www.tuya.com) switch. + +The platform supports switch and socket. + ++Full configuration details can be found on the main [Tuya component](/components/tuya/) page. +
\ No newline at end of file diff --git a/source/_components/tado.markdown b/source/_components/tado.markdown index 34447a66d90b..386db0de0d1b 100644 --- a/source/_components/tado.markdown +++ b/source/_components/tado.markdown @@ -13,7 +13,6 @@ ha_release: 0.41 ha_iot_class: "Cloud Polling" --- - The `tado` component platform is used as an interface to the [my.tado.com](https://my.tado.com/webapp/#/account/sign-in) website. It adds climate devices for every tado zone and sensors for some additional information of the zones. To use your tado thermostats in your installation, add the following to your `configuration.yaml` file: diff --git a/source/_components/tuya.markdown b/source/_components/tuya.markdown new file mode 100644 index 000000000000..a51c170dbffa --- /dev/null +++ b/source/_components/tuya.markdown @@ -0,0 +1,51 @@ +--- +layout: page +title: "Tuya" +description: "Instructions on how to setup the Tuya hub within Home Assistant." +date: 2018-07-09 09:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: tuya.png +ha_category: Hub +ha_iot_class: "Cloud Polling" +ha_release: 0.74 +--- + +The `tuya` component is the main component to integrate all [Tuya Smart](https://www.tuya.com) related platforms. You will need your Tuya account information (username, password and account country code) to discover and control devices which related to your account. + +## {% linkable_title Configuration %} + +To add your Tuya devices into your Home Assistant installation, add the following to your `configuration.yaml` file: + +```yaml +tuya: + username: YOUR_TUYA_USERNAME + password: YOUR_TUYA_PASSWORD + country_code: YOUR_ACCOUNT_COUNTRYCODE +``` + +{% configuration %} +username: + description: Your username to login to Tuya. + required: true + type: string +password: + description: Your password to login to Tuya. + required: true + type: string +country_code: + description: Your account country code (i.e.,1 for USA and 86 for China). + required: true + type: string +{% endconfiguration %} + +## {% linkable_title Service %} + +These services are available for the `tuya` component: + +- force_update +- pull_devices + +Devices state data and new devices will refresh automatically. If you want to refresh all devices information or get new devices related to your account manually, you can call the `force_update` or `pull_devices` service. diff --git a/source/_components/vacuum.xiaomi_miio.markdown b/source/_components/vacuum.xiaomi_miio.markdown index 4a5f09e68797..6cdc2c33f30a 100644 --- a/source/_components/vacuum.xiaomi_miio.markdown +++ b/source/_components/vacuum.xiaomi_miio.markdown @@ -136,13 +136,13 @@ easily via a hidden menu item at the Mi-Home app or using the `miio` command lin You can install the command line tool with: ```bash -$ npm install -g miio +npm install -g miio ``` Discovering devices on current network ```bash -$ miio discover +miio discover ``` This will list devices that are connected to the same network as your computer. Let it run for a while so it has a chance to reach all devices, as it might take a minute or two for all devices to answer. @@ -159,10 +159,10 @@ Support: At least basic The information output is: -* __Device ID__ - the unique identifier of the device, does not change if the device is reset. -* __Model ID__ - the model id if it could be determined, this indicates what type of device it is -* __Address__ - the IP that the device has on the network -* __Token__ - the token of the device or ??? if it could not be automatically determined +- __Device ID__ - the unique identifier of the device, does not change if the device is reset. +- __Model ID__ - the model id if it could be determined, this indicates what type of device it is +- __Address__ - the IP that the device has on the network +- __Token__ - the token of the device or ??? if it could not be automatically determined #### {% linkable_title Windows and Android %} @@ -174,7 +174,7 @@ To fetch the token follow these instructions depending on your mobile phone plat 4. Change the MiToolKit language to English if you need to. 5. Click "Extract Token" 6. On the phone, you must confirm the backup. DO NOT enter any password and press the button to make the backup. -8. Once you have confirmed the backup the token extraction will begin, it should appear in the MiToolKit shortly. +7. Once you have confirmed the backup the token extraction will begin, it should appear in the MiToolKit shortly. #### {% linkable_title Linux and Android (not rooted) %} @@ -183,14 +183,14 @@ Follow the pairing process using your phone and Mi-Home app. You will be able to Before you begin you need to install `libffi-dev` and `libssl-dev` by running the command below. This is needed for `python-miio` to be installed correctly. ```bash -$ sudo apt-get install libffi-dev libssl-dev +sudo apt-get install libffi-dev libssl-dev ``` If your Home Assistant installation is running in a [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below. ```bash -$ sudo -u homeassistant -H -s -$ source /srv/homeassistant/bin/activate +sudo -u homeassistant -H -s +source /srv/homeassistant/bin/activate ``` To fetch the token follow these instructions depending on your mobile phone platform. @@ -205,7 +205,6 @@ To fetch the token follow these instructions depending on your mobile phone plat 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. - #### {% linkable_title Linux and Android (rooted!) %} Follow the pairing process using your phone and Mi-Home app. You will be able to retrieve the token from a SQLite file inside your phone. @@ -213,14 +212,14 @@ Follow the pairing process using your phone and Mi-Home app. You will be able to Before you begin you need to install `libffi-dev` and `libssl-dev` by running the command below. This is needed for `python-miio` to be installed correctly. ```bash -$ sudo apt-get install libffi-dev libssl-dev +sudo apt-get install libffi-dev libssl-dev ``` If your Home Assistant installation is running in a [Virtualenv](/docs/installation/virtualenv/#upgrading-home-assistant), make sure you activate it by running the commands below. ```bash -$ sudo -u homeassistant -H -s -$ source /srv/homeassistant/bin/activate +sudo -u homeassistant -H -s +source /srv/homeassistant/bin/activate ``` To fetch the token follow these instructions depending on your mobile phone platform. diff --git a/source/_components/websocket_api.markdown b/source/_components/websocket_api.markdown index 5cb8e926d0d1..7711d202b826 100644 --- a/source/_components/websocket_api.markdown +++ b/source/_components/websocket_api.markdown @@ -22,4 +22,4 @@ It is HIGHLY recommended that you set the `api_password`, especially if you are websocket_api: ``` -For details to use the WebSocket API, please refer to the [WebSocket API documentation](/developers/websocket_api/) . +For details to use the WebSocket API, please refer to the [WebSocket API documentation](/developers/websocket_api/) . diff --git a/source/_docs/ecosystem/synology.markdown b/source/_docs/ecosystem/synology.markdown index 20cf14f98fbd..ba2c69f04aed 100644 --- a/source/_docs/ecosystem/synology.markdown +++ b/source/_docs/ecosystem/synology.markdown @@ -19,9 +19,9 @@ To allow WebSocket by default for all service exposed by NGINX, you can enable i Open `/usr/syno/share/nginx/Portal.mustache` and add the followings in the `Location` section: ``` - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "upgrade"; - proxy_read_timeout 86400; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; + proxy_read_timeout 86400; ``` Then restart the NGINX daemon: diff --git a/source/_docs/installation/hassbian.markdown b/source/_docs/installation/hassbian.markdown index 7ae3954bce16..9c12947cd46c 100644 --- a/source/_docs/installation/hassbian.markdown +++ b/source/_docs/installation/hassbian.markdown @@ -14,8 +14,8 @@ Hassbian is our customized operating system for the Raspberry Pi Zero, 2,3 and 3 - [Install Hassbian](/docs/hassbian/installation/) - [Customize your installation](/docs/hassbian/customization/) - - [Pi specific integrations](/docs/hassbian/common-tasks/) - - [Learn how to perform common tasks](/docs/hassbian/integrations/) + - [Pi specific integrations](/docs/hassbian/integrations/) + - [Learn how to perform common tasks](/docs/hassbian/common-tasks/) ### {% linkable_title Activating the virtual environment %} diff --git a/source/_faq/after-upgrading.markdown b/source/_faq/after-upgrading.markdown index 0440745d0a95..c74ca7d7646b 100644 --- a/source/_faq/after-upgrading.markdown +++ b/source/_faq/after-upgrading.markdown @@ -9,9 +9,8 @@ footer: true ha_category: Usage --- +After upgrading to a new version, you may notice your browser gets stuck at the "loading data" login screen. Close the window/tab and go into your browser settings and delete all the cookies for your URL. You can then log back in and it should work. -After upgrading to a new version, you may notice your browser gets stuck at the "loading data" login screen. Close the window/tab and go into your browser settings and delete all the cookies for your URL. You can then log back in and it should work. - -Android Chrome +Android Chrome: chrome -> settings -> site settings -> storage -> search for your URL for Home Assistant-> "clear & reset" diff --git a/source/_faq/browser.markdown b/source/_faq/browser.markdown index ee2dd204f7a6..78ae2000c46b 100644 --- a/source/_faq/browser.markdown +++ b/source/_faq/browser.markdown @@ -9,5 +9,4 @@ footer: true ha_category: Usage --- - Close the windows or tab and clear the cache. The frontend is aggressively caching and clearing the cache ensures that the frontend is reloaded when you access it the next time. diff --git a/source/_faq/component.markdown b/source/_faq/component.markdown index 0f46cf01cf7d..9d4aaadff0b8 100644 --- a/source/_faq/component.markdown +++ b/source/_faq/component.markdown @@ -9,7 +9,6 @@ footer: true ha_category: Configuration --- - When a component does not show up, many different things can be the case. Before you try any of these steps, make sure to look at the `home-assistant.log` file and see if there are any errors related to your component you are trying to set up. If you have incorrect entries in your configuration files you can use the `check_config` script to assist in identifying them: `hass --script check_config`. diff --git a/source/_faq/configuration-file.markdown b/source/_faq/configuration-file.markdown index 8f06e8247f42..c33e1678269e 100644 --- a/source/_faq/configuration-file.markdown +++ b/source/_faq/configuration-file.markdown @@ -9,5 +9,4 @@ footer: true ha_category: Configuration --- - And not JSON or XML for the [configuration file](/docs/configuration/)? Because [YAML](/docs/configuration/yaml/) can be written by hand, you don't have to care about commas or tag and it's a superset of JSON. diff --git a/source/_faq/connection-error.markdown b/source/_faq/connection-error.markdown index 3acb6edd3dce..cad8704c49f2 100644 --- a/source/_faq/connection-error.markdown +++ b/source/_faq/connection-error.markdown @@ -9,7 +9,6 @@ footer: true ha_category: Usage --- - It can happen that you get a traceback that notify you about connection issues while running Home Assistant. Eg. ```bash diff --git a/source/_lovelace/entities.markdown b/source/_lovelace/entities.markdown index fec4fc9b8acc..a727e42badb4 100644 --- a/source/_lovelace/entities.markdown +++ b/source/_lovelace/entities.markdown @@ -19,17 +19,8 @@ type: type: string entities: required: true - description: "A list of entity IDs or an `entity` object." + description: "A list of entity IDs or `entity` objects, see below." type: list - keys: - entity: - required: true - description: "An `entity_id` to use in the frontend." - type: string - name: - required: true - description: "The name for the `entity_id` to use in the frontend." - type: string title: required: false description: The card title. @@ -41,6 +32,25 @@ show_header_toggle: default: true {% endconfiguration %} +## {% linkable_title Options For Entities %} + +If you define entities as objects instead of strings, you can add more customization and configuration: + +{% configuration %} +entity: + required: true + description: Home Assistant entity ID. + type: string +type: + required: false + description: "Sets a custom card type: `custom:my-custom-card`" + type: string +name: + required: false + description: Overwrites friendly name. + type: string +{% endconfiguration %} + ## {% linkable_title Example %} ```yaml diff --git a/source/_lovelace/entity-filter.markdown b/source/_lovelace/entity-filter.markdown index f72711a90a9e..1bd4f6a02387 100644 --- a/source/_lovelace/entity-filter.markdown +++ b/source/_lovelace/entity-filter.markdown @@ -26,26 +26,17 @@ type: type: string entities: required: true - description: "List of entities to show." + description: "List of entities to filter." type: list - keys: - name: - required: false - description: The name to use in the front for the entity. - type: string - entity: - required: false - description: "The `entity_id` to show in the frontend." - type: string state_filter: required: true - description: Array of strings representing states. - type: array + description: List of strings representing states. + type: list card: required: false description: Extra options to pass down to the card rendering the result. type: object - default: entities type + default: entities card show_empty: required: false description: Allows hiding of card when no entities returned by filter. @@ -53,7 +44,7 @@ show_empty: default: true {% endconfiguration %} -## {% linkable_title Examples %} +### {% linkable_title Examples %} Show only active switches or lights in the house ```yaml @@ -64,9 +55,7 @@ Show only active switches or lights in the house - light.kitchen_lights - light.ceiling_lights state_filter: - - 'on' - card: - title: Eating power + - "on" ``` Show only people that are at home using [glance](/lovelace/glance/): @@ -78,13 +67,13 @@ Show only people that are at home using [glance](/lovelace/glance/): - device_tracker.demo_anne_therese - device_tracker.demo_home_boy state_filter: - - 'home' + - home card: type: glance title: People at home ```
-
-Screenshot of the entity filter used on a Glance card.
+
+ Entity filter combined with glance card.
-
-Screenshot of the 2 cards in a horizontal stack card.
+
+ Two picture cards in a horizontal stack card.
-
-Screenshot of the iframe card.
+
+ Windy weather radar as iframe.
-
-Screenshot of the picture elements card.
+
+ A functional floorplan powered by picture elements.
-
-Screenshot of the picture glance card.
+
+ Picture glance card for a living room.
-
-Screenshot of the vertical stack card.
+
+
+ Picture- and entities-card in a stack.
-
-Screenshot of the vertical stack and horizontal stack combined in a card.
+
+
+ Create a grid layout using vertical and horizontal stack.
Please remember to [secure your installation](/docs/configuration/securing/) once you've finished with the installation process. @@ -24,38 +24,35 @@ We will need a few things to get started with installing Home Assistant. Links b - [Raspberry Pi 3 model B](http://a.co/gEfMqL4) + [Power Supply](https://www.raspberrypi.org/help/faqs/#powerReqs) (at least 2.5A) - [Micro SD Card](http://a.co/gslOydD). Get one that is Class 10 as they are more reliable. Size 32 GB or bigger recommended. - SD Card reader. Part of most laptops, and also available as [standalone USB sticks](http://a.co/5FCyb0N) (the brand doesn't matter, just pick the cheapest) -- Ethernet cable (optional, Hass.io can work with WiFi too) - -
- Support for the Raspberry Pi 3 model B+ is available in the alternative installation method [Hassbian](/docs/hassbian/installation/). - - The recently released Raspberry Pi 3 model B+ is not yet supported by Hass.io. -
+- Ethernet cable (optional, Hass.io can work with WiFi as well) +- A USB-Stick (optional, allows for unattended configuration) ### {% linkable_title Software requirements %} -- Download [Hass.io image for Raspberry Pi 3][pi3] +- Download Hass.io image for Raspberry Pi 3 as [32bit][pi3-32] or [64bit][pi3-64] variant - Download [Etcher] to write the image to an SD card - Text Editor like [Visual Studio Code](https://code.visualstudio.com/) [Etcher]: https://etcher.io/ -[pi3]: https://github.com/home-assistant/hassio-build/releases/download/1.3/resinos-hassio-1.3-raspberrypi3.img.bz2 +[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.5/hassos_rpi3-1.5.img.gz +[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.5/hassos_rpi3-64-1.5.img.gz ### {% linkable_title Installing Hass.io %} 1. Put the SD card in your SD card reader. 1. Open Etcher, select the Hass.io image and flash it to the SD card. -1. WiFi setup only: open the file `system-connections/resin-sample` (from the `resin-boot` volume on the SD card) with a text editor. Change `ssid` to be your network name and `psk` to be your password. Note: When connecting to a 5 GHz-only network, make sure your device supports that. If you don't know what that means, then you probably have nothing to worry about. +1. WiFi setup only: Format a USB-Stick with name `CONFIG` and copy one of [the examples] to the file `network/hassos-wifi`. 1. Unmount the SD card and remove it from your SD card reader. 1. Insert the SD card into your Raspberry Pi 3. If you are going to use an Ethernet cable, connect that too. -1. Connect your Raspberry Pi to the power supply so it turns on. -1. The Raspberry Pi will now boot up, connect to the Internet and download the latest version of Home Assistant. This will take about 20 minutes. Do not expect anything but the Home Assistant logo on the HDMI display, or any use for a keyboard or mouse. +1. Connect your Raspberry Pi to the power supply, so it turns on. +1. The Raspberry Pi will now boot up, connect to the Internet and download the latest version of Home Assistant, which will take about 20 minutes. 1. Home Assistant will be available at [http://hassio.local:8123][local]. Shortly after the download has started, a simple preparation status page will be available at this URL. Point your browser there. The page refreshes automatically, and Home Assistant will be shown when the download is complete. [local]: http://hassio.local:8123 +[the examples]: https://github.com/home-assistant/hassos/blob/dev/Documentation/network.md-When you're done, remember to set up regular backups of your configuration. This will protect you from hardware failure and mistakes. On Hass.io you have snapshots, but you can back up to [GitHub](/docs/ecosystem/backup/backup_github/), [DropBox](/docs/ecosystem/backup/backup_usb/) and many other ways. All that matters is that you set them up and test them regularly. +When you're done, remember to set up regular backups of your configuration. These backups will protect you from hardware failure and mistakes. On Hass.io you have snapshots, but you can back up to [GitHub](/docs/ecosystem/backup/backup_github/), [DropBox](/docs/ecosystem/backup/backup_dropbox/) and many other ways. All that matters is that you set them up and test them regularly.
### [Next step: Configuring Home Assistant »](/getting-started/configuration/) diff --git a/source/hassio/index.markdown b/source/hassio/index.markdown index a5f4798c8dc7..0773f3918e64 100644 --- a/source/hassio/index.markdown +++ b/source/hassio/index.markdown @@ -19,10 +19,10 @@ The advantages of using Hass.io: - Free and open source - Optimized for embedded devices like Raspberry Pi - 100% local home automation -- Easy installation and updates (powered by [ResinOS] and [Docker]) -- Management user interface integrated into Home Assistant -- Easily create and restore full backups of your whole configuration. -- Easily install many popular add-ons including [Google Assistant], encryption via [Let's Encrypt] and dynamic DNS via [Duck DNS].[Browse available add-ons »][all]
+- Easy installation and updates (powered by [HassOS] and [Docker]) +- Management web interface integrated into Home Assistant +- Create and restore full backups of your whole configuration with ease +- Install many popular add-ons with a single click! For example [Google Assistant], encryption via [Let's Encrypt] and dynamic DNS via [Duck DNS].
[Browse available add-ons »][all]
- Active community that is helpful and sharing add-ons including AppDaemon, Homebridge and InfluxDB.
[Browse the forums »][forums]
[Join the Hass.io chat »][chat]
[Browse community add-on repositories »][comm-add-ons]
@@ -51,13 +51,13 @@ Hass.io upgrade process from the SSH command line
[comm-add-ons]: https://community.home-assistant.io/tags/hassio-repository
[all]: /addons/
[chat]: https://discord.gg/K3UVxJd
-[ResinOS]: https://resinos.io/
+[HassOS]: https://github.com/home-assistant/hassos
[Docker]: https://www.docker.com/
[install]: /hassio/installation/
## {% linkable_title hassio command %}
-On the SSH command line you can use the `hassio` command to retrieve logs, check the details of connected hardware, and more.
+On the SSH command line, you can use the `hassio` command to retrieve logs, check the details of connected hardware, and more.
Home Assistant:
@@ -92,7 +92,7 @@ You can get a better description of the CLI capabilities by typing `hassio help`
```bash
NAME:
- hassio - Commandline tool to allow interation with hass.io
+ hassio - Commandline tool to allow interaction with hass.io
USAGE:
hassio [global options] command [command options] [arguments...]
diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown
index 3d62ece3620f..97296ebaa790 100644
--- a/source/hassio/installation.markdown
+++ b/source/hassio/installation.markdown
@@ -1,7 +1,7 @@
---
layout: page
title: "Installing Hass.io"
-description: "Instructions on how-to install Hass.io."
+description: "Instructions on how to install Hass.io."
date: 2017-04-30 13:28
sidebar: true
comments: false
@@ -9,34 +9,24 @@ sharing: true
footer: true
---
-Hass.io images are available for all available Raspberry Pi and Intel NUC platforms.
+Hass.io images are available for:
-
- The recently released Raspberry Pi 3 model B+ is not yet supported. -
- -- Download the appropriate image for your Raspberry Pi / Intel NUC: +- Download the appropriate image for your IoT: - [Raspberry Pi / Zero][pi1] + - [Raspberry Pi / Zero W][pi0-w] - [Raspberry Pi 2][pi2] - - [Raspberry Pi 3][pi3] - - [Intel NUC][nuc] + - [Raspberry Pi 3 32bit][pi3-32] + - [Raspberry Pi 3 64bit][pi3-64] +- As [Virtual Appliance]: + - [VMDK][vmdk]-Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/help/faqs/#powerReqs) with your Pi. Mobile chargers may not be suitable since some are designed to only provide the full power with that manufacturer's handsets. +Please remember to ensure you're using an [appropriate power supply](https://www.raspberrypi.org/help/faqs/#powerReqs) with your Pi. Mobile chargers may not be suitable since some were only designed to provide just enough power to the device it was designed for by the manufacturer.
- Flash the downloaded image to an SD card using [Etcher]. -- There is an [issue in the Etcher flashing process on Mac OS High Sierra](https://github.com/resin-io/etcher/issues/1908). - There is an easy workaround, just uncompress the image first. - - ```bash - $ bunzip2 -c resinos-hassio-1.3-raspberrypi3.img.bz2 > image.img - ``` -
- -- Optional - Setup the WiFi or static IP: On the SD-card, edit the `system-connections/resin-sample` file and follow the [ResinOS howto][resinos-network]. +- Optional - Setup the WiFi or static IP: On the SD-card, create the `network/my-network` file and follow the [HassOS howto][hassos-network]. - Insert SD card to Raspberry Pi and turn it on. On first boot, it downloads the latest version of Home Assistant which takes ~20 minutes (slower/faster depending on the platform).
@@ -45,7 +35,7 @@ Please remember to ensure you're using an [appropriate power supply](https://www
- Enable either the [Samba add-on][samba] or the [SSH add-on][ssh] to manage your configuration in `/config/` (From the UI choose **Hass.io** which is located in the sidebar).
-If your router doesn't support mDNS then you'll have to use the IP address of your Pi, instead of `hassio.local`, for example `http://192.168.0.9:8123`. You should be able to find the IP address of your Pi from the admin interface of your router. +If your router doesn't support mDNS, then you'll have to use the IP address of your Pi instead of `hassio.local`. For example, `http://192.168.0.9:8123`. You should be able to find the IP address of your Pi from the admin interface of your router.
@@ -82,11 +72,14 @@ When you use this installation method, the core SSH add-on may not function corr A detailed guide about running Hass.io as a virtual machine is available in the [blog](/blog/2017/11/29/hassio-virtual-machine/). [Etcher]: https://etcher.io/ -[resinos-network]: https://docs.resin.io/deployment/network/2.0.0/ -[pi1]: https://github.com/home-assistant/hassio-build/releases/download/1.3/resinos-hassio-1.3-raspberrypi.img.bz2 -[pi2]: https://github.com/home-assistant/hassio-build/releases/download/1.3/resinos-hassio-1.3-raspberrypi2.img.bz2 -[pi3]: https://github.com/home-assistant/hassio-build/releases/download/1.3/resinos-hassio-1.3-raspberrypi3.img.bz2 -[nuc]: https://github.com/home-assistant/hassio-build/releases/download/1.3/resinos-hassio-1.3-intel-nuc.img.bz2 +[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/1.6/hassos_rpi0-w-1.6.img.gz +[pi1]: https://github.com/home-assistant/hassos/releases/download/1.6/hassos_rpi-1.6.img.gz +[pi2]: https://github.com/home-assistant/hassos/releases/download/1.6/hassos_rpi2-1.6.img.gz +[pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.5/hassos_rpi3-1.5.img.gz +[pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.5/hassos_rpi3-64-1.5.img.gz +[vmdk]: https://github.com/home-assistant/hassos/releases/download/1.6/hassos_ova-1.6.vmdk [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/blog/2018-07-hassio-images/blogpost.png b/source/images/blog/2018-07-hassio-images/blogpost.png new file mode 100644 index 000000000000..443fb8a540b6 Binary files /dev/null and b/source/images/blog/2018-07-hassio-images/blogpost.png differ diff --git a/source/images/lovelace/lovelace_iframe.png b/source/images/lovelace/lovelace_iframe.png index 958824a52834..b25f1029d7dc 100644 Binary files a/source/images/lovelace/lovelace_iframe.png and b/source/images/lovelace/lovelace_iframe.png differ diff --git a/source/images/lovelace/lovelace_views.gif b/source/images/lovelace/lovelace_views.gif deleted file mode 100644 index 89b7513f3260..000000000000 Binary files a/source/images/lovelace/lovelace_views.gif and /dev/null differ diff --git a/source/images/lovelace/lovelace_views.png b/source/images/lovelace/lovelace_views.png new file mode 100644 index 000000000000..785f1c9af226 Binary files /dev/null and b/source/images/lovelace/lovelace_views.png differ diff --git a/source/images/supported_brands/tuya.png b/source/images/supported_brands/tuya.png new file mode 100644 index 000000000000..58608de6153e Binary files /dev/null and b/source/images/supported_brands/tuya.png differ diff --git a/source/lovelace/changelog.markdown b/source/lovelace/changelog.markdown index 923247b75c01..80b9e5c1570f 100644 --- a/source/lovelace/changelog.markdown +++ b/source/lovelace/changelog.markdown @@ -25,7 +25,7 @@ footer: true - 📣 New button to show unused entities in Lovelace -## Changes in 0.73.0b5 %} +## {% linkable_title Changes in 0.73.0b5 %} - 🏁 Only minor fixes in this release diff --git a/source/lovelace/index.markdown b/source/lovelace/index.markdown index dbadcf72a4f5..6f2862b8ad03 100644 --- a/source/lovelace/index.markdown +++ b/source/lovelace/index.markdown @@ -120,6 +120,6 @@ This is probably because your version of Firefox doesn't have custom components ### Custom components don't load on my IOS device? -This is because for IOS devices by default javascript served is `es5`. You can allow custom components to load by forcing `javascript: latest` in your `configuration.yaml` under `frontend:`. +This is because for IOS devices by default javascript served is `es5`. You can allow custom components to load by forcing `javascript_version: latest` in your `configuration.yaml` under `frontend:`. > Note: Enabling `latest` on IOS could cause automation and script editor to crash. diff --git a/source/lovelace/views.markdown b/source/lovelace/views.markdown index 8c741d1f0830..d1eb9d7e5c12 100644 --- a/source/lovelace/views.markdown +++ b/source/lovelace/views.markdown @@ -9,88 +9,122 @@ sharing: true footer: true --- -These are exactly as before, tab views with icons or text that help you manage large dashboards with many entities. The views have now deep-links like `/lovelace/0`. You can also assign your own [custom IDs](/lovelace/views/#custom-id). - -- Using custom id in view, for [nicer navigation paths](/lovelace/views/#custom-id) in URLs. -- Using [icons](/lovelace/views/#icons) instead of text. -- Using a card to [fill a complete view](/lovelace/views/#panel-view), just like panels. -- Using [themes](/lovelace/views/#themes) in views. - -| Name | Type | Default | Description -| ---- | ---- | ------- | ----------- -| title | string | Optional | Text title of the view -| id | string | number | The id to use in URL path of this view -| icon | string | Optional | The material design icon for the view, uses this instead of title -| panel | boolean | false | Marks view as a panel reusing the first card in the list - -
-
-Screenshot of views.
-
+ 
+ Use titles and icons to describe the content of views.
+