mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 01:06:52 +00:00
Added documentation for EnOcean component (#515)
* Added documentation for enocean components * More clearly state the limitations of the EnOcean support
This commit is contained in:
parent
4d68b72472
commit
41f6365e21
29
source/_components/binary_sensor.enocean.markdown
Normal file
29
source/_components/binary_sensor.enocean.markdown
Normal file
@ -0,0 +1,29 @@
|
||||
---
|
||||
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
|
||||
---
|
||||
|
||||
This can typically be one of those batteryless wall switches. Currently only one type has been tested: Eltako FT55. Other devices will most likely not work without changing the Home-Asisstant code.
|
||||
|
||||
|
||||
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
|
||||
binary_sensor:
|
||||
- platform: enocean
|
||||
id: [0x01,0x90,0x84,0x3C]
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer.
|
||||
- **platform** (*Required*): Set to `enocean`.
|
42
source/_components/enocean.markdown
Normal file
42
source/_components/enocean.markdown
Normal file
@ -0,0 +1,42 @@
|
||||
---
|
||||
layout: page
|
||||
title: "EnOcean"
|
||||
description: "Connect EnOcean devices to home-assistant"
|
||||
date: 2016-05-25 23:39
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: enocean.png
|
||||
ha_category: Hub
|
||||
---
|
||||
|
||||
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 unnecessary.
|
||||
|
||||
The `enocean` component adds support for some of these devices. You will need a controller like the [USB300](https://www.enocean.com/en/enocean_modules/usb-300-oem/) in order for it to work.
|
||||
|
||||
There is currently support for the following device types within Home Assistant:
|
||||
|
||||
- [Binary Sensor](../binary_sensor.enocean) (wall switches)
|
||||
- [Sensor](../sensor.enocean) (power meters)
|
||||
- [Light](../light.enocean) (dimmers)
|
||||
- [Switch](../switch.enocean)
|
||||
|
||||
However, only a few devices have been confirmed to work. These are:
|
||||
|
||||
- Eltako FUD61 dimmer
|
||||
- Eltako FT55 battery-less wall switch
|
||||
- Permundo PSC234 (switch and power monitor)
|
||||
|
||||
Other devices will most likely need some changes in the Home-Assistant code in order to work. Support for teaching of devices is also missing at this time.
|
||||
|
||||
# Configuration
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
enocean:
|
||||
device: /dev/ttyUSB0
|
||||
```
|
||||
|
||||
If no device is specified, the default will be **/dev/ttyUSB0**
|
||||
|
33
source/_components/light.enocean.markdown
Normal file
33
source/_components/light.enocean.markdown
Normal file
@ -0,0 +1,33 @@
|
||||
---
|
||||
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
|
||||
---
|
||||
|
||||
An EnOcean light can take many formes. Currently only one type has been tested: Eltako FUD61 dimmer.
|
||||
|
||||
|
||||
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
|
||||
light:
|
||||
- name: Living_room
|
||||
platform: enocean
|
||||
id: [0x01,0x90,0x84,0x3C]
|
||||
sender_id: [0xFF,0xC6,0xEA,0x04]
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **id** (*Required*): The ID of the device. This is the 4 bytes long number written on the dimmer.
|
||||
- **sender_id** (*Required*): The Sender ID of the device. This is a 4 bytes long number.
|
||||
- **platform** (*Required*): Set to `enocean`.
|
||||
- **name** (*Required*): An identifier for the switch
|
32
source/_components/sensor.enocean.markdown
Normal file
32
source/_components/sensor.enocean.markdown
Normal file
@ -0,0 +1,32 @@
|
||||
---
|
||||
layout: page
|
||||
title: "EnOcean Sensor"
|
||||
description: "Instructions 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
|
||||
---
|
||||
|
||||
|
||||
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:
|
||||
- name: Television
|
||||
platform: enocean
|
||||
id: [0x01,0x90,0x84,0x3C]
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **id** (*Required*): The ID of the device. This is a 4 bytes long number.
|
||||
- **platform** (*Required*): Set to `enocean`.
|
||||
- **name** (*Required*): An identifier for the switch
|
31
source/_components/switch.enocean.markdown
Normal file
31
source/_components/switch.enocean.markdown
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
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
|
||||
---
|
||||
|
||||
An EnOcean switch can take many forms. Currently only one type has been tested: Permundo PSC234
|
||||
|
||||
|
||||
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
|
||||
switch:
|
||||
- name: Television
|
||||
platform: enocean
|
||||
id: [0x01,0x90,0x84,0x3C]
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **id** (*Required*): The ID of the device. This is a 4 bytes long number.
|
||||
- **platform** (*Required*): Set to `enocean`.
|
||||
- **name** (*Required*): An identifier for the switch
|
BIN
source/images/supported_brands/enocean.png
Normal file
BIN
source/images/supported_brands/enocean.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 8.9 KiB |
Loading…
x
Reference in New Issue
Block a user