Skip to content

Commit 9fcbf49

Browse files
sebromeroactions-user
authored andcommitted
Update documentation
1 parent a0db3b5 commit 9fcbf49

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

docs/api.md

+37-37
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ Plays a tone with the given frequency and duration.
7878
If blocking is set to True, the function will wait until the tone is finished.
7979

8080
Parameters:
81-
frequency: The frequency of the tone in Hz
82-
lenght_ms: The duration of the tone in milliseconds
83-
blocking: If set to True, the function will wait until the tone is finished
81+
frequency: The frequency of the tone in Hz
82+
lenght_ms: The duration of the tone in milliseconds
83+
blocking: If set to True, the function will wait until the tone is finished
8484

8585
<a id="modulino.buzzer.ModulinoBuzzer.no_tone"></a>
8686

@@ -117,7 +117,7 @@ def set_led_status(a, b, c)
117117
Turn on or off the button LEDs according to the given status.
118118

119119
Parameters:
120-
a (bool): The status of the LED A.
120+
a (bool): The status of the LED A.
121121
b (bool): The status of the LED B.
122122
c (bool): The status of the LED C.
123123

@@ -146,7 +146,7 @@ def is_pressed(index)
146146
Returns True if the button at the given index is currently pressed.
147147

148148
Parameters:
149-
index (int): The index of the button. A = 0, B = 1, C = 2.
149+
index (int): The index of the button. A = 0, B = 1, C = 2.
150150

151151
<a id="modulino.modulino.I2CHelper"></a>
152152

@@ -378,7 +378,7 @@ def range(value)
378378
Sets the range of the encoder value.
379379

380380
Parameters:
381-
value (tuple): A tuple with two integers representing the minimum and maximum values of the range.
381+
value (tuple): A tuple with two integers representing the minimum and maximum values of the range.
382382

383383
<a id="modulino.knob.ModulinoKnob.on_rotate_clockwise"></a>
384384

@@ -392,7 +392,7 @@ def on_rotate_clockwise(value)
392392
Sets the callback for the rotate clockwise event.
393393

394394
Parameters:
395-
value (function): The function to be called when the encoder is rotated clockwise.
395+
value (function): The function to be called when the encoder is rotated clockwise.
396396

397397
<a id="modulino.knob.ModulinoKnob.on_rotate_counter_clockwise"></a>
398398

@@ -406,7 +406,7 @@ def on_rotate_counter_clockwise(value)
406406
Sets the callback for the rotate counter clockwise event.
407407

408408
Parameters:
409-
value (function): The function to be called when the encoder is rotated counter clockwise.
409+
value (function): The function to be called when the encoder is rotated counter clockwise.
410410

411411
<a id="modulino.knob.ModulinoKnob.on_press"></a>
412412

@@ -420,7 +420,7 @@ def on_press(value)
420420
Sets the callback for the press event.
421421

422422
Parameters:
423-
value (function): The function to be called when the encoder is pressed.
423+
value (function): The function to be called when the encoder is pressed.
424424

425425
<a id="modulino.knob.ModulinoKnob.on_release"></a>
426426

@@ -434,7 +434,7 @@ def on_release(value)
434434
Sets the callback for the release event.
435435

436436
Parameters:
437-
value (function): The function to be called when the encoder is released.
437+
value (function): The function to be called when the encoder is released.
438438

439439
<a id="modulino.knob.ModulinoKnob.value"></a>
440440

@@ -459,7 +459,7 @@ def value(new_value)
459459
Sets the value of the encoder. This overrides the previous value.
460460

461461
Parameters:
462-
new_value (int): The new value of the encoder.
462+
new_value (int): The new value of the encoder.
463463

464464
<a id="modulino.knob.ModulinoKnob.pressed"></a>
465465

@@ -509,12 +509,12 @@ def set_range_rgb(index_from, index_to, r, g, b, brightness=100)
509509
Sets the color of the LEDs in the given range to the given RGB values.
510510

511511
Parameters:
512-
index_from (int): The starting index of the range.
513-
index_to (int): The ending index (inclusive) of the range.
514-
r (int): The red value of the color.
515-
g (int): The green value of the color.
516-
b (int): The blue value of the color.
517-
brightness (int): The brightness of the LED. It should be a value between 0 and 100.
512+
index_from (int): The starting index of the range.
513+
index_to (int): The ending index (inclusive) of the range.
514+
r (int): The red value of the color.
515+
g (int): The green value of the color.
516+
b (int): The blue value of the color.
517+
brightness (int): The brightness of the LED. It should be a value between 0 and 100.
518518

