solderedelectronics/soldered-relay-esp-idf-component

Readme

# Soldered Relay Component

| ![Relay](https://cms.soldered.com/products/333021/media/333021_featured-photo_03c689.jpg) |
| :-----------------------------------------------------------------------------------------: |
|                       [Relay](https://solde.red/333021)                       |

ESP-IDF driver for Soldered relay boards, wired directly to GPIO pins or connected over I2C via [Qwiic/easyC](https://soldered.com/collections/qwiic-ecosystem).

### Repository Contents

- **/src** - source files (.c)
- **/include** - header files (.h)
- **/examples** - examples for using the library
  - `basic` - single relay wired to a GPIO pin
  - `4channel` - four relays wired to GPIO pins
  - `qwiic` - one Qwiic/easyC relay board channel, driven over I2C
- **_other_** - idf_component.yml manifest file for ESP Component Registry

### Usage

**GPIO-wired relays** (`basic`, `4channel` examples): connect the relay module's control pin to a GPIO, then call `relay_init()` followed by `relay_on()`/`relay_off()`/`relay_toggle()`.

**Qwiic/easyC relay boards** (`qwiic` example): connect the board via its Qwiic connector to an I2C bus, then call `relay_init_qwiic()` with an already-initialized `i2c_master_bus_handle_t`, the board's I2C address (default `0x30`, switch-selectable on the board), and the channel to control. After that, the same `relay_on()`/`relay_off()`/`relay_toggle()`/`relay_get_state()` calls work identically regardless of backend.

### Hardware design

Hardware design, BOM, gerbers, and 3D files for these boards are in their respective hardware repositories, e.g. [1-channel-relay-board-hardware-design](https://github.com/SolderedElectronics/1-channel-relay-board-hardware-design) and [1-channel-relay-board-qwiic-hardware-design](https://github.com/SolderedElectronics/1-channel-relay-board-qwiic-hardware-design).

### Documentation

Access library documentation [here](https://docs.soldered.com/).

### About Soldered

<img src="https://raw.githubusercontent.com/SolderedElectronics/Soldered-Generic-Arduino-Library/dev/extras/Soldered-logo-color.png" alt="soldered-logo" width="500"/>

At Soldered, we design and manufacture a wide selection of electronic products to help you turn your ideas into acts and bring you one step closer to your final project. Our products are intented for makers and crafted in-house by our experienced team in Osijek, Croatia. We believe that sharing is a crucial element for improvement and innovation, and we work hard to stay connected with all our makers regardless of their skill or experience level. Therefore, all our products are open-source. Finally, we always have your back. If you face any problem concerning either your shopping experience or your electronics project, our team will help you deal with it, offering efficient customer service and cost-free technical support anytime. Some of those might be useful for you:

- [Web Store](https://www.soldered.com/shop)
- [Tutorials & Projects](https://soldered.com/learn)
- [Documentation](https://docs.soldered.com)

### Open-source license

Soldered invests vast amounts of time into hardware & software for these products, which are all open-source. Please support future development by buying one of our products.

Check license details in the LICENSE file. Long story short, use these open-source files for any purpose you want to, as long as you apply the same open-source licence to it and disclose the original source. No warranty - all designs in this repository are distributed in the hope that they will be useful, but without any warranty. They are provided "AS IS", therefore without warranty of any kind, either expressed or implied. The entire quality and performance of what you do with the contents of this repository are your responsibility. In no event, Soldered (TAVU) will be liable for your damages, losses, including any general, special, incidental or consequential damage arising out of the use or inability to use the contents of this repository.

## Have fun!

And thank you from your fellow makers at Soldered Electronics.