update examples for testing of final fw image

Author: malcolm-sparkfun

source_only_examples/project1_a.py

@@ -1,18 +1,31 @@
+# MicroPython SparkFun Inventor's Kit Circuit 1A: Blink an LED
+
+# What you should see:
+# When this code runs, it blinks the LED 10 times by setting the LED high, then low and sleeping in between each step.
+# 
+# For more information, check out the guide here: TODO: guide URL
+
+# To blink the LED, we need to enable the board pin 34 (the pin that the LED is connected to in the circuit).
+# To do this we load the Pin definition for the board
 from machine import Pin
 
+# Now create a Pin variable for the LED pin, number 34. Also define it as an output pin, so we can turn it on and off
 led_pin = Pin(34, Pin.OUT)
-led_pin.high()
-led_pin.low()
 
+# We turn the LED on by setting the pin value to high or on
+# And to turn the LED off, we set the pin to low like so:
+# led_pin.high()
+# led_pin.low()
+
+# To blink the LED, we can turn it on, wait a period of time and then turn it off. This is done by sleeping between the on and off commands.
+
+# To do this in MicroPython, we need a sleep function. Let’s load the sleep function, which will sleep for a number of seconds.
 from time import sleep
-led_pin.high()
-sleep(1)
-led_pin.low()
-sleep(1)
-led_pin.high()
-sleep(1)
-led_pin.low()
 
+# Now lets blink the LED - sleeping for 1 second between turning the LED on and off
+# Now we’ll present the idea of a for loop. A loop repeats a statement for a number of specified times.
+
+# To blink our LED 10 times, use the following commands:
 for i in range(10):
  led_pin.high()
  sleep(1)

source_only_examples/project1_b.py

@@ -1,12 +1,19 @@
+# MicroPython SparkFun Inventor's Kit Circuit 1B: Potentiometer
+
+# What you should see:
+# You should see the LED blink faster or slower in accordance with your potentiometer. The delay between each flash will change based on the position of the knob.
+# 
+# For more information, check out the guide here: TODO: guide URL
+
 from machine import Pin # Allows us to use "Pin" to use code to interface with the pins on our board
 
 from machine import ADC # Allows us to use "ADC" (analog-to-digital conversion) to read from our analog pin
 
 led_pin = Pin(34, Pin.OUT) # Create a pin variable for the led pin (pin 34)
 potentiometer = ADC(Pin.board.A0) # Create an ADC variable for reading the potentiometer value from analog pin A0
 
-# Try moving the potentiometer and re-running this cell and you should see this value change.
-print(potentiometer.read_u16()) # Use the "read_u16" method to read the value of our potentiometer.
+# Try moving the potentiometer and running the below line repeatedly and you should see the value change
+# print(potentiometer.read_u16()) # Use the "read_u16" method to read the value of our potentiometer.
 
 # Now, let's blink the LED with different speeds based on the potentiometer input
 import time # Allows us to use "time.sleep()" to delay for a certain number of seconds

source_only_examples/project1_c.py

@@ -1,31 +1,40 @@
+# MicroPython SparkFun Inventor's Kit Circuit 1C: Photoresistor
+# 
+# What you should see:
+# The program stores the light level in a variable. Then, using an if/else statement, the program checks to see what it should do with the LED. 
+# If the variable is above the threshold (it’s bright), turn the LED off. If the variable is below the threshold (it’s dark), turn the LED on. 
+# You now have just built your own night-light!
+#
+# For more information, check out the guide here: TODO: guide URL
+
 from machine import Pin # Allows us to use "Pin" to use code to interface with the pins on our board
 
 from machine import ADC # Allows us to use "ADC" (analog-to-digital conversion) to read from our analog pin
 
 led_pin = Pin(34, Pin.OUT) # Create a pin variable for the led pin (pin 34)
 photoresistor = ADC(Pin.board.A0) # Create an ADC variable for reading the photoresistor value from analog pin A0
 
-# Try moving the potentiometer and re-running this cell and you should see this value change.
-print(photoresistor.read_u16()) # Use the "read_u16" method to read the value of our potentiometer.
+# Try moving the potentiometer and running the below line repeatedly and you should see the value change
+# print(photoresistor.read_u16()) # Use the "read_u16" method to read the value of our potentiometer.
 
 # Now, let's turn the LED on and off based on the photoresistor value.
 import time # Allows us to use "time.sleep()" to delay for a certain number of seconds
 