519519
<a id="modulino.pixels.ModulinoPixels.set_range_color"></a>
520520

@@ -527,10 +527,10 @@ def set_range_color(index_from, index_to, color, brightness=100)
527527
Sets the color of the LEDs in the given range to the given color.
528528

529529
Parameters:
530-
index_from (int): The starting index of the range.
531-
index_to (int): The ending index (inclusive) of the range.
532-
color (ModulinoColor): The color of the LEDs.
533-
brightness (int): The brightness of the LED. It should be a value between 0 and 100.
530+
index_from (int): The starting index of the range.
531+
index_to (int): The ending index (inclusive) of the range.
532+
color (ModulinoColor): The color of the LEDs.
533+
brightness (int): The brightness of the LED. It should be a value between 0 and 100.
534534

535535
<a id="modulino.pixels.ModulinoPixels.set_all_rgb"></a>
536536

@@ -543,10 +543,10 @@ def set_all_rgb(r, g, b, brightness=100)
543543
Sets the color of all the LEDs to the given RGB values.
544544

545545
Parameters:
546-
r (int): The red value of the color.
547-
g (int): The green value of the color.
548-
b (int): The blue value of the color.
549-
brightness (int): The brightness of the LED. It should be a value between 0 and 100.
546+
r (int): The red value of the color.
547+
g (int): The green value of the color.
548+
b (int): The blue value of the color.
549+
brightness (int): The brightness of the LED. It should be a value between 0 and 100.
550550

551551
<a id="modulino.pixels.ModulinoPixels.set_all_color"></a>
552552

@@ -559,8 +559,8 @@ def set_all_color(color, brightness=100)
559559
Sets the color of all the LEDs to the given color.
560560

561561
Parameters:
562-
color (ModulinoColor): The color of the LEDs.
563-
brightness (int): The brightness of the LED. It should be a value between 0 and 100.
562+
color (ModulinoColor): The color of the LEDs.
563+
brightness (int): The brightness of the LED. It should be a value between 0 and 100.
564564

565565
<a id="modulino.pixels.ModulinoPixels.set_color"></a>
566566

@@ -573,9 +573,9 @@ def set_color(idx, rgb: ModulinoColor, brightness=100)
573573
Sets the color of the given LED index to the given color.
574574

575575
Parameters:
576-
idx (int): The index of the LED.
577-
rgb (ModulinoColor): The color of the LED.
578-
brightness (int): The brightness of the LED. It should be a value between 0 and 100.
576+
idx (int): The index of the LED.
577+
rgb (ModulinoColor): The color of the LED.
578+
brightness (int): The brightness of the LED. It should be a value between 0 and 100.
579579

580580
<a id="modulino.pixels.ModulinoPixels.set_rgb"></a>
581581

@@ -588,11 +588,11 @@ def set_rgb(idx, r, g, b, brightness=100)
588588
Set the color of the given LED index to the given RGB values.
589589

590590
Parameters:
591-
idx (int): The index of the LED.
592-
r (int): The red value of the color.
593-
g (int): The green value of the color.
594-
b (int): The blue value of the color.
595-
brightness (int): The brightness of the LED. It should be a value between 0 and 100.
591+
idx (int): The index of the LED.
592+
r (int): The red value of the color.
593+
g (int): The green value of the color.
594+
b (int): The blue value of the color.
595+
brightness (int): The brightness of the LED. It should be a value between 0 and 100.
596596

597597
<a id="modulino.pixels.ModulinoPixels.clear"></a>
598598

@@ -605,7 +605,7 @@ def clear(idx)
605605
Turns off the LED at the given index.
606606

607607
Parameters:
608-
idx (int): The index of the LED.
608+
idx (int): The index of the LED.
609609

610610
<a id="modulino.pixels.ModulinoPixels.clear_all"></a>
611611

@@ -618,7 +618,7 @@ def clear_all()
618618
Turns all the LEDs off.
619619

620620
Parameters:
621-
idx (int): The index of the LED
621+
idx (int): The index of the LED
622622

623623
<a id="modulino.pixels.ModulinoPixels.show"></a>
624624

0 commit comments

Comments
 (0)