Examples: Tidyup pass, Plasma 2040/2350 W cross compatibility.

Author: Gadgetoid

examples/hue_twinkles_encoder.py

@@ -8,7 +8,7 @@
 import plasma
 
 """
-A simple example for controlling pulsing LED patterns with an Encoder Wheel.
+Control pulsing LED patterns with an Encoder Wheel.
 
 Pressing the middle button will change between Hue, Spread, Brightness and Speed mode.
 

examples/plasma2040/alternating-blinkies.py

@@ -1,9 +1,11 @@
-# This super simple example sets up two alternating colours, great for festive lights!
-
 import time
 
 import plasma
 
+"""
+This super simple example sets up two alternating colours, great for festive lights!
+"""
+
 # Set how many LEDs you have
 NUM_LEDS = 50
 

examples/plasma2040/level.py

@@ -3,22 +3,24 @@
 import time
 
 import machine
-# Import msa301 and I2C helper
 from breakout_msa301 import BreakoutMSA301
-# Import helpers for RGB LEDs and Buttons
 from pimoroni import RGBLED, Button
 
 import plasma
 
-# A simple balancing game, where you use the MSA301 accelerometer to line up a band with a goal on the strip.
-# This can either be done using:
-# - Angle mode: Where position on the strip directly matches the accelerometer's angle
-# - Velocity mode: Where tilting the accelerometer changes the speed the band moves at
-# When the goal position is reached, a new position is randomly selected
+"""
+A simple balancing game, where you use the MSA301 accelerometer to line up a band with a goal on the strip.
 
