Skip to content

Commit

Permalink
docs(devices): add specific default actions to all devices documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
xaviml committed Apr 29, 2020
1 parent 9ac8a61 commit 3722700
Show file tree
Hide file tree
Showing 18 changed files with 264 additions and 70 deletions.
32 changes: 28 additions & 4 deletions docs/_data/controllers/E1524_E1810.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,40 @@
name: E1524/E1810 (IKEA)
device_support:
- Light (E1810Controller; 350ms delay)
- Media Player (E1810MediaPlayerController; 500ms delay)
light_example: E1810Controller
- type: Light
controller: E1810Controller
delay: 350
mapping:
- "Click ⏻ 🠖 Toggle"
- "Hold ⏻ 🠖 Sync"
- "Click 🔆 🠖 Brighten up (1 step)"
- "Click 🔅 🠖 Dim down (1 step)"
- "Click < 🠖 Color temp down / Left color wheel (1 step)"
- "Click > 🠖 Color temp up / Right color wheel (1 step)"
- "Hold 🔆 🠖 Brighten up"
- "Hold 🔅 🠖 Dim down"
- "Hold < 🠖 Color temp down / Left color wheel"
- "Hold > 🠖 Color temp up / Right color wheel"
- type: Media Player
controller: E1810MediaPlayerController
delay: 500
mapping:
- "Click ⏻ 🠖 Play/Pause"
- "Click 🔆 🠖 Volume up (1 step)"
- " Click 🔅 🠖 Volume down (1 step)"
- "Click < 🠖 Previous track"
- "Click > 🠖 Next track"
- "Hold 🔆 🠖 Volume up"
- "Hold 🔅 🠖 Volume down"
- "Hold < 🠖 Previous source"
- "Hold > 🠖 Next source"
integrations:
- name: Zigbee2mqtt
codename: z2m
actions:
- "toggle 🠖 Click ⏻"
- "toggle_hold 🠖 Hold ⏻"
- "brightness_up_click 🠖 Click 🔆"
- "brightness_down_click 🠖 Click 🔅"
- "brightness_down_click 🠖 Click 🔅"
- "arrow_left_click 🠖 Click <"
- "arrow_right_click 🠖 Click >"
- "brightness_up_hold 🠖 Hold 🔆"
Expand Down
18 changes: 14 additions & 4 deletions docs/_data/controllers/E1743.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
name: E1743 (IKEA)
device_support:
- Light (E1743Controller; 350ms delay)
- Switch (E1743SwitchController)
light_example: E1743Controller
device_support:
- type: Light
controller: E1743Controller
delay: 350
mapping:
- "Click \"I\" 🠖 Turn on"
- "Click \"O\" 🠖 Turn off"
- "Hold \"I\" 🠖 Brighten up"
- "Hold \"O\" 🠖 Brighten down"
- type: Switch
controller: E1743SwitchController
mapping:
- "Click \"I\" 🠖 Turn on"
- "Click \"O\" 🠖 Turn off"
integrations:
- name: Zigbee2mqtt
codename: z2m
Expand Down
21 changes: 18 additions & 3 deletions docs/_data/controllers/E1744.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,23 @@
name: E1744 (IKEA)
device_support:
- Light (E1744LightController; 1200ms delay)
- Media Player (E1744MediaPlayerController; 1000ms delay)
light_example: E1744LightController
- type: Light
controller: E1744LightController
delay: 1200
mapping:
- "Left turn 🠖 Dim down"
- "Right turn 🠖 Brighten up"
- "1 click 🠖 Toggle"
- "2 click 🠖 Full brightness"
- "3 click 🠖 Minimum brightness"
- type: Media Player
controller: E1744MediaPlayerController
delay: 1000
mapping:
- "Left turn 🠖 Volume down"
- "Right turn 🠖 Volume up"
- "1 click 🠖 Play/Pause"
- "2 click 🠖 Skip forward"
- "3 click 🠖 Skip backward"
integrations:
- name: Zigbee2mqtt
codename: z2m
Expand Down
10 changes: 8 additions & 2 deletions docs/_data/controllers/ICTCG1.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
name: ICTCG1 (IKEA)
device_support:
- Light (ICTCG1Controller; 350ms delay)
light_example: ICTCG1Controller
- type: Light
controller: ICTCG1Controller
delay: 350
mapping:
- "Left turn 🠖 Dim down"
- "Quick left turn 🠖 Turn off"
- "Right turn 🠖 Brighten up"
- "Quick right turn 🠖 Full brightness"
integrations:
- name: Zigbee2mqtt
codename: z2m
Expand Down
24 changes: 14 additions & 10 deletions docs/_data/controllers/IM6001-BTP01.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
name: IM6001-BTP01 (SmartThings)
device_support:
- Light (SmartThingsButtonLightController; 350ms delay)
- Media Player (SmartThingsButtonMediaPlayerController; 500ms delay)
light_example: SmartThingsButtonLightController
note: >-
When using it as light controller and the button is click, it toggles the light.
When using it as light controller and the button is double-click, it sets the maximum brightness.
When using it as light controller and the button is held, it sets the brightness to 50%.
When using it as media player controller and the button is click, it plays/pauses.
When using it as media player controller and the button is double-click, it skips forwards.
When using it as media player controller and the button is held, it skips backwards.
- type: Light
controller: SmartThingsButtonLightController
delay: 350
mapping:
- "1 click 🠖 Toggle"
- "2 clicks 🠖 Full brightness"
- "Hold the button 🠖 50% brightness"
- type: Media Player
controller: SmartThingsButtonMediaPlayerController
delay: 500
mapping:
- "1 click 🠖 Play/Pause"
- "2 clicks 🠖 Skip forwards"
- "Hold the button 🠖 Skip backward"
integrations:
- name: Zigbee2mqtt
codename: z2m
Expand Down
12 changes: 9 additions & 3 deletions docs/_data/controllers/LZL4BWHL01.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
name: LZL4BWHL01 (Lutron)
device_support:
- Light (LZL4BWHL01LightController; 350ms delay)
light_example: LZL4BWHL01LightController
device_support:
- type: Light
controller: LZL4BWHL01LightController
delay: 350
mapping:
- "Top button pressed 🠖 Full brightness"
- "Arrow up held 🠖 Brighten up"
- "Arrow down held 🠖 Dim down"
- "Bottom button pressed 🠖 Turn off"
integrations:
- name: deCONZ
codename: deconz
Expand Down
15 changes: 12 additions & 3 deletions docs/_data/controllers/MFKZQ01LM.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
name: MFKZQ01LM Xiaomi Smart Cube (Aqara)
device_support:
- Light (MFKZQ01LMLightController; 350ms delay)
light_example: MFKZQ01LMLightController
device_support:
- type: Light
controller: MFKZQ01LMLightController
delay: 350
mapping:
- "Shake the cube 🠖 Minimum brightness"
- "Doble tap in a surface 🠖 Toggle"
- "Swipe horizontal direction 🠖 Full brightness"
- "Flip cube 180 degrees 🠖 Color temp up / Right color wheel (1 step)"
- "Flip cube 90 degrees 🠖 Color temp down / Left color wheel (1 step)"
- "Rotate cube to left 🠖 Dim down (1 step)"
- "Rotate cube to right 🠖 Brighten up (1 step)"
integrations:
- name: Zigbee2mqtt
codename: z2m
Expand Down
17 changes: 13 additions & 4 deletions docs/_data/controllers/PJ2-2B.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
name: PJ2-2B (Lutron Caseta Pro)
device_support:
- Light (LutronCasetaProPicoLightController; 350ms delay)
- Media Player (LutronCasetaProPicoMediaPlayerController; 500ms delay)
light_example: LutronCasetaProPicoLightController
device_support:
- type: Light
controller: LutronCasetaProPicoLightController
delay: 350
mapping:
- "Top button 🠖 Full brightness"
- "Bottom button 🠖 Turn off"
- type: Media Player
controller: LutronCasetaProPicoMediaPlayerController
delay: 500
mapping:
- "Top button 🠖 Play/Pause"
- "Bottom button 🠖 Next track"
note: >-
This requires the <a href="https://github.com/upsert/lutron-caseta-pro">LutronCasetaPro</a>
CUSTOM integration by upsert. THIS WILL NOT WORK with the default Lutron Caseta integration.
Expand Down
21 changes: 17 additions & 4 deletions docs/_data/controllers/PJ2-2BRL.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
name: PJ2-2BRL (Lutron Caseta Pro)
device_support:
- Light (LutronCasetaProPicoLightController; 350ms delay)
- Media Player (LutronCasetaProPicoMediaPlayerController; 500ms delay)
light_example: LutronCasetaProPicoLightController
device_support:
- type: Light
controller: LutronCasetaProPicoLightController
delay: 350
mapping:
- "Top button 🠖 Full brightness"
- "Arrow up button 🠖 Brighten up"
- "Arrow down button 🠖 Dim down"
- "Bottom button 🠖 Turn off"
- type: Media Player
controller: LutronCasetaProPicoMediaPlayerController
delay: 500
mapping:
- "Top button 🠖 Play/Pause"
- "Arrow up button 🠖 Volume up"
- "Arrow down button 🠖 Volume down"
- "Bottom button 🠖 Next track"
note: >-
This requires the <a href="https://github.com/upsert/lutron-caseta-pro">LutronCasetaPro</a>
CUSTOM integration by upsert. THIS WILL NOT WORK with the default Lutron Caseta integration.
Expand Down
23 changes: 19 additions & 4 deletions docs/_data/controllers/PJ2-3BRL.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,23 @@
name: PJ2-3BRL (Lutron Caseta Pro)
device_support:
- Light (LutronCasetaProPicoLightController; 350ms delay)
- Media Player (LutronCasetaProPicoMediaPlayerController; 500ms delay)
light_example: LutronCasetaProPicoLightController
device_support:
- type: Light
controller: LutronCasetaProPicoLightController
delay: 350
mapping:
- "Top button 🠖 Full brightness"
- "Arrow up button 🠖 Brighten up"
- "Favourite/Middle round 🠖 50% brightness"
- "Arrow down button 🠖 Dim down"
- "Bottom button 🠖 Turn off"
- type: Media Player
controller: LutronCasetaProPicoMediaPlayerController
delay: 500
mapping:
- "Top button 🠖 Play/Pause"
- "Arrow up button 🠖 Volume up"
- "Favourite/Middle round 🠖 Next source"
- "Arrow down button 🠖 Volume down"
- "Bottom button 🠖 Next track"
note: >-
This requires the <a href="https://github.com/upsert/lutron-caseta-pro">LutronCasetaPro</a>
CUSTOM integration by upsert. THIS WILL NOT WORK with the default Lutron Caseta integration.
Expand Down
21 changes: 17 additions & 4 deletions docs/_data/controllers/PJ2-4B.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
name: PJ2-4B (Lutron Caseta Pro)
device_support:
- Light (LutronCasetaProPJ24BLightController; 350ms delay)
- Media Player (LutronCasetaProPicoPJ24BMediaPlayerController; 500ms delay)
light_example: LutronCasetaProPJ24BLightController
device_support:
- type: Light
controller: LutronCasetaProPJ24BLightController
delay: 350
mapping:
- "Top button 🠖 Full brightness"
- "Second button 🠖 Brighten up"
- "Third button 🠖 Dim down"
- "Bottom button 🠖 Turn off"
- type: Media Player
controller: LutronCasetaProPicoPJ24BMediaPlayerController
delay: 500
mapping:
- "Top button 🠖 Play/Pause"
- "Second button 🠖 Volume up"
- "Third button 🠖 Volume down"
- "Bottom button 🠖 Next track"
note: >-
This requires the <a href="https://github.com/upsert/lutron-caseta-pro">LutronCasetaPro</a>
CUSTOM integration by upsert. THIS WILL NOT WORK with the default Lutron Caseta integration.
Expand Down
13 changes: 10 additions & 3 deletions docs/_data/controllers/WXKG01LM.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
name: WXKG01LM (Aqara)
device_support:
- Light (WXKG01LMLightController; 350ms delay)
light_example: WXKG01LMLightController
device_support:
- type: Light
controller: WXKG01LMLightController
delay: 350
mapping:
- "1 click 🠖 Toggle"
- "2 clicks 🠖 Full brightness"
- "3 clicks 🠖 Minimum brightness"
- "4 clicks 🠖 50% brightness"
- "Hold the button 🠖 Brightness up/down with direction changes"
integrations:
- name: Zigbee2mqtt
codename: z2m
Expand Down
11 changes: 8 additions & 3 deletions docs/_data/controllers/WXKG11LM.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
name: WXKG11LM (Aqara)
device_support:
- Light (WXKG11LMLightController; 350ms delay)
light_example: WXKG11LMLightController
device_support:
- type: Light
controller: WXKG11LMLightController
delay: 350
mapping:
- "1 click 🠖 Toggle"
- "2 clicks 🠖 Full brightness"
- "Hold the button 🠖 Brightness up/down with direction changes"
note: >-
For z2m integration, this controller has 2 sensors that need to be added to the configuration.
One ends with `_action` and the other one with `_click`.
Expand Down
12 changes: 9 additions & 3 deletions docs/_data/controllers/WXKG12LM.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
name: WXKG12LM (Aqara)
device_support:
- Light (WXKG12LMLightController; 350ms delay)
light_example: WXKG12LMLightController
device_support:
- type: Light
controller: WXKG12LMLightController
delay: 350
mapping:
- "1 click 🠖 Toggle"
- "2 clicks 🠖 Full brightness"
- "Shake the controller 🠖 Minimum brightness"
- "Hold the button 🠖 Brightness up/down with direction changes"
note: >-
For z2m integration, this controller has 2 sensors that need to be added to the configuration.
One ends with `_action` and the other one with `_click`.
Expand Down
21 changes: 17 additions & 4 deletions docs/_data/controllers/ZYCT-202.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
name: ZYCT-202 (Trust)
device_support:
- Light (ZYCT202LightController; 350ms delay)
- Media Player (ZYCT202MediaPlayerController; 500ms delay)
light_example: ZYCT202LightController
device_support:
- type: Light
controller: ZYCT202LightController
delay: 350
mapping:
- "Click \"I\" 🠖 Turn on "
- "Hold brightness up 🠖 Brighten up"
- "Hold brightness down 🠖 Dim down"
- "Click \"O\" 🠖 Turn off"
- type: Media Player
controller: ZYCT202MediaPlayerController
delay: 500
mapping:
- "Click \"I\" 🠖 Play/Pause"
- "Hold brightness up 🠖 Volume up"
- "Hold brightness down 🠖 Volume down"
- "Click \"O\" 🠖 Play/Pause"
integrations:
- name: Zigbee2mqtt
codename: z2m
Expand Down
19 changes: 16 additions & 3 deletions docs/_data/controllers/double-key-wireless.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
name: Double key wireless (Aqara)
device_support:
- Light (DoubleKeyWirelessAqaraController; 350ms delay)
light_example: DoubleKeyWirelessAqaraController
- type: Light
controller: DoubleKeyWirelessAqaraController
delay: 350
mapping:
- "Click on both 🠖 Toggle"
- "Double click on both 🠖 Brighten up (1 step)"
- "Long click on both 🠖 Dim down (1 step)"
- "Click on left 🠖 Toggle"
- "Double click on left 🠖 Brighten up (1 step)"
- "Long click on left 🠖 Dim down (1 step)"
- "Click on right 🠖 Toggle"
- "Double click on right 🠖 Brighten up (1 step)"
- "Long click on right 🠖 Dim down (1 step)"
integrations:
- name: Zigbee2mqtt
codename: z2m
Expand All @@ -19,4 +30,6 @@ note: >-
Note that all actions related to both, left and right, do the same.
This is because ControllerX is design to control just one entity (light or media player).
So you can include the `actions` parameter to include the actions needed.
You can check <a href="https://github.com/xaviml/controllerx/issues/18#issuecomment-582535634">here</a> for reference.
You can check <a href="https://github.com/xaviml/controllerx/issues/18#issuecomment-582535634">here</a> for reference.
Also, this controller support hold action, but not release. This means that there is not
smooth brightness changes when holding, just step by step everytime is held.
Loading

0 comments on commit 3722700

Please sign in to comment.