Skip to content

Commit f228137

Browse files
sebromeroactions-user
authored andcommitted
Update documentation
1 parent 4287f7a commit f228137

File tree

1 file changed

+135
-1
lines changed

1 file changed

+135
-1
lines changed

docs/api.md

+135-1
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@
33
* [buzzer](#modulino.buzzer)
44
* [ModulinoBuzzer](#modulino.buzzer.ModulinoBuzzer)
55
* [NOTES](#modulino.buzzer.ModulinoBuzzer.NOTES)
6+
* [\_\_init\_\_](#modulino.buzzer.ModulinoBuzzer.__init__)
67
* [tone](#modulino.buzzer.ModulinoBuzzer.tone)
78
* [no\_tone](#modulino.buzzer.ModulinoBuzzer.no_tone)
89
* [buttons](#modulino.buttons)
910
* [ModulinoButtons](#modulino.buttons.ModulinoButtons)
11+
* [\_\_init\_\_](#modulino.buttons.ModulinoButtons.__init__)
1012
* [set\_led\_status](#modulino.buttons.ModulinoButtons.set_led_status)
1113
* [long\_press\_duration](#modulino.buttons.ModulinoButtons.long_press_duration)
1214
* [long\_press\_duration](#modulino.buttons.ModulinoButtons.long_press_duration)
@@ -35,6 +37,7 @@
3537
* [button\_c\_pressed](#modulino.buttons.ModulinoButtons.button_c_pressed)
3638
* [pressure](#modulino.pressure)
3739
* [ModulinoPressure](#modulino.pressure.ModulinoPressure)
40+
* [\_\_init\_\_](#modulino.pressure.ModulinoPressure.__init__)
3841
* [pressure](#modulino.pressure.ModulinoPressure.pressure)
3942
* [temperature](#modulino.pressure.ModulinoPressure.temperature)
4043
* [altitude](#modulino.pressure.ModulinoPressure.altitude)
@@ -56,9 +59,11 @@
5659
* [reset\_bus](#modulino.modulino.Modulino.reset_bus)
5760
* [distance](#modulino.distance)
5861
* [ModulinoDistance](#modulino.distance.ModulinoDistance)
62+
* [\_\_init\_\_](#modulino.distance.ModulinoDistance.__init__)
5963
* [distance](#modulino.distance.ModulinoDistance.distance)
6064
* [knob](#modulino.knob)
6165
* [ModulinoKnob](#modulino.knob.ModulinoKnob)
66+
* [\_\_init\_\_](#modulino.knob.ModulinoKnob.__init__)
6267
* [reset](#modulino.knob.ModulinoKnob.reset)
6368
* [update](#modulino.knob.ModulinoKnob.update)
6469
* [range](#modulino.knob.ModulinoKnob.range)
@@ -79,6 +84,7 @@
7984
* [\_\_init\_\_](#modulino.pixels.ModulinoColor.__init__)
8085
* [\_\_int\_\_](#modulino.pixels.ModulinoColor.__int__)
8186
* [ModulinoPixels](#modulino.pixels.ModulinoPixels)
87+
* [\_\_init\_\_](#modulino.pixels.ModulinoPixels.__init__)
8288
* [set\_range\_rgb](#modulino.pixels.ModulinoPixels.set_range_rgb)
8389
* [set\_range\_color](#modulino.pixels.ModulinoPixels.set_range_color)
8490
* [set\_all\_rgb](#modulino.pixels.ModulinoPixels.set_all_rgb)
@@ -91,11 +97,13 @@
9197
* [show](#modulino.pixels.ModulinoPixels.show)
9298
* [movement](#modulino.movement)
9399
* [ModulinoMovement](#modulino.movement.ModulinoMovement)
100+
* [\_\_init\_\_](#modulino.movement.ModulinoMovement.__init__)
94101
* [accelerometer](#modulino.movement.ModulinoMovement.accelerometer)
95102
* [gyro](#modulino.movement.ModulinoMovement.gyro)
96103
* [thermo](#modulino.thermo)
97104
* [Measurement](#modulino.thermo.Measurement)
98105
* [ModulinoThermo](#modulino.thermo.ModulinoThermo)
106+
* [\_\_init\_\_](#modulino.thermo.ModulinoThermo.__init__)
99107
* [measurements](#modulino.thermo.ModulinoThermo.measurements)
100108
* [relative\_humidity](#modulino.thermo.ModulinoThermo.relative_humidity)
101109
* [temperature](#modulino.thermo.ModulinoThermo.temperature)
@@ -128,6 +136,21 @@ The supported notes are defined as follows:
128136
- C8, CS8, D8, DS8
129137
- REST (Silence)
130138

139+
<a id="modulino.buzzer.ModulinoBuzzer.__init__"></a>
140+
141+
### `__init__`
142+
143+
```python
144+
def __init__(i2c_bus=None, address=None)
145+
```
146+
147+
Initializes the Modulino Buzzer.
148+
149+
**Arguments**:
150+
151+
- `i2c_bus` _I2C_ - The I2C bus to use. If not provided, the default I2C bus will be used.
152+
- `address` _int_ - The I2C address of the module. If not provided, the default address will be used.
153+
131154
<a id="modulino.buzzer.ModulinoBuzzer.tone"></a>
132155

133156
### `tone`
@@ -167,6 +190,21 @@ class ModulinoButtons(Modulino)
167190

168191
Class to interact with the buttons of the Modulino Buttons.
169192

193+
<a id="modulino.buttons.ModulinoButtons.__init__"></a>
194+
195+
### `__init__`
196+
197+
```python
198+
def __init__(i2c_bus=None, address=None)
199+
```
200+
201+
Initializes the Modulino Buttons.
202+
203+
**Arguments**:
204+
205+
- `i2c_bus` _I2C_ - The I2C bus to use. If not provided, the default I2C bus will be used.
206+
- `address` _int_ - The I2C address of the module. If not provided, the default address will be used.
207+
170208
<a id="modulino.buttons.ModulinoButtons.set_led_status"></a>
171209

172210
### `set_led_status`
@@ -477,6 +515,21 @@ class ModulinoPressure(Modulino)
477515

478516
Class to interact with the pressure sensor of the Modulino Pressure.
479517

518+
<a id="modulino.pressure.ModulinoPressure.__init__"></a>
519+
520+
### `__init__`
521+
522+
```python
523+
def __init__(i2c_bus: I2C = None, address: int = None) -> None
524+
```
525+
526+
Initializes the Modulino Pressure.
527+
528+
**Arguments**:
529+
530+
- `i2c_bus` _I2C_ - The I2C bus to use. If not provided, the default I2C bus will be used.
531+
- `address` _int_ - The I2C address of the module. If not provided, the default address will be used.
532+
480533
<a id="modulino.pressure.ModulinoPressure.pressure"></a>
481534

482535
### `pressure`
@@ -555,6 +608,12 @@ If the address is provided, the device will check if it is connected to the bus.
555608
If the address is 8-bit, it will be converted to 7-bit.
556609
If no bus is provided, the default bus will be used if available.
557610

611+
**Arguments**:
612+
613+
- `i2c_bus` _I2C_ - The I2C bus to use. If not provided, the default I2C bus will be used.
614+
- `address` _int_ - The address of the device. If not provided, the device will try to auto discover it.
615+
- `name` _str_ - The name of the device.
616+
558617
<a id="modulino.modulino.Modulino.discover"></a>
559618

560619
### `discover`
@@ -564,7 +623,7 @@ def discover(default_addresses: list[int]) -> int | None
564623
```
565624

566625
Tries to find the given modulino device in the device chain
567-
based on the pre-defined default addresses.
626+
based on the pre-defined default addresses. The first address found will be returned.
568627
If the address has been changed to a custom one it won't be found with this function.
569628

570629
**Returns**:
@@ -725,6 +784,21 @@ class ModulinoDistance(Modulino)
725784

726785
Class to interact with the distance sensor of the Modulino Distance.
727786

787+
<a id="modulino.distance.ModulinoDistance.__init__"></a>
788+
789+
### `__init__`
790+
791+
```python
792+
def __init__(i2c_bus=None, address: int | None = None) -> None
793+
```
794+
795+
Initializes the Modulino Distance.
796+
797+
**Arguments**:
798+
799+
- `i2c_bus` _I2C_ - The I2C bus to use. If not provided, the default I2C bus will be used.
800+
- `address` _int_ - The I2C address of the module. If not provided, the default address will be used.
801+
728802
<a id="modulino.distance.ModulinoDistance.distance"></a>
729803

730804
### `distance`
@@ -748,6 +822,21 @@ class ModulinoKnob(Modulino)
748822

749823
Class to interact with the rotary encoder of the Modulinio Knob.
750824

825+
<a id="modulino.knob.ModulinoKnob.__init__"></a>
826+
827+
### `__init__`
828+
829+
```python
830+
def __init__(i2c_bus=None, address=None)
831+
```
832+
833+
Initializes the Modulino Knob.
834+
835+
**Arguments**:
836+
837+
- `i2c_bus` _I2C_ - The I2C bus to use. If not provided, the default I2C bus will be used.
838+
- `address` _int_ - The I2C address of the module. If not provided, the default address will be used.
839+
751840
<a id="modulino.knob.ModulinoKnob.reset"></a>
752841

753842
### `reset`
@@ -996,6 +1085,21 @@ class ModulinoPixels(Modulino)
9961085

9971086
Class to interact with the LEDs of the Modulino Pixels.
9981087

1088+
<a id="modulino.pixels.ModulinoPixels.__init__"></a>
1089+
1090+
### `__init__`
1091+
1092+
```python
1093+
def __init__(i2c_bus=None, address=None)
1094+
```
1095+
1096+
Initializes the Modulino Pixels.
1097+
1098+
**Arguments**:
1099+
1100+
- `i2c_bus` _I2C_ - The I2C bus to use. If not provided, the default I2C bus will be used.
1101+
- `address` _int_ - The I2C address of the module. If not provided, the default address will be used.
1102+
9991103
<a id="modulino.pixels.ModulinoPixels.set_range_rgb"></a>
10001104

10011105
### `set_range_rgb`
@@ -1170,6 +1274,21 @@ class ModulinoMovement(Modulino)
11701274

11711275
Class to interact with the movement sensor (IMU) of the Modulino Movement.
11721276

1277+
<a id="modulino.movement.ModulinoMovement.__init__"></a>
1278+
1279+
### `__init__`
1280+
1281+
```python
1282+
def __init__(i2c_bus=None, address: int | None = None) -> None
1283+
```
1284+
1285+
Initializes the Modulino Movement.
1286+
1287+
**Arguments**:
1288+
1289+
- `i2c_bus` _I2C_ - The I2C bus to use. If not provided, the default I2C bus will be used.
1290+
- `address` _int_ - The I2C address of the module. If not provided, the default address will be used.
1291+
11731292
<a id="modulino.movement.ModulinoMovement.accelerometer"></a>
11741293

11751294
### `accelerometer`
@@ -1212,6 +1331,21 @@ class ModulinoThermo(Modulino)
12121331

12131332
Class to interact with the temperature and humidity sensor of the Modulino Thermo.
12141333

1334+
<a id="modulino.thermo.ModulinoThermo.__init__"></a>
1335+
1336+
### `__init__`
1337+
1338+
```python
1339+
def __init__(i2c_bus: I2C = None, address: int = DEFAULT_ADDRESS) -> None
1340+
```
1341+
1342+
Initializes the Modulino Thermo.
1343+
1344+
**Arguments**:
1345+
1346+
- `i2c_bus` _I2C_ - The I2C bus to use. If not provided, the default I2C bus will be used.
1347+
- `address` _int_ - The I2C address of the module. If not provided, the default address will be used.
1348+
12151349
<a id="modulino.thermo.ModulinoThermo.measurements"></a>
12161350

12171351
### `measurements`

0 commit comments

Comments
 (0)