-# Press "A" to change the game mode.
-# Press "B" to start or stop the game mode.
-# Press "Boot" to invert the direction of the accelerometer tilt
+This can either be done using:
+- Angle mode: Where position on the strip directly matches the accelerometer's angle.
+- Velocity mode: Where tilting the accelerometer changes the band's speed.
+
+When the goal position is reached, a new position is randomly selected.
+
+- Press "A" to change the game mode.
+- Press "Boot" to start or stop the game mode.
+- Press "B" to invert the direction of the accelerometer tilt
+"""
 
 # Set how many LEDs you have
 NUM_LEDS = 30
@@ -64,7 +66,13 @@
 
 user_sw = Button("USER_SW", repeat_time=0)
 button_a = Button("BUTTON_A", repeat_time=0)
-button_b = Button("BUTTON_B", repeat_time=0)
+
+try:
+    # Button B is only available on Plasma 2040
+    button_b = Button("BUTTON_B", repeat_time=0)
+except ValueError:
+    button_b = None
+
 led = RGBLED("LED_R", "LED_G", "LED_B")
 
 i2c = machine.I2C()
@@ -172,27 +180,29 @@ def colour_band(centre_position, width, goal_position, goal_width, hue):
 
     sw_pressed = user_sw.read()
     a_pressed = button_a.read()
-    b_pressed = button_b.read()
+    b_pressed = button_b and button_b.read()
 
-    if b_pressed:
+    if sw_pressed:
         game_mode = not game_mode
 
-    if sw_pressed:
+    if b_pressed:
         invert = not invert
 
     if mode == ANGLE:
-        if game_mode:
-            led.set_rgb(255, 255, 0)
-        else:
-            led.set_rgb(0, 255, 0)
+        if led:
+            if game_mode:
+                led.set_rgb(255, 255, 0)
+            else:
+                led.set_rgb(0, 255, 0)
         if a_pressed:
             mode = VELOCITY
 
     elif mode == VELOCITY:
-        if game_mode:
-            led.set_rgb(255, 0, 255)
-        else:
-            led.set_rgb(0, 0, 255)
+        if led:
+            if game_mode:
+                led.set_rgb(255, 0, 255)
+            else:
+                led.set_rgb(0, 0, 255)
         if a_pressed:
             mode = ANGLE
 

examples/plasma2040/monitor.py

@@ -1,14 +1,15 @@
 import machine
-# Import bme68x and I2C helper
 from breakout_bme68x import BreakoutBME68X
-# Import helpers for RGB LEDs and Buttons
 from pimoroni import RGBLED, Button
 
 import plasma
 
-# Uses a BME68x to monitor the ambient temperature, pressure and humidity, and show them as bars on an LED strip.
-# Press "A" to cycle to the next mode.
-# Press "B" to cycle to the previous mode.
+"""
+Uses a BME68x to monitor the ambient temperature, pressure and humidity, and show them as bars on an LED strip.
+
+- Press "A" to cycle to the next mode.
+- Press "B" to cycle to the previous mode.
+"""
 
 # Set how many LEDs you have
 NUM_LEDS = 30
@@ -50,10 +51,11 @@
 # WS2812 / NeoPixel™ LEDs
 led_strip = plasma.WS2812(NUM_LEDS)
 
+user_sw = Button("USER_SW", repeat_time=0)
 button_a = Button("BUTTON_A", repeat_time=0)
-button_b = Button("BUTTON_B", repeat_time=0)
 led = RGBLED("LED_R", "LED_G", "LED_B")
 
+
 i2c = machine.I2C()
 bme = BreakoutBME68X(i2c)
 
@@ -121,7 +123,7 @@ def colour_gauge(percent, start_led, end_led, start_hue, end_hue):
         colour_gauge(t, 0, NUM_LEDS, HUMIDITY_HUE_START, HUMIDITY_HUE_END)
 
     a_pressed = button_a.read()
-    b_pressed = button_b.read()
+    b_pressed = user_sw.read()
 
     if mode == ALL:
         led.set_rgb(127, 127, 127)

examples/plasma2040/rainbow.py

@@ -1,13 +1,14 @@
 import time
 
-# Import helpers for RGB LEDs, Buttons, and Analog
 from pimoroni import RGBLED, Analog, Button
 
 import plasma
 
-# Press "B" to speed up the LED cycling effect.
-# Press "A" to slow it down again.
-# Press "Boot" to reset the speed back to default.
+"""
+- Press "B" to speed up the LED cycling effect.
+- Press "A" to slow it down again.
+- Press "Boot" to reset the speed back to default.
+"""
 
 # Set how many LEDs you have
 NUM_LEDS = 30
@@ -18,6 +19,9 @@
 # How many times the LEDs will be updated per second
 UPDATES = 60
 
+# Magic values for Plasma 2040 current sense
+# 3A * 0.015Ω = 0.045V
+# 0.045V * 50 (gain) = 2.25V maximum
 ADC_GAIN = 50
 SHUNT_RESISTOR = 0.015
 
@@ -31,9 +35,18 @@
 
 user_sw = Button("USER_SW", repeat_time=0)
 button_a = Button("BUTTON_A", repeat_time=0)
-button_b = Button("BUTTON_B", repeat_time=0)
+try:
+    # Button B is only available on Plasma 2040
+    button_b = Button("BUTTON_B", repeat_time=0)
+except ValueError:
+    button_b = None
 led = RGBLED("LED_R", "LED_G", "LED_B")
-sense = Analog("CURRENT_SENSE", ADC_GAIN, SHUNT_RESISTOR)
+
+try:
+    # Sense is only available on Plasma 2040
+    sense = Analog("CURRENT_SENSE", ADC_GAIN, SHUNT_RESISTOR)
+except ValueError:
+    sense = None
 
 # Start updating the LED strip
 led_strip.start()
@@ -46,7 +59,7 @@
 while True:
     sw = user_sw.read()
     a = button_a.read()
-    b = button_b.read()
+    b = button_b and button_b.read()
 
     if sw:
         speed = DEFAULT_SPEED
@@ -67,7 +80,7 @@
     led.set_rgb(speed, 0, 255 - speed)
 
     count += 1
-    if count >= UPDATES:
+    if sense and count >= UPDATES:
         # Display the current value once every second
         print("Current =", sense.read_current(), "A")
         count = 0

examples/plasma2040/random-blinkies.py

@@ -1,11 +1,12 @@
-# This simple example randomises LED colours and brightness for a subtly sparkly effect.
-
 import time
-# Random functions! randrange is for picking integers from a range, and uniform is for floats.
 from random import randrange, uniform
 
 import plasma
 
+"""
+This example randomises LED colours and brightness for a subtly sparkly effect.
+"""
+
 # Set how many LEDs you have
 NUM_LEDS = 50
 
@@ -32,6 +33,8 @@
 led_strip.start()
 
 # Light up all the leds random colours and brightnesses from the specified ranges...
+# randrange is for picking integers from a range,
+# uniform is for generating random uniform floats between a minimum and maximum value.
 for i in range(NUM_LEDS):
     led_strip.set_hsv(i, randrange(HUE_START, HUE_END) / 360, 1.0, uniform(BRIGHTNESS_MIN, BRIGHTNESS_MAX))
 

examples/plasma2040/rgb-led-and-buttons.py

@@ -1,21 +1,33 @@
 import time
 
-# Import helpers for RGB LEDs and Buttons
 from pimoroni import RGBLED, Button
 
+"""
+Demonstrate the use of buttons on Plasma 2040 and Plasma 2350 W
+"""
+
 user_sw = Button("USER_SW", repeat_time=0)
 button_a = Button("BUTTON_A", repeat_time=0)
-button_b = Button("BUTTON_B", repeat_time=0)
+
+try:
+    # Button B is only available on Plasma 2040
+    button_b = Button("BUTTON_B", repeat_time=0)
+except ValueError:
+    button_b = None
+
 led = RGBLED("LED_R", "LED_G", "LED_B")
+
 led.set_rgb(0, 0, 0)
 
 while True:
     if user_sw.read():
         print("Pressed User SW - {}".format(time.ticks_ms()))
         led.set_rgb(255, 0, 0)
+
     if button_a.read():
         print("Pressed A - {}".format(time.ticks_ms()))
         led.set_rgb(0, 255, 0)
-    if button_b.read():
+
+    if button_b and button_b.read():
         print("Pressed B - {}".format(time.ticks_ms()))
         led.set_rgb(0, 0, 255)

examples/plasma2040/rotary.py

@@ -2,16 +2,16 @@
 import time
 
 import machine
-# Import bme68x and I2C helper
 from breakout_encoder import BreakoutEncoder
-# Import helpers for RGB LEDs and Buttons
 from pimoroni import RGBLED, Button
 
 import plasma
 
-# Press "B" to enable cycling.
-# Press "A" to change the encoder mode.
-# Press "Boot" to reset the effects back to default.
+"""
+- Press "B" to enable cycling.
+- Press "A" to change the encoder mode.
+- Press "Boot" to reset the effects back to default.
+"""
 
 # Set how many LEDs you have
 NUM_LEDS = 30
@@ -42,7 +42,13 @@
 
 user_sw = Button("USER_SW", repeat_time=0)
 button_a = Button("BUTTON_A", repeat_time=0)
-button_b = Button("BUTTON_B", repeat_time=0)
+
+try:
+    # Button B is only available on Plasma 2040
+    button_b = Button("BUTTON_B", repeat_time=0)
+except ValueError:
+    button_b = None
+
 led = RGBLED("LED_R", "LED_G", "LED_B")
 
 i2c = machine.I2C()
@@ -141,7 +147,7 @@ def brightness_gauge(v, vmax=100):
 
     sw_pressed = user_sw.read()
     a_pressed = button_a.read()
-    b_pressed = button_b.read()
+    b_pressed = button_b and button_b.read()
 
     if sw_pressed:
         speed = DEFAULT_SPEED

examples/plasma_stick/cheerlights.py

@@ -6,10 +6,10 @@
 
 import plasma
 
-'''
+"""
 This Plasma Stick example sets your LED strip to the current #cheerlights colour.
 Find out more about the Cheerlights API at https://cheerlights.com/
-'''
+"""
 
 URL = 'http://api.thingspeak.com/channels/1417/field/2/last.json'
 UPDATE_INTERVAL = 120  # refresh interval in secs. Be nice to free APIs!

examples/sparkles.py

@@ -3,6 +3,10 @@
 
 import plasma
 
+"""
+Use multiple overlapping, phase-shifted sine waves to create a sparkly effect.
+"""
+
 NUM_LEDS = 26
 EFFECT_SPEED = 2       # Does what it says on the tin! (lower is slower but you might see quantization/stepping)
 EFFECT_SHARPNESS = 10  # Numbers between 1 and 1000 are practical, give them a try!