Merge branch 'current' into next

This commit is contained in:
Fabian Affolter 2019-01-27 23:38:52 +01:00
commit c3e094fdce
No known key found for this signature in database
GPG Key ID: E23CD2DD36A4397F
111 changed files with 1673 additions and 2136 deletions

View File

@ -144,8 +144,8 @@ social:
# Home Assistant release details
current_major_version: 0
current_minor_version: 86
current_patch_version: 1
date_released: 2019-01-24
current_patch_version: 3
date_released: 2019-01-26
# Either # or the anchor link to latest release notes in the blog post.
# Must be prefixed with a # and have double quotes around it.

View File

@ -11,7 +11,7 @@ footer: true
Sets up an SSL proxy with NGINX and redirect port 80 to 443. Make sure you have generated a certificate before you start this add-on.
In the `http` section of the `configuration.yaml` file remove `ssl_certificate` and `ssl_key` and don't enter the port in the `base_url` to avoid an HTTP 502 error.
In the `http` section of the `configuration.yaml` file remove `ssl_certificate`, `ssl_key` and `server_port` and don't enter the port in the `base_url` to avoid an HTTP 502 error.
```json
{

View File

@ -92,6 +92,8 @@ code:
type: string
{% endconfiguration %}
For more information about the configuration including protocols, see the [telldus documentation](https://developer.telldus.com/wiki/TellStick_conf).
## {% linkable_title Service calls %}
If you wish to teach a self-learning device in your TellStick configuration:

View File

@ -1,16 +0,0 @@
---
layout: page
title: "Ecobee Binary Sensor"
description: "Instructions on how to setup the Ecobee sensors within Home Assistant."
date: 2015-11-30 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ecobee.png
ha_category: Environment
ha_release: 0.9
ha_iot_class: "Local Push"
---
To get your Ecobee binary sensors working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/).

View File

@ -1,76 +0,0 @@
---
layout: page
title: "EnOcean Binary Sensor"
description: "Instructions on how to set up EnOcean binary sensors within Home Assistant."
date: 2016-05-25 23:49
sidebar: true
comments: false
sharing: true
footer: true
logo: enocean.png
ha_category: Binary Sensor
ha_release: 0.21
ha_iot_class: "Local Push"
---
This can typically be one of those batteryless wall switches.
Tested with:
- Eltako FT55 which uses the EnOcean PTM 215 module
- [TRIO2SYS Wall switches](http://www.trio2sys.fr/index.php/fr/produits-enocean-sans-fil-sans-pile-interoperable/emetteur-sans-fils-sans-pile-interoperable-enocean) which uses the EnOcean PTM210 DB module
All switches using theses modules are expected to work. Other devices will most likely not work without changing the Home Assistant code.
## {% linkable_title Configuration %}
To use your EnOcean device, you first have to set up your [EnOcean hub](/components/enocean/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: enocean
id: [0x01,0x90,0x84,0x3C]
```
{% configuration %}
id:
description: The ID of the device. This is the 4 bytes long number written on the dimmer.
required: true
type: list
name:
description: An identifier for the switch in the frontend.
required: false
type: string
default: EnOcean binary sensor
device_class:
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
required: false
type: device_class
{% endconfiguration %}
EnOcean binary sensors only generate 'button_pressed' events. The event data has following four fields:
- **id**: The ID of the device (see configuration).
- **pushed**: `1` for a button press, `0` for a button release.
- **which**: Always `0` when using the single rocket. `0` or `1` when using the dual rocket switch.
- **onoff**: `0` or `1` for either side of the rocket.
## {% linkable_title Automation example %}
Sample automation to switch lights on and off:
```yaml
# Example automation to turn lights on/off on button release
automation:
- alias: hall light switches
trigger:
platform: event
event_type: button_pressed
event_data:
id: [0xYY, 0xYY, 0xYY, 0xYY]
pushed: 0
action:
service_template: "{% raw %}{% if trigger.event.data.onoff %} light.turn_on {% else %} light.turn_off {%endif %}{% endraw %}"
data_template:
entity_id: "{% raw %}{% if trigger.event.data.which == 1 %} light.hall_left {% else %} light.hall_right {%endif %}{% endraw %}"
```

View File

@ -1,16 +0,0 @@
---
layout: page
title: "Fritzbox Binary Sensor"
description: "Instructions on how to integrate an AVM Fritzbox alarm sensor."
date: 2018-10-01 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: avm.png
ha_category: Binary Sensor
ha_release: "0.80"
ha_iot_class: "Local Polling"
---
To get AVM fritzbox binary sensor follow the instructions for the [Fritzbox component](/components/fritzbox/).

View File

@ -1,18 +0,0 @@
---
layout: page
title: "ISY994 Binary Sensor"
description: "Instructions on how to integrate ISY994 binary sensors into Home Assistant."
date: 2016-09-03 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: universal_devices.png
ha_category: Binary Sensor
ha_iot_class: "Local Push"
ha_release: pre 0.7
---
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) binary sensors from within Home Assistant.
They will be automatically discovered if the `isy994` component is loaded.

View File

@ -1,16 +0,0 @@
---
layout: page
title: "eQ-3 MAX! Cube binary sensors"
description: "Instructions on how to integrate eQ-3 MAX! components with Home Assistant via eQ-3 MAX! Cube."
date: 2017-02-04 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: maxcube.png
ha_category: Climate
ha_release: "0.40"
ha_iot_class: "Local Polling"
---
See instructions at the [main component](/components/maxcube/).

View File

