3
3
* [ buzzer] ( #modulino.buzzer )
4
4
* [ ModulinoBuzzer] ( #modulino.buzzer.ModulinoBuzzer )
5
5
* [ NOTES] ( #modulino.buzzer.ModulinoBuzzer.NOTES )
6
+ * [ \_\_ init\_\_ ] ( #modulino.buzzer.ModulinoBuzzer.__init__ )
6
7
* [ tone] ( #modulino.buzzer.ModulinoBuzzer.tone )
7
8
* [ no\_ tone] ( #modulino.buzzer.ModulinoBuzzer.no_tone )
8
9
* [ buttons] ( #modulino.buttons )
9
10
* [ ModulinoButtons] ( #modulino.buttons.ModulinoButtons )
11
+ * [ \_\_ init\_\_ ] ( #modulino.buttons.ModulinoButtons.__init__ )
10
12
* [ set\_ led\_ status] ( #modulino.buttons.ModulinoButtons.set_led_status )
11
13
* [ long\_ press\_ duration] ( #modulino.buttons.ModulinoButtons.long_press_duration )
12
14
* [ long\_ press\_ duration] ( #modulino.buttons.ModulinoButtons.long_press_duration )
35
37
* [ button\_ c\_ pressed] ( #modulino.buttons.ModulinoButtons.button_c_pressed )
36
38
* [ pressure] ( #modulino.pressure )
37
39
* [ ModulinoPressure] ( #modulino.pressure.ModulinoPressure )
40
+ * [ \_\_ init\_\_ ] ( #modulino.pressure.ModulinoPressure.__init__ )
38
41
* [ pressure] ( #modulino.pressure.ModulinoPressure.pressure )
39
42
* [ temperature] ( #modulino.pressure.ModulinoPressure.temperature )
40
43
* [ altitude] ( #modulino.pressure.ModulinoPressure.altitude )
56
59
* [ reset\_ bus] ( #modulino.modulino.Modulino.reset_bus )
57
60
* [ distance] ( #modulino.distance )
58
61
* [ ModulinoDistance] ( #modulino.distance.ModulinoDistance )
62
+ * [ \_\_ init\_\_ ] ( #modulino.distance.ModulinoDistance.__init__ )
59
63
* [ distance] ( #modulino.distance.ModulinoDistance.distance )
60
64
* [ knob] ( #modulino.knob )
61
65
* [ ModulinoKnob] ( #modulino.knob.ModulinoKnob )
66
+ * [ \_\_ init\_\_ ] ( #modulino.knob.ModulinoKnob.__init__ )
62
67
* [ reset] ( #modulino.knob.ModulinoKnob.reset )
63
68
* [ update] ( #modulino.knob.ModulinoKnob.update )
64
69
* [ range] ( #modulino.knob.ModulinoKnob.range )
79
84
* [ \_\_ init\_\_ ] ( #modulino.pixels.ModulinoColor.__init__ )
80
85
* [ \_\_ int\_\_ ] ( #modulino.pixels.ModulinoColor.__int__ )
81
86
* [ ModulinoPixels] ( #modulino.pixels.ModulinoPixels )
87
+ * [ \_\_ init\_\_ ] ( #modulino.pixels.ModulinoPixels.__init__ )
82
88
* [ set\_ range\_ rgb] ( #modulino.pixels.ModulinoPixels.set_range_rgb )
83
89
* [ set\_ range\_ color] ( #modulino.pixels.ModulinoPixels.set_range_color )
84
90
* [ set\_ all\_ rgb] ( #modulino.pixels.ModulinoPixels.set_all_rgb )
91
97
* [ show] ( #modulino.pixels.ModulinoPixels.show )
92
98
* [ movement] ( #modulino.movement )
93
99
* [ ModulinoMovement] ( #modulino.movement.ModulinoMovement )
100
+ * [ \_\_ init\_\_ ] ( #modulino.movement.ModulinoMovement.__init__ )
94
101
* [ accelerometer] ( #modulino.movement.ModulinoMovement.accelerometer )
95
102
* [ gyro] ( #modulino.movement.ModulinoMovement.gyro )
96
103
* [ thermo] ( #modulino.thermo )
97
104
* [ Measurement] ( #modulino.thermo.Measurement )
98
105
* [ ModulinoThermo] ( #modulino.thermo.ModulinoThermo )
106
+ * [ \_\_ init\_\_ ] ( #modulino.thermo.ModulinoThermo.__init__ )
99
107
* [ measurements] ( #modulino.thermo.ModulinoThermo.measurements )
100
108
* [ relative\_ humidity] ( #modulino.thermo.ModulinoThermo.relative_humidity )
101
109
* [ temperature] ( #modulino.thermo.ModulinoThermo.temperature )
@@ -128,6 +136,21 @@ The supported notes are defined as follows:
128
136
- C8, CS8 , D8, DS8
129
137
- REST (Silence)
130
138
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
+
131
154
<a id =" modulino.buzzer.ModulinoBuzzer.tone " ></a >
132
155
133
156
### ` tone `
@@ -167,6 +190,21 @@ class ModulinoButtons(Modulino)
167
190
168
191
Class to interact with the buttons of the Modulino Buttons.
169
192
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
+
170
208
< a id = " modulino.buttons.ModulinoButtons.set_led_status" >< / a>
171
209
172
210
# ## `set_led_status`
@@ -477,6 +515,21 @@ class ModulinoPressure(Modulino)
477
515
478
516
Class to interact with the pressure sensor of the Modulino Pressure.
479
517
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
+
480
533
< a id =" modulino.pressure.ModulinoPressure.pressure" >< / a>
481
534
482
535
# ## `pressure`
@@ -555,6 +608,12 @@ If the address is provided, the device will check if it is connected to the bus.
555
608
If the address is 8 - bit, it will be converted to 7 - bit.
556
609
If no bus is provided, the default bus will be used if available.
557
610
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
+
558
617
< a id =" modulino.modulino.Modulino.discover" >< / a>
559
618
560
619
# ## `discover`
@@ -564,7 +623,7 @@ def discover(default_addresses: list[int]) -> int | None
564
623
```
565
624
566
625
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.
568
627
If the address has been changed to a custom one it won' t be found with this function.
569
628
570
629
** Returns** :
@@ -725,6 +784,21 @@ class ModulinoDistance(Modulino)
725
784
726
785
Class to interact with the distance sensor of the Modulino Distance.
727
786
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
+
728
802
< a id =" modulino.distance.ModulinoDistance.distance" >< / a>
729
803
730
804
# ## `distance`
@@ -748,6 +822,21 @@ class ModulinoKnob(Modulino)
748
822
749
823
Class to interact with the rotary encoder of the Modulinio Knob.
750
824
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
+
751
840
< a id =" modulino.knob.ModulinoKnob.reset" >< / a>
752
841
753
842
# ## `reset`
@@ -996,6 +1085,21 @@ class ModulinoPixels(Modulino)
996
1085
997
1086
Class to interact with the LEDs of the Modulino Pixels.
998
1087
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
+
999
1103
< a id =" modulino.pixels.ModulinoPixels.set_range_rgb" >< / a>
1000
1104
1001
1105
# ## `set_range_rgb`
@@ -1170,6 +1274,21 @@ class ModulinoMovement(Modulino)
1170
1274
1171
1275
Class to interact with the movement sensor (IMU ) of the Modulino Movement.
1172
1276
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
+
1173
1292
< a id =" modulino.movement.ModulinoMovement.accelerometer" >< / a>
1174
1293
1175
1294
# ## `accelerometer`
@@ -1212,6 +1331,21 @@ class ModulinoThermo(Modulino)
1212
1331
1213
1332
Class to interact with the temperature and humidity sensor of the Modulino Thermo.
1214
1333
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
+
1215
1349
< a id =" modulino.thermo.ModulinoThermo.measurements" >< / a>
1216
1350
1217
1351
# ## `measurements`
0 commit comments