Skip to content

Commit

Permalink
doc(README.md)
Browse files Browse the repository at this point in the history
  • Loading branch information
@xaviml
xaviml committed Feb 1, 2020
1 parent 0928388 commit cc32b12
Showing 1 changed file with 21 additions and 18 deletions.
39 changes: 21 additions & 18 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

## Breaking changes

:warning: This app has lost the support for AppDaemon 3.x, please migrate to AppDaemon 4.x. The hassio addon for it has been released recently.
:warning: `sensor` and `event_id` are removed from the parameters, now there is a unique parameter called `controller`. So from v2.2.0 you will need to replace `sensor` and `event_id` for `controller`

:warning: The module is called now controllerx.
:warning: You will also need to add a new parameter `integration` to state how the controller is connected with. These are the supported integration, z2m, deconz and zha. This does not mean that there is support for all three integration for all controllers, some controllers do not have some integration due to the lack of the device and being still in development. If you possess a device that is not integrated, you can freely open an issue and I will be glad to help :smiley:

_Bring full functionality to light and media player controllers. From turning devices on/off to changing the color lights._

Expand All @@ -20,7 +20,7 @@ This automation brings the following functionalities for different [devices](htt
- Play/pause music
- Volume up/down for a media player.

The appdaemon app supports zigbee2mqtt (use the `sensor` parameter) and deConz (use the `event_id` parameter).
This project gives support now to controllers integrated with zigbee2mqtt, deCONZ and ZHA.

## Installation

Expand All @@ -40,7 +40,8 @@ This is an example configuration template:
nameOfYourInstanceApp:
module: controllerx
class: <class of your controller>
sensor: <sensor(s) entity id>
controller: <controller entity id>
integration: <z2m | deconz | zha>
light: <light, group entity id>
```
Expand All @@ -50,43 +51,45 @@ or:
nameOfYourInstanceApp:
module: controllerx
class: <class of your controller>
sensor: <sensor(s) entity id>
controller: <controller entity id>
integration: <z2m | deconz | zha>
light:
name: <light, group entity id>
color_mode: auto | xy_color | color_temp
```
This is a real example for E1524/E1810 controller that controls all the livingroom lights.
This is a real example for E1524/E1810 controller with z2m that controls all the livingroom lights.
```yaml
livingroom_controller:
module: controllerx
class: E1810Controller
sensor: sensor.livingroom_controller_action
controller: sensor.livingroom_controller_action
integration: z2m
light: group.livingroom_lights
```
This is a real example to control a media player with E1744:
This is a real example to control a media player with E1744 with deCONZ:
```yaml
bedroom_speaker:
module: controllerx
class: E1744MediaPlayerController
sensor: sensor.symfonisk_controller_action
controller: symfonisk_controller
integration: deconz
media_player: media_player.bedroom_speaker
```
These are the generic app parameters for all type of controllers. You can see the rest in [here](https://github.com/xaviml/controllerx/wiki/Controller-types)
| key | optional | type | default | example | description |
| -------------- | -------- | -------------- | -------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `module` | False | string | - | `controllerx` | The Python module |
| `class` | False | string | - | `E1810Controller` | The Python class. Check the classes for each controller on the [supported controllers](https://github.com/xaviml/controllerx/wiki/Supported-controllers) page. |
| `sensor` | False | string \| list | - | `sensor.controller` or `sensor.controller1, sensor.controller2` | The sensor(s) entity id from HA. Note that for IKEA E1524/E1810 it finishes with "\_action" by default and for IKEA E1743 with "\_click". `sensor` and `event_id` cannot be used together. This attribute could be used for devices integrated with zigbee2mqtt. This can be also sent as list on the YAML (using "-") |
| `event_id` | False | string \| list | - | `hue_switch` or `hue_switch1, hue_switch2` | The event id(s). `sensor` and `event_id` cannot be used together. This attribute could be used for devices integrated with deConz. This can be also sent as list on the YAML (using "-") |
| `event` | True | string | `deconz_event` | | The event feature was meant to be used for devices integrated with deConz, but the event can be overwritten for other use cases. |
| `actions` | True | list | All actions | | This is a list of actions to be included and controlled by the app. To see which actions has each controller check the [supported controllers](https://github.com/xaviml/controllerx/wiki/Supported-controllers) page |
| `action_delta` | True | int | 300 | | This is the threshold time between the previous action and the next one (being the same action). If the time difference between the two actions is less than this attribute, then the action won't be called. I recommend changing this if you see the same action being called twice. |
| key | optional | type | default | example | description |
| -------------- | -------- | -------------- | ----------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `module` | False | string | - | `controllerx` | The Python module |
| `class` | False | string | - | `E1810Controller` | The Python class. Check the classes for each controller on the [supported controllers](https://github.com/xaviml/controllerx/wiki/Supported-controllers) page. |
| `controller` | False | string \| list | - | `sensor.controller` or `hue_switch1, hue_switch2` | This is the controller id. This will change depending on the integration. In case of `z2m` is the name of the sensor in HA, it normally finishes with `_action`. For `deconz` is the device name given on the phoscon app. And finally, for `zha` is the device IEEE. |
| `integration` | False | string | - | `z2m`, `deconz` or `zha` | This is the integration that the device was integrated. |
| `actions` | True | list | All actions | | This is a list of actions to be included and controlled by the app. To see which actions has each controller check the [supported controllers](https://github.com/xaviml/controllerx/wiki/Supported-controllers) page |
| `action_delta` | True | int | 300 | | This is the threshold time between the previous action and the next one (being the same action). If the time difference between the two actions is less than this attribute, then the action won't be called. I recommend changing this if you see the same action being called twice. |

## Contributing

Expand Down

0 comments on commit cc32b12

Please sign in to comment.