Add documentation to examples

Author: sebromero

examples/distance.py

@@ -1,4 +1,8 @@
 """
+This example shows how to use the ModulinoDistance class to read the distance from the Time of Flight sensor of the Modulino.
+The sensor works by sending out short pulses of light and then measure the time it takes for some of the emitted light to come back
+when it hits an object. The time it takes for the light to come back is directly proportional to the distance between the sensor and the object.
+
 Initial author: Sebastian Romero ([email protected])
 """
 

examples/knob.py

@@ -1,4 +1,15 @@
 """
+This example shows how to use the ModulinoKnob class to read the value of a rotary encoder knob.
+The knob is used to increase or decrease a value. The knob is rotated clockwise to increase the value and counter-clockwise to decrease it.
+
+You can register callbacks for the following events:
+- Press: The knob is pressed.
+- Release: The knob is released.
+- Rotate clockwise: The knob is rotated clockwise.
+- Rotate counter clockwise: The knob is rotated counter clockwise.
+
+Use reset() to reset the knob value to 0.
+
 Initial author: Sebastian Romero ([email protected])
 """
 

examples/knob_buzzer.py

@@ -1,4 +1,10 @@
 """
+This example demonstrates how to use the ModulinoKnob and ModulinoBuzzer classes to play different notes using a buzzer.
+The knob is used to select the note to play. The knob is rotated clockwise to increase the frequency of the note and counter-clockwise to decrease it.
+Once the knob is pressed, the buzzer stops playing the note.
+Only the notes between 400 and 2000 Hz from the predefined list are played in this example.
+You can run print(ModulinoBuzzer.NOTES) to see the full list of available notes.
+
 Initial author: Sebastian Romero ([email protected])
 """
 

examples/knob_pixels.py

@@ -1,4 +1,8 @@
 """
+This example shows how to use the ModulinoKnob and ModulinoPixels classes to control a set of pixels with a knob.
+The knob is used to set the number of pixels to turn on.
+The range property of the knob is used to map the knob values to the number of pixels to turn on.
+
 Initial author: Sebastian Romero ([email protected])
 """
 

examples/movement.py

@@ -1,4 +1,7 @@
 """
+This example shows how to use the ModulinoMovement class to read the accelerometer 
+and gyroscope values from the Modulino.
+
 Initial author: Sebastian Romero ([email protected])
 """
 

examples/pixels.py

@@ -1,4 +1,9 @@
 """
+This example shows how to use the ModulinoPixels class to control a set of pixels.
+The pixels are set to different colors and animations.
+You can use the ModulinoColor class to set predefined colors:
+- RED, GREEN, BLUE, YELLOW, CYAN, VIOLET, WHITE
+
 Initial author: Sebastian Romero ([email protected])
 """
 

examples/pixels_thermo.py

@@ -1,4 +1,11 @@
 """
+This example shows how to use the ModulinoPixels and ModulinoThermo classes to display the temperature on a pixel strip.
+A high temperature is represented by red color and a lower temperature with a yellow color.
+
+The pixels will map to the temperature range so that the first pixel represents 
+the lowest temperature and the last pixel the highest temperature of the predefined range.
+You can change the temperature range to accommodate the temperature range of your environment.
+
 Initial author: Sebastian Romero ([email protected])
 """
 
@@ -8,7 +15,7 @@
 pixels = ModulinoPixels()
 thermo_module = ModulinoThermo()
 
-# Yellow to red scale with 8 steps in between
+# Yellow to red scale with 8 steps
 colors = [
     (255, 255, 0), 
     (255, 204, 0), 

examples/pressure.py

@@ -1,4 +1,7 @@
 """
+This example shows how to use the ModulinoPressure class to read the pressure, 
+temperature and altitude from the Modulino.
+
 Initial author: Sebastian Romero ([email protected])
 """
 

examples/thermo.py

@@ -1,4 +1,8 @@
 """
+This example shows how to use the ModulinoThermo class to read 
+the temperature and humidity from the Modulino.
+If those values are temporarily unavailable, they will be set to None.
+
 Initial author: Sebastian Romero ([email protected])
 """
 

examples/third_party_board.py

@@ -1,4 +1,11 @@
 """
+This example shows how to use the Modulino library with a third party board.
+When running on a non-Arduino board, the I2C bus must be initialized manually.
+Usually the available I2C buses are predefined and can be accessed by their number, e.g. I2C(0).
+If not, the pins for SDA and SCL must be specified.
+
+Please note that the Modulinos are designed to work with a bus frequency of 100kHz.
+
 Initial author: Sebastian Romero ([email protected])
 """