Skip to content

Commit 09d4e8c

Browse files
sebromeroactions-user
authored andcommitted
Update documentation
1 parent cf7bcec commit 09d4e8c

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

docs/api.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,12 @@
109109
* [button\_a\_pressed](#modulino.buttons.ModulinoButtons.button_a_pressed)
110110
* [button\_b\_pressed](#modulino.buttons.ModulinoButtons.button_b_pressed)
111111
* [button\_c\_pressed](#modulino.buttons.ModulinoButtons.button_c_pressed)
112+
* [latch\_relay](#modulino.latch_relay)
113+
* [ModulinoLatchRelay](#modulino.latch_relay.ModulinoLatchRelay)
114+
* [\_\_init\_\_](#modulino.latch_relay.ModulinoLatchRelay.__init__)
115+
* [on](#modulino.latch_relay.ModulinoLatchRelay.on)
116+
* [off](#modulino.latch_relay.ModulinoLatchRelay.off)
117+
* [is\_on](#modulino.latch_relay.ModulinoLatchRelay.is_on)
112118
* [helpers](#modulino.helpers)
113119
* [map\_value](#modulino.helpers.map_value)
114120
* [map\_value\_int](#modulino.helpers.map_value_int)
@@ -1536,6 +1542,62 @@ def button_c_pressed() -> bool
15361542

15371543
Returns True if button C is currently pressed.
15381544

1545+
<a id="modulino.latch_relay.ModulinoLatchRelay"></a>
1546+
1547+
## class `ModulinoLatchRelay`
1548+
1549+
```python
1550+
class ModulinoLatchRelay(Modulino)
1551+
```
1552+
1553+
Class to control the relay module of the Modulino.
1554+
1555+
<a id="modulino.latch_relay.ModulinoLatchRelay.__init__"></a>
1556+
1557+
### `__init__`
1558+
1559+
```python
1560+
def __init__(i2c_bus=None, address=None)
1561+
```
1562+
1563+
Initializes the Modulino Buzzer.
1564+
1565+
**Arguments**:
1566+
1567+
- `i2c_bus` _I2C_ - The I2C bus to use. If not provided, the default I2C bus will be used.
1568+
- `address` _int_ - The I2C address of the module. If not provided, the default address will be used.
1569+
1570+
<a id="modulino.latch_relay.ModulinoLatchRelay.on"></a>
1571+
1572+
### `on`
1573+
1574+
```python
1575+
def on() -> None
1576+
```
1577+
1578+
Turns on the relay.
1579+
1580+
<a id="modulino.latch_relay.ModulinoLatchRelay.off"></a>
1581+
1582+
### `off`
1583+
1584+
```python
1585+
def off() -> None
1586+
```
1587+
1588+
Turns off the relay.
1589+
1590+
<a id="modulino.latch_relay.ModulinoLatchRelay.is_on"></a>
1591+
1592+
### `is_on`
1593+
1594+
```python
1595+
@property
1596+
def is_on() -> bool
1597+
```
1598+
1599+
Checks if the relay is currently on.
1600+
15391601
<a id="modulino.helpers.map_value"></a>
15401602

15411603
### `map_value`

0 commit comments

Comments
 (0)