Add additional documentation

Author: sebromero

src/modulino/buttons.py

@@ -31,8 +31,8 @@ def set_led_status(self, a, b, c):
 
     Parameters:
         a (bool): The status of the LED A.
-      b (bool): The status of the LED B.
-      c (bool): The status of the LED C.
+        b (bool): The status of the LED B.
+        c (bool): The status of the LED C.
     """
     data = bytearray(3)
     data[0] = 1 if a else 0
@@ -42,82 +42,144 @@ def set_led_status(self, a, b, c):
 
   @property
   def long_press_duration(self):
+    """
+    Returns the duration in milliseconds that the button must 
+    be pressed to trigger the long press event
+    """
     return self._long_press_duration
 
   @long_press_duration.setter
   def long_press_duration(self, value):
+    """
+    Sets the duration in milliseconds that the button must 
+    be pressed to trigger the long press event
+    """
     self._long_press_duration = value
 
   @property
   def on_button_a_press(self):
+    """
+    Returns the callback for the press event of button A.    
+    """
     return self._on_button_a_press
 
   @on_button_a_press.setter
   def on_button_a_press(self, value):
+    """
+    Sets the callback for the press event of button A.
+    """
     self._on_button_a_press = value
 
   @property
   def on_button_a_release(self):
+    """
+    Returns the callback for the release event of button A.
+    """
     return self._on_button_a_release
 
   @on_button_a_release.setter
   def on_button_a_release(self, value):
+    """
+    Sets the callback for the release event of button A.
+    """
     self._on_button_a_release = value
 
   @property
   def on_button_a_long_press(self):
+    """
+    Returns the callback for the long press event of button A.
+    """
     return self._on_button_a_long_press
 
   @on_button_a_long_press.setter
   def on_button_a_long_press(self, value):
+    """
+    Sets the callback for the long press event of button A.
+    """
     self._on_button_a_long_press = value
 
   @property
   def on_button_b_press(self):
+    """
+    Returns the callback for the press event of button B.
+    """
     return self._on_button_b_press
 
   @on_button_b_press.setter
   def on_button_b_press(self, value):
+    """
+    Sets the callback for the press event of button B.
+    """
     self._on_button_b_press = value
 
   @property
   def on_button_b_release(self):
+    """
+    Returns the callback for the release event of button B.
+    """
     return self._on_button_b_release
 
   @on_button_b_release.setter
   def on_button_b_release(self, value):
+    """
+    Sets the callback for the release event of button B.
+    """
     self._on_button_b_release = value
 
   @property
   def on_button_b_long_press(self):
+    """
+    Returns the callback for the long press event of button B.
+    """
     return self._on_button_b_long_press
 
   @on_button_b_long_press.setter
   def on_button_b_long_press(self, value):
+    """
+    Sets the callback for the long press event of button B.
+    """
     self._on_button_b_long_press = value
 
   @property
   def on_button_c_press(self):
+    """
+    Returns the callback for the press event of button C.
+    """
     return self._on_button_c_press
 
   @on_button_c_press.setter
   def on_button_c_press(self, value):
+    """
+    Sets the callback for the press event of button C.
+    """
     self._on_button_c_press = value
 
   @property
   def on_button_c_release(self):
+    """
+    Returns the callback for the release event of button C.
+    """
     return self._on_button_c_release
 
   @on_button_c_release.setter
   def on_button_c_release(self, value):
+    """
+    Sets the callback for the release event of button C.
+    """
     self._on_button_c_release = value
 
   @property
   def on_button_c_long_press(self):
+    """
+    Returns the callback for the long press event of button C.
+    """
     return self._on_button_c_long_press
 
   @on_button_c_long_press.setter
   def on_button_c_long_press(self, value):
+    """
+    Sets the callback for the long press event of button C.
+    """
     self._on_button_c_long_press = value
 
   def update(self):
@@ -189,12 +251,21 @@ def is_pressed(self, index):
 
   @property
   def button_a_pressed(self):
+    """
+    Returns True if button A is currently pressed.
+    """
     return self.is_pressed(0)
 
   @property
   def button_b_pressed(self):
+    """
+    Returns True if button B is currently pressed.
+    """
     return self.is_pressed(1)
 
   @property
   def button_c_pressed(self):
+    """
+    Returns True if button C is currently pressed.
+    """
     return self.is_pressed(2)

src/modulino/buzzer.py

@@ -2,6 +2,22 @@
 from time import sleep_ms
 
 class ModulinoBuzzer(Modulino):
+  """
+  Class to play tones on the buzzer of the Modulino.
+  The supported notes are defined as follows:
+  - B0
+  - C1, CS1, D1, DS1, E1, F1, FS1, G1, GS1, A1, AS1, B1
+  - C2, CS2, D2, DS2, E2, F2, FS2, G2, GS2, A2, AS2, B2
+  - C3, CS3, D3, DS3, E3, F3, FS3, G3, GS3, A3, AS3, B3
+  - C4, CS4, D4, DS4, E4, F4, FS4, G4, GS4, A4, AS4, B4
+  - C5, CS5, D5, DS5, E5, F5, FS5, G5, GS5, A5, AS5, B5
+  - C6, CS6, D6, DS6, E6, F6, FS6, G6, GS6, A6, AS6, B6
+  - C7, CS7, D7, DS7, E7, F7, FS7, G7, GS7, A7, AS7, B7
+  - C8, CS8, D8, DS8
+  - REST (Silence)
+
+  Those notes are accessible through ModulinoBuzzer.NOTES e.g. ModulinoBuzzer.NOTES["C4"]
+  """
   NOTES = {
     "B0": 31,
     "C1": 33,
@@ -109,7 +125,7 @@ def tone(self, frequency, lenght_ms=0xFFFF, blocking=False):
 
     Parameters:
         frequency: The frequency of the tone in Hz
-        lenght_ms: The duration of the tone in milliseconds
+        lenght_ms: The duration of the tone in milliseconds. If omitted, the tone will play indefinitely
         blocking: If set to True, the function will wait until the tone is finished
     """
     self.data[0:4]=frequency.to_bytes(4,'little')

