Paulus Schoutsen
GitHub
commit
0c833c0bc3
45 changed files with 1469 additions and 85 deletions
|
|
@ -79,3 +79,33 @@ automation:
|
|||
service: alarm_control_panel.alarm_trigger
|
||||
entity_id: alarm_control_panel.ha_alarm
|
||||
```
|
||||
|
||||
Sending a notification when the alarm is triggered.
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
- alias: 'Send notification when alarm triggered'
|
||||
trigger:
|
||||
- platform: state
|
||||
entity_id: alarm_control_panel.ha_alarm
|
||||
to: 'triggered'
|
||||
action:
|
||||
- service: notify.notify
|
||||
data:
|
||||
message: "ALARM! The alarm has been triggered"
|
||||
```
|
||||
|
||||
Disarming the alarm when the door is properly unlocked.
|
||||
|
||||
```yaml
|
||||
automation:
|
||||
- alias: 'Disarm alarm when door unlocked by keypad'
|
||||
trigger:
|
||||
- platform: state
|
||||
entity_id: sensor.front_door_lock_alarm_type
|
||||
to: '19'
|
||||
# many z-wave locks use Alarm Type 19 for 'Unlocked by Keypad'
|
||||
action:
|
||||
- service: alarm_control_panel.alarm_disarm
|
||||
entity_id: alarm_control_panel.house_alarm
|
||||
```
|
||||
|
|
|
|||
16
source/_components/binary_sensor.tellduslive.markdown
Normal file
16
source/_components/binary_sensor.tellduslive.markdown
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Telldus Binary Sensor"
|
||||
description: "Instructions how to integrate Telldus Live binary sensors into Home Assistant."
|
||||
date: 2017-10-24 10:09
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: telldus.png
|
||||
ha_category: Binary Sensor
|
||||
featured: false
|
||||
---
|
||||
|
||||
Integrates Telldus Live binary sensors into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions.
|
||||
|
||||
|
|
@ -14,8 +14,6 @@ ha_iot_class: "Cloud Polling"
|
|||
---
|
||||
|
||||
|
||||
The `neato` camera platform allows you to view the latest cleaning map of your [Neato Botvac Connected]
|
||||
(https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).
|
||||
|
||||
The requirement is that you have setup your [Neato hub](/components/neato/).
|
||||
The `neato` camera platform allows you to view the latest cleaning map of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).
|
||||
|
||||
To add `neato` camera to your installation, follow instructions in [Neato component](/components/neato/).
|
||||
|
|
|
|||
33
source/_components/climate.ephember
Normal file
33
source/_components/climate.ephember
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
layout: page
|
||||
title: "EPH Controls Ember Thermostat"
|
||||
description: "Instructions on how to integrate EPH Controls Ember thermostats within Home Assistant."
|
||||
date: 2017-10-07 12:40
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: ephcontrolsember.png
|
||||
ha_category: Climate
|
||||
ha_release: "0.55"
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `ephember` climate platform lets you control [EPH Controls](http://emberapp.ephcontrols.com/) thermostats. The module only works if you have a WiFi gateway to control your EPH system and an account on the ember app.
|
||||
|
||||
To set it up, add the following information to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
climate:
|
||||
- platform: ephember
|
||||
username: YOUR_EMAIL
|
||||
password: YOUR_PASSWORD
|
||||
```
|
||||
|
||||
A single interface can handle up to 32 connected devices.
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): The email address you used to sign up to the ember app
|
||||
- **password** (*Required*): The password you used to sign up to the ember app
|
||||
|
|
@ -35,7 +35,8 @@ Configuration variables:
|
|||
- **target_temp** (*Optional*): Set initial target temperature. Failure to set this variable will result in target temperature being set to null on startup.
|
||||
- **ac_mode** (*Optional*): Set the switch specified in the *heater* option to be treated as a cooling device instead of a heating device.
|
||||
- **min_cycle_duration** (*Optional*): Set a minimum amount of time that the switch specified in the *heater* option must be in it's current state prior to being switched either off or on.
|
||||
- **tolerance** (*Optional*): Set a minimum amount of difference between the temperature read by the sensor specified in the *target_sensor* option and the target temperature that must change prior to being switched either off or on. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will start when the sensor goes below 24.5 and it will stop when the sensor goes above 25.5.
|
||||
- **cold_tolerance** (*Optional*): Set a minimum amount of difference between the temperature read by the sensor specified in the *target_sensor* option and the target temperature that must change prior to being switched on. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will start when the sensor equals or goes below 24.5.
|
||||
- **hot_tolerance** (*Optional*): Set a minimum amount of difference between the temperature read by the sensor specified in the *target_sensor* option and the target temperature that must change prior to being switched off. For example, if the target temperature is 25 and the tolerance is 0.5 the heater will stop when the sensor equals or goes above 25.5.
|
||||
- **keep_alive** (*Optional*): Set a keep-alive interval. If set, the switch specified in the *heater* option will be triggered every time the interval elapses. Use with heaters and A/C units that shut off if they don't receive a signal from their remote for a while.
|
||||
|
||||
A full configuration example looks like the one below. `min_cycle_duration` and `keep_alive` must contain at least one of the following entries: `days:`, `hours:`, `minutes:`, `seconds:` or `milliseconds:`.
|
||||
|
|
@ -50,7 +51,8 @@ climate:
|
|||
min_temp: 15
|
||||
max_temp: 21
|
||||
target_temp: 17
|
||||
tolerance: 0.3
|
||||
cold_tolerance: 0.3
|
||||
hot_tolerance: 0
|
||||
min_cycle_duration:
|
||||
seconds: 5
|
||||
keep_alive:
|
||||
|
|
|
|||
|
|
@ -251,3 +251,69 @@ automation:
|
|||
position: 25
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### {% linkable_title Change The Icon %}
|
||||
|
||||
This example shows how to change the icon based on the cover state.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
cover:
|
||||
- platform: template
|
||||
covers:
|
||||
cover_group:
|
||||
friendly_name: "Cover Group"
|
||||
open_cover:
|
||||
service: script.cover_group
|
||||
data:
|
||||
modus: 'open'
|
||||
close_cover:
|
||||
service: script.cover_group
|
||||
data:
|
||||
modus: 'close'
|
||||
stop_cover:
|
||||
service: script.cover_group
|
||||
data:
|
||||
modus: 'stop'
|
||||
value_template: "{{is_state('sensor.cover_group', 'open')}}"
|
||||
icon_template: >-
|
||||
{% if is_state('sensor.cover_group', 'open') %}
|
||||
mdi:window-open
|
||||
{% else %}
|
||||
mdi:window-closed
|
||||
{% endif %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### {% linkable_title Change The Entity Picture %}
|
||||
|
||||
This example shows how to change the entity picture based on the cover state.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
cover:
|
||||
- platform: template
|
||||
covers:
|
||||
cover_group:
|
||||
friendly_name: "Cover Group"
|
||||
open_cover:
|
||||
service: script.cover_group
|
||||
data:
|
||||
modus: 'open'
|
||||
close_cover:
|
||||
service: script.cover_group
|
||||
data:
|
||||
modus: 'close'
|
||||
stop_cover:
|
||||
service: script.cover_group
|
||||
data:
|
||||
modus: 'stop'
|
||||
value_template: "{{is_state('sensor.cover_group', 'open')}}"
|
||||
icon_template: >-
|
||||
{% if is_state('sensor.cover_group', 'open') %}
|
||||
/local/cover-open.png
|
||||
{% else %}
|
||||
/local/cover-closed.png
|
||||
{% endif %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
|
|
|||
|
|
@ -42,3 +42,5 @@ To configure Geofency, you must configure (via the Webhook feature) to send a PO
|
|||
Geofency will automatically generate the device tracker name used for geofences, and you will find it in `known_devices.yaml` after the first request. For beacons, the device name will be `beacon_<name from Geofency>`, e.g., `device_tracker.beacon_car`.
|
||||
|
||||
When you enter a geofence or stationary beacon, your location name in Home Assistant will be set to the name of the geofence or beacon location in Geofency. When you exit a geofence or stationary beacon, your location name in Home Assistant will be set to 'not home'. For mobile beacons, the location name will be 'not_home' whenever the beacon is entered or exited outside of a [zone](https://home-assistant.io/components/zone/), otherwise, it will be set to the name of the zone.
|
||||
|
||||
To make Geofency work better with the [proximity](https://home-assistant.io/components/proximity/) component, you should enable the 'Send Current Location' feature in the Webhook configuration screen. This ensures that the _current_ GPS coordinates are included in exit events instead of the coordinates of the (center of) the zone that was exited.
|
||||
|
|
@ -68,6 +68,8 @@ Configuration variables:
|
|||
- **host** (*Required*): The IP address of your router, eg. 192.168.1.1.
|
||||
- **username** (*Required*): The username of an user with administrative privileges, usually *root*.
|
||||
- **password** (*Required*): The password for your given account.
|
||||
- **dhcp_software** (*Optional*): The DHCP software used in your router: `dnsmasq` or `dhcpd`. Defaults to `dnsmasq`.
|
||||
|
||||
|
||||
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
|
||||
|
||||
|
|
|
|||
|
|
@ -18,6 +18,32 @@ This offers the official frontend to control Home Assistant.
|
|||
frontend:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
themes:
|
||||
description: Allow to define different themes. See below for further details.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
"[identifier]":
|
||||
description: Name to use in the frontend.
|
||||
required: true
|
||||
type: [list, map]
|
||||
keys:
|
||||
"[css-identifier]":
|
||||
description: The CSS identifier.
|
||||
required: true
|
||||
type: [list, string]
|
||||
extra_html_url:
|
||||
description: "List of addtional [resources](/developers/frontend_creating_custom_ui/) to load."
|
||||
required: false
|
||||
type: list
|
||||
development_repo:
|
||||
description: Allow to point to a directory containing frontend files instead of taking them from a pre-built PyPI package. Useful for Frontend development.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
## {% linkable_title Themes %}
|
||||
|
||||
Starting with version 0.49 you can define themes:
|
||||
|
|
|
|||
|
|
@ -65,11 +65,15 @@ homeassistant:
|
|||
aliases:
|
||||
- bedroom shades
|
||||
- bedroom covers
|
||||
hallway_ceiling_switch:
|
||||
google_assistant: true
|
||||
google_assistant_type: light
|
||||
```
|
||||
|
||||
*Entity Customization Keys:*
|
||||
* *google_assistant*: True exposes entity, false will hide it
|
||||
* *google_assistant_name*: Can be used to override the primary name of an entity. By default the `friendly_name` of an entity is used.
|
||||
* *google_assistant_type*: Can be used to override the domain/type of an entity. For example a switch can be treated as a light
|
||||
* *aliases*: Provides "nicknames" to Google Assistant. These function as alternate names for an entity that Assistant will understand when spoken.
|
||||
|
||||
### {% linkable_title Setup %}
|
||||
|
|
|
|||
|
|
@ -29,7 +29,6 @@ Configuration variables:
|
|||
- **server_host** (*Optional*): Only listen to incoming requests on specific IP/host (default: accept all)
|
||||
- **server_port** (*Optional*): Let you set a port to use. Defaults to 8123.
|
||||
- **base_url** (*Optional*): The URL that Home Assistant is available on the internet. For example: `hass-example.duckdns.org:8123`. Defaults to the local IP address. The iOS app finds local installations, if you have an outside URL use this so that you can auto-fill when discovered in the app.
|
||||
- **development** (*Optional*): Disable caching and load unvulcanized assets. Useful for Frontend development.
|
||||
- **ssl_certificate** (*Optional*): Path to your TLS/SSL certificate to serve Home Assistant over a secure connection.
|
||||
- **ssl_key** (*Optional*): Path to your TLS/SSL key to serve Home Assistant over a secure connection.
|
||||
- **cors_allowed_origins** (*Optional*): A list of origin domain names to allow [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) requests from. Enabling this will set the `Access-Control-Allow-Origin` header to the Origin header if it is found in the list, and the `Access-Control-Allow-Headers` header to `Origin, Accept, X-Requested-With, Content-type, X-HA-access`. You must provide the exact Origin, i.e. `https://home-assistant.io` will allow requests from `https://home-assistant.io` but __not__ `http://home-assistant.io`.
|
||||
|
|
|
|||
|
|
@ -32,6 +32,6 @@ insteon_hub:
|
|||
|
||||
Configuration variables:
|
||||
|
||||
- **username** (*Required*): The username used to access the Insteon interface (e.g. the [connect.insteon.com](connect.insteon.com) site).
|
||||
- **username** (*Required*): The username used to access the Insteon interface (e.g. the [connect.insteon.com](http://connect.insteon.com/) site).
|
||||
- **password** (*Required*): The password used to access the Insteon interface.
|
||||
- **api_key** (*Required*): The Insteon REST API key emailed to you once you are approved in the Insteon Developer program.
|
||||
|
|
|
|||
|
|
@ -29,4 +29,5 @@ Configuration variables:
|
|||
- **host** (*Required*): The IP address of the device the Hyperion service is running on.
|
||||
- **port** (*Optional*): The port used to communicate with the Hyperion service. Defaults to `19444`.
|
||||
- **name** (*Optional*): The name of the device used in the frontend.
|
||||
- **priority** (*Optional*): The priority of the hyperion instance. Defaults to `128`.
|
||||
- **default_color** (*Optional*): The color of the light. Defaults to `[255, 255, 255]`.
|
||||
|
|
|
|||
|
|
@ -42,6 +42,7 @@ Configuration variables:
|
|||
- **effect_value_template** (*Optional*): Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract the effect value.
|
||||
- **effect_list** (*Optional*): The list of effects the light supports.
|
||||
- **name** (*Optional*): The name of the switch. Default is 'MQTT Switch'.
|
||||
- **on_command_type** (*Optional*): Defines when on the payload_on is sent. Using `last` (the default) will send any style (brightness, color, etc) topics first and then a `payload_on` to the `command_topic`. Using `first` will send the `payload_on` and then any style topics. Using `brightness` will only send brightness commands instead of the `payload_on` to turn the light on.
|
||||
- **optimistic** (*Optional*): Flag that defines if switch works in optimistic mode. Default is true if no state topic defined, else false.
|
||||
- **payload_off** (*Optional*): The payload that represents disabled state. Default is "OFF".
|
||||
- **payload_on** (*Optional*): The payload that represents enabled state. Default is "ON".
|
||||
|
|
@ -128,6 +129,24 @@ light:
|
|||
optimistic: false
|
||||
```
|
||||
|
||||
### {% linkable_title Brightness without on commands %}
|
||||
|
||||
To enable a light that sends only brightness topics to turn it on, add the following to your `configuration.yaml` file. The `command_topic` is only used to send an off command in this case:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
light:
|
||||
- platform: mqtt
|
||||
name: "Brightness light"
|
||||
state_topic: "office/light/status"
|
||||
command_topic: "office/light/switch"
|
||||
payload_off: "OFF"
|
||||
brightness_state_topic: 'office/rgb1/light/brightness'
|
||||
brightness_command_topic: 'office/rgb1/light/brightness/set'
|
||||
on_command_type: 'brightness'
|
||||
```
|
||||
|
||||
|
||||
### {% linkable_title Implementations %}
|
||||
|
||||
- A [basic example](https://github.com/mertenats/open-home-automation/tree/master/ha_mqtt_light) using a nodeMCU board (ESP8266) to control its built-in LED (on/off).
|
||||
|
|
|
|||
|
|
@ -143,3 +143,91 @@ light:
|
|||
{% endif %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### {% linkable_title Change The Icon %}
|
||||
|
||||
This example shows how to change the icon based on the light state.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
light:
|
||||
- platform: template
|
||||
lights:
|
||||
theater_volume:
|
||||
friendly_name: "Receiver Volume"
|
||||
value_template: >-
|
||||
{% if is_state('media_player.receiver', 'on') %}
|
||||
{% if states.media_player.receiver.attributes.is_volume_muted %}
|
||||
off
|
||||
{% else %}
|
||||
on
|
||||
{% endif %}
|
||||
{% else %}
|
||||
off
|
||||
{% endif %}
|
||||
icon_template: >-
|
||||
{% if is_state('media_player.receiver', 'on') %}
|
||||
{% if states.media_player.receiver.attributes.is_volume_muted %}
|
||||
mdi:lightbulb-off
|
||||
{% else %}
|
||||
mdi:lightbulb-on
|
||||
{% endif %}
|
||||
{% else %}
|
||||
mdi:lightbulb-off
|
||||
{% endif %}
|
||||
turn_on:
|
||||
service: media_player.volume_mute
|
||||
data:
|
||||
entity_id: media_player.receiver
|
||||
is_volume_muted: false
|
||||
turn_off:
|
||||
service: media_player.volume_mute
|
||||
data:
|
||||
entity_id: media_player.receiver
|
||||
is_volume_muted: true
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### {% linkable_title Change The Entity Picture %}
|
||||
|
||||
This example shows how to change the entity picture based on the light state.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
light:
|
||||
- platform: template
|
||||
lights:
|
||||
theater_volume:
|
||||
friendly_name: "Receiver Volume"
|
||||
value_template: >-
|
||||
{% if is_state('media_player.receiver', 'on') %}
|
||||
{% if states.media_player.receiver.attributes.is_volume_muted %}
|
||||
off
|
||||
{% else %}
|
||||
on
|
||||
{% endif %}
|
||||
{% else %}
|
||||
off
|
||||
{% endif %}
|
||||
icon_template: >-
|
||||
{% if is_state('media_player.receiver', 'on') %}
|
||||
{% if states.media_player.receiver.attributes.is_volume_muted %}
|
||||
/local/lightbulb-off.png
|
||||
{% else %}
|
||||
/local/lightbulb-on.png
|
||||
{% endif %}
|
||||
{% else %}
|
||||
/local/lightbulb-off.png
|
||||
{% endif %}
|
||||
turn_on:
|
||||
service: media_player.volume_mute
|
||||
data:
|
||||
entity_id: media_player.receiver
|
||||
is_volume_muted: false
|
||||
turn_off:
|
||||
service: media_player.volume_mute
|
||||
data:
|
||||
entity_id: media_player.receiver
|
||||
is_volume_muted: true
|
||||
```
|
||||
{% endraw %}
|
||||
|
|
|
|||
|
|
@ -32,18 +32,37 @@ media_player:
|
|||
```
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): Name of the device
|
||||
- **name** (*Optional*): Name of the device. This overrides the
|
||||
default name (often model number) that is returned by the device.
|
||||
- **host** (*Optional*): IP address or hostname of the device
|
||||
- **source_ignore** (*Optional*): List of sources to hide in the front-end
|
||||
- **source_names** (*Optional*): Mapping of internal AVR source names to custom ones, allowing to rename e.g. `HDMI1` to `ChromeCast`
|
||||
|
||||
A few notes:
|
||||
### {% linkable_title Discovery notes %}
|
||||
|
||||
- Not specifying the host variable will result in automatically searching your network for Yamaha Receivers. It will add a media player device for each one.
|
||||
- For receivers that support more than one zone, Home Assistant will add one media player per zone supported by the player, named "$name Zone 2" and "$name Zone 3".
|
||||
- In some cases, auto-discovery fails due to a known bug in the receiver's firmware. It is possible to manually specify the receiver's IP address or via it's hostname (if it is discoverable by your DNS) then.
|
||||
- Please note: If adding the IP address or hostname manually, you **must** enable network standby on your receiver, or else startup of Home Assistant will hang if you have your receiver switched off.
|
||||
- Currently, this component supports powering on/off, mute, volume control and source selection. Playback controls, for instance play and stop are available for sources that supports it.
|
||||
- If the `discovery` component is enabled, all units on the network
|
||||
will be discovered using UPNP.
|
||||
- For receivers that support more than one zone, Home Assistant will
|
||||
add one media player per zone supported by the player, named "$name
|
||||
Zone 2" and "$name Zone 3".
|
||||
- If you specify `host` manually, you **must** enable network standby
|
||||
on your receiver, or else startup of Home Assistant will hang if you
|
||||
have your receiver switched off.
|
||||
- In some cases, auto-discovery fails due to a known bug in the
|
||||
receiver's firmware. It is possible to manually specify the
|
||||
receiver's IP address or via it's hostname (if it is discoverable by
|
||||
your DNS) then.
|
||||
|
||||
### {% linkable_title Supported operations %}
|
||||
|
||||
- Media players created by yamaha support powering on/off, mute,
|
||||
volume control and source selection. Playback controls, for instance
|
||||
play and stop are available for sources that supports it.
|
||||
- The `play_media` service is implemented for `NET RADIO` source
|
||||
only. The `media_id` is a `>` separted string of the menu path on
|
||||
the vtuner service. For instance `Bookmarks>Internet>WAMC 90.3 FM`.
|
||||
|
||||
### {% linkable_title Example configuration %}
|
||||
|
||||
A full configuration example will look like the sample below:
|
||||
```yaml
|
||||
|
|
@ -58,3 +77,33 @@ media_player:
|
|||
HDMI1: "ChromeCast"
|
||||
AV4: "Vinyl"
|
||||
```
|
||||
|
||||
### {% linkable_title Example `play_media` script %}
|
||||
|
||||
The `play_media` function can be used in scripts easily to build media
|
||||
player presets. When done in scripts, the sequence will also allow you
|
||||
to set volume per source.
|
||||
|
||||
```yaml
|
||||
# Example play_media script
|
||||
#
|
||||
# This is for an environment where Zone 2 of the receiver named
|
||||
# `Living Room Stereo` drives outdoor speakers on the porch.
|
||||
script:
|
||||
rp_porch:
|
||||
alias: "Radio Paradise Porch"
|
||||
sequence:
|
||||
- service: media_player.turn_on
|
||||
data:
|
||||
entity_id: media_player.living_room_stereo_zone_2
|
||||
- service: media_player.volume_set
|
||||
data:
|
||||
entity_id: media_player.living_room_stereo_zone_2
|
||||
volume_level: 0.48
|
||||
- service: media_player.play_media
|
||||
data:
|
||||
entity_id: media_player.living_room_stereo_zone_2
|
||||
media_content_type: "NET RADIO"
|
||||
media_content_id: "Bookmarks>Internet>Radio Paradise"
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -26,9 +26,9 @@ media_player:
|
|||
```
|
||||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): Name of the device
|
||||
- **host** (*Required*): IP address or hostname of the device
|
||||
- **port** (*Optional*): UDP Port
|
||||
- **interval_seconds** (*Optional*): Polling interval (default: 480 seconds = 8 minutes)
|
||||
|
||||
A few notes:
|
||||
|
||||
|
|
@ -39,7 +39,6 @@ A full configuration example will look like the sample below:
|
|||
# Example configuration.yaml entry
|
||||
media_player:
|
||||
- platform: yamaha_musiccast
|
||||
name: "Living Room"
|
||||
host: 192.168.178.97
|
||||
port: 5005
|
||||
```
|
||||
|
|
|
|||
69
source/_components/remember_the_milk.markdown
Normal file
69
source/_components/remember_the_milk.markdown
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Remember The Milk"
|
||||
description: "Instructions on how to use Remember The Milk with Home Assistant."
|
||||
date: 2017-10-10 10:10
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
ha_category: Calendar
|
||||
ha_release: 0.57
|
||||
---
|
||||
|
||||
The `Remember The Milk` (RTM) component allows you to create tasks in [remember_the_milk](https://www.rememberthemilk.com) from Home Assistant. You can use this if you want Home Assistant to send you a task that you should not forget, e.g. water the plants. The component allows you to have several RTM accounts in parallel.
|
||||
|
||||
## {% linkable_title Setup %}
|
||||
|
||||
The setup consists of two steps: getting an API key and registering your account
|
||||
|
||||
### {% linkable_title Step 1: API key %}
|
||||
|
||||
To be able to use this component, you need a Remember The Milk account and you need to apply for your own [API key](https://www.rememberthemilk.com/services/api/keys.rtm). With the API key you will also receive your personal `shared secret`. Both of them need to be stored in your Home Assistant configuration:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
remember_the_milk:
|
||||
your_rtm_account:
|
||||
api_key: <your secret api key goes here>
|
||||
shared_secret: <your secret shared secret goes here>
|
||||
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
{% configuration %}
|
||||
account_name:
|
||||
description: Name of the RTM account, as you can have serveral accounts in RTM. The name must be unique.
|
||||
required: true
|
||||
type: string
|
||||
api_key:
|
||||
description: Put the API key you've received in here.
|
||||
required: true
|
||||
type: string
|
||||
shared_secret:
|
||||
description: Put the shared secret you've received in here.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Step 2: registering your account %}
|
||||
|
||||
After saving the configuration, you need to (re-)start Home Assistant. On the first start you will notice a new "Configuration" panel appearing on the Home Assistant page. After opening the configuration page, follow the link "Remember The Milk login". This will take you to a login page where you have to log in with your normal Rember The Milk credentials. This will authorize Home Assistant to access your Remember The Milk account.
|
||||
|
||||
After that click on the "login completed" button. This will tell Home Assistant that you have completed the login process on the Remember The Milk page and Home Assistant should try to register with this account.
|
||||
|
||||
If the registration was successful, the Configuration panel will disappear from your Home Assistant screen and a Remember The Milk panel should appear. This completes the setup process.
|
||||
|
||||
In the background Home Assistant downloaded a "token" from the Remember The Milk server which is stored in the `remember_the_milk.conf` file locally. So you only need to register once. After that the token is used to authenticate with the server.
|
||||
|
||||
## {% linkable_title Creating tasks %}
|
||||
|
||||
This component offers a new service domain ```remember_the_milk``` with the service ```create_task```. You can call this service with the argument ```name``` to create a new task in your Remember The Milk account. You can call this service from your usual automations.
|
||||
|
||||
The task creation supports the "smart syntax", so to create a task with the tag "from_hass" which is due today you can create a task with the name ```test task created in Home Assistant ^today #from_hass```. More info about the smart syntax is available on the [Remember The Milk documentation](https://www.rememberthemilk.com/help/answer/basics-smartadd-howdoiuse).
|
||||
|
||||
|
||||
## {% linkable_title Disclaimer %}
|
||||
This product uses the Remember The Milk API but is not endorsed or certified by Remember The Milk.
|
||||
|
|
@ -16,6 +16,8 @@ ha_release: 0.39
|
|||
|
||||
The `itach` remote platform allows you to control IR devices with a [Global Caché iTach Device](https://www.globalcache.com/products/itach/ip2irspecs) and GC-100 devices. The Global Cache IR API are similar across their product line. See API documentation links at the end of this page.
|
||||
|
||||
In order to utilize the digital input (binary sensor) and relay (switch) features of your Global Cache device you will need to use the [gc100 component](https://home-assistant.io/components/gc100) and associated platforms.
|
||||
|
||||
To use your iTach remote in your installation, you will need to know the IR commands for your devices in Pronto hex format and add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
48
source/_components/sensor.luftdaten.markdown
Normal file
48
source/_components/sensor.luftdaten.markdown
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Luftdaten Sensor"
|
||||
description: "Instructions how to setup Luftdaten sensor in Home Assistant."
|
||||
date: 2017-11-01 10:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: home-assistant.png
|
||||
ha_category: Health
|
||||
ha_release: 0.57
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `luftdaten` sensor platform will query the open data API of [luftdaten.info](http://luftdaten.info) to monitor air quality and other weather data from a specific (self build) sensor station.
|
||||
|
||||
- To get the ID of a particle sensor you need to select it on the [Feinstaub map](http://deutschland.maps.luftdaten.info/) and find it in the sidebar (Column "Sensor ID").
|
||||
- To get the ID of a temperature/humidity sensor you need to find it on the map hosted on [Madavi](https://www.madavi.de/sensor/feinstaub-map-dht/).
|
||||
|
||||
To enable this sensor, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: luftdaten
|
||||
sensorid: 3123
|
||||
monitored_conditions:
|
||||
- P1
|
||||
- P2
|
||||
- platform: luftdaten
|
||||
sensorid: 155
|
||||
monitored_conditions:
|
||||
- temperature
|
||||
- humidity
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **sensorid** (*Required*): The ID of the sensor.
|
||||
- **monitored_conditions** (*Required*): A list of conditions you want to monitor. The following conditions can be monitored:
|
||||
- `P1` for particle sensors (particles 10 microns and below).
|
||||
- `P2` for particle sensors (particles 2.5 microns and below).
|
||||
- `temperature` for weather sensors.
|
||||
- `humidity` for weather sensors.
|
||||
- **name** (*Optional*): Name of the sensor to use in the frontend. Defaults to `Luftdaten Sensor`.
|
||||
- **resource** (*Optional*): The URL of the API endpoint. Usually this has not to be changed. The default is `https://api.luftdaten.info/v1/sensor/`.
|
||||
- **verify_ssl** (*Optional*): Verify SSL connection. Defaults to `true`.
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Neato Robotics Sensor"
|
||||
description: "Instructions how to integrate a Neato Botvac Connected sensors within Home Assistant."
|
||||
date: 2016-11-09 20:11
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: neato.png
|
||||
ha_category: Sensor
|
||||
ha_release: 0.33
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `neato` sensor platform allows you to watch status and battery of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).
|
||||
The status sensor will contain attributes on the robots last clean session.
|
||||
|
||||
To add `neato` sensors to your installation, follow instructions in [Neato component](/components/neato/).
|
||||
|
|
@ -27,9 +27,8 @@ Configuration variables:
|
|||
|
||||
- **name** (*Optional*): Additional name for the sensors. Default to platform name.
|
||||
- **monitored_conditions** array (*Optional*): Conditions to display in the frontend. Defaults to `traffic_jam`.
|
||||
- **traffic_jam**: A human-readable text summary.
|
||||
- **mean_velocity**: The current temperature.
|
||||
- **congestion**: The wind speed.
|
||||
|
||||
- **traffic_jam**: Amount of kilometers in traffic jam (km).
|
||||
- **mean_velocity**: Mean velocity (km/h).
|
||||
- **congestion**: Index of congestion (n/a).
|
||||
|
||||
The data is coming from the [Direction des routes Île-de-France (DiRIF)](http://www.sytadin.fr).
|
||||
|
|
|
|||
|
|
@ -61,6 +61,10 @@ sensor:
|
|||
description: Defines a template for the icon of the sensor.
|
||||
required: false
|
||||
type: template
|
||||
icon_template:
|
||||
description: Defines a template for the entity picture of the sensor.
|
||||
required: false
|
||||
type: template
|
||||
{% endconfiguration %}
|
||||
|
||||
## {% linkable_title Considerations %}
|
||||
|
|
@ -215,3 +219,29 @@ sensor:
|
|||
{% endif %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### {% linkable_title Change The Entity Picture %}
|
||||
|
||||
This example shows how to change the entity picture based on the day/night cycle.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
sensor:
|
||||
- platform: template
|
||||
sensors:
|
||||
day_night:
|
||||
friendly_name: "Day/Night"
|
||||
value_template: >-
|
||||
{% if is_state('sun.sun', 'above_horizon') %}
|
||||
Day
|
||||
{% else %}
|
||||
Night
|
||||
{% endif %}
|
||||
entity_picture_template: >-
|
||||
{% if is_state('sun.sun', 'above_horizon') %}
|
||||
/local/daytime.png
|
||||
{% else %}
|
||||
/local/nighttime.png
|
||||
{% endif %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ sensor:
|
|||
Configuration variables:
|
||||
|
||||
- **name** (*Optional*): Name of the sensor. Defaults to `Uptime`.
|
||||
- **unit_of_measurement** (*Optional*): Units for uptime measurement in either `days` or `hours`. Defaults to `days`.
|
||||
- **unit_of_measurement** (*Optional*): Units for uptime measurement in either `days`, `hours`, or `minutes`. Defaults to `days`.
|
||||
|
||||
```yaml
|
||||
# Example with configuration variables
|
||||
|
|
|
|||
36
source/_components/switch.deluge.markdown
Normal file
36
source/_components/switch.deluge.markdown
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Deluge Switch"
|
||||
description: "Instructions how to integrate Deluge within Home Assistant."
|
||||
date: 2017-10-19 09:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: deluge.png
|
||||
ha_category: Downloading
|
||||
ha_release: 0.57
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
|
||||
The `deluge` switch platform allows you to control your [Deluge](http://deluge-torrent.org/) client from within Home Assistant. The platform enables you switch all your torrents in pause, and then unpause them all.
|
||||
|
||||
To add Deluge to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
switch:
|
||||
platform: deluge
|
||||
host: IP_ADDRESS
|
||||
username : USERNAME
|
||||
password : PASSWORD
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): This is the IP address of your Deluge daemon, eg. 192.168.1.32.
|
||||
- **username** (*Required*): Your Deluge username, if you use authentication.
|
||||
- **password** (*Required*): Your Deluge password, if you use authentication.
|
||||
- **port** (*Optional*): The port your Deluge daemon uses, defaults to 58846. Warning,this is not the port of the WebUI
|
||||
- **name** (*Optional*): The name to use when displaying this Deluge instance.
|
||||
|
|
@ -12,6 +12,6 @@ ha_category: Switch
|
|||
ha_release: 0.31
|
||||
---
|
||||
|
||||
The `neato` switch platform allows you to control your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).
|
||||
The `neato` switch platform allows you to enable or disable the schedule of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).
|
||||
|
||||
To add `neato` switch to your installation, follow instructions in [Neato component](/components/neato/).
|
||||
|
|
|
|||
|
|
@ -186,3 +186,31 @@ switch:
|
|||
{% endif %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### {% linkable_title Change The Entity Picture %}
|
||||
|
||||
This example shows how to change the entity picture based on the day/night cycle.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
switch:
|
||||
- platform: template
|
||||
switches:
|
||||
garage:
|
||||
value_template: "{{ is_state('cover.garage_door', 'on') }}"
|
||||
turn_on:
|
||||
service: cover.open_cover
|
||||
data:
|
||||
entity_id: cover.garage_door
|
||||
turn_off:
|
||||
service: cover.close_cover
|
||||
data:
|
||||
entity_id: cover.garage_door
|
||||
entity_picture_template: >-
|
||||
{% if is_state('cover.garage_door', 'open') %}
|
||||
/local/garage-open.png
|
||||
{% else %}
|
||||
/local/garage-closed.png
|
||||
{% endif %}
|
||||
```
|
||||
{% endraw %}
|
||||
|
|
|
|||
94
source/_components/timer.markdown
Normal file
94
source/_components/timer.markdown
Normal file
|
|
@ -0,0 +1,94 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Timer"
|
||||
description: "Instructions how to integrate timers into Home Assistant."
|
||||
date: 2017-10-23 06:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: home-assistant.png
|
||||
ha_category: Automation
|
||||
ha_release: 0.57
|
||||
---
|
||||
|
||||
The `timer` component aims to simplify automations based on (dynamic) durations.
|
||||
|
||||
When a timer finishes or gets cancelled the corresponding events are fired. This allows you to diffferentiate if a timer has switched from `active` to `idle` because the given duration has elapsed or it has been cancelled. To control timers in your automations you can use the services mentioned below. When calling the `start` service on a timer that is already running, it resets the duration it will need to finish and restart the timer without triggering any events. This for example makes it easy to create timed lights that get triggered by motion.
|
||||
|
||||
<p class='note warning'>
|
||||
With the current implementation timers don't persist over restarts. After a restart they will be idle again, together with their initial configuration.
|
||||
</p>
|
||||
|
||||
To add a timer to your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
timer:
|
||||
timer:
|
||||
duration: '00:01:00'
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **[alias]** (*Required*): Alias for the timer. Multiple entries are allowed.
|
||||
- **name** (*Optional*): Friendly name of the timer.
|
||||
- **duration** (*Optional*): Initial duration in seconds or `00:00:00` when Home Assistant starts. Defaults to 0.
|
||||
- **icon** (*Optional*): Set a custom icon for the state card.
|
||||
|
||||
Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your timer and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`.
|
||||
|
||||
## {% linkable_title Events %}
|
||||
|
||||
| Event | Description |
|
||||
| --------------- | ----------- |
|
||||
| timer.cancelled | Fired when a timer has been cancelled |
|
||||
| timer.finished | Fired when a timer has completed |
|
||||
|
||||
## {% linkable_title Services %}
|
||||
|
||||
#### {% linkable_title Service `timer.start` %}
|
||||
|
||||
Starts or restarts a timer with the provided duration. If no duration is given, it will either restart with its initial value, or continue a paused timer with the remaining duration. If a new duration is provided, this will be the new default for the timer until Home Assistant is restarted (which loads your default values). The duration can be specified as a number of seconds or the easier to read `01:23:45` format.
|
||||
If no `entity_id` is given all active timers will be started.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name of the entity to take action, e.g., `timer.timer0`. |
|
||||
| `duration` | yes | Duration in seconds or `00:00:00` until the timer finishes. |
|
||||
|
||||
#### {% linkable_title Service `timer.pause` %}
|
||||
|
||||
Pause a running timer. This will retain the remaining duration for later continuation. If no `entity_id` is given all active timers will be paused.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name of the entity to take action, e.g., `timer.timer0`. |
|
||||
|
||||
#### {% linkable_title Service `timer.cancel` %}
|
||||
|
||||
Cancel an active timer. This resets the duration to the last known initial value without firing the `timer.finished` event. If no `entity_id` is given all active timers will be cancelled.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name of the entity to take action, e.g., `timer.timer0`. |
|
||||
|
||||
#### {% linkable_title Service `timer.finish` %}
|
||||
|
||||
Manually finish a running timer earlier than scheduled. If no `entity_id` is given all active timers will be finished.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name of the entity to take action, e.g., `timer.timer0`. |
|
||||
|
||||
|
||||
### {% linkable_title Use the service %}
|
||||
|
||||
Select <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services** from the **Developer Tools**. Choose **timer** from the list of **Domains**, select the **Service**, enter something like the sample below into the **Service Data** field, and hit **CALL SERVICE**.
|
||||
|
||||
```json
|
||||
{
|
||||
"entity_id": "timer.timer0"
|
||||
}
|
||||
```
|
||||
|
||||
|
|
@ -14,25 +14,27 @@ ha_iot_class: "Local Polling"
|
|||
ha_release: 0.43
|
||||
---
|
||||
|
||||
The `tradfri` component supports for the IKEA Trådfri (Tradfri) gateway. The gateway can control lights connected to it and Home Assistant will automatically discover its presence on your network.
|
||||
The `tradfri` component supports for the IKEA Trådfri (Tradfri) gateway. The gateway can control lights connected to it and Home Assistant will automatically discover its presence on your network, if `discovery:` is present in your `configuration.yaml` file.
|
||||
|
||||
You will be prompted to configure the gateway through the Home Assistant interface, Enter the security key when prompted and click configure
|
||||
You will be prompted to configure the gateway through the Home Assistant interface. Enter the security key when prompted and click configure.
|
||||
|
||||
<p class='note'>
|
||||
If you see an "Unable to connect" message, restart the gateway and try again. Don't forget to assign a permanent IP to your Trådfri gateway.
|
||||
</p>
|
||||
|
||||
The gateway can also be manually configured by adding the following lines to your `configuration.yaml` file:
|
||||
You can add the following to your `configuration.yaml` file if you are not using the [`discovery:`](/components/discovery/) component:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
tradfri:
|
||||
host: IP_ADDRESS
|
||||
api_key: API_KEY
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **host** (*Required*): The IP address or hostname of your Trådfri gateway.
|
||||
- **api_key** (*Required*): Can be found listed as Security Key on the back of the Trådfri gateway.
|
||||
- **allow_tradfri_groups** (*Optional*): (true/false) Enable this to stop Home Assistant from importing the groups defined on the Trådfri bridge.
|
||||
- **allow_tradfri_groups** (*Optional*): Enable this to stop Home Assistant from importing the groups defined on the Trådfri bridge. Defaults to `true`.
|
||||
|
||||
<p class='note'>
|
||||
Do not use the `api_key` variable. The key is only needed once at initial setup.
|
||||
</p>
|
||||
|
|
|
|||
45
source/_components/tts.microsoft.markdown
Normal file
45
source/_components/tts.microsoft.markdown
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Microsoft Text-to-Speech"
|
||||
description: "Instructions how to setup Microsoft Text-to-Speech with Home Assistant."
|
||||
date: 2017-10-23 11:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: microsoft.png
|
||||
ha_category: Text-to-speech
|
||||
ha_release: 0.57
|
||||
---
|
||||
|
||||
The `microsoft` text-to-speech platform uses [Microsoft Text-to-Speech engine](https://docs.microsoft.com/en-us/azure/cognitive-services/speech/home) to read a text with natural sounding voices. This component uses an API that is part of the Cognitive Services offering and is known as the Bing Speech API.
|
||||
You will need an API key, which is free. You can use your [Azure subscription](https://azure.microsoft.com) or get an API key on the [Cognitive Services site](https://azure.microsoft.com/en-us/try/cognitive-services/).
|
||||
|
||||
To enable text-to-speech with Microsoft, add the following lines to your `configuration.yaml`:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
tts:
|
||||
- platform: microsoft
|
||||
api_key: [YourAPIKey]
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **api_key** (*Required*): Your API key.
|
||||
- **language** (*Optional*): The language to use. Defaults to `en-us`. Accepted values are listed in the documentation mentioned below.
|
||||
- **gender** (*Optional*): The gender you would like to use for the voice. Accepted values are `Female` and `Male`. Defaults to `Female`
|
||||
- **type** (*Optional*): The voice type you want to use. Accepted values are listed in the service name mapping [in the documentation](https://docs.microsoft.com/en-us/azure/cognitive-services/Speech/api-reference-rest/bingvoiceoutput). Defaults to `ZiraRUS`
|
||||
|
||||
|
||||
A full configuration sample including optional configuration variables:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
tts:
|
||||
- platform: microsoft
|
||||
api_key: XXXXXXXXX
|
||||
language: en-us
|
||||
gender: male
|
||||
type: BenjaminRUS
|
||||
```
|
||||
24
source/_components/vacuum.neato.markdown
Normal file
24
source/_components/vacuum.neato.markdown
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
---
|
||||
layout: page
|
||||
title: "Neato Robotics Vacuum"
|
||||
description: "Instructions how to integrate a Neato Botvac Connected Vacuum within Home Assistant."
|
||||
date: 2017-10-18 16:11
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: neato.png
|
||||
ha_category: Vacuum
|
||||
ha_release: 0.57
|
||||
ha_iot_class: "Cloud Polling"
|
||||
redirect_from: /components/sensor.neato/
|
||||
---
|
||||
|
||||
<p class='note'>
|
||||
Starting with 0.57 the `neato` sensor was migrated to a vacuum platform.
|
||||
</p>
|
||||
|
||||
The `neato` vacuum platform allows you to control your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).
|
||||
The status will contain attributes on the robots last clean session.
|
||||
|
||||
To add `neato` sensors to your installation, follow instructions in [Neato component](/components/neato/).
|
||||
|
|
@ -24,7 +24,7 @@ Home Assistant integrates with the Wink API and automatically sets up any switch
|
|||
|
||||
Check the related components pages for actual devices that are supported.
|
||||
|
||||
### Authenticate using [developer.wink.com](https://developer.wink.com)
|
||||
### {% linkable_title Authenticate using [developer.wink.com](https://developer.wink.com) %}
|
||||
|
||||
You need to setup a developer account with Wink. This process can take a few days to get approved.
|
||||
|
||||
|
|
@ -44,20 +44,7 @@ When using the configurator make sure the initial setup is performed on the same
|
|||
wink:
|
||||
```
|
||||
|
||||
~~### Authentication with your Wink email and password.~~
|
||||
|
||||
|
||||
~~This method pulls a new token on every startup of Home Assistant from this [URL](https://winkbearertoken.appspot.com)~~
|
||||
|
||||
```yaml
|
||||
wink:
|
||||
email: YOUR_WINK_EMAIL_ADDRESS
|
||||
password: YOUR_WINK_PASSWORD
|
||||
```
|
||||
|
||||
This is no longer working due to a recent change Wink made, and will be removed in the next release of Home Assistant. Please create a [developer.wink.com](https://developer.wink.com) account so you can keep using Wink!
|
||||
|
||||
### Full oauth authentication (legacy).
|
||||
### {% linkable_title Full oauth authentication (legacy). %}
|
||||
|
||||
This should be used for users that obtained their client_id and client_secret via email from Wink support prior to [developer.wink.com's](https://developer.wink.com) existance.
|
||||
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/
|
|||
- Decoupled mode of the Aqara Wall Switches (Single & Double)
|
||||
- Additional alarm events of the Gas and Smoke Detector: Analog alarm, battery fault alarm (smoke detector only), sensitivity fault alarm, I2C communication failure
|
||||
|
||||
## Setup
|
||||
## {% linkable_title Setup %}
|
||||
|
||||
Follow the setup process using your phone and Mi-Home app. From here you will be able to retrieve the key from within the app following [this tutorial](https://community.home-assistant.io/t/beta-xiaomi-gateway-integration/8213/1832).
|
||||
|
||||
|
|
@ -60,8 +60,7 @@ To enable {{ page.title }} in your installation, add the following to your `conf
|
|||
xiaomi_aqara:
|
||||
discovery_retry: 5
|
||||
gateways:
|
||||
- mac:
|
||||
key: xxxxxxxxxxxxxxxx
|
||||
- key: xxxxxxxxxxxxxxxx
|
||||
```
|
||||
|
||||
### {% linkable_title Multiple Gateways %}
|
||||
|
|
@ -109,24 +108,90 @@ xiaomi_aqara:
|
|||
host:
|
||||
description: The host / ip address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.
|
||||
required: false
|
||||
type: string
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
### {% linkable_title Services %}
|
||||
|
||||
The gateway provides two services: `xiaomi_aqara.play_ringtone` and `xiaomi_aqara.stop_ringtone`. To play ringtones by Home Assistant, the version of the gateway firmware must be `1.4.1_145` at least. A `ringtone_id` and `gw_mac` must be supplied. The parameter `ringtone_vol` (percent) is optional. Allowed values of the `ringtone_id` are:
|
||||
The gateway provides the following services:
|
||||
|
||||
- alarm ringtones [0-8]
|
||||
- doorbell ring [10-13]
|
||||
- alarm clock [20-29]
|
||||
- custom ringtones (uploaded by the Mi Home app) starting from 10001
|
||||
#### {% linkable_title Service xiaomi_aqara.play_ringtone %}
|
||||
|
||||
Play a specific ringtone. The version of the gateway firmware must be `1.4.1_145` at least. Take a look at the examples below.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||
| `ringtone_id` | no | One of the allowed ringtone ids |
|
||||
| `ringtone_vol` | yes | The volume in percent |
|
||||
|
||||
Allowed values of the `ringtone_id` are:
|
||||
|
||||
- Alarms
|
||||
- 0 - Police car 1
|
||||
- 1 - Police car 2
|
||||
- 2 - Accident
|
||||
- 3 - Countdown
|
||||
- 4 - Ghost
|
||||
- 5 - Sniper rifle
|
||||
- 6 - Battle
|
||||
- 7 - Air raid
|
||||
- 8 - Bark
|
||||
- Doorbells
|
||||
- 10 - Doorbell
|
||||
- 11 - Knock at a door
|
||||
- 12 - Amuse
|
||||
- 13 - Alarm clock
|
||||
- Alarm clock
|
||||
- 20 - MiMix
|
||||
- 21 - Enthusiastic
|
||||
- 22 - GuitarClassic
|
||||
- 23 - IceWorldPiano
|
||||
- 24 - LeisureTime
|
||||
- 25 - ChildHood
|
||||
- 26 - MorningStreamLiet
|
||||
- 27 - MusicBox
|
||||
- 28 - Orange
|
||||
- 29 - Thinker
|
||||
- Custom ringtones (uploaded by the Mi Home app) starting from 10001
|
||||
|
||||
#### {% linkable_title Service xiaomi_aqara.stop_ringtone %}
|
||||
|
||||
Stops a playing ringtone immediately.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||
|
||||
#### {% linkable_title Service xiaomi_aqara.add_device %}
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||
|
||||
#### {% linkable_title Service xiaomi_aqara.add_device %}
|
||||
|
||||
Enables the join permission of the Xiaomi Aqara Gateway for 30 seconds. A new device can be added afterwards by pressing the pairing button once.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||
|
||||
#### {% linkable_title Service xiaomi_aqara.remove_device %}
|
||||
|
||||
Removes a specific device. The removal is required if a device shall be paired with another gateway.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||
| `device_id` | no | Hardware address of the device to remove |
|
||||
|
||||
## {% linkable_title Examples %}
|
||||
|
||||
### Long Press on Smart Button
|
||||
### {% linkable_title Long Press on Smart Button %}
|
||||
|
||||
This example plays the sound of a dog barking when the button is held down, and stops the sound when the button is pressed once.
|
||||
|
||||
This example plays the sound of a dog barking when the button is held down,
|
||||
and stops the sound when the button is pressed once.
|
||||
*Note: The sound will stop playing automatically when it has ended.*
|
||||
|
||||
```yaml
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue