Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sebromero authored and actions-user committed Oct 25, 2024
1 parent b12726f commit a1aac92
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,10 @@ or if a custom one was set.
def available_devices()
```

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

Returns:
list: A list of Modulino objects.

<a id="modulino.modulino.Modulino.reset_bus"></a>

Expand All @@ -238,8 +241,7 @@ Resets the i2c bus. This is useful when the bus is in an unknown state.
The modulinos that are equipped with a micro controller use DMA operations.
If the host board does a reset during such operation it can make the bus get stuck.

Returns
----
Returns:
I2C: A new i2c bus object after resetting the bus.

<a id="modulino.pixels.ModulinoColor"></a>
Expand Down

0 comments on commit a1aac92

Please sign in to comment.