-# We'll set our threshold to half of the maximum value of the ADC reading (65535)
-threshold = 65535 / 2 
+# We'll set our threshold to a bit below the top of the range of the photoresistor (65535)
+# you can change this as you want to match the lighting in your room
+threshold = 55000 
 
 # Infinite loop so this cell keeps running until we stop it.
 while True:
  photoValue = photoresistor.read_u16() # Get the new photoresistor value (0 - 65535)
 
  print(f"Photoresistor Value: {photoValue : 5}", end='\r') # Print our Photoresistor reading (don't mind the fanciness of this line it just makes the print format nicely)
 
- # Turn on the LED but only if the photoresistor value is above the threshold
- if photoValue > threshold:
+ # Turn on the LED but only if the photoresistor value is below the threshold
+ if photoValue < threshold:
  led_pin.high()
  else:
  led_pin.low()
 
  # A short delay to make the printout easier to read
  time.sleep(0.250)
-

source_only_examples/project1_d.py

@@ -1,3 +1,12 @@
+# MicroPython SparkFun Inventor's Kit Circuit 1D: RGB Night-Light
+#
+# What you should see:
+# This program puts together the photoresistor, potentiometer, and RGB led to create a customizable night light. 
+# When the light of your room is below the threshold, the RGB will turn on. 
+# The color of the RGB can then be set with the potentiometer.
+#
+# For more information, check out the guide here: TODO: guide URL
+
 from machine import Pin # Allows us to use "Pin" to use code to interface with the pins on our board
 
 from machine import ADC # Allows us to use "ADC" (analog-to-digital conversion) to read from our analog pin
@@ -68,8 +77,9 @@ def turnOff():
 photoresistor = ADC(Pin.board.A0) # Create an ADC variable for reading the photoresistor value from analog pin A0
 potentiometer = ADC(Pin.board.A1) # Create an ADC variable for reading the potentiometer value from analog pin A1
 
-# We'll set our photo-resistor threshold to a quarter of the maximum value of the ADC reading (65535)
-threshold = 65535 / 4
+# We'll set our threshold to a bit below the top of the range of the photoresistor (65535)
+# you can change this as you want to match the lighting in your room
+threshold = 55000 
 potentiometerMax = 65535 # Maximum value for the potentiometer reading 
 
 # Infinite loop to continously read the photoresistor and potentiometer values

source_only_examples/project2_a.py

@@ -1,3 +1,10 @@
+# MicroPython SparkFun Inventor's Kit Circuit 2A: Buzzer
+
+# What you should see:
+# When the program begins, a song will play from the buzzer once. Use the potentiometer to adjust the volume.
+# 
+# For more information, check out the guide here: TODO: guide URL
+
 from machine import Pin # Allows us to use "Pin" to use code to interface with the pins on our board
 from machine import PWM # Allows us to use "PWM" (pulse-width modulation) to control the brightness of our LED
 

source_only_examples/project2_b.py

@@ -1,3 +1,10 @@
+# MicroPython SparkFun Inventor's Kit Circuit 2B: Digital Trumpet
+#
+# What you should see:
+# Different tones will play when you press different keys. Turning the potentiometer will adjust the volume.
+# 
+# For more information, check out the guide here: TODO: guide URL
+
 from machine import Pin # Allows us to use "Pin" to use code to interface with the pins on our board
 from machine import PWM # Allows us to use "PWM" (pulse-width modulation) to control the brightness of our LED
 

source_only_examples/project2_c.py

@@ -1,3 +1,12 @@
+# MicroPython SparkFun Inventor's Kit Circuit 2C: Simon Says Game
+#
+# What you should see:
+# The circuit will flash all of the LEDs and play a melody. After a few seconds, it will flash the first light in the pattern. 
+# If you repeat the pattern correctly by pressing the corresponding colored button, then the game will move to the next round and add another color to the pattern sequence. 
+# If you make a mistake, the loss melody will play. If you get to round 10, the win melody will play. Press any button to start a new game.
+# 
+# For more information, check out the guide here: TODO: guide URL
+
 from machine import Pin # Allows us to use "Pin" to use code to interface with the pins on our board
 from machine import PWM # Allows us to use "PWM" (pulse-width modulation) to control the brightness of our LED
 

source_only_examples/project3_a.py

@@ -1,37 +1,12 @@
-# TODO: Depending on how we want this to look, we may not include this (in case it is in firmware) but for now
-# this will get it to work. 
-from machine import PWM, Pin, ADC
-import math
+# MicroPython SparkFun Inventor's Kit Circuit 3A: Servo Motors
+#
+# What you should see:
+# Turning the potentiometer will cause the servo to turn.
+# 
+# For more information, check out the guide here: TODO: guide URL
 
