docs(controller): add example configuration to each controller page

xaviml · Mar 26, 2020 · 21b86c3 · 21b86c3
1 parent 33a5c1b
commit 21b86c3
Show file tree

Hide file tree

Showing 18 changed files with 30 additions and 2 deletions.
diff --git a/docs/_data/controllers/E1524_E1810.yml b/docs/_data/controllers/E1524_E1810.yml
@@ -2,11 +2,13 @@ name: E1524/E1810 (IKEA)
 device_support: 
   - Light (E1810Controller; 350ms delay)
   - Media Player (E1810MediaPlayerController; 500ms delay)
+light_example: E1810Controller
 integrations:
   - name: Zigbee2mqtt
     codename: z2m
     actions:
       - "toggle 🠖 Click ⏻"
+      - "toggle_hold 🠖 Hold ⏻"
       - "brightness_up_click 🠖 Click 🔆"
       - "brightness_down_click  🠖 Click 🔅"
       - "arrow_left_click 🠖 Click <"

diff --git a/docs/_data/controllers/E1743.yml b/docs/_data/controllers/E1743.yml
@@ -1,6 +1,7 @@
 name: E1743 (IKEA)
 device_support: 
   - Light (E1743Controller; 350ms delay)
+light_example: E1743Controller
 integrations:
   - name: Zigbee2mqtt
     codename: z2m

diff --git a/docs/_data/controllers/E1744.yml b/docs/_data/controllers/E1744.yml
@@ -2,6 +2,7 @@ name: E1744 (IKEA)
 device_support: 
   - Light (E1744LightController; 1200ms delay)
   - Media Player (E1744MediaPlayerController; 1000ms delay)
+light_example: E1744LightController
 integrations:
   - name: Zigbee2mqtt
     codename: z2m

diff --git a/docs/_data/controllers/ICTCG1.yml b/docs/_data/controllers/ICTCG1.yml
@@ -1,6 +1,7 @@
 name: ICTCG1 (IKEA)
 device_support: 
   - Light (ICTCG1Controller; 350ms delay)
+light_example: ICTCG1Controller
 integrations:
   - name: Zigbee2mqtt
     codename: z2m

diff --git a/docs/_data/controllers/IM6001-BTP01.yml b/docs/_data/controllers/IM6001-BTP01.yml
@@ -2,6 +2,7 @@ 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.

diff --git a/docs/_data/controllers/LZL4BWHL01.yml b/docs/_data/controllers/LZL4BWHL01.yml
@@ -1,6 +1,7 @@
 name: LZL4BWHL01 (Lutron)
 device_support: 
   - Light (LZL4BWHL01LightController; 350ms delay)
+light_example: LZL4BWHL01LightController
 integrations:
   - name: deCONZ
     codename: deconz

diff --git a/docs/_data/controllers/MFKZQ01LM.yml b/docs/_data/controllers/MFKZQ01LM.yml
@@ -1,6 +1,7 @@
 name: MFKZQ01LM Xiaomi Smart Cube (Aqara)
 device_support: 
   - Light (MFKZQ01LMLightController; 350ms delay)
+light_example: MFKZQ01LMLightController
 integrations:
   - name: Zigbee2mqtt
     codename: z2m

diff --git a/docs/_data/controllers/PJ2-2B.yml b/docs/_data/controllers/PJ2-2B.yml
@@ -2,7 +2,7 @@ name: PJ2-2B (Lutron Caseta Pro)
 device_support: 
   - Light (LutronCasetaProPicoLightController; 350ms delay)
   - Media Player (LutronCasetaProPicoMediaPlayerController; 500ms delay)
-
+light_example: LutronCasetaProPicoLightController
 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.

diff --git a/docs/_data/controllers/PJ2-2BRL.yml b/docs/_data/controllers/PJ2-2BRL.yml
@@ -2,6 +2,7 @@ name: PJ2-2BRL (Lutron Caseta Pro)
 device_support: 
   - Light (LutronCasetaProPicoLightController; 350ms delay)
   - Media Player (LutronCasetaProPicoMediaPlayerController; 500ms delay)