@ -69,8 +69,8 @@ payload_not_available:
type: string
default: offline
json_attributes_topic:
description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes.
reqired: false
description: The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in [MQTT sensor](/components/sensor.mqtt/#json-attributes-topic-configuration) documentation.
required: false
type: string
qos:
description: The maximum QoS level to be used when receiving messages.

View File

@ -1,20 +0,0 @@
---
layout: page
title: "MyChevy Binary Sensor"
description: "Instructions on how to integrate Chevy Bolt binary sensors car into Home Assistant."
date: 2017-08-28 17:00
sidebar: true
comments: false
sharing: true
footer: true
logo: chevy.png
ha_category: Car
ha_release: 0.62
ha_iot_class: "Cloud Polling"
---
The `mychevy` binary sensor platform allows you to monitor your Chevy Bolt car from within Home Assistant.
The binary sensor platform will be automatically configured if the `mychevy` component is configured.
For configuration instructions, see the [`mychevy` component](/components/mychevy/) documentation.

View File

@ -1,120 +0,0 @@
---
layout: page
title: "Raspihats Binary Sensor"
description: "Instructions on how to integrate Raspihats add-on boards for Raspberry Pi into Home Assistant as a binary_sensor."
date: 2017-05-01 04:09
sidebar: true
comments: false
sharing: true
footer: true
logo: raspihats.png
ha_category: DIY
ha_release: 0.44
ha_iot_class: "Local Push"
---
The `raspihats` binary sensor platform allows you to read sensor values using the digital inputs of the [raspihats](http://www.raspihats.com/) boards.
## {% linkable_title Configuration %}
To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: raspihats
i2c_hats:
- board: DI6acDQ6rly
address: 0x60
channels:
- index: 0
name: PIR Office
invert_logic: true
device_class: motion
- index: 1
name: PIR Bedroom
```
{% configuration %}
i2c_hats:
description: An array of used I2C-HATs.
required: false
type: list
keys:
board:
description: The board name either Di16, Di6Rly6, DI16ac or DI6acDQ6rly.
required: true
type: string
address:
description: The board I2C address as HEX value.
required: true
type: string
channels:
description: Array of used digital input channels.
required: true
type: list
keys:
index:
description: Digital input channel index.
required: true
type: integer
name:
description: Friendly name to use for the frontend.
required: true
type: string
invert_logic:
description: Inverts the input logic.
required: false
default: false
type: boolean
device_class:
description: See device classes in [binary_sensor component](/components/binary_sensor/).
required: false
default: "None"
type: string
{% endconfiguration %}
## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
Enable I2c interface with the Raspberry Pi configuration utility:
```bash
# pi user environment: Enable i2c interface
$ sudo raspi-config
```
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish`.
Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
```bash
# pi user environment: Install i2c dependencies and utilities
$ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
# pi user environment: Add homeassistant user to the i2c group
$ sudo usermod -a -G i2c homeassistant
```
### {% linkable_title Check the i2c address of the sensor %}
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address:
```bash
$ /usr/sbin/i2cdetect -y 1
```
It will output a table like this:
```text
0 1 2 3 4 5 6 7 8 9 a b c d e f
00: -- -- -- -- -- -- -- -- -- -- -- -- --
10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
20: -- -- -- 23 -- -- -- -- -- -- -- -- -- -- -- --
30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
40: 40 -- -- -- -- -- UU -- -- -- -- -- -- -- -- --
50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
70: -- -- -- -- -- -- -- 77
```
For more details about the `raspihats` add-on boards for Raspberry Pi, visit [raspihats.com](http://www.raspihats.com/).

View File

@ -1,16 +0,0 @@
---
layout: page
title: "SleepIQ Binary Sensor"
description: "Instructions for how to integrate SleepIQ sensors within Home Assistant."
date: 2016-08-28 8:56
sidebar: true
comments: false
sharing: true
footer: true
logo: sleepiq.png
ha_category: Health
ha_release: 0.29
ha_iot_class: "Local Polling"
---
To get your SleepIQ binary sensors working with Home Assistant, follow the instructions for the general [SleepIQ component](/components/sleepiq/).

View File

@ -1,17 +0,0 @@
---
layout: page
title: "Tahoma Binary Sensor"
description: "Instructions on how to integrate Tahoma binary sensors into Home Assistant."
date: 2018-06-14 21:57
sidebar: true
comments: false
sharing: true
footer: true
logo: tahoma.png
ha_category: Binary Sensor
ha_release: 0.73
---
The `tahoma` binary sensor platform lets you see binary sensors added to your Tahoma Box in Home Assistant. For example smoke detectors.
Binary sensors will be added automatically. Please refer to the [component](/components/tahoma/) configuration on how to setup Tahoma.

View File

@ -1,15 +0,0 @@
---
layout: page
title: "Telldus Binary Sensor"
description: "Instructions on 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.

View File

@ -1,15 +0,0 @@
---
layout: page
title: "Zigbee Home Automation Binary Sensor"
description: "Instructions on how to setup Zigbee Home Automation binary sensors within Home Assistant."
date: 2017-02-22 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: Binary Sensor
ha_iot_class: "Local Polling"
---
To get your Zigbee binary sensors working with Home Assistant, follow the instructions for the general [Zigbee Home Automation component](/components/zha/).

View File

@ -180,7 +180,7 @@ calendar:
alias: worktime wakeup
trigger:
platform: time
at: 06:40:00
at: '06:40:00'
action:
- service: media_player.media_play
entity_id: media_player.bedroom

View File

@ -34,7 +34,6 @@ camera:
- platform: uvc
nvr: IP_ADDRESS
key: API_KEY
ssl: USE_SSL
```
{% configuration %}

View File

@ -1,291 +0,0 @@
---
layout: page
title: "Ecobee Thermostat"
description: "Instructions on how to setup the Ecobee thermostats within Home Assistant."
date: 2016-08-26 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ecobee.png
ha_category: Climate
ha_release: 0.9
ha_iot_class: "Cloud Push"
---
<p class='note'>
To get your Ecobee thermostats working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/).
</p>
## {% linkable_title Concepts %}
The Ecobee Thermostat supports the following key concepts.
The _target temperature_ is the temperature that the device attempts
to achieve. The target temperature is either determined by the
currently active climate or it may be overridden by a hold. When the
thermostat is not in auto mode, there is a single target
temperature. When the thermostat is in auto operation mode, there is a
pair of target temperatures: the lower target temperature determines
the lowest desired temperature, while the higher target temperature
determines the highest desired temperature (the thermostat will switch
between heating and cooling to keep the temperature within these
limits).
A _climate_ is a predefined or user-defined set of states that the
thermostat aims to achieve. The ecobee thermostat provides three predefined
climates: Home, Away, and Sleep. The user can define additional climates.
A _hold_ is an override of the target temperature defined in the
currently active climate. The temperature targeted in the hold mode may be
explicitly set (temperature hold), it may be derived from a reference
climate (home, away, sleep, etc.), or it may be derived from a vacation
defined by the thermostat. All holds are temporary. Temperature and
climate holds expire when the thermostat transitions to the next climate
defined in its program. A vacation hold starts at the beginning of the
defined vacation period, and expires when the vacation period ends.
When in _away mode_, the target temperature is permanently overridden by
the target temperature defined for the away climate. The away mode is a
simple way to emulate a vacation mode.
The _operation mode_ of the device is the currently active operational
modes that the Ecobee thermostat provides: heat, auxHeatOnly, cool,
auto, and off.
## {% linkable_title Attributes %}
The following attributes are provided by the Ecobee Thermostat:
`name`, `temperature_unit`, `current_temperature`, `target_temperature`,
`target_temperature_low`, `target_temperature_high`, `desired_fan_mode`,
`fan`, `current_hold_mode`, `current_operation`, `operation_list`,
`operation_mode`, `mode`, `fan_min_on_time`, `device_state_attributes`,
`is_away_mode_on`, `vacation`, `climate_list`, `aux_heat`.
The attributes `min_temp` and `max_temp` are meaningless constant values.
### {% linkable_title Attribute `name` %}
Returns the name of the Ecobee Thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the Ecobee Thermostat
### {% linkable_title Attribute `temperature_unit` %}
Returns the unit of measurement used for temperature by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the temperature unit
### {% linkable_title Attribute `current_temperature` %}
Returns the current temperature measured by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Currently measured temperature
### {% linkable_title Attribute `target_temperature` %}
Returns the target temperature of the thermostat, when the thermostat is
not in auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### {% linkable_title Attribute `target_temperature_low` %}
Returns the desired heating temperature set in the thermostat when in
auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### {% linkable_title Attribute `target_temperature_high` %}
Returns the desired cooling temperature set in the thermostat when in
auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### {% linkable_title Attribute `desired_fan_mode` %}
Returns the desired fan mode of the current operation.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'on', 'off'
### {% linkable_title Attribute `fan` %}
Returns the current fan state.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'on', 'off'
### {% linkable_title Attribute `current_hold_mode` %}
Returns the current temperature hold, if any.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'temp', 'vacation', 'home', 'away', etc., None
### {% linkable_title Attribute `current_operation` %}
Returns the current operation of the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'auto', 'cool', 'heat', 'off'
### {% linkable_title Attribute `operation_list` %}
Returns the list of available operation modes.
| Attribute type | Description |
| ---------------| ----------- |
| List of String | Available operation modes
### {% linkable_title Attribute `operation_mode` %}
Returns the current operation mode of the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Currently active operation mode
### {% linkable_title Attribute `mode` %}
Returns the climate currently active on the thermostat. The mode
is returned as the user-visible name (rather than the internally used name).
### {% linkable_title Attribute `fan_min_on_time` %}
Returns the current fan minimum on time.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Current fan minimum on time in minutes
### {% linkable_title Attribute `is_away_mode_on` %}
Returns whether the thermostat is in away mode (see the corresponding
service for more detail).
### {% linkable_title Attribute `actual humidity` %}
Returns the humidity as measured by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Current humidity
### {% linkable_title Attribute `vacation` %}
Returns the currently active vacation or `None`.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of currently active vacation |
### {% linkable_title Attribute `climate_list` %}
Returns the list of climates defined in the thermostat.
### {% linkable_title Attribute `aux_heat` %}
Returns the current auxiliary heat state.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'on', 'off'
## {% linkable_title Services %}
The following services are provided by the Ecobee Thermostat:
`set_away_mode`, `set_hold_mode`, `set_temperature`, `set_operation_mode`,
`fan_min_on_time`, `resume_program`.
The services `set_aux_heat`, `set_humidity`, `set_fan_mode`, and
`set_swing_mode` offered by the [Climate component](/components/climate/)
are not implemented for this thermostat.
### {% linkable_title Service `set_away_mode` %}
Turns the away mode on or off for the thermostat.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `away_mode` | no | 'on' or 'off'
### {% linkable_title Service `set_hold_mode` %}
Puts the thermostat into the given hold mode. For 'home', 'away', 'sleep',
and any other hold based on a reference climate, the
target temperature is taken from the reference climate.
For 'temp', the current temperature is taken as the target temperature.
When None is provided as parameter, the hold_mode is turned off.
It is not possible to set a vacation hold; such hold has to be
defined on the thermostat directly. However, a vacation hold can be
canceled.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `hold_mode` | no | `temp`, `home`, `away`, `sleep`, `None`, `smart1`, `smart2`, etc.
NOTE: If you create custom hold modes (also known as "Comfort Settings") on your ecobee.com dashboard, their hold_modes are `smart1`, `smart2`, `smart3`, etc. The number for each custom mode should match the mode's icon on your ecobee.com dashboard. Also note that the mode numbers/icons in the ecobee mobile app *may not match* the numbers/icons from the ecobee.com web dashboard. The ones on the website are the ones you shoud use to determine the correct `smartX` hold_mode IDs.
### {% linkable_title Service `set_temperature` %}
Puts the thermostat into a temporary hold at the given temperature.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `target_temp_low` | no | Desired heating target temperature (when in auto mode)
| `target_temp_high` | no | Desired cooling target temperature (when in auto mode)
| `temperature` | no | Desired target temperature (when not in auto mode)
Only the target temperatures relevant for the current operation mode need to
be provided.
### {% linkable_title Service `set_operation_mode` %}
Sets the current operation mode of the thermostat.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `operation_mode` | no | 'auto', 'auxHeatOnly', 'cool', 'heat', 'off'
### {% linkable_title Service `fan_min_on_time` %}
Sets the fan minimum on time.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `fan_min_on_time` | no | Desired fan minimum on time
### {% linkable_title Service `resume_program` %}
Resumes the currently active schedule.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `resume_all` | no | true or false

View File

@ -1,32 +0,0 @@
---
layout: page
title: "Fritzbox Thermostat"
description: "Instructions on how to integrate the AVM Fritzbox thermostat."
date: 2017-11-12 17:10
sidebar: true
comments: false
sharing: true
footer: true
logo: avm.png
ha_category: Climate
ha_release: 0.68
ha_iot_class: "Local Polling"
---
<p class='note'>
To get AVM fritzbox thermostat follow the instructions for the general [Fritzbox](/components/fritzbox/).
</p>
### {% linkable_title Attributes %}
The are several attributes that can be useful for automations and templates.
| Attribute | Description |
| --------- | ----------- |
| `device_locked` | The state of the key lock at the device.
| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface.
| `low_battery` | The low battery state indication.
| `battery_level` | The battery level (only available since Fritz!OS 7).
| `holiday_mode` | The state of the holiday mode (only available since Fritz!OS 7).
| `summer_mode` | The state of the summer mode (only available since Fritz!OS 7).
| `window_open` | The state of the window open detection (only available since Fritz!OS 7).

View File

@ -1,16 +0,0 @@
---
layout: page
title: "eQ-3 MAX! Cube thermostat"
description: "Instructions on how to integrate eQ-3 MAX! components with Home Assistant via eQ-3 MAX! Cube."
date: 2017-02-04 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: maxcube.png
ha_category: Climate
ha_release: "0.40"
ha_iot_class: "Local Polling"
---
See instructions at the [main component](/components/maxcube/).

View File

@ -8,14 +8,18 @@ comments: false
sharing: true
footer: true
logo: coinbase.png
ha_category: Finance
ha_category:
- Finance
- Sensor
ha_release: 0.61
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/sensor.coinbase/
---
The `coinbase` component lets you access account balances and exchange rates from [coinbase](https://coinbase.com).
You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the component to access relevant data.
You will need to obtain an API key from coinbase's [developer site](https://www.coinbase.com/settings/api) to use this component. You need to give read access to `wallet:accounts` in order for the component to access relevant data.
## {% linkable_title Configuration %}

View File

@ -8,8 +8,13 @@ comments: false
sharing: true
footer: true
logo: zehnder.png
ha_category: Hub
ha_category:
- Fan
- Sensor
ha_release: "0.48"
redirect_from:
- /components/fan.comfoconnect/
- /components/sensor.comfoconnect/
---
The `comfoconnect` component lets you control Zehnder ComfoAir [Q350](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q350-st)/[450](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q450-st)/[600](http://www.international.zehnder-systems.com/products-and-systems/comfosystems/zehnder-comfoair-q600-st)
@ -25,7 +30,7 @@ To set it up, add the following information to your `configuration.yaml` file:
```yaml
comfoconnect:
host: 192.168.1.213
host: IP_ADDRESS
```
{% configuration %}

View File

@ -1,17 +0,0 @@
---
layout: page
title: "ISY994 Cover"
description: "Instructions on how to integrate ISY994 covers into Home Assistant."
date: 2016-09-03 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: universal_devices.png
ha_category: Cover
ha_iot_class: "Local Push"
---
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) cover from within Home Assistant.
They will be automatically discovered if the `isy994` component is loaded.

View File

@ -1,16 +0,0 @@
---
layout: page
title: "Lutron Cover"
description: "Instructions on how to setup the Lutron shades within Home Assistant."
date: 2018-01-11 20:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lutron.png
ha_category: Cover
ha_iot_class: "Local Polling"
ha_release: 0.61
---
To get your Lutron roller shades working with Home Assistant, follow the instructions for the general [Lutron component](/components/lutron/).

View File

@ -1,22 +0,0 @@
---
layout: page
title: "Lutron Caseta Cover"
description: "Instructions on how to setup the Lutron Caseta covers within Home Assistant."
date: 2017-05-20 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lutron.png
ha_category: Cover
ha_iot_class: "Local Polling"
ha_release: 0.45
---
To get Lutron Caseta roller and honeycomb shades working with Home Assistant, first follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).
After setup, shades will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a shade called 'Living Room Window' will appear in Home Assistant as `cover.living_room_window`.
For more information on working with shades in Home Assistant, see the [Covers component](/components/cover/).
Available services: `cover.open_cover`, `cover.close_cover` and `cover.set_cover_position`. Cover `position` ranges from `0` for fully closed to `100` for fully open.

View File

@ -83,7 +83,7 @@ state_closed:
position_topic:
description: The MQTT topic subscribed to receive cover position messages. If `position_topic` is set `state_topic` is ignored.
required: false
type: integer
type: string
position_open:
description: Number which represents open position.
required: false

View File

@ -1,17 +0,0 @@
---
layout: page
title: "Tahoma Cover"
description: "Instructions on how to integrate Tahoma covers into Home Assistant."
date: 2017-07-18 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: tahoma.png
ha_category: Cover
ha_release: 0.59
---
The `tahoma` cover platform lets you control covers added to your Tahoma Box in Home Assistant.
Covers will be added automatically. Please refer to the [component](/components/tahoma/) configuration on how to setup Tahoma.

View File

@ -1,16 +0,0 @@
---
layout: page
title: "Telldus Live Cover"
description: "Instructions on how to integrate Telldus Live Covers into Home Assistant."
date: 2016-01-17 15:49
sidebar: true
comments: false
sharing: true
footer: true
logo: telldus.png
ha_category: Cover
featured: false
---
Integrates Telldus Live Covers into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions.

View File

@ -23,23 +23,24 @@ The following OID examples pull the current MAC Address table from a router. Thi
| Brand | Device/Firmware | OID |
|---|---|---|---|
| Aerohive | AP230 | `1.3.6.1.4.1.26928.1.1.1.2.1.2.1.1` |
| Apple | Airport Express (2nd gen.) 7.6.9 | `1.3.6.1.2.1.3.1.1.2` or `1.3.6.1.2.1.4.22.1.2`|
| Aruba | IAP325 on AOS 6.5.4.8 | `1.3.6.1.4.1.14823.2.3.3.1.2.4.1.1` |
| BiPAC | 7800DXL Firmware 2.32e | `1.3.6.1.2.1.17.7.1.2.2.1.1` |
| DD-WRT | unknown version/model | `1.3.6.1.2.1.4.22.1.2` |
| Mikrotik | unknown RouterOS version/model | `1.3.6.1.4.1.14988.1.1.1.2.1.1` |
| Mikrotik | RouterOS 6.x on RB2011 | `1.3.6.1.2.1.4.22.1.2` |
| Aruba | IAP325 on AOS 6.5.4.8 | `1.3.6.1.4.1.14823.2.3.3.1.2.4.1.1` |
| pfSense | 2.2.4 | `1.3.6.1.2.1.4.22.1.2` |
| BiPAC | 7800DXL Firmware 2.32e | `1.3.6.1.2.1.17.7.1.2.2.1.1` |
| OpenWrt | Chaos Calmer 15.05 | `1.3.6.1.2.1.4.22.1.2` |
| pfSense | 2.2.4 | `1.3.6.1.2.1.4.22.1.2` |
| Ruckus | ZoneDirector 9.13.3 | `1.3.6.1.4.1.25053.1.2.2.1.1.3.1.1.1.6` |
| TP-Link | Archer VR2600v | `1.3.6.1.2.1.3.1.1.2.19.1` |
| TP-Link | Archer VR600 | `1.3.6.1.2.1.3.1.1.2` |
| EdgeRouter | Lite v1.9.0 | `1.3.6.1.2.1.4.22.1.2` |
| Ruckus | ZoneDirector 9.13.3 | `1.3.6.1.4.1.25053.1.2.2.1.1.3.1.1.1.6` |
| DD-WRT | unknown RouterOS version/model | `1.3.6.1.2.1.4.22.1.2` |
| Apple Airport Express (2nd gen.) | 7.6.9 | `1.3.6.1.2.1.3.1.1.2` or `1.3.6.1.2.1.4.22.1.2`|
| Ubiquiti | Edgerouter Lite v1.9.0 | `1.3.6.1.2.1.4.22.1.2` |
To use the SNMP version 1 platform in your installation, add the following to your `configuration.yaml` file:
To use the SNMP version 1 or 2c platform in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry for SNMP version 1
# Example configuration.yaml entry for SNMP version 1 or 2c
device_tracker:
- platform: snmp
host: 192.168.1.1

View File

@ -1,6 +1,6 @@
---
layout: page
title: "ecobee"
title: "Ecobee"
description: "Instructions for how to integrate Ecobee thermostats and sensors within Home Assistant."
date: 2015-11-30 17:54
sidebar: true
@ -8,14 +8,27 @@ comments: false
sharing: true
footer: true
logo: ecobee.png
ha_category: Hub
ha_category:
- Sensor
- Binary Sensor
- Notify
- Climate
- Weather
featured: true
ha_release: 0.9
ha_iot_class: "Cloud Push"
redirect_from:
- /components/sensor.ecobee/
- /components/binary_sensor.ecobee/
- /components/notify.ecobee/
- /components/climate.ecobee/
- /components/weather.ecobee/
---
The `ecobee` component lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats.
## {% linkable_title Configuration %}
You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. To get the key, first you need to register your thermostat which should be done as part of the ecobee installation. Once you have done that perform the following steps.
1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/developers/).
@ -24,7 +37,7 @@ You will need to obtain an API key from ecobee's [developer site](https://www.ec
4. Fill in the fields.
5. Click **save**.
Now login to the regular consumer portal, and in the hamburger menu there will be a new option **Developer**. Now we can create the Application to hook up to Home Assistant.
Now login to the regular consumer portal, and in the hamburger menu there will be a new option **Developer**. Now we can create the Application to hook up to Home Assistant.
1. Select the Developer option.
2. Select **Create New**.
@ -33,11 +46,11 @@ Now login to the regular consumer portal, and in the hamburger menu there will b
5. You don't need an Application Icon or Detailed Description.
6. Click **Create**.
Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the **X** to close the Developer section.
Now under the Name and Summary Section you will have an API key. Copy this key and use it in you configuration section below. Click the **X** to close the Developer section.
The first time you run Home Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar.
The first time you run Home Assistant with this component it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar.
The PIN can be found from the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in states in the portal.
The PIN can be found from the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in states in the portal.
- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this you can temporarily comment out the `default_view` section or add the `configurator.ecobee` component to your `default_view` and restart Home Assistant.
@ -48,7 +61,7 @@ To set it up, add the following information to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
ecobee:
api_key: YOUR_API_KEY
api_key: YOUR_API_KEY
```
{% configuration %}
@ -69,3 +82,296 @@ hold_temp:
</p>
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.
## {% linkable_title Notifications %}
To get your Ecobee notifications working with Home Assistant, you must first have the main Ecobee component loaded and running. Once you have that configured, you can setup this component to send messages to your Ecobee device.
To use this notification platform in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
notify:
- name: NOTIFIER_NAME
platform: ecobee
```
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: "`notify`"
type: string
{% endconfiguration %}
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
## {% linkable_title Thermostat %}
### {% linkable_title Concepts %}
The Ecobee Thermostat supports the following key concepts.
The _target temperature_ is the temperature that the device attempts
to achieve. The target temperature is either determined by the
currently active climate or it may be overridden by a hold. When the
thermostat is not in auto mode, there is a single target
temperature. When the thermostat is in auto operation mode, there is a
pair of target temperatures: the lower target temperature determines
the lowest desired temperature, while the higher target temperature
determines the highest desired temperature (the thermostat will switch
between heating and cooling to keep the temperature within these
limits).
A _climate_ is a predefined or user-defined set of states that the
thermostat aims to achieve. The ecobee thermostat provides three predefined
climates: Home, Away, and Sleep. The user can define additional climates.
A _hold_ is an override of the target temperature defined in the
currently active climate. The temperature targeted in the hold mode may be
explicitly set (temperature hold), it may be derived from a reference
climate (home, away, sleep, etc.), or it may be derived from a vacation
defined by the thermostat. All holds are temporary. Temperature and
climate holds expire when the thermostat transitions to the next climate
defined in its program. A vacation hold starts at the beginning of the
defined vacation period, and expires when the vacation period ends.
When in _away mode_, the target temperature is permanently overridden by
the target temperature defined for the away climate. The away mode is a
simple way to emulate a vacation mode.
The _operation mode_ of the device is the currently active operational
modes that the Ecobee thermostat provides: heat, auxHeatOnly, cool,
auto, and off.
## {% linkable_title Attributes %}
The following attributes are provided by the Ecobee Thermostat:
`name`, `temperature_unit`, `current_temperature`, `target_temperature`,
`target_temperature_low`, `target_temperature_high`, `desired_fan_mode`,
`fan`, `current_hold_mode`, `current_operation`, `operation_list`,
`operation_mode`, `mode`, `fan_min_on_time`, `device_state_attributes`,
`is_away_mode_on`, `vacation`, `climate_list`, `aux_heat`.
The attributes `min_temp` and `max_temp` are meaningless constant values.
### {% linkable_title Attribute `name` %}
Returns the name of the Ecobee Thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the Ecobee Thermostat
### {% linkable_title Attribute `temperature_unit` %}
Returns the unit of measurement used for temperature by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of the temperature unit
### {% linkable_title Attribute `current_temperature` %}
Returns the current temperature measured by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Currently measured temperature
### {% linkable_title Attribute `target_temperature` %}
Returns the target temperature of the thermostat, when the thermostat is
not in auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### {% linkable_title Attribute `target_temperature_low` %}
Returns the desired heating temperature set in the thermostat when in
auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### {% linkable_title Attribute `target_temperature_high` %}
Returns the desired cooling temperature set in the thermostat when in
auto operation mode.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Target temperature
### {% linkable_title Attribute `desired_fan_mode` %}
Returns the desired fan mode of the current operation.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'on', 'off'
### {% linkable_title Attribute `fan` %}
Returns the current fan state.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'on', 'off'
### {% linkable_title Attribute `current_hold_mode` %}
Returns the current temperature hold, if any.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'temp', 'vacation', 'home', 'away', etc., None
### {% linkable_title Attribute `current_operation` %}
Returns the current operation of the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'auto', 'cool', 'heat', 'off'
### {% linkable_title Attribute `operation_list` %}
Returns the list of available operation modes.
| Attribute type | Description |
| ---------------| ----------- |
| List of String | Available operation modes
### {% linkable_title Attribute `operation_mode` %}
Returns the current operation mode of the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| String | Currently active operation mode
### {% linkable_title Attribute `mode` %}
Returns the climate currently active on the thermostat. The mode
is returned as the user-visible name (rather than the internally used name).
### {% linkable_title Attribute `fan_min_on_time` %}
Returns the current fan minimum on time.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Current fan minimum on time in minutes
### {% linkable_title Attribute `is_away_mode_on` %}
Returns whether the thermostat is in away mode (see the corresponding
service for more detail).
### {% linkable_title Attribute `actual humidity` %}
Returns the humidity as measured by the thermostat.
| Attribute type | Description |
| ---------------| ----------- |
| Integer | Current humidity
### {% linkable_title Attribute `vacation` %}
Returns the currently active vacation or `None`.
| Attribute type | Description |
| ---------------| ----------- |
| String | Name of currently active vacation |
### {% linkable_title Attribute `climate_list` %}
Returns the list of climates defined in the thermostat.
### {% linkable_title Attribute `aux_heat` %}
Returns the current auxiliary heat state.
| Attribute type | Description |
| ---------------| ----------- |
| String | 'on', 'off'
## {% linkable_title Services %}
The following services are provided by the Ecobee Thermostat:
`set_away_mode`, `set_hold_mode`, `set_temperature`, `set_operation_mode`,
`fan_min_on_time`, `resume_program`.
The services `set_aux_heat`, `set_humidity`, `set_fan_mode`, and
`set_swing_mode` offered by the [Climate component](/components/climate/)
are not implemented for this thermostat.
### {% linkable_title Service `set_away_mode` %}
Turns the away mode on or off for the thermostat.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `away_mode` | no | 'on' or 'off'
### {% linkable_title Service `set_hold_mode` %}
Puts the thermostat into the given hold mode. For 'home', 'away', 'sleep',
and any other hold based on a reference climate, the
target temperature is taken from the reference climate.
For 'temp', the current temperature is taken as the target temperature.
When None is provided as parameter, the hold_mode is turned off.
It is not possible to set a vacation hold; such hold has to be
defined on the thermostat directly. However, a vacation hold can be
canceled.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `hold_mode` | no | `temp`, `home`, `away`, `sleep`, `None`, `smart1`, `smart2`, etc.
NOTE: If you create custom hold modes (also known as "Comfort Settings") on your ecobee.com dashboard, their hold_modes are `smart1`, `smart2`, `smart3`, etc. The number for each custom mode should match the mode's icon on your ecobee.com dashboard. Also note that the mode numbers/icons in the ecobee mobile app *may not match* the numbers/icons from the ecobee.com web dashboard. The ones on the website are the ones you shoud use to determine the correct `smartX` hold_mode IDs.
### {% linkable_title Service `set_temperature` %}
Puts the thermostat into a temporary hold at the given temperature.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `target_temp_low` | no | Desired heating target temperature (when in auto mode)
| `target_temp_high` | no | Desired cooling target temperature (when in auto mode)
| `temperature` | no | Desired target temperature (when not in auto mode)
Only the target temperatures relevant for the current operation mode need to
be provided.
### {% linkable_title Service `set_operation_mode` %}
Sets the current operation mode of the thermostat.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `operation_mode` | no | 'auto', 'auxHeatOnly', 'cool', 'heat', 'off'
### {% linkable_title Service `fan_min_on_time` %}
Sets the fan minimum on time.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `fan_min_on_time` | no | Desired fan minimum on time
### {% linkable_title Service `resume_program` %}
Resumes the currently active schedule.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `resume_all` | no | true or false

View File

@ -8,9 +8,19 @@ comments: false
sharing: true
footer: true
logo: enocean.png
ha_category: Hub
ha_category:
- Hub
- Binary Sensor
- Sensor
- Light
- Switch
ha_release: 0.21
ha_iot_class: "Local Push"
redirect_from:
- /components/binary_sensor.enocean/
- /components/sensor.enocean/
- /components/light.enocean/
- /components/switch.enocean/
---
The [EnOcean](https://en.wikipedia.org/wiki/EnOcean) standard is supported by many different vendors. There are switches and sensors of many different kinds, and typically they employ energy harvesting to get power such that no batteries are necessary.
@ -19,10 +29,10 @@ The `enocean` component adds support for some of these devices. You will need a
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](/components/binary_sensor.enocean/) (wall switches)
- [Sensor](/components/sensor.enocean/) (power meters)
- [Light](/components/light.enocean/) (dimmers)
- [Switch](/components/switch.enocean/)
- Binary Sensor (wall switches)
- Sensor (power meters)
- Light (dimmers)
- Switch
However, only a few devices have been confirmed to work. These are:
@ -47,3 +57,168 @@ device:
required: true
type: string
{% endconfiguration %}
## {% linkable_title Binary Sensor %}
This can typically be one of those batteryless wall switches.
Tested with:
- Eltako FT55 which uses the EnOcean PTM 215 module
- [TRIO2SYS Wall switches](http://www.trio2sys.fr/index.php/fr/produits-enocean-sans-fil-sans-pile-interoperable/emetteur-sans-fils-sans-pile-interoperable-enocean) which uses the EnOcean PTM210 DB module
All switches using theses modules are expected to work. Other devices will most likely not work without changing the Home Assistant code.
## {% linkable_title Configuration %}
To use your EnOcean device, you first have to set up your [EnOcean hub](/components/enocean/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: enocean
id: [0x01,0x90,0x84,0x3C]
```
{% configuration %}
id:
description: The ID of the device. This is the 4 bytes long number written on the dimmer.
required: true
type: list
name:
description: An identifier for the switch in the frontend.
required: false
type: string
default: EnOcean binary sensor
device_class:
description: The [type/class](/components/binary_sensor/) of the sensor to set the icon in the frontend.
required: false
type: device_class
{% endconfiguration %}
EnOcean binary sensors only generate 'button_pressed' events. The event data has following four fields:
- **id**: The ID of the device (see configuration).
- **pushed**: `1` for a button press, `0` for a button release.
- **which**: Always `0` when using the single rocket. `0` or `1` when using the dual rocket switch.
- **onoff**: `0` or `1` for either side of the rocket.
## {% linkable_title Automation example %}
Sample automation to switch lights on and off:
```yaml
# Example automation to turn lights on/off on button release
automation:
- alias: hall light switches
trigger:
platform: event
event_type: button_pressed
event_data:
id: [0xYY, 0xYY, 0xYY, 0xYY]
pushed: 0
action:
service_template: "{% raw %}{% if trigger.event.data.onoff %} light.turn_on {% else %} light.turn_off {%endif %}{% endraw %}"
data_template:
entity_id: "{% raw %}{% if trigger.event.data.which == 1 %} light.hall_left {% else %} light.hall_right {%endif %}{% endraw %}"
```
## {% linkable_title Light %}
An EnOcean light can take many forms. Currently only one type has been tested: Eltako FUD61 dimmer.
To use your EnOcean device, you first have to set up your [EnOcean hub](/components/enocean/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
- platform: enocean
id: [0x01,0x90,0x84,0x3C]
sender_id: [0xFF,0xC6,0xEA,0x04]
```
{% configuration %}
id:
description: The ID of the device. This is the 4 bytes long number written on the dimmer.
required: true
type: list
sender_id:
description: The Sender ID of the device. This is a 4 bytes long number.
required: true
type: list
name:
description: An identifier for the Ligh in the frontend.
required: false
default: EnOcean Light
type: string
{% endconfiguration %}
## {% linkable_title Sensor %}
The `enocean` sensor platform currently only allows reading out the power measured in a Permundo PSC234 switch.
To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: enocean
name: Television
id: [0x01,0x90,0x84,0x3C]
```
{% configuration %}
id:
description: The ID of the device. This is a 4 bytes long number.
required: true
type: list
name:
description: An identifier for the switch
required: true
default: EnOcean sensor
type: string
{% endconfiguration %}
## {% linkable_title Switch %}
An EnOcean switch can take many forms. Currently, only a few types have been tested: Permundo PSC234 and Nod On SIN-2-1-01.
To use your EnOcean device, you first have to set up your [EnOcean hub](/components/enocean/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: enocean
id: [0x01,0x90,0x84,0x3C]
```
{% configuration %}
id:
description: The ID of the device. This is a 4 bytes long number.
required: true
type: list
name:
description: An identifier for the switch.
required: false
default: EnOcean Switch
type: string
channel:
description: The number of the channel (typically 0 or 1) for the output channel to switch.
required: false
default: 0
type: integer
{% endconfiguration %}
```yaml
# Example entries for a switch with 2 outputs (channels), e.g., the Nod On SIN-2-1-01
switch nodon01_0:
- platform: enocean
id: [0x05,0x04,0x03,0x02]
name: enocean_nodon01_0
channel: 0
switch nodon01_1:
- platform: enocean
id: [0x05,0x04,0x03,0x02]
name: enocean_nodon01_1
channel: 1
```

View File

@ -1,17 +0,0 @@
---
layout: page
title: "Zehnder ComfoAir Q Ventilation fans"
description: "Instructions on how to integrate Zehnder ComfoAir Q350/450/600 fans into Home Assistant."
date: 2017-06-28 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: zehnder.png
ha_category: Fan
ha_release: "0.48"
---
Please see the [main component] for information how to set it up.
[main component]: /components/comfoconnect/

View File

@ -1,17 +0,0 @@
---
layout: page
title: "ISY994 Fan"
description: "Instructions on how to integrate ISY994 fans into Home Assistant."
date: 2016-09-03 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: universal_devices.png
ha_category: Fan
ha_iot_class: "Local Push"
---
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) fan from within Home Assistant.
They will be automatically discovered if the `isy994` component is loaded.

View File

@ -1,16 +0,0 @@
---
layout: page
title: "Zigbee Home Automation Fan"
description: "Instructions how to setup Zigbee Home Automation fans within Home Assistant."
date: 2018-02-10 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: Fan
ha_iot_class: "Local Polling"
ha_release: 0.66
---
To get your Zigbee fans working with Home Assistant, follow the instructions for the general [Zigbee Home Automation component](/components/zha/).

View File

@ -8,9 +8,16 @@ comments: false
sharing: true
footer: true
logo: avm.png
ha_category: Hub
ha_category:
- Binary Sensor
- Climate
- Switch
ha_release: 0.68
ha_iot_class: "Local Polling"
redirect_from:
- /components/binary_sensor.fritzbox/
- /components/switch.fritzbox/
- /components/climate.fritzbox/
---
The [AVM](https://en.avm.de) Fritzbox component for Home Assistant allows you to integrate the switch and climate devices.
@ -22,7 +29,6 @@ The [AVM](https://en.avm.de) Fritzbox component for Home Assistant allows you to
- [FRITZ!DECT 200](https://en.avm.de/products/fritzdect/fritzdect-200/)
- [Eurotronic Comet DECT](https://eurotronic.org/produkte/elektronische-heizkoerperthermostate/sparmatic-comet/)
## {% linkable_title Setup %}
```yaml
@ -53,3 +59,25 @@ devices:
required: true
type: string
{% endconfiguration %}
## {% linkable_title Switch & Thermostat %}
To get AVM Fritzbox switch and thermostat follow the instructions above.
### {% linkable_title Attributes %}
The are several attributes that can be useful for automations and templates.
| Attribute | Description |
| --------- | ----------- |
| `device_locked` | The state of the key lock at the device.
| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface.
| `low_battery` | The low battery state indication.
| `battery_level` | The battery level (only available since Fritz!OS 7).
| `holiday_mode` | The state of the holiday mode (only available since Fritz!OS 7).
| `summer_mode` | The state of the summer mode (only available since Fritz!OS 7).
| `window_open` | The state of the window open detection (only available since Fritz!OS 7).
| `temperature_unit` | The unit of the temperature sensor (only available if the device support temperature sensor).
| `temperature` | The current temperature sensor reading (only available if the device supports temperature sensor).
| `total_consumption` | The total power consumption since the beginning of operation (only available if the device supports power meter function).
| `total_consumption_unit` | The unit of the total_consumption (only available if the device supports power meter function).

View File

@ -77,7 +77,7 @@ Check our [community forums](https://community.home-assistant.io/c/projects/them
There are 2 themes-related services:
- `frontend.reload_themes`: reloads theme configuration from your `configuration.yaml` file.
- `frontend.set_theme(name)`: sets backend-preferred theme name.
- `frontend.set_theme(name)`: sets backend-preferred theme name.
Example in automation:
@ -96,7 +96,7 @@ automation:
name: happy
```
To enable "night mode":
To enable "night mode":
```yaml
automation:
@ -104,7 +104,7 @@ automation:
initial_state: true
trigger:
- platform: time
at: '21:00'
at: '21:00:00'
action:
- service: frontend.set_theme
data:

View File

@ -49,7 +49,7 @@ Right after enabling, the app will take you to the **Log to custom URL** setting
The relevant endpoint starts with: `/api/webhook/` and ends with a unique sequence of characters. This is provided by the integrations panel in the configuration screen (configured above).
```text
https://YOUR.DNS.HOSTNAME:PORT/api/webook/WEBHOOK_ID
https://YOUR.DNS.HOSTNAME:PORT/api/webhook/WEBHOOK_ID
```
- Add the above URL (updating YOUR.DNS.HOSTNAME:PORT to your details) into the **URL** field.
@ -60,7 +60,7 @@ https://YOUR.DNS.HOSTNAME:PORT/api/webook/WEBHOOK_ID
```text
latitude=%LAT&longitude=%LON&device=%SER&accuracy=%ACC&battery=%BATT&speed=%SPD&direction=%DIR&altitude=%ALT&provider=%PROV&activity=%ACT
```
- You can change the name of your device name by replacing `&device=%SER` with `&device=DEVICE_NAME`.
- You can change the name of your device name by replacing `&device=%SER` with `&device=%DEVICE_NAME`.
- Check that the **HTTP Headers** setting contains
```text
Content-Type: application/x-www-form-urlencoded

View File

@ -8,14 +8,40 @@ comments: false
sharing: true
footer: true
logo: universal_devices.png
ha_category: Hub
ha_category:
- Hub
- Binary Sensor
- Cover
- Fan
- Light
- Lock
- Sensor
- Switch
ha_release: 0.28
ha_iot_class: "Local Push"
redirect_from:
- /components/binary_sensor.isy994/
- /components/cover.isy994/
- /components/fan.isy994/
- /components/light.isy994/
- /components/lock.isy994/
- /components/sensor.isy994/
- /components/switch.isy994/
---
The ISY994 is a home automation controller that is capable of controlling Insteon and X10 devices. Some models of the ISY994 can even control Z-Wave devices.
The ISY994 controller is manufactured by [Universal Devices](https://www.universal-devices.com/residential/isy994i-series/).
There is currently support for the following device types within Home Assistant:
- Binary Sensor
- Cover
- Light
- Fan
- Lock
- Sensor
- Switch
### {% linkable_title Basic Configuration %}
Home Assistant is capable of communicating with any binary sensor, cover, fan, light, lock, sensor and switch that is configured on the controller. Using the programs on the controller, custom binary sensors, cover, fan, lock, and switches can also be created.

View File

@ -1,43 +0,0 @@
---
layout: page
title: "EnOcean Light"
description: "Instructions on how to set up EnOcean lights within Home Assistant."
date: 2016-05-25 23:49
sidebar: true
comments: false
sharing: true
footer: true
logo: enocean.png
ha_category: Light
ha_release: 0.21
ha_iot_class: "Local Push"
---
An EnOcean light can take many forms. Currently only one type has been tested: Eltako FUD61 dimmer.
To use your EnOcean device, you first have to set up your [EnOcean hub](/components/enocean/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
light:
- platform: enocean
id: [0x01,0x90,0x84,0x3C]
sender_id: [0xFF,0xC6,0xEA,0x04]
```
{% configuration %}
id:
description: The ID of the device. This is the 4 bytes long number written on the dimmer.
required: true
type: list
sender_id:
description: The Sender ID of the device. This is a 4 bytes long number.
required: true
type: list
name:
description: An identifier for the Ligh in the frontend.
required: false
default: EnOcean Light
type: string
{% endconfiguration %}

View File

@ -67,7 +67,7 @@ devices:
{% endconfiguration %}
<p class='note'>
Depending on your controller or bulb type, there are two ways to configure brightness.
Depending on your controller or bulb type, there are two ways to configure brightness.
The component defaults to rgbw. If your device has a separate white channel, you do not need to specify anything else; changing the white value will adjust the brightness of white channel keeping rgb color constant. However, if your device does not have a separate white channel, you will need to set the mode to rgb. In this mode, the device will keep the same color, and adjust the rgb values to dim or brighten the color.
</p>
@ -98,7 +98,7 @@ light:
automation:
alias: random_flux_living_room_lamp
trigger:
platform: time
platform: time_pattern
seconds: '/45'
action:
service: light.turn_on

View File

@ -1,17 +0,0 @@
---
layout: page
title: "ISY994 Light"
description: "Instructions on how to integrate ISY994 lights into Home Assistant."
date: 2016-09-03 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: universal_devices.png
ha_category: Light
ha_iot_class: "Local Push"
---
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) light from within Home Assistant.
They will be automatically discovered if the `isy994` component is loaded.

View File

@ -1,18 +0,0 @@
---
layout: page
title: "Lightwave Light"
description: "Instructions on how to integrate Lightwave lights with Home Assistant."
date: 2018-12-05 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lightwave.png
ha_category: Light
ha_release: 0.84
ha_iot_class: "Assumed State"
---
The `lightwave` light platform integrates your Lightwave lights into Home Assistant.
<p class='note'>
Configuration details for the Lightwave platform can be found on the main [Lightwave component](/components/lightwave/) page.
</p>

View File

@ -1,15 +0,0 @@
---
layout: page
title: "LiteJet Light"
description: "Instructions on how to setup the LiteJet lights within Home Assistant."
date: 2016-10-26 13:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Light
ha_release: 0.32
ha_iot_class: "Local Polling"
---
To get your LiteJet lights working with Home Assistant, follow the instructions for the general [LiteJet component](/components/litejet/).

View File

@ -1,15 +0,0 @@
---
layout: page
title: "Lutron Light"
description: "Instructions on how to setup the Lutron lights within Home Assistant."
date: 2017-04-30 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lutron.png
ha_category: Light
ha_iot_class: "Local Polling"
---
To get your Lutron lights working with Home Assistant, follow the instructions for the general [Lutron component](/components/lutron/).

View File

@ -1,23 +0,0 @@
---
layout: page
title: "Lutron Caseta Light"
description: "Instructions on how to setup the Lutron Caseta lights within Home Assistant."
date: 2017-04-30 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lutron.png
ha_category: Light
ha_iot_class: "Local Polling"
---
To get Lutron Caseta lights working with Home Assistant, follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).
After setup, dimmable lights including wall and plug-in dimmers will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a light called 'Bedroom Lamp' will appear in Home Assistant as `light.bedroom_lamp`.
For non-dimmable lights or switched loads, see [Lutron Caseta Switch](/components/switch.lutron_caseta/).
For more information on working with lights in Home Assistant, see the [Lights component](/components/light/).
Available services: `light.turn_on`, `light.turn_off` and `light.toggle`. The `light.turn_on` service supports attributes `brightness` and `brightness_pct`.

View File

@ -1,16 +0,0 @@
---
layout: page
title: "Telldus Live Light"
description: "Instructions on how to integrate Telldus Live Lights into Home Assistant."
date: 2016-01-17 15:49
sidebar: true
comments: false
sharing: true
footer: true
logo: telldus.png
ha_category: Light
featured: false
---
Integrates Telldus Live Lights into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions.

View File

@ -1,15 +0,0 @@
---
layout: page
title: "Zigbee Home Automation Light"
description: "Instructions on how to setup Zigbee Home Automation lights within Home Assistant."
date: 2017-02-22 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: Light
ha_iot_class: "Local Polling"
---
To get your Zigbee lights working with Home Assistant, follow the instructions for the general [Zigbee Home Automation component](/components/zha/).

View File

@ -8,13 +8,22 @@ comments: false
sharing: true
footer: true
logo: lightwave.png
ha_category: Hub
ha_category:
- Hub
- Light
- Switch
ha_release: 0.84
ha_iot_class: "Assumed State"
redirect_from:
- /components/light.lightwave/
- /components/switch.lightwave/
---
The `lightwave` component links Home Assistant with your Lightwave WiFi link for controlling Lightwave lights and switches.
The `lightwave` component links Home Assistant with your Lightwave WiFi link for controlling Lightwave lights and switches.
This component uses the official API published by Lightwave on their website [https://api.lightwaverf.com/](https://api.lightwaverf.com/).
To add your Lightwave devices into your Home Assistant installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
lightwave:
@ -45,5 +54,6 @@ Each `switch` or `light` requires an `id` and a `name`. The `id` takes the form
The first use of a light or switch will try to register with your Lightwave WiFi Link hub. If the hub has not been registered a message on your hub will be displayed asking you to pair the device. You have 12 seconds to push the button on your hub to accept this. Once done, you should be able to control your lights and switches via Home Assistant. This only needs to be done if the hub has not been registered.
The Lightwave Home Assistant component currently supports the following Lightwave devices:
- Lightwave lights
- Lightwave switches

View File

@ -7,9 +7,16 @@ sidebar: true
comments: false
sharing: true
footer: true
ha_category: Hub
ha_category:
- Light
- Scene
- Switch
ha_iot_class: "Local Push"
ha_release: 0.32
redirect_from:
- /components/light.litejet/
- /components/scene.litejet/
- /components/switch.litejet/
---
LiteJet is a centralized lighting system that predates most home automation technology. All lights and wall switches are wired to a central panel. This central panel has a serial port interface that allows a computer to control the system via LiteJet's third party protocol.

View File

@ -1,17 +0,0 @@
---
layout: page
title: "ISY994 Lock"
description: "Instructions on how to integrate ISY994 locks into Home Assistant."
date: 2016-09-03 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: universal_devices.png
ha_category: Lock
ha_iot_class: "Local Push"
---
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) lock from within Home Assistant.
They will be automatically discovered if the `isy994` component is loaded.

View File

@ -8,15 +8,25 @@ comments: false
sharing: true
footer: true
logo: lutron.png
ha_category: Hub
ha_category:
- Hub
- Cover
- Light
- Scene
- Switch
featured: false
ha_release: 0.37
ha_iot_class: "Local Polling"
redirect_from:
- /components/cover.lutron/
- /components/light.lutron/
- /components/scene.lutron/
- /components/switch.lutron/
---
[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches/dimmers, occupancy sensors, HVAC controls, etc. The `lutron` component in Home Assistant is responsible for communicating with the main hub for these systems.
Presently, there's only support for communicating with the [RadioRA 2](http://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RadioRA2/Overview.aspx) Main Repeater and only handle light switches and dimmers.
Presently, there's only support for communicating with the [RadioRA 2](http://www.lutron.com/en-US/Products/Pages/WholeHomeSystems/RadioRA2/Overview.aspx) Main Repeater and only handle light switches, dimmers, and seeTouch keypad scenes.
## {% linkable_title Configuration %}
@ -62,3 +72,11 @@ The `action` attribute varies depending on the button type.
For raise/lower buttons (dimmer buttons, shade controls, etc.) there will be two values, `pressed` and `released`, fired when the button is pressed and when it's released, respectively.
For single-action buttons (scene selection, etc.), `action` will be `single`, and there will only be one event fired. This is a limitation of the Lutron controller which doesn't give Home Assistant any way of knowing when a single-action button is released.
## {% linkable_title Scene %}
This component uses keypad programming to identify scenes. Currently, it only works with SeeTouch keypads.
The Lutron scene platform allows you to control scenes programmed into your SeeTouch keypads.
After setup, scenes will appear in Home Assistant using the area, keypad and button name.

View File

@ -8,10 +8,20 @@ comments: false
sharing: true
footer: true
logo: lutron.png
ha_category: Hub
ha_category:
- Hub
- Cover
- Light
- Scene
- Switch
featured: false
ha_release: 0.41
ha_iot_class: "Local Polling"
redirect_from:
- /components/cover.lutron_caseta/
- /components/light.lutron_caseta/
- /components/scene.lutron_caseta/
- /components/switch.lutron_caseta/
---
[Lutron](http://www.lutron.com/) is an American lighting control company. They have several lines of home automation devices that manage light switches, dimmers, occupancy sensors, HVAC controls, etc. The `lutron_caseta` component in Home Assistant is responsible for communicating with the Lutron Caseta Smart Bridge for the [Caseta](http://www.casetawireless.com) product line of dimmers, switches and shades.
@ -20,10 +30,10 @@ This component only supports the [Caseta](http://www.casetawireless.com) line of
The currently supported Caseta devices are:
- Wall and plug-in dimmers as Home Assistant [lights](/components/light.lutron_caseta/)
- Wall switches as Home Assistant [switches](/components/switch.lutron_caseta/)
- Scenes as Home Assistant [scenes](/components/scene.lutron_caseta/)
- Lutron shades as Home Assistant [covers](/components/cover.lutron_caseta/)
- Wall and plug-in dimmers as Home Assistant
- Wall switches as Home Assistant
- Scenes as Home Assistant
- Lutron shades as Home Assistant
When configured, the `lutron_caseta` component will automatically discover the currently supported devices as setup in the Lutron Smart Bridge. The name assigned in the Lutron mobile app will be used to form the `entity_id` used in Home Assistant. e.g., a dimmer called 'Lamp' in a room called 'Bedroom' becomes `light.bedroom_lamp` in Home Assistant.
@ -64,3 +74,43 @@ It is recommended to assign a static IP address to your Lutron Smart Bridge. Thi
<br>
Use a DHCP reservation on your router to reserve the address or in the PRO model of the Smart Bridge, set the IP address under Network Settings in the Advanced / Integration menu in the mobile app.
</p>
To get Lutron Caseta roller, honeycomb shades, lights, scene and switch working with Home Assistant. First follow the instructions for the general Lutron Caseta component above.
## {% linkable_title Cover %}
After setup, shades will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a shade called 'Living Room Window' will appear in Home Assistant as `cover.living_room_window`.
For more information on working with shades in Home Assistant, see the [Covers component](/components/cover/).
Available services: `cover.open_cover`, `cover.close_cover` and `cover.set_cover_position`. Cover `position` ranges from `0` for fully closed to `100` for fully open.
## {% linkable_title Light %}
After setup, dimmable lights including wall and plug-in dimmers will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a light called 'Bedroom Lamp' will appear in Home Assistant as `light.bedroom_lamp`.
For non-dimmable lights or switched loads, see the switch section on this page.
For more information on working with lights in Home Assistant, see the [Lights component](/components/light/).
Available services: `light.turn_on`, `light.turn_off` and `light.toggle`. The `light.turn_on` service supports attributes `brightness` and `brightness_pct`.
## {% linkable_title Scene %}
The Lutron Caseta scene platform allows you to control your Smart Bridge Scenes that are created in the Lutron mobile app.
After setup, scenes will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a scene called 'Entertain' will appear in Home Assistant as `scene.entertain`.
For more information on working with scenes in Home Assistant, see the [Scenes component](/components/scene/).
Available services: `scene.turn_on`.
## {% linkable_title Switch %}
After setup, switches will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a light switch called 'Master Bathroom Vanity' will appear in Home Assistant as `switch.master_bathroom_vanity`.
For dimmable lights including wall and plug-in dimmers, see the light section on this page.
For more information on working with switches in Home Assistant, see the [Switches component](/components/switch/).
Available services: `switch.turn_on` and `switch.turn_off`.

View File

@ -8,18 +8,30 @@ comments: false
sharing: true
footer: true
logo: maxcube.png
ha_category: Climate
ha_category:
- Climate
- Binary Sensor
ha_release: "0.40"
ha_iot_class: "Local Polling"
redirect_from:
- /components/binary_sensor.maxcube/
- /components/climate.maxcube/
---
[eQ-3 MAX!](http://www.eq-3.com/products/max.html) integration for Home Assistant allows you to connect eQ-3 MAX! components via the eQ-3 MAX! Cube. The components connects to the eQ-3 MAX! Cube via TCP and automatically makes all supported components available in Home Assistant. The name for each device is created by concatenating the MAX! room and device names.
There is currently support for the following device types within Home Assistant:
- Binary Sensor
- Climate
Limitations:
- Configuring weekly schedules is not possible.
- Implementation is based on the reverse engineered [MAX! protocol](https://github.com/Bouni/max-cube-protocol).
Supported Devices:
- MAX! Radiator Thermostat (tested)
- MAX! Radiator Thermostat+
- MAX! Window Sensor (tested)

View File

@ -13,16 +13,23 @@ ha_release: 0.36
ha_iot_class: "Local Polling"
---
The `nad` platform allows you to control a [NAD receiver](http://nadelectronics.com) through RS232 from Home Assistant.
The `nad` platform allows you to control a [NAD receiver](http://nadelectronics.com) through RS232, TCP and Telnet from Home Assistant.
To add an NAD receiver to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
# Example configuration.yaml entry for RS232 configuration
media_player:
- platform: nad
serial_port: /dev/ttyUSB0
```
```yaml
# Example configuration.yaml entry for TCP configuration
media_player:
- platform: nad
type: TCP
host: IP_ADDRESS
```
{% configuration %}
type:

View File

@ -11,14 +11,17 @@ logo: chevy.png
ha_category: Car
ha_release: 0.62
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/binary_sensor.mychevy/
- /components/sensor.mychevy/
---
The `mychevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using the javascript API that the website uses (as of Dec 2018). The mychevy website has been known to be both unstable (interfaces changing somewhat willy nilly) and have substantial outages. So be forwarned in using this component.
The `mychevy` component communicates with the [my.chevrolet](https://my.chevrolet.com) website using the javascript API that the website uses (as of Dec 2018). The MyChevy website has been known to be both unstable (interfaces changing somewhat willy nilly) and has substantial outages. So be forwarned in using this component.
This component provides the following platforms:
- Binary sensors: if the car is plugged in
- Sensors: Battery Level, Charge Mode, EST Range, Total Distance Traveled
- Binary sensors: if the car is plugged in
- Sensors: Battery Level, Charge Mode, EST Range, Total Distance Traveled
## {% linkable_title Configuration %}
@ -47,13 +50,12 @@ country:
type: string
{% endconfiguration %}
### {% linkable_title Limitations %}
The architecture of the GM automotive networking imposes some limitations on the functionality of the component.
The OnStar network link is very slow, and takes 1 - 3 minutes to get information back from the car. As such the mychevy component only polls every 30 minutes to not overwhelms that connection.
The OnStar network link is very slow, and takes 1 - 3 minutes to get information back from the car. As such the `mychevy` component only polls every 30 minutes to not overwhelms that connection.
The OnStar network (or more specifically the gateway used by the my.chevrolet website) appears to suffer more than most networks when the car is a) in a garage, and b) it's cold outside (like < 15 degrees F). One of the provided sensors is a status sensor which indicates if we got connectivity with the car on the last polling cycle or not.
The "API" for this is written through using some existing API calls from the Javascript web user interfae. As such, it only currently is known to work if you have a Chevy Bolt EV or a Chevy Volt, and only 1 Chevy car connected to OnStar. Patches for extended support should go to the [https://github.com/sdague/mychevy](https://github.com/sdague/mychevy) project first, then Home Assistant can be extended.
The "API" for this is written through using some existing API calls from the Javascript web user interface. As such, it only currently is known to work if you have a Chevy Bolt EV or a Chevy Volt, and only 1 Chevy car connected to OnStar. Patches for extended support should go to the [https://github.com/sdague/mychevy](https://github.com/sdague/mychevy) project first, then Home Assistant can be extended.

View File

@ -9,14 +9,10 @@ sharing: true
footer: true
logo: nest.png
ha_category: Hub
featured: false
featured: true
ha_iot_class: "Cloud Push"
---
<p class='note warning'>
Nest is [no longer accepting new developer accounts](/blog/2019/01/24/nest-cannot-access-data/). If you don't have an account already, you will not be able to sign up and access your own data.
</p>
The Nest component is the main component to integrate all [Nest](https://nest.com/) related platforms. To connect Nest, you will have to [sign up for a developer account](https://developers.nest.com/products) and get a `client_id` and `client_secret`.
### {% linkable_title Setting up developer account %}

View File

@ -1,34 +0,0 @@
---
layout: page
title: "Ecobee Notify"
description: "Instructions on how to setup the Ecobee notification component within Home Assistant."
date: 2016-05-12 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ecobee.png
ha_category: Notifications
ha_release: "0.20"
---
To get your Ecobee notifications working with Home Assistant, you must first have the main [Ecobee component](/components/ecobee/) loaded and running. Once you have that configured, you can setup this component to send messages to your Ecobee device.
To use this notification platform in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
notify:
- name: NOTIFIER_NAME
platform: ecobee
```
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: "`notify`"
type: string
{% endconfiguration %}
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

View File

@ -142,8 +142,7 @@ automation:
- alias: Update OpenUV every 30 minutes during the daytime
trigger:
platform: time_pattern
minutes: "/30"
seconds: 00
minutes: '/30'
condition:
condition: and
conditions:
@ -164,8 +163,7 @@ automation:
- alias: Update OpenUV every hour (24 of 50 calls per day)
trigger:
platform: time_pattern
minutes: "/60"
seconds: 00
minutes: '/60'
action:
service: openuv.update_data
```

View File

@ -8,9 +8,231 @@ comments: false
sharing: true
footer: true
logo: raspihats.png
ha_category: DIY
ha_category:
- DIY
- Binary Sensor
- Switch
ha_release: 0.45
ha_iot_class: "Local Push"
redirect_from:
- /components/binary_sensor.raspihats/
- /components/switch.raspihats/
---
The `raspihats` component is the base for all related Raspihats platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding pages.
The `raspihats` component is the base for all related Raspihats platforms in Home Assistant. There is no setup needed for the component itself.
## {% linkable_title Binary Sensor %}
The `raspihats` binary sensor platform allows you to read sensor values using the digital inputs of the [raspihats](http://www.raspihats.com/) boards.
## {% linkable_title Configuration %}
To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: raspihats
i2c_hats:
- board: DI6acDQ6rly
address: 0x60
channels:
- index: 0
name: PIR Office
invert_logic: true
device_class: motion
- index: 1
name: PIR Bedroom
```
{% configuration %}
i2c_hats:
description: An array of used I2C-HATs.
required: false
type: list
keys:
board:
description: The board name either Di16, Di6Rly6, DI16ac or DI6acDQ6rly.
required: true
type: string
address:
description: The board I2C address as HEX value.
required: true
type: string
channels:
description: Array of used digital input channels.
required: true
type: list
keys:
index:
description: Digital input channel index.
required: true
type: integer
name:
description: Friendly name to use for the frontend.
required: true
type: string
invert_logic:
description: Inverts the input logic.
required: false
default: false
type: boolean
device_class:
description: See device classes in [binary_sensor component](/components/binary_sensor/).
required: false
default: "None"
type: string
{% endconfiguration %}
## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
Enable I2c interface with the Raspberry Pi configuration utility:
```bash
# pi user environment: Enable i2c interface
$ sudo raspi-config
```
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish`.
Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
```bash
# pi user environment: Install i2c dependencies and utilities
$ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
# pi user environment: Add homeassistant user to the i2c group
$ sudo usermod -a -G i2c homeassistant
```
### {% linkable_title Check the i2c address of the sensor %}
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address:
```bash
$ /usr/sbin/i2cdetect -y 1
```
It will output a table like this:
```text
0 1 2 3 4 5 6 7 8 9 a b c d e f
00: -- -- -- -- -- -- -- -- -- -- -- -- --
10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
20: -- -- -- 23 -- -- -- -- -- -- -- -- -- -- -- --
30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
40: 40 -- -- -- -- -- UU -- -- -- -- -- -- -- -- --
50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
70: -- -- -- -- -- -- -- 77
```
For more details about the `raspihats` add-on boards for Raspberry Pi, visit [raspihats.com](http://www.raspihats.com/).
## {% linkable_title Switch %}
The `raspihats` switch platform allows you to control the digital outputs of your [Raspihats](http://www.raspihats.com/) boards.
## {% linkable_title Configuration %}
To use your Raspihats boards in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: raspihats
i2c_hats:
- board: DI6acDQ6rly
address: 0x60
channels:
- index: 0
name: Fan Office
invert_logic: true
initial_state: true
- index: 1
name: Light Office
```
{% configuration %}
i2c_hats:
description: An array of used I2C-HATs.
required: false
type: list
keys:
board:
description: The board name.
required: true
type: string
address:
description: The board I2C address as HEX value.
required: true
type: string
channels:
description: An array of used digital input channels.
required: true
type: list
keys:
index:
description: The digital input channel index.
required: true
type: integer
name:
description: The friendly name to use for the frontend.
required: true
type: string
invert_logic:
description: Inverts the input logic.
required: false
default: false
type: boolean
initial_state:
description: "The initial state, can be either `true` or `false`. `none` means no state is forced on the corresponding digital output when this switch is instantiated."
required: false
default: None
type: boolean
{% endconfiguration %}
## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
Enable I2c interface with the Raspberry Pi configuration utility:
```bash
# pi user environment: Enable i2c interface
$ sudo raspi-config
```
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish`.
Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
```bash
# pi user environment: Install i2c dependencies and utilities
$ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
# pi user environment: Add homeassistant user to the i2c group
$ sudo usermod -a -G i2c homeassistant
```
## {% linkable_title Check the i2c address of the sensor %}
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address:
```bash
/usr/sbin/i2cdetect -y 1
```
It will output a table like this:
```text
0 1 2 3 4 5 6 7 8 9 a b c d e f
00: -- -- -- -- -- -- -- -- -- -- -- -- --
10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
20: -- -- -- 23 -- -- -- -- -- -- -- -- -- -- -- --
30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
40: 40 -- -- -- -- -- UU -- -- -- -- -- -- -- -- --
50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
70: -- -- -- -- -- -- -- 77
```
For more details about the Raspihats add-on boards for Raspberry Pi, visit [raspihats.com](http://www.raspihats.com/).

View File

@ -1,14 +0,0 @@
---
layout: page
title: "LiteJet Scenes"
description: "Instructions on how to setup LiteJet scenes within Home Assistant."
date: 2016-10-26 16:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Scene
ha_release: 0.32
---
To get your LiteJet scenes working with Home Assistant, follow the instructions for the general [LiteJet component](/components/litejet/).

View File

@ -1,21 +0,0 @@
---
layout: page
title: "Lutron Scene"
description: "Instructions on how to set up the Lutron scenes within Home Assistant."
date: 2018-10-09 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lutron.png
ha_category: Scene
ha_iot_class: "Local Polling"
ha_release: 0.85
---
To get your Lutron scenes working with Home Assistant, follow the instructions for the general [Lutron component](/components/lutron/).
This component uses keypad programming to identify scenes. Currently, it only works with SeeTouch keypads.
The Lutron scene platform allows you to control scenes programmed into your SeeTouch keypads.
After setup, scenes will appear in Home Assistant using the area, keypad, and button name.

View File

@ -1,24 +0,0 @@
---
layout: page
title: "Lutron Caseta Scene"
description: "Instructions on how to setup Lutron Caseta Scenes within Home Assistant."
date: 2017-07-28 16:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lutron.png
ha_category: Scene
ha_release: 0.49.2
ha_iot_class: "Cloud Polling"
---
To get Lutron Caseta Scenes working with Home Assistant, follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).
The Lutron Caseta scene platform allows you to control your Smart Bridge Scenes that are created in the Lutron mobile app.
After setup, scenes will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a scene called 'Entertain' will appear in Home Assistant as `scene.entertain`.
For more information on working with scenes in Home Assistant, see the [Scenes component](/components/scene/).
Available services: `scene.turn_on`.

View File

@ -1,17 +0,0 @@
---
layout: page
title: "Tahoma Scene"
description: "Instructions on how to integrate Tahoma scenes into Home Assistant."
date: 2018-02-18 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: tahoma.png
ha_category: Scene
ha_release: 0.64
---
The `tahoma` scene platform lets you trigger scenes added to your Tahoma Box in Home Assistant.
Scenes will be added automatically. Please refer to the [component](/components/tahoma/) configuration on how to setup Tahoma.

View File

@ -1,19 +0,0 @@
---
layout: page
title: "Velux Scene"
description: "Instructions on how to integrate Velux Scene with Home Assistant."
date: 2017-07-09 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: velux.png
ha_category: Scene
ha_release: 0.49
ha_iot_class: "Local Polling"
---
The `velux` scene platform allows you to control your [VELUX](http://www.velux.com/) windows.
The requirement is that you have setup the [VELUX](/components/velux/) component.

View File

@ -1,15 +0,0 @@
---
layout: page
title: "Coinbase Sensor"
description: "Instructions on how to setup Coinbase sensors within Home Assistant."
date: 2017-12-08 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: coinbase.png
ha_category: Finance
ha_release: 0.61
---
To get your coinbase sensors working with Home Assistant, follow the instructions for the general [Coinbase component](/components/coinbase/).

View File

@ -1,17 +0,0 @@
---
layout: page
title: "Zehnder ComfoAir Q Ventilation sensors"
description: "Instructions on how to integrate Zehnder ComfoAir Q350/450/600 sensors into Home Assistant."
date: 2017-06-28 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: zehnder.png
ha_category: Sensor
ha_release: "0.48"
---
Please see the [main component] for information how to set it up.
[main component]: /components/comfoconnect/

View File

@ -1,16 +0,0 @@
---
layout: page
title: "Ecobee Sensor"
description: "Instructions on how to setup the Ecobee sensors within Home Assistant."
date: 2015-11-30 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ecobee.png
ha_category: Environment
ha_release: 0.9
ha_iot_class: "Local Push"
---
To get your Ecobee sensors working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/).

View File

@ -1,39 +0,0 @@
---
layout: page
title: "EnOcean Sensor"
description: "Instructions on how to integrate TellStick sensors into Home Assistant."
date: 2016-05-26 01:00
sidebar: true
comments: false
sharing: true
footer: true
logo: enocean.png
ha_category: Sensor
ha_release: 0.21
ha_iot_class: "Local Push"
---
The `enocean` sensor platform currently only allows reading out the power measured in a Permundo PSC234 switch.
To use your EnOcean device, you first have to set up your [EnOcean hub](../enocean) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
sensor:
- platform: enocean
name: Television
id: [0x01,0x90,0x84,0x3C]
```
{% configuration %}
id:
description: The ID of the device. This is a 4 bytes long number.
required: true
type: list
name:
description: An identifier for the switch
required: true
default: EnOcean sensor
type: string
{% endconfiguration %}

View File

@ -146,9 +146,8 @@ You can also use the `sensor.google_travel_sensor_update` service to update the
alias: "Commute - Update morning commute sensor"
initial_state: 'on'
trigger:
- platform: time
- platform: time_pattern
minutes: '/2'
seconds: 00
condition:
- condition: time
after: '08:00:00'

View File

@ -1,17 +0,0 @@
---
layout: page
title: "ISY994 Sensor"
description: "Instructions on how to integrate ISY994 sensors into Home Assistant."
date: 2016-09-03 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: universal_devices.png
ha_category: Sensor
ha_iot_class: "Local Push"
---
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) sensor from within Home Assistant.
They will be automatically discovered if the `isy994` component is loaded.

View File

@ -132,7 +132,7 @@ In this section you find some real-life examples of how to use this sensor.
### {% linkable_title JSON attributes topic configuration %}
The example sensor below shows a configuration example which uses a JSON dict: `{"ClientName": <string>, "IP": <string>, "MAC": <string>, "RSSI": <string>, "HostName": <string>, "ConnectedSSID": <string>}` in a separate topic to add extra attributes. It also makes use of the `availability` topic. Attributes can then be extracted in [Templates](/docs/configuration/templating/#attributes). For example, to extract the `ClientName` attribute from the sensor below, use a template similar to: {% raw %}`{{ state_attr('sensor.bs_rssi', 'ClientName') }}`{% endraw %}.
The example sensor below shows a configuration example which uses a JSON dict: `{"ClientName": <string>, "IP": <string>, "MAC": <string>, "RSSI": <string>, "HostName": <string>, "ConnectedSSID": <string>}` in a separate topic `home/sensor1/attributes` to add extra attributes. It also makes use of the `availability` topic. Extra attributes will be displayed in the frontend and can also be extracted in [Templates](/docs/configuration/templating/#attributes). For example, to extract the `ClientName` attribute from the sensor below, use a template similar to: {% raw %}`{{ state_attr('sensor.bs_rssi', 'ClientName') }}`{% endraw %}.
{% raw %}
```yaml
@ -146,13 +146,7 @@ sensor:
availability_topic: "home/sensor1/status"
payload_available: "online"
payload_not_available: "offline"
json_attributes:
- ClientName
- IP
- MAC
- RSSI
- HostName
- ConnectedSSID
json_attributes_topic: "home/sensor1/attributes"
```
{% endraw %}

View File

@ -1,22 +0,0 @@
---
layout: page
title: "MyChevy Sensor"
description: "Instructions on how to integrate Chevy Bolt sensors car into Home Assistant."
date: 2017-08-28 17:00
sidebar: true
comments: false
sharing: true
footer: true
logo: chevy.png
ha_category: Car
ha_release: 0.62
ha_iot_class: "Cloud Polling"
---
The `mychevy` sensor platform allows you to monitor your Chevy Bolt car from within Home Assistant.
The sensor platform will be automatically configured if the `mychevy` component is configured.
For configuration instructions, see the [`mychevy` component](/components/mychevy/) documentation.

View File

@ -68,7 +68,7 @@ headers:
## {% linkable_title Examples %}
In this section you find some real-life examples of how to use this sensor. There is also a [Jupyter notebook](http://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/web-scraping.ipynb) available for this example to give you a bit more insight.
In this section you find some real-life examples of how to use this sensor. There is also a [Jupyter notebook](https://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/other/web-scraping.ipynb) available for this example to give you a bit more insight.
### {% linkable_title Home Assistant %}

View File

@ -1,16 +0,0 @@
---
layout: page
title: "SleepIQ Sensor"
description: "Instructions for how to integrate SleepIQ sensors within Home Assistant."
date: 2016-08-28 8:56
sidebar: true
comments: false
sharing: true
footer: true
logo: sleepiq.png
ha_category: Health
ha_release: 0.29
ha_iot_class: "Local Polling"
---
To get your SleepIQ sensors working with Home Assistant, follow the instructions for the general [SleepIQ component](/components/sleepiq/).

View File

@ -1,17 +0,0 @@
---
layout: page
title: "Tahoma Sensor"
description: "Instructions on how to integrate Tahoma sensors into Home Assistant."
date: 2017-07-18 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: tahoma.png
ha_category: Sensor
ha_release: 0.59
---
The `tahoma` sensor platform lets you see sensors added to your Tahoma Box in Home Assistant.
Sensors will be added automatically. Please refer to the [component](/components/tahoma/) configuration on how to setup Tahoma.

View File

@ -1,16 +0,0 @@
---
layout: page
title: "Telldus Live sensor"
description: "Instructions on how to integrate Telldus Live sensors into Home Assistant."
date: 2016-01-17 15:49
sidebar: true
comments: false
sharing: true
footer: true
logo: telldus.png
ha_category: Sensor
ha_iot_class: "Local Polling"
---
Integrates Telldus Live sensors into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions.

View File

@ -286,9 +286,8 @@ sensor:
automation:
- alias: 'nonsmoker_update'
trigger:
- platform: time
- platform: time_pattern
minutes: '/5'
seconds: 0
action:
- service: homeassistant.update_entity
entity_id: sensor.nonsmoker

View File

@ -31,10 +31,9 @@ The electricity price can be used to make automations. The sensor has a `max_pri
```yaml
- alias: "Electricity price"
trigger:
platform: time
platform: time_pattern
# Matches every hour at 1 minutes past whole
minutes: 1
seconds: 00
condition:
condition: template
value_template: '{{ float(states.sensor.electricity_price_hamretunet_10.state) > 0.9 * float(states.sensor.electricity_price_hamretunet_10.attributes.max_price) }}'

View File

@ -1,16 +0,0 @@
---
layout: page
title: "Zigbee Home Automation Sensor"
description: "Instructions on how to setup Zigbee Home Automation sensors within Home Assistant."
date: 2017-02-22 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: Sensor
ha_iot_class: "Local Polling"
---
To get your Zigbee sensors working with Home Assistant, follow the instructions for the general [Zigbee Home Automation Component](/components/zha/).

View File

@ -8,9 +8,15 @@ comments: false
sharing: true
footer: true
logo: sleepiq.png
ha_category: Health
ha_category:
- Health
- Sensor
- Binary Sensor
ha_release: 0.29
ha_iot_class: "Local Polling"
redirect_from:
- /components/binary_sensor.sleepiq/
- /components/sensor.sleepiq/
---
The SleepIQ implementation lets you view sensor data from [SleepIQ by SleepNumber](http://www.sleepnumber.com/sn/en/sleepiq-sleep-tracker). In particular, it lets you see the occupancy and current SleepNumber (ie current firmness) of each side of a SleepNumber bed.
@ -40,4 +46,3 @@ password:
required: true
type: string
{% endconfiguration %}

View File

@ -1,57 +0,0 @@
---
layout: page
title: "EnOcean Switch"
description: "Instructions on how to set up EnOcean switches within Home Assistant."
date: 2016-05-25 23:49
sidebar: true
comments: false
sharing: true
footer: true
logo: enocean.png
ha_category: Switch
ha_release: 0.21
ha_iot_class: "Local Push"
---
An EnOcean switch can take many forms. Currently, only a few types have been tested: Permundo PSC234 and Nod On SIN-2-1-01.
To use your EnOcean device, you first have to set up your [EnOcean hub](/components/enocean/) and then add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: enocean
id: [0x01,0x90,0x84,0x3C]
```
{% configuration %}
id:
description: The ID of the device. This is a 4 bytes long number.
required: true
type: list
name:
description: An identifier for the switch.
required: false
default: EnOcean Switch
type: string
channel:
description: The number of the channel (typically 0 or 1) for the output channel to switch.
required: false
default: 0
type: integer
{% endconfiguration %}
```yaml
# Example entries for a switch with 2 outputs (channels), e.g., the Nod On SIN-2-1-01
switch nodon01_0:
- platform: enocean
id: [0x05,0x04,0x03,0x02]
name: enocean_nodon01_0
channel: 0
switch nodon01_1:
- platform: enocean
id: [0x05,0x04,0x03,0x02]
name: enocean_nodon01_1
channel: 1
```

View File

@ -1,29 +0,0 @@
---
layout: page
title: "Fritzbox Switch"
description: "Instructions on how to integrate the AVM Fritzbox switch."
date: 2017-11-12 17:10
sidebar: true
comments: false
sharing: true
footer: true
logo: avm.png
ha_category: Switch
ha_release: 0.68
ha_iot_class: "Local Polling"
---
To get AVM Fritzbox switch follow the instructions for the [Fritzbox component](/components/fritzbox/).
### {% linkable_title Attributes %}
The are several attributes that can be useful for automations and templates.
| Attribute | Description |
| --------- | ----------- |
| `device_locked` | The state of the key lock at the device.
| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface.
| `temperature_unit` | The unit of the temperature sensor (only available if the device support temperature sensor).
| `temperature` | The current temperature sensor reading (only available if the device supports temperature sensor).
| `total_consumption` | The total power consumption since the beginning of operation (only available if the device supports power meter function).
| `total_consumption_unit` | The unit of the total_consumption (only available if the device supports power meter function).

View File

@ -1,17 +0,0 @@
---
layout: page
title: "ISY994 Switch"
description: "Instructions on how to integrate ISY994 switch into Home Assistant."
date: 2016-09-03 23:00
sidebar: true
comments: false
sharing: true
footer: true
logo: universal_devices.png
ha_category: Switch
ha_iot_class: "Local Push"
---
The `isy994` platform allows you to get data from your [ISY994](https://www.universal-devices.com/residential/isy994i-series/) switch from within Home Assistant.
They will be automatically discovered if the `isy994` component is loaded.

View File

@ -1,18 +0,0 @@
---
layout: page
title: "Lightwave Switch"
description: "Instructions on how to integrate Lightwave Switches with Home Assistant."
date: 2018-12-05 18:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lightwave.png
ha_category: Switch
ha_release: 0.84
ha_iot_class: "Assumed State"
---
The `lightwave` switch platform integrates your Lightwave switches into Home Assistant.
<p class='note'>
Configuration details for the Lightwave platform can be found on the main [Lightwave component](/components/lightwave/) page.
</p>

View File

@ -1,15 +0,0 @@
---
layout: page
title: "LiteJet Switch"
description: "Instructions on how to setup the LiteJet switches within Home Assistant."
date: 2016-10-26 13:00
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Switch
ha_release: 0.32
ha_iot_class: "Local Polling"
---
To get your LiteJet switches working with Home Assistant, follow the instructions for the general [LiteJet component](/components/litejet/).

View File

@ -1,16 +0,0 @@
---
layout: page
title: "Lutron Switch"
description: "Instructions on how to setu p the Lutron switches within Home Assistant."
date: 2018-10-09 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lutron.png
ha_category: Switch
ha_iot_class: "Local Polling"
ha_release: 0.85
---
To get your Lutron switches working with Home Assistant, follow the instructions for the general [Lutron component](/components/lutron/).

View File

@ -1,23 +0,0 @@
---
layout: page
title: "Lutron Caseta Switch"
description: "Instructions on how to setup the Lutron Caseta switches within Home Assistant."
date: 2017-04-30 09:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lutron.png
ha_category: Switch
ha_iot_class: "Local Polling"
---
To get Lutron Caseta switches working with Home Assistant, follow the instructions for the general [Lutron Caseta component](/components/lutron_caseta/).
After setup, switches will appear in Home Assistant using an `entity_id` based on the name used in the Lutron mobile app. For example, a light switch called 'Master Bathroom Vanity' will appear in Home Assistant as `switch.master_bathroom_vanity`.
For dimmable lights including wall and plug-in dimmers, see [Lutron Caseta Light](/components/light.lutron_caseta/).
For more information on working with switches in Home Assistant, see the [Switches component](/components/switch/).
Available services: `switch.turn_on` and `switch.turn_off`.

View File

@ -1,120 +0,0 @@
---
layout: page
title: "Raspihats Switch"
description: "Instructions on how to integrate Raspihats add-on boards for Raspberry Pi into Home Assistant as a switch."
date: 2017-05-15 04:20
sidebar: true
comments: false
sharing: true
footer: true
logo: raspihats.png
ha_category: DIY
ha_release: 0.45
ha_iot_class: "Local Push"
---
The `raspihats` switch platform allows you to control the digital outputs of your [Raspihats](http://www.raspihats.com/) boards.
## {% linkable_title Configuration %}
To use your Raspihats boards in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: raspihats
i2c_hats:
- board: DI6acDQ6rly
address: 0x60
channels:
- index: 0
name: Fan Office
invert_logic: true
initial_state: true
- index: 1
name: Light Office
```
{% configuration %}
i2c_hats:
description: An array of used I2C-HATs.
required: false
type: list
keys:
board:
description: The board name.
required: true
type: string
address:
description: The board I2C address as HEX value.
required: true
type: string
channels:
description: An array of used digital input channels.
required: true
type: list
keys:
index:
description: The digital input channel index.
required: true
type: integer
name:
description: The friendly name to use for the frontend.
required: true
type: string
invert_logic:
description: Inverts the input logic.
required: false
default: false
type: boolean
initial_state:
description: "The initial state, can be either `true` or `false`. `none` means no state is forced on the corresponding digital output when this switch is instantiated."
required: false
default: None
type: boolean
{% endconfiguration %}
## {% linkable_title Directions for installing smbus support on Raspberry Pi %}
Enable I2c interface with the Raspberry Pi configuration utility:
```bash
# pi user environment: Enable i2c interface
$ sudo raspi-config
```
Select `Interfacing options->I2C` choose `<Yes>` and hit `Enter`, then go to `Finish`.
Install dependencies for use the `smbus-cffi` module and enable your _homeassistant_ user to join the _i2c_ group:
```bash
# pi user environment: Install i2c dependencies and utilities
$ sudo apt-get install build-essential libi2c-dev i2c-tools python-dev libffi-dev
# pi user environment: Add homeassistant user to the i2c group
$ sudo usermod -a -G i2c homeassistant
```
## {% linkable_title Check the i2c address of the sensor %}
After installing `i2c-tools`, a new utility is available to scan the addresses of the connected sensors, so you can see the sensor address:
```bash
/usr/sbin/i2cdetect -y 1
```
It will output a table like this:
```text
0 1 2 3 4 5 6 7 8 9 a b c d e f
00: -- -- -- -- -- -- -- -- -- -- -- -- --
10: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
20: -- -- -- 23 -- -- -- -- -- -- -- -- -- -- -- --
30: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
40: 40 -- -- -- -- -- UU -- -- -- -- -- -- -- -- --
50: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
60: -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
70: -- -- -- -- -- -- -- 77
```
For more details about the Raspihats add-on boards for Raspberry Pi, visit [raspihats.com](http://www.raspihats.com/).

View File

@ -1,17 +0,0 @@
---
layout: page
title: "Tahoma Switch"
description: "Instructions on how to integrate Tahoma switches into Home Assistant."
date: 2017-07-18 12:00
sidebar: true
comments: false
sharing: true
footer: true
logo: tahoma.png
ha_category: Sensor
ha_release: 0.59
---
The `tahoma` switch platform lets you see switches added to your Tahoma Box in Home Assistant.
Switches will be added automatically. Please refer to the [component](/components/tahoma/) configuration on how to setup Tahoma.

View File

@ -1,15 +0,0 @@
---
layout: page
title: "Telldus Live Switch"
description: "Instructions on how to integrate Telldus Live switches into Home Assistant."
date: 2016-01-17 15:49
sidebar: true
comments: false
sharing: true
footer: true
logo: telldus.png
ha_category: Switch
featured: false
---
Integrates Telldus Live switches into Home Assistant. See the [main component](/components/tellduslive/) for configuration instructions.

View File

@ -1,15 +0,0 @@
---
layout: page
title: "Zigbee Home Automation Switch"
description: "Instructions on how to setup Zigbee Home Automation switches within Home Assistant."
date: 2017-02-22 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: Switch
ha_iot_class: "Local Polling"
---
To get your Zigbee switches working with Home Assistant, follow the instructions for the general [Zigbee Home Automation component](/components/zha/).

View File

@ -8,13 +8,33 @@ comments: false
sharing: true
footer: true
logo: tahoma.png
ha_category: Hub
ha_category:
- Hub
- Binary Sensor
- Cover
- Scene
- Switch
- Sensor
ha_release: 0.59
ha_iot_class: "Cloud Polling"
redirect_from:
- /components/binary_sensor.tahoma/
- /components/cover.tahoma/
- /components/scene.tahoma/
- /components/switch.tahoma/
- /components/sensor.tahoma/
---
The `Tahoma` component platform is used as an interface to the [tahomalink.com](https://www.tahomalink.com) website. It adds covers, scenes and a sun sensor from the Tahoma platform.
There is currently support for the following device types within Home Assistant:
- Binary Sensor
- Sensor
- Cover
- Switch
- Scene
## {% linkable_title Configuration %}
To use your Tahoma devices in your installation, add the following to your `configuration.yaml` file:

View File

@ -8,9 +8,22 @@ comments: false
sharing: true
footer: true
logo: telldus.png
ha_category: Hub
ha_category:
- Hub
- Binary Sensor
- Cover
- Light
- Sensor
- Switch
featured: false
ha_release: 0.11
ha_config_flow: true
redirect_from:
- /components/binary_sensor.tellduslive/
- /components/cover.tellduslive/
- /components/light.tellduslive/
- /components/sensor.tellduslive/
- /components/switch.tellduslive/
---
The `tellduslive` component let you connect to [Telldus Live](https://live.telldus.com). It's cloud platform that connects to your Tellstick Net or Tellstick ZNet connected gear at home.

View File

@ -8,12 +8,15 @@ comments: false
sharing: true
footer: true
logo: velux.png
ha_category: Hub
ha_category:
- Scene
ha_release: 0.49
ha_iot_class: "Local Polling"
redirect_from:
- /components/scene.velux/
---
[Velux](http://www.velux.com) integration for Home Assistant allows you to connect to a Velux KLF 200 interface, to control [io-homecontrol](http://www.io-homecontrol.com) devices like windows and blinds. The module allows you to start scenes configured within KLF 200.
[Velux](http://www.velux.com) integration for Home Assistant allows you to connect to a Velux KLF 200 interface, to control [io-homecontrol](http://www.io-homecontrol.com) devices like windows and blinds. The module allows you to start scenes configured within KLF 200.
## {% linkable_title Configuration %}

View File

@ -1,16 +0,0 @@
---
layout: page
title: "Ecobee Weather"
description: "Instructions on how to setup the Ecobee weather within Home Assistant."
date: 2017-11-29 21:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ecobee.png
ha_category: Weather
ha_release: 0.59
ha_iot_class: "Local Push"
---
To get your Ecobee weather component working with Home Assistant, follow the instructions for the general [Ecobee component](/components/ecobee/).

View File

@ -8,9 +8,20 @@ comments: false
sharing: true
footer: true
logo: zigbee.png
ha_category: Hub
ha_category:
- Binary Sensor
- Fan
- Light
- Sensor
- Switch
ha_release: 0.44
ha_iot_class: "Local Polling"
redirect_from:
- /components/binary_sensor.zha/
- /components/fan.zha/
- /components/light.zha/
- /components/sensor.zha/
- /components/switch.zha/
---
[Zigbee Home Automation](http://www.zigbee.org/zigbee-for-developers/applicationstandards/zigbeehomeautomation/)
@ -18,11 +29,11 @@ integration for Home Assistant allows you to connect many off-the-shelf Zigbee b
There is currently support for the following device types within Home Assistant:
- [Binary Sensor](../binary_sensor.zha) (e.g., motion and door sensors)
- [Sensor](../sensor.zha) (e.g., temperature sensors)
- [Light](../light.zha)
- [Switch](../switch.zha)
- [Fan](../fan.zha)
- Binary Sensor
- Sensor
- Light
- Switch
- Fan
Known working Zigbee radio modules:

View File

@ -30,8 +30,8 @@ automation:
- alias: Enable First Morning Trigger
trigger:
- platform: time
at: '5:00'
action:
at: '05:00:00'
action:
service: homeassistant.turn_on
entity_id: input_boolean.trigger_first_morning
@ -41,12 +41,12 @@ automation:
- platform: sun
event: sunrise
offset: "01:00:00"
action:
action:
service: homeassistant.turn_off
entity_id: input_boolean.trigger_first_morning
# This is the main automation. It triggers when my motion sensor is triggered
# (in this case, a motion sensor from a security system attached to my Vera)
- alias: First Morning Motion
@ -59,17 +59,17 @@ automation:
condition: state
entity_id: input_boolean.trigger_first_morning
state: 'on'
action:
# turn off the "waiting" boolean regardless of whether lights will turn on
# so that this happens only once
- service: homeassistant.turn_off
entity_id: input_boolean.trigger_first_morning
# But only turn on lights if the living room and kitchen lights are off or dimmed
# If a condition tests false, the automation will end
# If a condition tests false, the automation will end
- condition: and
conditions:
conditions:
- condition: numeric_state
entity_id: light.livingroom_ec
# if light is off, force a 0, otherwise use the brightness value
@ -84,13 +84,13 @@ automation:
entity_id: light.kitchen_ceiling
value_template: {% raw %}'{% if states.light.kitchen_ceiling.state == "on" %}{{ states.light.kitchen_ceiling.attributes.brightness }}{% else %}0{% endif %}'{% endraw %}
below: 128
# Trigger a scene
# You could add as many services or scenes as you'd like
- service: scene.turn_on
entity_id: scene.morning_first_motion
```
#### {% linkable_title The Scene %}
@ -98,7 +98,7 @@ automation:
Here is the Scene that is called via the Automations above.
```yaml
# here's the scene that gets called. Lights in
# here's the scene that gets called. Lights in
# my living room and kitchen turn on.
scene:
- name: Morning First Motion

View File

@ -0,0 +1,217 @@
---
layout: page
title: "KNX automation and interaction with other systems"
description: "General KNX set up and communication with other systems like the Philips Hue."
date: 2019-01-20 22:00 +0100
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Automation Examples
---
This cookbook shows a general KNX set up and communication with other systems like the Philips Hue.
## {% linkable_title General KNX setup %}
``` yaml
knx:
# This is all you need to get the KNX component up and running.
# Auto config works nicely and usually no config data for your KNX ip tunnel is needed.
# If the KNX router is not found automatically, check the docs and add the IP config here.
# get some sensor data from KNX to HA
sensor:
- platform: knx
name: Helligkeit Treppe oben
address: '6/1/0'
type: 'illuminance'
# The entity_id of this sensor will be generated from the name by a slug function.
# In this case, it will be sensor.helligkeit_treppe_oben
# See dev tools' state page (icons at the bottom of left side menu) for a list of all entity_ids
light:
# See "sensor" remarks above for an explanation of the resulting entity_ids
- platform: knx
# switched light
name: 'Eltern Decke'
address: '1/2/10'
state_address: '1/2/11'
- platform: knx
# dimmed light
name: 'Eltern Bett'
address: '1/2/12'
state_address: '1/2/15'
brightness_address: '1/2/13'
brightness_state_address: '1/2/16'
cover:
# KNX Covers are roller shutters and blinds.
# These items currently expose a bug with the invert_position setting:
# Either you will get 100% for an open shutter and 0% for a closed one
# or you will get the function of up and down arrows exchanged wrongly.
# Hope this is resolved soon.
# ---
# See "sensor" remarks above for an explanation of the resulting entity_ids
- platform: knx
name: "Eltern"
move_long_address: '3/2/0'
move_short_address: '3/2/1'
position_address: '3/2/3'
position_state_address: '3/2/2'
travelling_time_up: 23
travelling_time_down: 21
invert_position: true
- platform: knx
name: "Büro"
move_long_address: '3/2/4'
move_short_address: '3/2/5'
position_address: '3/2/7'
position_state_address: '3/2/6'
travelling_time_up: 23
travelling_time_down: 21
invert_position: true
```
## {% linkable_title Using some values from HA within KNX %}
``` yaml
# configuration.yaml example
sensor:
# Register with Dark Sky to retrieve current environment data.
# Registration is free for the amount of requests we need here.
- platform: openweathermap
name: OpenWeather
language: de
api_key: YOUR_API_KEY
monitored_conditions:
- weather
- temperature
- wind_speed
- wind_bearing
- humidity
- pressure
- clouds
- rain
- snow
- weather_code
knx:
# Expose the above sensor data from HA to KNX group addresses.
# To find the right "type" setting for each parameter, create a group address in ETS,
# add a consuming actor for this kind of parameter to it and check the properties pane.
# ETS will show you a data type (DPT) that you can compare to the available DPTs in the
# documentation of the HA KNX component.
expose:
- type: 'temperature'
entity_id: 'sensor.dark_sky_temperature'
address: '0/1/10'
- type: 'humidity'
entity_id: 'sensor.dark_sky_humidity'
address: '0/1/11'
- type: 'temperature'
entity_id: 'sensor.dark_sky_pressure'
address: '0/1/12'
- type: 'DPT-9'
entity_id: 'sensor.dark_sky_wind_speed'
address: '0/1/13'
- type: 'DPT-14'
entity_id: 'sensor.dark_sky_wind_bearing'
address: '0/1/14'
```
## {% linkable_title Basic KNX automation %}
This example uses an automation that is activated by a KNX switch.
The automation then triggers a script that controls a KNX light and dims it down in 5 steps from 80% to 0% over a time span of 5 minutes.
Care must be taken to stop the script, when the light is otherwise switched (i.e., by its normal on/off KNX switch). If we don't do that, the light will first switch correctly, but then the script will continue to run in the background and after the next delay has passed it will kick in again and activate its next dim level.
```yaml
knx:
switch:
- platform: knx
# The normal on/off switch for the light
name: "Licht, Eltern Bett"
address: '1/2/12'
- platform: knx
# The switch that triggers the dim script
# This switch must be configured in ETS to send on when pressed and off when released
name: "Licht, Eltern Bett, Fadeout"
address: '1/2/17'
light:
# This is the light that we want to dim (more precisely it is the dimming actuator of the light).
# It is directly controlled through the first switch above.
# (Note that the switch shares its group address with this light and thus controls it over the KNX bus.)
- platform: knx
name: 'Eltern Bett'
address: '1/2/12'
state_address: '1/2/15'
brightness_address: '1/2/13'
brightness_state_address: '1/2/16'
automation:
# start the dim script, if the dim switch is pressed
- id: light_eltern_bett_fadeout
alias: Licht Eltern Bett Fade-Out
trigger:
- entity_id: switch.licht_eltern_bett_fadeout
platform: state
to: 'on'
condition: []
action:
# in case the script was already running, we first stop it
- service: script.turn_off
entity_id: script.light_eltern_bett_fadeout
- service: script.turn_on
entity_id: script.light_eltern_bett_fadeout
# stop the dim script, if light is switched manually
- id: light_eltern_bett_fadeout_stop
alias: Licht Eltern Bett Fade-Out STOP
trigger:
- entity_id: switch.licht_eltern_bett
platform: state
# no argument here = trigger with ANY state change
condition: []
action:
- service: script.turn_off
entity_id: script.light_eltern_bett_fadeout
script:
light_eltern_bett_fadeout:
alias: Licht Eltern Bett Fade-Out
sequence:
- service: light.turn_on
entity_id: light.eltern_bett
data:
brightness_pct: 80
- delay: '00:01:00'
- service: light.turn_on
entity_id: light.eltern_bett
data:
brightness_pct: 60
- delay: '00:01:00'
- service: light.turn_on
entity_id: light.eltern_bett
data:
brightness_pct: 40
- delay: '00:01:00'
- service: light.turn_on
entity_id: light.eltern_bett
data:
brightness_pct: 20
- delay: '00:01:00'
- service: light.turn_on
entity_id: light.eltern_bett
data:
brightness_pct: 10
- delay: '00:01:00'
- service: light.turn_off
entity_id: light.eltern_bett
```

View File

@ -25,9 +25,8 @@ automation:
# Changes Hue light every two minutes to random color if input boolean is set to on
- alias: 'Set LivingColors to random color'
trigger:
platform: time
platform: time_pattern
minutes: '/2'
seconds: 0
condition:
condition: state
entity_id: input_boolean.loop_livingcolors

View File

@ -30,13 +30,9 @@ automation:
- alias: Send message at a given time
trigger:
platform: time
hours: 12
minutes: 15
seconds: 0
at: '12:15:00'
action:
service: notify.jabber
data:
message: 'Time for lunch'
```

Some files were not shown because too many files have changed in this diff Show More