fatimaxsen/I2CRelay
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

++

Browse Source
This commit is contained in:
Fatima Idrees 2025-05-12 11:27:07 +03:00
parent 400a727892
commit baa1dd100c
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -30,8 +30,6 @@ At **FABLAB Bahrain**, we're revolutionizing the world of IoT devices with our c
--- ---
### Features
### Key Features of the 8-Relay Module with ESP32-C3 Super Mini ### Key Features of the 8-Relay Module with ESP32-C3 Super Mini
- **8-Channel Relay Control:** Enables switching of up to 8 high-power devices independently. - **8-Channel Relay Control:** Enables switching of up to 8 high-power devices independently.
@ -61,12 +59,12 @@ At **FABLAB Bahrain**, we're revolutionizing the world of IoT devices with our c
#### Files #### Files
The library is composed of several files, each with a specific role: The library is composed of two files, each with a specific role:
1. **I2CRelay.h** [5] 1. **I2CRelay.h**
- Defines the `I2CRelay` class, which extends the functionality to control relays over I2C. - Defines the `I2CRelay` class, which extends the functionality to control relays over I2C.
2. **I2CRelay.cpp** [4] 2. **I2CRelay.cpp**
- Contains the implementation of methods for the `I2CRelay` class. - Contains the implementation of methods for the `I2CRelay` class.
--- ---
@ -79,8 +77,6 @@ The I2CRelay library offers broad versatility for automation through its configu
### API Overview ### API Overview
# I2CRelay Library API Overview
| Method / Constructor | Description | Parameters / Usage Example | | Method / Constructor | Description | Parameters / Usage Example |
|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------|------------------------------------------------------| |---------------------------------------------------|-------------------------------------------------------------------------------------------------------------|------------------------------------------------------|
| `I2CRelay(uint8_t address = 0x08, uint8_t sda = 8, uint8_t scl = 3)` | Create an I2CRelay object with optional I2C address and pin selection. | `I2CRelay relay;`<br>`I2CRelay relay(0x10, 21, 22);` | | `I2CRelay(uint8_t address = 0x08, uint8_t sda = 8, uint8_t scl = 3)` | Create an I2CRelay object with optional I2C address and pin selection. | `I2CRelay relay;`<br>`I2CRelay relay(0x10, 21, 22);` |