Add more descriptive comments to examples

Author: JosipKuci

DRV8825/DRV8825/Examples/drv8825-acceleration.py

@@ -3,31 +3,44 @@
 # BRIEF: An example of accelerating stepper motor.
 # LAST UPDATED: 2025-05-27
 
-from drv8825 import  DRV8825
-from time import sleep
+from drv8825 import DRV8825  # Import the DRV8825 motor driver module
+from time import sleep       # Import sleep function for timing delays
 
-DIR_PIN = 4 #GPIO4
-STEP_PIN = 5 #GPIO5
+# Define GPIO pins for motor control
+DIR_PIN = 4   # GPIO pin used for direction control
+STEP_PIN = 5  # GPIO pin used for step pulses
 
-motor=DRV8825()
+# Create a DRV8825 motor instance
+motor = DRV8825()
+
+# Initialize the motor with the specified DIR and STEP pins
 motor.begin(DIR=DIR_PIN, STEP=STEP_PIN)
+
+# Set the number of steps the motor takes per full rotation (usually 200 for a 1.8° stepper motor)
 motor.setStepsPerRotation(200)
+
+# Set the length of each step pulse in microseconds
 motor.setStepPulseLength(1000)
+
+# Set motor rotation direction to clockwise
 motor.setDirection(DRV8825.CLOCK_WISE)
+
+# Enable the motor driver (turns on output)
 motor.enable()
 
 print("Accelerating")
 
+# Gradually increase the step frequency (i.e., speed up the motor)
+accelerationFactor = 1
+while accelerationFactor < 2000:
+    motor.step()                         # Send a single step pulse to the motor
+    sleep(1 / accelerationFactor)        # Delay inversely proportional to the factor (higher = faster)
+    accelerationFactor += 1              # Increase acceleration factor
+    print(accelerationFactor)            # Print current acceleration factor
 
-accelerationFactor=1
-while accelerationFactor<2000:
-    motor.step()
-    sleep(1/accelerationFactor)
-    accelerationFactor+=1
-    print(accelerationFactor)
-    
-while accelerationFactor>1:
-    motor.step()
-    sleep(1/accelerationFactor)
-    accelerationFactor-=1
-    print(accelerationFactor)
+# Gradually decrease the step frequency (i.e., slow down the motor)
+while accelerationFactor > 1:
+    motor.step()                         # Send a single step pulse
+    sleep(1 / accelerationFactor)        # Delay increases as acceleration factor decreases
+    accelerationFactor -= 1              # Decrease acceleration factor
+    print(accelerationFactor)            # Print current acceleration factor

WS2812/WS2812/Examples/ws2812b-blink.py

@@ -1,29 +1,32 @@
-# FILE:ws2812b-blink-example.py
+# FILE: ws2812b-blink-example.py
 # AUTHOR: Soldered
 # BRIEF: A simple example of blinking WS2812b LED's
 # LAST UPDATED: 2025-05-26
 
-import machine
-import neopixel
-import time
+import machine         # For accessing GPIO pins
+import neopixel        # Library to control WS2812b (NeoPixel) LEDs
+import time            # For delay/sleep functions
 
 # === Configuration ===
-PIN = 33         # GPIO pin
-NUM_PIXELS = 24   # Number of LEDs on-board (Change as needed)
+PIN = 33               # GPIO pin connected to the data line of the WS2812B LED strip
+NUM_PIXELS = 24        # Number of LEDs in the strip (adjust this to match your setup)
 
 # === Setup ===
+# Create a NeoPixel object on the specified GPIO pin with the specified number of LEDs
 np = neopixel.NeoPixel(machine.Pin(PIN), NUM_PIXELS)
 
-# === Function to set color (R, G, B) ===
+# === Function to set all LEDs to a specified color (R, G, B) ===
 def set_color(r, g, b):
-    for i in range(NUM_PIXELS):
-        np[i] = (r, g, b)
-        np.write()
+    for i in range(NUM_PIXELS):  # Iterate over each LED
+        np[i] = (r, g, b)         # Set the color for the current LED
+        np.write()               # Update the strip (could be moved outside loop for efficiency)
 
 # === Blink loop ===
+# Continuously blink all LEDs on and off
 while True:
-    set_color(255,255, 255)  # White color
-    time.sleep(0.5)
-    set_color(0,0,0) #Turn off
-    time.sleep(0.5)
+    set_color(255, 255, 255)     # Turn all LEDs on to full white
+    time.sleep(0.5)              # Wait 0.5 seconds
+    set_color(0, 0, 0)           # Turn all LEDs off (black)
+    time.sleep(0.5)              # Wait 0.5 seconds
+
 

WS2812/WS2812/Examples/ws2812b-simple-fade.py

@@ -1,27 +1,32 @@
-# FILE:ws2812b-simple-fade-example.py
+# FILE: ws2812b-simple-fade-example.py
 # AUTHOR: Soldered
 # BRIEF: A simple fade animation on WS2812b LED's
 # LAST UPDATED: 2025-05-26
 
-import machine
-import neopixel
-import time
+import machine         # For accessing hardware like GPIO
+import neopixel        # NeoPixel/WS2812B control module
+import time            # For delays
 
 # === Configuration ===
-PIN = 33         # GPIO pin
-NUM_PIXELS = 24   # Number of LEDs on-board (Change as needed)
+PIN = 33               # GPIO pin connected to the data line of the WS2812B strip
+NUM_PIXELS = 24        # Number of LEDs in the strip (adjust to your setup)
 
 # === Setup ===
+# Initialize NeoPixel object on the specified pin with the given number of LEDs
 np = neopixel.NeoPixel(machine.Pin(PIN), NUM_PIXELS)
 
 # === Fade Loop ===
+# This loop creates a moving red gradient (fading tail) along the LED strip
 while True:
-    for j in range (NUM_PIXELS):
-        time.sleep(0.01)
-        for i in range (NUM_PIXELS):
-            time.sleep(0.01)
-            if j+i<NUM_PIXELS:
-                np[i+j]=(i*8,0,0)
+    for j in range(NUM_PIXELS):           # Outer loop: shift the animation forward one LED at a time
+        time.sleep(0.01)                  # Short delay to control overall speed
+        for i in range(NUM_PIXELS):       # Inner loop: calculate and set brightness for each LED
+            time.sleep(0.01)              # Additional delay for smoother visual effect
+
+            # Calculate LED index based on current position (j) and brightness position (i)
+            if j + i < NUM_PIXELS:
+                np[i + j] = (i * 8, 0, 0)  # Set red intensity based on position (i), green and blue = 0
             else:
-                np[(i+j)-NUM_PIXELS]=(i*8,0,0)
-        np.write()
+                np[(i + j) - NUM_PIXELS] = (i * 8, 0, 0)  # Wrap around when index exceeds strip length
+
+        np.write()  # Update the LED strip with new values