-class Servo:
- def __init__(self,pin_id,min_us=544.0,max_us=2400.0,min_deg=0.0,max_deg=180.0,freq=50):
- self.pwm = machine.PWM(machine.Pin(pin_id))
- self.pwm.freq(freq)
- self.current_us = 0.0
- self._slope = (min_us-max_us)/(math.radians(min_deg)-math.radians(max_deg))
- self._offset = min_us
- 
- def write(self,deg):
- self.write_rad(math.radians(deg))
-
- def read(self):
- return math.degrees(self.read_rad())
- 
- def write_rad(self,rad):
- self.write_us(rad*self._slope+self._offset)
- 
- def read_rad(self):
- return (self.current_us-self._offset)/self._slope
- 
- def write_us(self,us):
- self.current_us=us
- self.pwm.duty_ns(int(self.current_us*1000.0))
- 
- def read_us(self):
- return self.current_us
-
- def off(self):
- self.pwm.duty_ns(0)
+from machine import Pin, ADC
+from sik_utilities import Servo # Import the servo class from the sik_utilities file (it uses PWM under the hood)
 
 led_pin = Pin(34, Pin.OUT) # Create a pin variable for the led pin (pin 34)
 potentiometer = ADC(Pin.board.A0) # Create an ADC variable for reading the potentiometer value from analog pin A0

source_only_examples/project3_b.py

@@ -1,3 +1,10 @@
+# MicroPython SparkFun Inventor's Kit Circuit 3B: Distance Sensor
+#
+# What you should see:
+# Move your hand or a large, flat object closer and farther away from the distance sensor. As the object approaches, the light will change from green to yellow to red.
+# 
+# For more information, check out the guide here: TODO: guide URL
+
 from machine import Pin # Allows us to use "Pin" to use code to interface with the pins on our board
 from machine import PWM # Allows us to use "PWM" (pulse-width modulation) to control the brightness of our LED
 from time import sleep_us, sleep

source_only_examples/project3_c.py

@@ -1,42 +1,16 @@
-# TODO: Depending on how we want this to look, we may not include this (in case it is in firmware) but for now
-# this will get it to work. 
-import machine
-import math
-from time import sleep_us
+# MicroPython SparkFun Inventor's Kit Circuit 3C: Motion Alarm
+#
+# What you should see:
+# The RGB LED will behave as in your last circuit. It will be green when objects are far, yellow when they are midrange and red when they are close. 
+# When an object is close the buzzer will also beep, and the servo will rotate back and forth.
+# 
+# For more information, check out the guide here: TODO: guide URL
+
+from time import sleep_us, sleep
 from machine import time_pulse_us
 from machine import Pin # Allows us to use "Pin" to use code to interface with the pins on our board
 from machine import PWM # Allows us to use "PWM" (pulse-width modulation) to control the brightness of our LED
-
-
-class Servo:
- def __init__(self,pin_id,min_us=544.0,max_us=2400.0,min_deg=0.0,max_deg=180.0,freq=50):
- self.pwm = machine.PWM(machine.Pin(pin_id))
- self.pwm.freq(freq)
- self.current_us = 0.0
- self._slope = (min_us-max_us)/(math.radians(min_deg)-math.radians(max_deg))
- self._offset = min_us
- 
- def write(self,deg):
- self.write_rad(math.radians(deg))
-
- def read(self):
- return math.degrees(self.read_rad())
- 
- def write_rad(self,rad):
- self.write_us(rad*self._slope+self._offset)
- 
- def read_rad(self):
- return (self.current_us-self._offset)/self._slope
- 
- def write_us(self,us):
- self.current_us=us
- self.pwm.duty_ns(int(self.current_us*1000.0))
- 
- def read_us(self):
- return self.current_us
-
- def off(self):
- self.pwm.duty_ns(0)
+from sik_utilities import Servo # Import the servo class from the sik_utilities file (it uses PWM under the hood)
 
 # LEDs
 pwmRed = PWM(Pin(28), freq=1000, duty_u16=0) # Create a PWM object on pin 28 with a frequency of 1000Hz and an initial "on time" of 0 (off)
@@ -53,9 +27,6 @@ def off(self):
 # Servo
 myServo = Servo(pin_id=35)
 
-from time import sleep_us
-from machine import time_pulse_us
-
 def get_distance():
  trigPin.high()
  sleep_us(10) # Send at least a 10 microsecond pulse to the trigger pin to start the measurement
@@ -67,8 +38,6 @@ def get_distance():
 
  return calculatedDistance # Return the calculated distance
 
-from time import sleep
-
 # Infinite loop to read the distance sensor and update the RGB LED colors based on the distance
 while True:
  distance = get_distance() # Get the distance from the sensor