Seeed multi channel relay control documentation

.github/workflows/docker.yml

@@ -20,7 +20,7 @@ jobs:
     steps:
       -
         name: Checkout source code
-        uses: actions/checkout@v3.5.0
+        uses: actions/checkout@v3.5.2
       -
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
@@ -39,7 +39,7 @@ jobs:
       -
         name: Build and push
         id: docker_build
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v4
         with:
           context: .
           push: true

.github/workflows/lint.yml

@@ -19,7 +19,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3.5.0
+    - uses: actions/checkout@v3.5.2
     - name: Set up Python 3.8
       uses: actions/setup-python@v4
       with:

.github/workflows/stale.yml

@@ -16,7 +16,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v7
+      - uses: actions/stale@v8
         with:
           days-before-pr-stale: 60
           days-before-pr-close: 7
@@ -35,7 +35,7 @@ jobs:
   close-issues:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@v7
+      - uses: actions/stale@v8
         with:
           days-before-pr-stale: -1
           days-before-pr-close: -1

.gitignore

@@ -11,3 +11,5 @@ venv
 .vscode
 *.DS_Store
 /.idea/
+/.vs/m5stackrelaydoc/v16
+/.vs

_redirects

@@ -9,3 +9,30 @@
 
 /changelog/2022.12.4.html /changelog/2022.12.0.html 301
 /components/display/ili9341.html /components/display/ili9xxx.html 301
+
+/cookbook/brilliant-mirabella-genio-smart-plugs.html https://devices.esphome.io/devices/Mirabella-Genio-Wi-Fi-1-USB 301
+/cookbook/zemismart-rgbw-downlights.html https://devices.esphome.io/devices/Zemismart-LED-RGBWW-Downlight 301
+/cookbook/relay.html https://devices.esphome.io/devices/Generic-Relay 301
+/cookbook/pir.html https://devices.esphome.io/devices/Generic-PIR 301
+/cookbook/mirabella-genio-bulb.html https://devices.esphome.io/devices/Mirabella-Genio-Monochromatic-Bulbs 301
+/cookbook/air_gradient_diy_air_quality_sensor.html https://devices.esphome.io/devices/AirGradient-DIY 301
+/cookbook/ble_itag.html https://devices.esphome.io/devices/ble_itag 301
+/cookbook/bruh.html https://devices.esphome.io/devices/bruh 301
+/cookbook/esw01-eu.html https://devices.esphome.io/devices/Etekcity-Voltson-ESW01-EU 301
+/cookbook/geiger-counter.html https://devices.esphome.io/devices/geiger-counter 301
+/cookbook/h801.html https://devices.esphome.io/devices/H801-RGBW-LED-Controller 301
+/cookbook/iaq_board.html https://devices.esphome.io/devices/iaq_board 301
+/cookbook/ifan02.html https://devices.esphome.io/devices/Sonoff-iFan02 301
+/cookbook/ilonda-wifi-smart-fish-feeder.html https://devices.esphome.io/devices/ilonda-wifi-smart-fish-feeder 301
+/cookbook/iwoole_rgbw_table_lamp.html https://devices.esphome.io/devices/iwoole_rgbw_table_lamp 301
+/cookbook/teckin_sb50.html https://devices.esphome.io/devices/Teckin-SB50_rgbww 301
+/cookbook/temt6000.html https://devices.esphome.io/devices/temt6000 301
+/cookbook/tracer-an.html https://devices.esphome.io/devices/epever_mptt_tracer_an 301
+/cookbook/tuya_rgbw.html https://devices.esphome.io/devices/tuya_rgbw 301
+/cookbook/uart_text_sensor.html /cookbook/lambda_magic.html#custom-uart-text-sensor 301
+/cookbook/endstop-cover.html /components/cover/endstop.html 301
+/cookbook/sonoff-light-switch.html https://devices.esphome.io/devices/Sonoff-Dual-DIY-light 301
+/cookbook/sonoff-basic-light-switch.html https://devices.esphome.io/devices/Sonoff-Basic-DIY-light 301
+/cookbook/sonoff-dual-light-switch.html https://devices.esphome.io/devices/Sonoff-Dual-DIY-light 301
+/cookbook/sonoff-t1-3.html https://devices.esphome.io/devices/Sonoff-T1-T2-T3 301
+/cookbook/dual-r2-cover.html /cookbook/lambda_magic.html#one-button-cover-control 301

components/output/template.rst

@@ -72,7 +72,7 @@ It is possible to access the state value inside Lambdas:
                 - output.turn_off: button_off
 
 
-Complete example from the cookbook: :doc:`Sonoff Dual Light Switch</cookbook/sonoff-dual-light-switch>`.
+Complete example: `Sonoff Dual Light Switch <https://devices.esphome.io/devices/Sonoff-Dual-DIY-light>`__.
 
 See Also
 --------

components/sensor/homeassistant.rst

@@ -32,7 +32,7 @@ Entity state attributes can also be imported:
     This component is only for numeral states. If you want to import arbitrary text states
     from Home Assistant, use the :doc:`Home Assistant Text Sensor </components/text_sensor/homeassistant>`.
 
-    Albeit you might not plan to *export* states from the node and you do not need an entity of the node
+    Although you might not plan to *export* states from the node and you do not need an entity of the node
     in Home Assistant, this component still requires you to register the node under Home Assistant. See:
     :doc:`Getting started with Home Assistant </guides/getting_started_hassio>`
 