+light_example: LutronCasetaProPicoLightController
 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.

diff --git a/docs/_data/controllers/PJ2-3BRL.yml b/docs/_data/controllers/PJ2-3BRL.yml
@@ -2,6 +2,7 @@ name: PJ2-3BRL (Lutron Caseta Pro)
 device_support: 
   - Light (LutronCasetaProPicoLightController; 350ms delay)
   - Media Player (LutronCasetaProPicoMediaPlayerController; 500ms delay)
+light_example: LutronCasetaProPicoLightController
 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.

diff --git a/docs/_data/controllers/PJ2-4B.yml b/docs/_data/controllers/PJ2-4B.yml
@@ -2,6 +2,7 @@ name: PJ2-4B (Lutron Caseta Pro)
 device_support: 
   - Light (LutronCasetaProPJ24BLightController; 350ms delay)
   - Media Player (LutronCasetaProPicoPJ24BMediaPlayerController; 500ms delay)
+light_example: LutronCasetaProPJ24BLightController
 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.

diff --git a/docs/_data/controllers/WXKG01LM.yml b/docs/_data/controllers/WXKG01LM.yml
@@ -1,6 +1,7 @@
 name: WXKG01LM (Aqara)
 device_support: 
   - Light (WXKG01LMLightController; 350ms delay)
+light_example: WXKG01LMLightController
 integrations:
   - name: Zigbee2mqtt
     codename: z2m

diff --git a/docs/_data/controllers/WXKG11LM.yml b/docs/_data/controllers/WXKG11LM.yml
@@ -1,6 +1,7 @@
 name: WXKG11LM (Aqara)
 device_support: 
   - Light (WXKG11LMLightController; 350ms delay)
+light_example: WXKG11LMLightController
 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`.

diff --git a/docs/_data/controllers/WXKG12LM.yml b/docs/_data/controllers/WXKG12LM.yml
@@ -1,6 +1,7 @@
 name: WXKG12LM (Aqara)
 device_support: 
   - Light (WXKG12LMLightController; 350ms delay)
+light_example: WXKG12LMLightController
 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`.

diff --git a/docs/_data/controllers/ZYCT-202.yml b/docs/_data/controllers/ZYCT-202.yml
@@ -2,6 +2,7 @@ name: ZYCT-202 (Trust)
 device_support: 
   - Light (ZYCT202LightController; 350ms delay)
   - Media Player (ZYCT202MediaPlayerController; 500ms delay)
+light_example: ZYCT202LightController
 integrations:
   - name: Zigbee2mqtt
     codename: z2m

diff --git a/docs/_data/controllers/double-key-wireless.yml b/docs/_data/controllers/double-key-wireless.yml
@@ -1,6 +1,7 @@
 name: Double key wireless (Aqara)
 device_support: 
-  - Light (E1810Controller; 350ms delay)
+  - Light (DoubleKeyWirelessAqaraController; 350ms delay)
+light_example: DoubleKeyWirelessAqaraController
 integrations:
   - name: Zigbee2mqtt
     codename: z2m

diff --git a/docs/_data/controllers/hue-dimmer-switch.yml b/docs/_data/controllers/hue-dimmer-switch.yml
@@ -1,6 +1,7 @@
 name: Hue Dimmer switch (Philips)
 device_support: 
   - Light (HueDimmerController; 350ms delay)
+light_example: HueDimmerController
 integrations:
   - name: Zigbee2mqtt
     codename: z2m

diff --git a/docs/_layouts/controller.html b/docs/_layouts/controller.html
@@ -27,6 +27,17 @@
   </table>
 
   <div>
+    <h3>Example configuration</h3>
+    <pre>
+      <code lang="yaml">
+  example_app:
+    module: controllerx
+    class: {{ controller.light_example }}
+    controller: < controller_id >
+    integration: < {{integration_names}} >
+    light: < light_entity >
+      </code>
+    </pre>
     {% if controller.note %}
     <h3>Note</h3>
     {{controller.note}} {% endif %}