src/modulino/knob.py

@@ -118,6 +118,9 @@ def update(self):
 
   @property
   def range(self):
+    """
+    Returns the range of the encoder value.
+    """    
     return self._value_range
 
   @range.setter
@@ -144,6 +147,9 @@ def range(self, value):
 
   @property
   def on_rotate_clockwise(self):
+    """
+    Returns the callback for the rotate clockwise event.
+    """
     return self._on_rotate_clockwise
 
   @on_rotate_clockwise.setter
@@ -158,6 +164,9 @@ def on_rotate_clockwise(self, value):
 
   @property
   def on_rotate_counter_clockwise(self):
+    """
+    Returns the callback for the rotate counter clockwise event.
+    """
     return self._on_rotate_counter_clockwise
 
   @on_rotate_counter_clockwise.setter
@@ -172,6 +181,9 @@ def on_rotate_counter_clockwise(self, value):
 
   @property
   def on_press(self):
+    """
+    Returns the callback for the press event.
+    """
     return self._on_press
 
   @on_press.setter
@@ -186,6 +198,9 @@ def on_press(self, value):
 
   @property
   def on_release(self):
+    """
+    Returns the callback for the release event.
+    """
     return self._on_release
 
   @on_release.setter

src/modulino/pixels.py

@@ -129,6 +129,13 @@ def clear(self, idx):
     self.set_color(idx, ModulinoColor(0, 0, 0), 0)
 
   def clear_range(self, start, end):
+    """
+    Turns off the LEDs in the given range.
+
+    Parameters:
+        start (int): The starting index of the range.
+        end (int): The ending index (inclusive) of the range.
+    """
     for i in range(start, end):
         self.clear(i)