Skip to content

Commit 8b7de82

Browse files
sebromeroactions-user
authored andcommitted
Update documentation
1 parent ef0301c commit 8b7de82

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

docs/api.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
* [pin\_strap\_address](#modulino.modulino.Modulino.pin_strap_address)
2121
* [device\_type](#modulino.modulino.Modulino.device_type)
2222
* [change\_address](#modulino.modulino.Modulino.change_address)
23+
* [enter\_bootloader](#modulino.modulino.Modulino.enter_bootloader)
2324
* [read](#modulino.modulino.Modulino.read)
2425
* [write](#modulino.modulino.Modulino.write)
2526
* [has\_default\_address](#modulino.modulino.Modulino.has_default_address)
@@ -352,6 +353,21 @@ def change_address(new_address: int)
352353
Sets the address of the i2c device to the given value.
353354
This is only supported on Modulinos that have a microcontroller.
354355

356+
<a id="modulino.modulino.Modulino.enter_bootloader"></a>
357+
358+
### `enter_bootloader`
359+
360+
```python
361+
def enter_bootloader()
362+
```
363+
364+
Enters the I2C bootloader of the device.
365+
This is only supported on Modulinos that have a microcontroller.
366+
367+
**Returns**:
368+
369+
- `bool` - True if the device entered bootloader mode, False otherwise.
370+
355371
<a id="modulino.modulino.Modulino.read"></a>
356372

357373
### `read`
@@ -404,11 +420,16 @@ or if a custom one was set.
404420

405421
```python
406422
@staticmethod
407-
def available_devices() -> list[Modulino]
423+
def available_devices(bus: I2C = None) -> list[Modulino]
408424
```
409425

410426
Finds all devices on the i2c bus and returns them as a list of Modulino objects.
411427

428+
**Arguments**:
429+
430+
- `bus` _I2C_ - The I2C bus to use. If not provided, the default I2C bus will be used.
431+
432+
412433
**Returns**:
413434

414435
- `list` - A list of Modulino objects.

0 commit comments

Comments
 (0)