Skip to content

Commit f55bdf1

Browse files
committed
Created documentation for Seeed relay switches
1 parent 0a25070 commit f55bdf1

File tree

3 files changed

+69
-0
lines changed

3 files changed

+69
-0
lines changed
584 KB
Loading
597 KB
Loading
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
.. _seeedmultichannelrelay_switch:
2+
3+
Seeed Multi Channel Relay Switch Component
4+
==========================================
5+
6+
.. seo::
7+
:description: Instructions for setting up seeedmultichannelrelay Switch.
8+
9+
The ``seeedmultichannelrelay`` switch platform supports the 8 channels of the relay unit. There are multi relays which are supported.
10+
The relays can be used to switch up to AC-250V or DC-110V. For more information:
11+
12+
Below are several links to supported relays
13+
https://wiki.seeedstudio.com/Grove-4-Channel_SPDT_Relay/
14+
15+
https://wiki.seeedstudio.com/Grove-8-Channel_Solid_State_Relay/
16+
17+
.. figure:: images/Seeed-4-Channel-SPDT-Relay.png
18+
:align: center
19+
:width: 80.0%
20+
21+
.. figure:: images/Seeed-8-Channel-Solid-State-Relay.png
22+
:align: center
23+
:width: 80.0%
24+
25+
.. code-block:: yaml
26+
27+
# Example configuration entry
28+
seeedmultichannelrelay:
29+
id: SeeedMultiChannelRelay_ID
30+
change_address_to: 0x11 # changes the address of the seeedmultichannelrelay only runs this once
31+
# ...
32+
33+
switch:
34+
- platform: seeedmultichannelrelay
35+
id: relay_1
36+
name: relay1
37+
channel: 1
38+
seeedmultichannelrelay_id: SeeedMultiChannelRelay_ID
39+
40+
Configuration variables:
41+
------------------------
42+
**Control**
43+
44+
- **change_address_to** (*Optional*, hex-address): This should only be added to change the i2c address
45+
on the EPROM of the relay. Afterwards the address will be permanently changed.
46+
47+
- All other options from I2C devices.
48+
49+
**Switch**
50+
51+
- **channel** (*Required*, string): The channel number to switch, options are 1 to 8 (depending on the relay switch design).
52+
- **seeedmultichannelrelay_id** (*Optional*, :ref:`config-id`): The ID of the Seed relay.
53+
- **interlock** (*Optional*, list): A list of other switches in an interlock group. See
54+
:ref:`switch-gpio-interlocking`.
55+
- **interlock_wait_time** (*Optional*, :ref:`config-time`): For interlocking mode, set how long
56+
to wait after other items in an interlock group have been disabled before re-activating.
57+
Useful for motors where immediately turning on in the other direction could cause problems.
58+
59+
- All other options from :ref:`Switch <config-switch>`.
60+
61+
This switch supports the same interlocking as the GPIO switch.
62+
63+
See Also
64+
--------
65+
66+
- :doc:`index`
67+
- :apiref:`seeedmultichannelrelay/switch/seeedmultichannelrelay_switch.h`
68+
- :apiref:`gpio/switch/gpio_switch.h`
69+
- :ghedit:`Edit`

0 commit comments

Comments
 (0)