From 1e3faefa64453101c83fe0efe3c334a87c18fff8 Mon Sep 17 00:00:00 2001 From: discodyer Date: Sat, 4 Jan 2025 14:00:23 +0800 Subject: [PATCH 1/9] add: Added Get One Now button and cover image --- .../2_Channel_Wi_Fi_AC_Relay_Module.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md index 7ec70d97634a..02d45c0de5ab 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md @@ -2,7 +2,7 @@ title: 2-Channel Wi-Fi AC Relay Module In Home Assistant description: | A smart device from Seeed Studio designed to control AC-powered appliances wirelessly -image: https://files.seeedstudio.com/wiki/XIAO/Gadgets/2_channel_ac_relay/3-thumbnail.webp +image: https://files.seeedstudio.com/wiki/XIAO/Gadgets/2_channel_ac_relay/2-114993526-dual-smart-relay-module-for-xiao-45font.jpg slug: /2_channel_wifi_ac_relay keywords: - XIAO @@ -15,6 +15,16 @@ last_update: date: 2024-11-27T03:21:36.491Z --- +# Getting started with 2-Channel Wi-Fi AC Relay Module In Home Assistant + +
+ +
+ + Get One Now 🖱️ + +

+ ## Overview The **[2-Channel Wi-Fi AC Relay Module](https://www.seeedstudio.com/Dual-Smart-Relay-Module-for-XIAO-p-6309.html)** is a smart device from Seeed Studio designed to control AC-powered appliances wirelessly. Its dual-channel configuration supports independent control of two loads, making it an excellent choice for automating household appliances such as lights, fans, and other devices in a Home Assistant environment. From dac2cbb8e9fe69ed75db2c554f3c9cafd44ff1d0 Mon Sep 17 00:00:00 2001 From: discodyer Date: Sat, 4 Jan 2025 15:41:34 +0800 Subject: [PATCH 2/9] add: add 6-Channel Wi-Fi Relay Module In Home Assistant page --- .../6_Channel_Wi_Fi_Relay_Module.md | 270 ++++++++++++++++++ .../RS485_Vision_AI_Camera.md | 2 +- .../Relay_add_on_module_for_xiao.md | 2 +- 3 files changed, 272 insertions(+), 2 deletions(-) create mode 100644 docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md new file mode 100644 index 000000000000..05982c64f4ac --- /dev/null +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md @@ -0,0 +1,270 @@ +--- +title: 6-Channel Wi-Fi Relay Module In Home Assistant +description: | + A smart device from Seeed Studio designed to wirelessly control devices with safe DC voltage. +image: https://files.seeedstudio.com/wiki/XIAO/Gadgets/6_channel_wifi_relay/six_channel_wifi_relay_simplified_diagram.png +slug: /6_channel_wifi_relay +keywords: + - XIAO + - Home Assistant + - Relay + - Smart Home +sidebar_position: 2 +last_update: + author: Cody + date: 01/04/2025 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Getting started with 6-Channel Wi-Fi Relay Module In Home Assistant + +
+ +
+ + Get One Now 🖱️ + +