@@ -50,7 +50,7 @@ Configuration variables:
 
 .. note::
 
-    The sensors implemented by this component are by default ``internal``, to avoid exporting back them to 
+    The sensors implemented by this component are by default ``internal``, to avoid exporting them back to 
     Home Assistant. Should you still want to do that (eg. because you use ESPHome's very efficient filters
     on them) you need to specifically configure ``internal: false``. Also, ``state_class``, ``unit_of_measurement`` 
     are not inherited from the imported sensor so you need to set them manually.

components/switch/m5stack4relay.rst

@@ -0,0 +1,52 @@
+.. _m5stack4relay_switch:
+
+M5Stack 4 Relay Switch Component
+================================
+
+.. seo::
+    :description: Instructions for setting up m5stack4relay Switch.
+    :image: m5stack4relay.jpg
+
+The ``m5stack4relay`` switch platform supports the 4 channels of the relay unit. 
+The relays can be used to switch up to AC-230V or DC-28V. For more information: https://docs.m5stack.com/en/unit/4relay
+
+.. figure:: images/m5stack4relay.png
+    :align: center
+    :width: 80.0%
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    m5stack4relay:
+        id: M5stackrelay_ID1
+        # ...
+
+    switch:
+      - platform: m5stack4relay
+        id: relay_1
+        name: relay1
+        channel: 1
+        m5stack4relay_id: M5stackrelay_ID1
+
+Configuration variables:
+------------------------
+
+- **channel** (*Required*, string): The channel number to switch, options are 1, 2, 3 or 4.
+- **m5stack4relay_id** (*Optional*, :ref:`config-id`): The ID of the M5Stack 4 relay.
+- **interlock** (*Optional*, list): A list of other switches in an interlock group. See
+  :ref:`switch-gpio-interlocking`.
+- **interlock_wait_time** (*Optional*, :ref:`config-time`): For interlocking mode, set how long
+  to wait after other items in an interlock group have been disabled before re-activating.
+  Useful for motors where immediately turning on in the other direction could cause problems.
+
+- All other options from :ref:`Switch <config-switch>`.
+
+This switch supports the same interlocking as the GPIO switch.
+
+See Also
+--------
+
+- :doc:`index`
+- :apiref:`m5stack4relay/switch/m5stack4relay_switch.h`
+- :apiref:`gpio/switch/gpio_switch.h`
+- :ghedit:`Edit`

components/switch/seeedmultichannelrelay.rst

@@ -0,0 +1,69 @@
+.. _seeedmultichannelrelay_switch:
+
+Seeed Multi Channel Relay Switch Component
+==========================================
+
+.. seo::
+    :description: Instructions for setting up seeedmultichannelrelay Switch.
+    :image: seeedmultichannelrelay.jpg
+
+The ``seeedmultichannelrelay`` switch platform supports the 8 channels of the relay unit. There are multi relays which are supported.
+The relays can be used to switch up to AC-250V or DC-110V. For more information: 
+
+Below are several links to supported relays
+https://wiki.seeedstudio.com/Grove-4-Channel_SPDT_Relay/
+https://wiki.seeedstudio.com/Grove-8-Channel_Solid_State_Relay/
+
+.. figure:: images/Seeed-4-Channel-SPDT-Relay.png
+    :align: center
+    :width: 80.0%
+
+.. figure:: images/Seeed-8-Channel-Solid-State-Relay.png
+    :align: center
+    :width: 80.0%
+
+.. code-block:: yaml
+
+    # Example configuration entry
+    seeedmultichannelrelay:
+        id: SeeedMultiChannelRelay_ID
+        address: 0x11 # changes the address of the seeedmultichannelrelay only runs this once
+        # ...
+
+    switch:
+      - platform: seeedmultichannelrelay
+        id: relay_1
+        name: relay1
+        channel: 1
+        seeedmultichannelrelay_id: SeeedMultiChannelRelay_ID
+
+Configuration variables:
+------------------------
+**Control**
+
+- **addres** (*Optional*, hex-address): This should only be added to change the i2c address
+  on the EPROM of the relay. Afterwards the address will be permanently changed.
+
+- All other options from I2C devices.
+
+**Switch**
+
+- **channel** (*Required*, string): The channel number to switch, options are 1 to 8 (depending on the relay switch design).
+- **seeedmultichannelrelay_id** (*Optional*, :ref:`config-id`): The ID of the Seed relay.
+- **interlock** (*Optional*, list): A list of other switches in an interlock group. See
+  :ref:`switch-gpio-interlocking`.
+- **interlock_wait_time** (*Optional*, :ref:`config-time`): For interlocking mode, set how long
+  to wait after other items in an interlock group have been disabled before re-activating.
+  Useful for motors where immediately turning on in the other direction could cause problems.
+
+- All other options from :ref:`Switch <config-switch>`.
+
+This switch supports the same interlocking as the GPIO switch.
+
+See Also
+--------
+
+- :doc:`index`
+- :apiref:`seeedmultichannelrelay/switch/seeedmultichannelrelay_switch.h`
+- :apiref:`gpio/switch/gpio_switch.h`
+- :ghedit:`Edit`