Skip to content

Commit 52bbe40

Browse files
sebromeroactions-user
authored andcommitted
Update documentation
1 parent 63ab4ff commit 52bbe40

File tree

1 file changed

+51
-9
lines changed

1 file changed

+51
-9
lines changed

docs/api.md

+51-9
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@
4444
* [set\_all\_color](#modulino.pixels.ModulinoPixels.set_all_color)
4545
* [set\_color](#modulino.pixels.ModulinoPixels.set_color)
4646
* [set\_rgb](#modulino.pixels.ModulinoPixels.set_rgb)
47+
* [set\_brightness](#modulino.pixels.ModulinoPixels.set_brightness)
48+
* [set\_all\_brightness](#modulino.pixels.ModulinoPixels.set_all_brightness)
4749
* [clear](#modulino.pixels.ModulinoPixels.clear)
4850
* [clear\_range](#modulino.pixels.ModulinoPixels.clear_range)
4951
* [clear\_all](#modulino.pixels.ModulinoPixels.clear_all)
@@ -529,6 +531,7 @@ def __int__() -> int
529531
```
530532

531533
Return the 32-bit integer representation of the color.
534+
Used bits: 8 to 15 for blue, 16 to 23 for green, 24 to 31 for red.
532535

533536
<a id="modulino.pixels.ModulinoPixels"></a>
534537

@@ -582,7 +585,7 @@ Sets the color of the LEDs in the given range to the given RGB values.
582585

583586
**Returns**:
584587

585-
- `ModulinoPixels` - The object itself. Allows for daily chaining of methods.
588+
- `ModulinoPixels` - The object itself. Allows for daisy chaining of methods.
586589

587590
<a id="modulino.pixels.ModulinoPixels.set_range_color"></a>
588591

@@ -607,7 +610,7 @@ Sets the color of the LEDs in the given range to the given color.
607610

608611
**Returns**:
609612

610-
- `ModulinoPixels` - The object itself. Allows for daily chaining of methods.
613+
- `ModulinoPixels` - The object itself. Allows for daisy chaining of methods.
611614

612615
<a id="modulino.pixels.ModulinoPixels.set_all_rgb"></a>
613616

@@ -632,7 +635,7 @@ Sets the color of all the LEDs to the given RGB values.
632635

633636
**Returns**:
634637

635-
- `ModulinoPixels` - The object itself. Allows for daily chaining of methods.
638+
- `ModulinoPixels` - The object itself. Allows for daisy chaining of methods.
636639

637640
<a id="modulino.pixels.ModulinoPixels.set_all_color"></a>
638641

@@ -653,7 +656,7 @@ Sets the color of all the LEDs to the given color.
653656

654657
**Returns**:
655658

656-
- `ModulinoPixels` - The object itself. Allows for daily chaining of methods.
659+
- `ModulinoPixels` - The object itself. Allows for daisy chaining of methods.
657660

658661
<a id="modulino.pixels.ModulinoPixels.set_color"></a>
659662

@@ -676,7 +679,7 @@ Sets the color of the given LED index to the given color.
676679

677680
**Returns**:
678681

679-
- `ModulinoPixels` - The object itself. Allows for daily chaining of methods.
682+
- `ModulinoPixels` - The object itself. Allows for daisy chaining of methods.
680683

681684
<a id="modulino.pixels.ModulinoPixels.set_rgb"></a>
682685

@@ -703,7 +706,46 @@ Set the color of the given LED index to the given RGB values.
703706

704707
**Returns**:
705708

706-
- `ModulinoPixels` - The object itself. Allows for daily chaining of methods.
709+
- `ModulinoPixels` - The object itself. Allows for daisy chaining of methods.
710+
711+
<a id="modulino.pixels.ModulinoPixels.set_brightness"></a>
712+
713+
### `set_brightness`
714+
715+
```python
716+
def set_brightness(idx: int, brightness: int) -> 'ModulinoPixels'
717+
```
718+
719+
Sets the brightness of the given LED index.
720+
721+
**Arguments**:
722+
723+
- `idx` _int_ - The index of the LED (0..7).
724+
- `brightness` _int_ - The brightness of the LED. It should be a value between 0 and 100.
725+
726+
727+
**Returns**:
728+
729+
- `ModulinoPixels` - The object itself. Allows for daisy chaining of methods.
730+
731+
<a id="modulino.pixels.ModulinoPixels.set_all_brightness"></a>
732+
733+
### `set_all_brightness`
734+
735+
```python
736+
def set_all_brightness(brightness: int) -> 'ModulinoPixels'
737+
```
738+
739+
Sets the brightness of all the LEDs.
740+
741+
**Arguments**:
742+
743+
- `brightness` _int_ - The brightness of the LED. It should be a value between 0 and 100.
744+
745+
746+
**Returns**:
747+
748+
- `ModulinoPixels` - The object itself. Allows for daisy chaining of methods.
707749

708750
<a id="modulino.pixels.ModulinoPixels.clear"></a>
709751

@@ -722,7 +764,7 @@ Turns off the LED at the given index.
722764

723765
**Returns**:
724766

725-
- `ModulinoPixels` - The object itself. Allows for daily chaining of methods.
767+
- `ModulinoPixels` - The object itself. Allows for daisy chaining of methods.
726768

727769
<a id="modulino.pixels.ModulinoPixels.clear_range"></a>
728770

@@ -742,7 +784,7 @@ Turns off the LEDs in the given range.
742784

743785
**Returns**:
744786

745-
- `ModulinoPixels` - The object itself. Allows for daily chaining of methods.
787+
- `ModulinoPixels` - The object itself. Allows for daisy chaining of methods.
746788

747789
<a id="modulino.pixels.ModulinoPixels.clear_all"></a>
748790

@@ -756,7 +798,7 @@ Turns all the LEDs off.
756798

757799
**Returns**:
758800

759-
- `ModulinoPixels` - The object itself. Allows for daily chaining of methods.
801+
- `ModulinoPixels` - The object itself. Allows for daisy chaining of methods.
760802

761803
<a id="modulino.pixels.ModulinoPixels.show"></a>
762804

0 commit comments

Comments
 (0)