+ +## Overview + +The **[6-Channel Wi-Fi Relay Module](https://www.seeedstudio.com/)** is a smart device from Seeed Studio designed for control within a safe DC voltage range, not for AC-powered appliances. Its six-channel configuration supports independent control of up to six loads, making it an excellent choice for automating a variety of devices in smart home environments. + +In addition to its six relay channels, this module also features two extra Grove expansion interfaces, allowing users to integrate additional sensors or actuators for more advanced automation scenarios. + +This guide provides a detailed walkthrough, including setup, integration, and advanced configuration for users ranging from beginners to smart-home enthusiasts. + +### Key Features and Specifications + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureDetails
Input VoltageDC 0~30V
Output VoltageDC 0~30V
Maximum Load10A per channel
Channels6 (independent control for each channel)
Connection TypeWi-Fi
Electrical portNO (Normally Open), COM (Common), NC (Normally Closed)
Grove extensionIIC×1, UART×1
+
+ +:::warning Safety Warning + +This relay module is designed for low-voltage DC operation. Do not connect it to AC power to avoid electrical hazards. Always disconnect the power supply before wiring the relay to prevent short circuits and electric shock. + +Voltages exceeding 24V may cause electric shock or burns, especially in cases of broken skin or in moist environments. Exercise caution when handling electrical devices to avoid injury. + +::: + +### Physical Layout and Connections + +
+ +- **NO (Normally Open)**: The normally open terminal. By default, this terminal is not connected to the common terminal (COM). When the relay is activated, the NO terminal connects to the COM terminal. It is typically used to control a load's switch. +- **COM (Common)**: The common terminal of the relay, shared as a connection point to one side of the circuit. +- **NC (Normally Closed)**: The normally closed terminal. By default, this terminal is connected to the common terminal (COM). When the relay is activated, the connection between the NC terminal and the COM terminal is broken. It is typically used for scenarios requiring disconnection control. + + | XIAO GPIO | Relay Channel | + | --------- | ------------- | + | GPIO2 | Relay 1 | + | GPIO21 | Relay 2 | + | GPIO1 | Relay 3 | + | GPIO0 | Relay 4 | + | GPIO19 | Relay 5 | + | GPIO18 | Relay 6 | + +## Getting Started + +### Requirements + +1. **Core Components**: + - 6-Channel Wi-Fi Relay Module +2. **Software**: + - **Home Assistant**: A smart home platform that will manage the sensor data. + - **ESPHome Add-on**: Firmware that enables easy configuration and management of ESP32 devices. +3. **Network**: + - Stable Wi-Fi for seamless interaction between hardware and Home Assistant. + +### Step 1: Setting Up Home Assistant {#setting-up-home-assistant} + +1. **Installation**: For optimal performance, it's recommended to install [Home Assistant OS](https://www.home-assistant.io/installation/) on a Virtual Machine or Raspberry Pi. Follow the official installation guide on the Home Assistant website. +2. **Enabling ESPHome Add-on**: + - Access the Home Assistant dashboard. + - Navigate to the "Add-ons" section and search for the ESPHome add-on. + - Click "Install" and then "Start" to enable it. + - Once installed, configure the add-on to ensure proper communication with the XIAO ESP32C6. + +
+ +By gathering the necessary components and setting up Home Assistant with the ESPHome add-on, you'll be ready to proceed with the integration of the 6-Channel relay module. + +:::tip install Home Assistant +We have also written how to install Home Assistant for some of Seeed Studio products, please refer to them. + +- [Getting Started with Home Assistant on ODYSSEY-X86](/ODYSSEY-X86-Home-Assistant) +- [Getting Started with Home Assistant on reTerminal](/reTerminal_Home_Assistant) +- [Getting Started with Home Assistant on LinkStar H68K/reRouter CM4](/h68k-ha-esphome) +::: + +### Step 2: Preparing the Relay Module + +By default, your device (XIAO ESP32C6) comes pre-flashed with firmware for 6-Channel relay. However, there are two scenarios where you may need to update the firmware: + +1. **Re-flashing the Firmware**: If the existing firmware is corrupted or you need to start fresh. +2. **Upgrading the Firmware**: If there is a newer version of the firmware with improved functionality. + +There are two simple methods for flashing the firmware: + +:::caution +Firefox does not support flashing firmware on ESP devices. Please use Google Chrome or Microsoft Edge instead. +::: + + + + +You can use this [Web Tool](https://seeed-projects.github.io/6-Channel_Relay_based_on_XIAO_ESP32C6/) for an easy and direct method to flash your firmware. Simply follow the on-screen instructions. + +- Click the `CONNECT` button to initiate the connection. The tool will automatically update the firmware. + +If something goes wrong, follow the on-screen troubleshooting steps or switch to the `ESPHome Web` method to complete the process. + + + + +For this method, you'll need to download the `bin` firmware file from [here](https://github.com/Seeed-Projects/6-Channel_Relay_based_on_XIAO_ESP32C6/releases)(you'll need to unzip the downloaded file). + +1. Connect the sensor kit to your PC. +2. Visit the [ESPHome Web](https://web.esphome.io/) page. +3. Select the firmware file with the `*.factory.bin` suffix. + +Watch the following video for a detailed walkthrough of flashing the firmware via ESPHome Web: + + + + + + +With either method, you'll have your firmware updated and ready for integration with Home Assistant. + +### Step 3: Network Configuration + +1. **Enable Access Point**: + - Upon powering up for the first time, the module will create a Wi-Fi network (SSID: `seeedstudio-6-channel-relay`). + +
+ +2. **Access Configuration**: + - Connect to the network using a phone or PC. + - Open a browser and navigate to . + - Enter the SSID and password of your home Wi-Fi network. + +
+ +3. **Home Assistant Integration**: + - Once connected to the home network, the module will be discoverable in Home Assistant under `Settings -> Devices & Services`. + +
+ +This way, you can connect the module to your Home Assistant network and let Home Assistant discover it. + +### Step 4: Add the module device + +1. **Automatic Discovery**: + - Ensure the **ESPHome** is installed in Home Assistant. + - Navigate to `Settings -> Devices & Services -> Integrations` and look for the device. +2. **Manual Configuration**: + - If not automatically discovered, manually add the device by specifying its IP address. + +After adding the device, you can see all six switches in the Overview page. + +
+ +You can also set the name of each switch individually. + +
+ +### Step 5: Connect the appliances you want to control + +:::warning Safety Warning + +This relay module is designed for low-voltage DC operation. Do not connect it to AC power to avoid electrical hazards. Always disconnect the power supply before wiring the relay to prevent short circuits and electric shock. + +Voltages exceeding 24V may cause electric shock or burns, especially in cases of broken skin or in moist environments. Exercise caution when handling electrical devices to avoid injury. + +::: + +1. Wiring: + - Follow the Physical Layout and Connections section to wire the relay module. + - Ensure all connections are secure, and there are no exposed wires. +2. Power On: + - Power on the module through USB. + - Turn on the DC power supply to control other electrical appliances. + +## Automation and Use Cases + +1. Basic Automation: + - Create a time-based schedule to toggle the relay at specific times. +2. Sensor Integration: + - Combine the relay with a temperature or motion sensor for conditional control (e.g., turn on a fan when the temperature exceeds a threshold). +3. Notifications: + - Set up Home Assistant to send notifications when the relay state changes or if the device goes offline. + +## Safety and Maintenance + +1. Periodically inspect wiring for wear and tear. +2. Use proper circuit protection devices, such as fuses or breakers. +3. Keep the device away from water and excessive heat. + +## FAQs + +1. **What happens if the device is disconnected from Wi-Fi?** + - The module will attempt to reconnect automatically. If it fails, it will enable its fallback access point for reconfiguration. +2. **Can I use the USB port while connected to AC power?** + - No, using USB while connected to AC power may damage the device or create a safety hazard. +3. **Can this module work without Home Assistant?** + - Yes, the module can be controlled via its **local IP address** or integrated with other platforms that support ESPHome or MQTT. + +## Tech Support & Product Discussion + +Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs. + +
+ + +
+ +
+ + +
diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/RS485_Vision_AI_Camera.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/RS485_Vision_AI_Camera.md index 5a3970c678fb..6e549d83e017 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/RS485_Vision_AI_Camera.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/RS485_Vision_AI_Camera.md @@ -6,7 +6,7 @@ keywords: - Camera image: https://files.seeedstudio.com/wiki/A1102/SenseCraft_AI_With_A1102/top.webp slug: /getting_started_with_rs485_vision_ai_cam -sidebar_position: 3 +sidebar_position: 4 last_update: date: 12/26/2024 author: Jason diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/Relay_add_on_module_for_xiao.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/Relay_add_on_module_for_xiao.md index 23519dfe5a19..7c78728b457a 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/Relay_add_on_module_for_xiao.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/Relay_add_on_module_for_xiao.md @@ -8,7 +8,7 @@ keywords: - Home Assistant - AC Relay - Smart Home -sidebar_position: 2 +sidebar_position: 3 last_update: author: Allen date: 12/02/2024 From 0a3d6675f2c085c7d19fa365ae5021f13c7916ab Mon Sep 17 00:00:00 2001 From: discodyer Date: Sat, 4 Jan 2025 17:40:42 +0800 Subject: [PATCH 3/9] add: Added wiring diagram for two-channel relay module --- .../SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md index 02d45c0de5ab..86d985f01a3b 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md @@ -84,6 +84,8 @@ Always disconnect AC power before wiring the relay. Avoid using the USB port whi #### Input and Output Terminals +
+ - Input - **N (Neutral)**: Connect the neutral wire from the AC power supply. - **L (Live)**: Connect the live wire from the AC power supply. From aa4e21e858559cb1da5a911549c910ed8dfc925a Mon Sep 17 00:00:00 2001 From: discodyer Date: Mon, 6 Jan 2025 12:52:41 +0800 Subject: [PATCH 4/9] update: Modified some content --- .../2_Channel_Wi_Fi_AC_Relay_Module.md | 33 +++---------------- .../6_Channel_Wi_Fi_Relay_Module.md | 17 ++++------ 2 files changed, 11 insertions(+), 39 deletions(-) diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md index 86d985f01a3b..0638886a547c 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md @@ -2,7 +2,7 @@ title: 2-Channel Wi-Fi AC Relay Module In Home Assistant description: | A smart device from Seeed Studio designed to control AC-powered appliances wirelessly -image: https://files.seeedstudio.com/wiki/XIAO/Gadgets/2_channel_ac_relay/2-114993526-dual-smart-relay-module-for-xiao-45font.jpg +image: https://files.seeedstudio.com/wiki/XIAO/Gadgets/2_channel_ac_relay/dual_smart_relay_module_for_xiao_45font.webp slug: /2_channel_wifi_ac_relay keywords: - XIAO @@ -97,24 +97,6 @@ Always disconnect AC power before wiring the relay. Avoid using the USB port whi - **N2 (Neutral)**: Neutral wire for the load connected to Relay 2. - **L2 (Live)**: Live wire for the load connected to Relay 2. -#### Physical Representation - -``` diagram -+-----------------------------------------+ -| Seeed Studio 2-Channel AC Wi-Fi Relay | -|-----------------------------------------| -| Input: | -| N (Neutral) | -| L (Live) | -| Output: Channel 1 | -| N1 (Neutral for Load 1) | -| L1 (Live for Load 1) | -| Output: Channel 2 | -| N2 (Neutral for Load 2) | -| L2 (Live for Load 2) | -+-----------------------------------------+ -``` - ## Getting Started ### Requirements @@ -156,15 +138,6 @@ This way, you can connect the module to your Home Assistant network and let Home 2. **Manual Configuration**: - If not automatically discovered, manually add the device by specifying its IP address. -## Automation and Use Cases - -1. Basic Automation: - - Create a time-based schedule to toggle the relay at specific times. -2. Sensor Integration: - - Combine the relay with a temperature or motion sensor for conditional control (e.g., turn on a fan when the temperature exceeds a threshold). -3. Notifications: - - Set up Home Assistant to send notifications when the relay state changes or if the device goes offline. - ## Safety and Maintenance 1. Periodically inspect wiring for wear and tear. @@ -180,6 +153,10 @@ This way, you can connect the module to your Home Assistant network and let Home 3. **Can this module work without Home Assistant?** - Yes, the module can be controlled via its **local IP address** or integrated with other platforms that support ESPHome or MQTT. +## Resources + +- **GitHub Repository**: Access the ESPHome Firmware at the [Seeed Studio Dual Channel Relay Module GitHub page](https://github.com/limengdu/2-Channel_Relay_based_on_XIAO_ESP32C3). + ## Tech Support & Product Discussion Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs. diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md index 05982c64f4ac..796025c8905c 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md @@ -49,10 +49,10 @@ This guide provides a detailed walkthrough, including setup, integration, and ad Input Voltage - DC 0~30V + DC 5V(For XIAO) - Output Voltage + DC withstand voltage DC 0~30V @@ -231,15 +231,6 @@ Voltages exceeding 24V may cause electric shock or burns, especially in cases of - Power on the module through USB. - Turn on the DC power supply to control other electrical appliances. -## Automation and Use Cases - -1. Basic Automation: - - Create a time-based schedule to toggle the relay at specific times. -2. Sensor Integration: - - Combine the relay with a temperature or motion sensor for conditional control (e.g., turn on a fan when the temperature exceeds a threshold). -3. Notifications: - - Set up Home Assistant to send notifications when the relay state changes or if the device goes offline. - ## Safety and Maintenance 1. Periodically inspect wiring for wear and tear. @@ -255,6 +246,10 @@ Voltages exceeding 24V may cause electric shock or burns, especially in cases of 3. **Can this module work without Home Assistant?** - Yes, the module can be controlled via its **local IP address** or integrated with other platforms that support ESPHome or MQTT. +## Resources + +- **GitHub Repository**: Access the ESPHome Firmware at the [Seeed Studio 6 Channel Relay Module GitHub page](https://github.com/Seeed-Projects/6-Channel_Relay_based_on_XIAO_ESP32C6). + ## Tech Support & Product Discussion Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs. From 23e8531dcb47d28b3e7236211c50141ff773a72f Mon Sep 17 00:00:00 2001 From: discodyer Date: Mon, 6 Jan 2025 18:45:11 +0800 Subject: [PATCH 5/9] update: Modify Requirements --- .../2_Channel_Wi_Fi_AC_Relay_Module.md | 8 +++----- .../6_Channel_Wi_Fi_Relay_Module.md | 8 +++----- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md index 0638886a547c..300e04c208f9 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md @@ -102,11 +102,9 @@ Always disconnect AC power before wiring the relay. Avoid using the USB port whi ### Requirements 1. **Core Components**: - - 2-Channel Wi-Fi AC Relay Module -2. **Software**: - - Home Assistant installed - - **ESPHome Add-On** set up for device communication(if not then the device will not be discovered) -3. **Network**: + - [2-Channel Wi-Fi AC Relay Module](https://www.seeedstudio.com/Dual-Smart-Relay-Module-for-XIAO-p-6309.html) + - [Home Assistant Green](https://www.seeedstudio.com/Home-Assistant-Green-p-5792.html) +2. **Network**: - Stable Wi-Fi for seamless interaction between hardware and Home Assistant. ### Step 1: Set Up the Relay Module (Physical Setup) diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md index 796025c8905c..ceb562e2a16f 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md @@ -109,11 +109,9 @@ Voltages exceeding 24V may cause electric shock or burns, especially in cases of ### Requirements 1. **Core Components**: - - 6-Channel Wi-Fi Relay Module -2. **Software**: - - **Home Assistant**: A smart home platform that will manage the sensor data. - - **ESPHome Add-on**: Firmware that enables easy configuration and management of ESP32 devices. -3. **Network**: + - [6-Channel Wi-Fi Relay Module](https://www.seeedstudio.com/) + - [Home Assistant Green](https://www.seeedstudio.com/Home-Assistant-Green-p-5792.html) +2. **Network**: - Stable Wi-Fi for seamless interaction between hardware and Home Assistant. ### Step 1: Setting Up Home Assistant {#setting-up-home-assistant} From 20a61dd8972e2f458e1d8f097b620fe24216111d Mon Sep 17 00:00:00 2001 From: discodyer Date: Wed, 8 Jan 2025 17:58:31 +0800 Subject: [PATCH 6/9] update: Modified the page content of dual channel relay --- .../2_Channel_Wi_Fi_AC_Relay_Module.md | 78 +++++++++++++++++-- .../6_Channel_Wi_Fi_Relay_Module.md | 2 +- 2 files changed, 72 insertions(+), 8 deletions(-) diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md index 300e04c208f9..719a6d04abea 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md @@ -15,6 +15,9 @@ last_update: date: 2024-11-27T03:21:36.491Z --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + # Getting started with 2-Channel Wi-Fi AC Relay Module In Home Assistant
@@ -109,13 +112,66 @@ Always disconnect AC power before wiring the relay. Avoid using the USB port whi ### Step 1: Set Up the Relay Module (Physical Setup) -1. Wiring: - - Follow the Physical Layout and Connections section to wire the relay module. - - Ensure all connections are secure, and there are no exposed wires. -2. Power On: - - Turn on the AC supply. Do not power on the module through USB if it is connected to AC power. +1. **Installation**: homeassistant is already pre-installed in Home Assistant Green. +2. **Enabling ESPHome Add-on**: + - Access the Home Assistant dashboard. + - Navigate to the "Add-ons" section and search for the ESPHome add-on. + - Click "Install" and then "Start" to enable it. + - Once installed, configure the add-on to ensure proper communication with the XIAO ESP32C3. + +
+ +By gathering the necessary components and setting up Home Assistant with the ESPHome add-on, you'll be ready to proceed with the integration of the 2-Channel Wi-Fi AC Relay Module. + +:::tip install Home Assistant +We have also written how to install Home Assistant for some of Seeed Studio products, please refer to them. + +- [Getting Started with Home Assistant on ODYSSEY-X86](/ODYSSEY-X86-Home-Assistant) +- [Getting Started with Home Assistant on reTerminal](/reTerminal_Home_Assistant) +- [Getting Started with Home Assistant on LinkStar H68K/reRouter CM4](/h68k-ha-esphome) +::: + +### Step 2: Preparing the Relay Module + +By default, your device (XIAO ESP32C3) comes pre-flashed with firmware for 2-Channel Wi-Fi AC Relay Module. However, there are two scenarios where you may need to update the firmware: + +1. **Re-flashing the Firmware**: If the existing firmware is corrupted or you need to start fresh. +2. **Upgrading the Firmware**: If there is a newer version of the firmware with improved functionality. + +There are two simple methods for flashing the firmware: + +:::caution +Firefox does not support flashing firmware on ESP devices. Please use Google Chrome or Microsoft Edge instead. +::: + + + + +You can use this [Web Tool](https://limengdu.github.io/2-Channel_Relay_based_on_XIAO_ESP32C3/) for an easy and direct method to flash your firmware. Simply follow the on-screen instructions. -### Step 2: Network Configuration +- Click the `CONNECT` button to initiate the connection. The tool will automatically update the firmware. + +If something goes wrong, follow the on-screen troubleshooting steps or switch to the `ESPHome Web` method to complete the process. + + + + +For this method, you'll need to download the `bin` firmware file from [here](https://github.com/limengdu/2-Channel_Relay_based_on_XIAO_ESP32C3/releases)(you'll need to unzip the downloaded file). + +1. Connect the sensor kit to your PC. +2. Visit the [ESPHome Web](https://web.esphome.io/) page. +3. Select the firmware file with the `*.factory.bin` suffix. + +Watch the following video for a detailed walkthrough of flashing the firmware via ESPHome Web: + + + + + + +With either method, you'll have your firmware updated and ready for integration with Home Assistant. + +### Step 3: Network Configuration 1. **Enable Access Point**: - Upon powering up for the first time, the module will create a Wi-Fi network (SSID: `seeedstudio-relay`). @@ -123,12 +179,17 @@ Always disconnect AC power before wiring the relay. Avoid using the USB port whi - Connect to the network using a phone or PC. - Open a browser and navigate to `http://192.168.4.1`. - Enter the SSID and password of your home Wi-Fi network. + +
+ 3. **Home Assistant Integration**: - Once connected to the home network, the module will be discoverable in Home Assistant under `Settings -> Devices & Services`. +
+ This way, you can connect the module to your Home Assistant network and let Home Assistant discover it. -### Step 3: Add the module device +### Step 4: Add the module device 1. **Automatic Discovery**: - Ensure the **ESPHome** is installed in Home Assistant. @@ -136,6 +197,8 @@ This way, you can connect the module to your Home Assistant network and let Home 2. **Manual Configuration**: - If not automatically discovered, manually add the device by specifying its IP address. +After adding the device, you can see both switches in the Overview page. You can also set the name of each switch individually. + ## Safety and Maintenance 1. Periodically inspect wiring for wear and tear. @@ -154,6 +217,7 @@ This way, you can connect the module to your Home Assistant network and let Home ## Resources - **GitHub Repository**: Access the ESPHome Firmware at the [Seeed Studio Dual Channel Relay Module GitHub page](https://github.com/limengdu/2-Channel_Relay_based_on_XIAO_ESP32C3). +- **Dual Channel Relay Module Schematic**: [Seeed_Studio_2-Channel_AC_Wi-Fi_Relay_SCH.pdf](https://www.seeedstudio.com/wiki/XIAO/Gadgets/2_channel_ac_relay/resource/Seeed_Studio_2-Channel_AC_Wi-Fi_Relay_SCH.pdf). ## Tech Support & Product Discussion diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md index ceb562e2a16f..350c7c3c6464 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md @@ -116,7 +116,7 @@ Voltages exceeding 24V may cause electric shock or burns, especially in cases of ### Step 1: Setting Up Home Assistant {#setting-up-home-assistant} -1. **Installation**: For optimal performance, it's recommended to install [Home Assistant OS](https://www.home-assistant.io/installation/) on a Virtual Machine or Raspberry Pi. Follow the official installation guide on the Home Assistant website. +1. **Installation**: homeassistant is already pre-installed in Home Assistant Green. 2. **Enabling ESPHome Add-on**: - Access the Home Assistant dashboard. - Navigate to the "Add-ons" section and search for the ESPHome add-on. From 540f611012b9cb836bbe37f7bf44dfc4221d8dfd Mon Sep 17 00:00:00 2001 From: discodyer Date: Wed, 8 Jan 2025 19:50:35 +0800 Subject: [PATCH 7/9] update: Modified the page content of dual channel relay --- .../2_Channel_Wi_Fi_AC_Relay_Module.md | 5 +++++ .../6_Channel_Wi_Fi_Relay_Module.md | 12 ++---------- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md index 719a6d04abea..eae8829550a6 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md @@ -175,6 +175,9 @@ With either method, you'll have your firmware updated and ready for integration 1. **Enable Access Point**: - Upon powering up for the first time, the module will create a Wi-Fi network (SSID: `seeedstudio-relay`). + +
+ 2. **Access Configuration**: - Connect to the network using a phone or PC. - Open a browser and navigate to `http://192.168.4.1`. @@ -199,6 +202,8 @@ This way, you can connect the module to your Home Assistant network and let Home After adding the device, you can see both switches in the Overview page. You can also set the name of each switch individually. +
+ ## Safety and Maintenance 1. Periodically inspect wiring for wear and tear. diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md index 350c7c3c6464..1d338ee6f532 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md @@ -127,14 +127,6 @@ Voltages exceeding 24V may cause electric shock or burns, especially in cases of By gathering the necessary components and setting up Home Assistant with the ESPHome add-on, you'll be ready to proceed with the integration of the 6-Channel relay module. -:::tip install Home Assistant -We have also written how to install Home Assistant for some of Seeed Studio products, please refer to them. - -- [Getting Started with Home Assistant on ODYSSEY-X86](/ODYSSEY-X86-Home-Assistant) -- [Getting Started with Home Assistant on reTerminal](/reTerminal_Home_Assistant) -- [Getting Started with Home Assistant on LinkStar H68K/reRouter CM4](/h68k-ha-esphome) -::: - ### Step 2: Preparing the Relay Module By default, your device (XIAO ESP32C6) comes pre-flashed with firmware for 6-Channel relay. However, there are two scenarios where you may need to update the firmware: @@ -178,9 +170,9 @@ With either method, you'll have your firmware updated and ready for integration ### Step 3: Network Configuration 1. **Enable Access Point**: - - Upon powering up for the first time, the module will create a Wi-Fi network (SSID: `seeedstudio-6-channel-relay`). + - Upon powering up for the first time, the module will create a Wi-Fi network (SSID: `seeedstudio-2-channel-relay`). -
+
2. **Access Configuration**: - Connect to the network using a phone or PC. From f42d89610a6b79ac14cfd8c3f4ac42ff8428b69c Mon Sep 17 00:00:00 2001 From: discodyer Date: Wed, 8 Jan 2025 19:53:28 +0800 Subject: [PATCH 8/9] fix: Modified the relay page content --- .../2_Channel_Wi_Fi_AC_Relay_Module.md | 10 +--------- .../6_Channel_Wi_Fi_Relay_Module.md | 2 +- 2 files changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md index eae8829550a6..31d2961e3c1f 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/2_Channel_Wi_Fi_AC_Relay_Module.md @@ -112,7 +112,7 @@ Always disconnect AC power before wiring the relay. Avoid using the USB port whi ### Step 1: Set Up the Relay Module (Physical Setup) -1. **Installation**: homeassistant is already pre-installed in Home Assistant Green. +1. **Installation**: homeassistant is already pre-installed in [Home Assistant Green](https://www.seeedstudio.com/Home-Assistant-Green-p-5792.html). 2. **Enabling ESPHome Add-on**: - Access the Home Assistant dashboard. - Navigate to the "Add-ons" section and search for the ESPHome add-on. @@ -123,14 +123,6 @@ Always disconnect AC power before wiring the relay. Avoid using the USB port whi By gathering the necessary components and setting up Home Assistant with the ESPHome add-on, you'll be ready to proceed with the integration of the 2-Channel Wi-Fi AC Relay Module. -:::tip install Home Assistant -We have also written how to install Home Assistant for some of Seeed Studio products, please refer to them. - -- [Getting Started with Home Assistant on ODYSSEY-X86](/ODYSSEY-X86-Home-Assistant) -- [Getting Started with Home Assistant on reTerminal](/reTerminal_Home_Assistant) -- [Getting Started with Home Assistant on LinkStar H68K/reRouter CM4](/h68k-ha-esphome) -::: - ### Step 2: Preparing the Relay Module By default, your device (XIAO ESP32C3) comes pre-flashed with firmware for 2-Channel Wi-Fi AC Relay Module. However, there are two scenarios where you may need to update the firmware: diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md index 1d338ee6f532..1d2d102a3321 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md @@ -116,7 +116,7 @@ Voltages exceeding 24V may cause electric shock or burns, especially in cases of ### Step 1: Setting Up Home Assistant {#setting-up-home-assistant} -1. **Installation**: homeassistant is already pre-installed in Home Assistant Green. +1. **Installation**: homeassistant is already pre-installed in [Home Assistant Green](https://www.seeedstudio.com/Home-Assistant-Green-p-5792.html). 2. **Enabling ESPHome Add-on**: - Access the Home Assistant dashboard. - Navigate to the "Add-ons" section and search for the ESPHome add-on. From ff3985a1e7a960edcf854d2c25889f5a7da672fe Mon Sep 17 00:00:00 2001 From: discodyer Date: Fri, 10 Jan 2025 14:21:13 +0800 Subject: [PATCH 9/9] add: Added pictures of 6-Ch Relay Module --- .../SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md index 1d2d102a3321..bb702b4258d0 100644 --- a/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md +++ b/docs/Sensor/SeeedStudio_XIAO_Gadgets/6_Channel_Wi_Fi_Relay_Module.md @@ -2,7 +2,7 @@ title: 6-Channel Wi-Fi Relay Module In Home Assistant description: | A smart device from Seeed Studio designed to wirelessly control devices with safe DC voltage. -image: https://files.seeedstudio.com/wiki/XIAO/Gadgets/6_channel_wifi_relay/six_channel_wifi_relay_simplified_diagram.png +image: https://files.seeedstudio.com/wiki/XIAO/Gadgets/6_channel_wifi_relay/7-114993588_6_CH_Relay_Sensor_feature.webp slug: /6_channel_wifi_relay keywords: - XIAO @@ -20,7 +20,7 @@ import TabItem from '@theme/TabItem'; # Getting started with 6-Channel Wi-Fi Relay Module In Home Assistant -
+