fixed bugs and comments

Author: Philip van Allen

examples/move_simple.py

@@ -1,3 +1,8 @@
+# move_simple.py
+#
+# a non-hardware dependant example of using the VarSpeedPython class
+# to ramp a value from one value to another
+#
 import time
 
 from varspeed import Vspeed

examples/move_simple_led.py

@@ -1,3 +1,7 @@
+# move_simple_led.py
+#
+# changes the brightness of an LED over time
+
 import board
 import digitalio
 import pwmio
@@ -18,12 +22,22 @@
 # LED setup for most CircuitPython boards:
 led = pwmio.PWMOut(board.D2, frequency=5000, duty_cycle=0)
 
+print(f'Paused for 5 seconds at {MIN}...')
+# set the servo to a known starting point
+led.duty_cycle = MIN
+time.sleep(5)
+
+print(f'Moving to {MIN}...')
+
 running = True
 while running:
     # run a move from the current position
     # move(new_position,time_secs of move,steps in move,easing function)
     position, running, changed = vs.move(
-        new_position=MAX, time_secs=2, steps=100, easing="QuadEaseInOut")
+        new_position=MAX, time_secs=5, steps=100, easing="QuadEaseInOut")
     if changed:
         print(f'Step: {vs.step}, Position: {position}')
-        led.duty_cycle = int(position / 100)
+        led.duty_cycle = int(position)
+
+print(f'Paused for 5 seconds at {position}...')
+time.sleep(5)

examples/move_simple_servo.py

@@ -1,3 +1,7 @@
+# move_simple_servo.py
+#
+# changes the position of a servo over time
+#
 import time
 import board
 import pwmio
@@ -11,7 +15,7 @@
 #
 # init_position = initial start position
 # result = float, int
-vs = Vspeed(init_position=max, result="int")
+vs = Vspeed(init_position=MIN, result="int")
 # make the output of the function be within the bounds set
 vs.set_bounds(lower_bound=MIN, upper_bound=MAX)
 
@@ -21,13 +25,12 @@
 # Create a servo object
 my_servo = servo.Servo(pwm)
 
+print(f'Paused for 5 seconds at {MIN}...')
 # set the servo to a known starting point
-my_servo.angle = vs.position
-
-print(f'Paused at {vs.position}...')
+my_servo.angle = MIN
 time.sleep(5)
 
-print(f'Moving to {min}...')
+print(f'Moving to {MIN}...')
 running = True
 while running:
     # move(new_position,time_secs of move,steps in move,easing function)

examples/sequence_simple.py

@@ -1,3 +1,8 @@
+# sequence_simple.py
+#
+# a non-hardware dependant example of using the VarSpeedPython class
+# to have a series of moves in a sequence
+#
 import time
 
 from varspeed import Vspeed
@@ -9,13 +14,13 @@
 #
 # init_position = initial start position
 # result = float, int
-vs = Vspeed(init_position=max, result="int")
+vs = Vspeed(init_position=MAX, result="int")
 # make the output of the function be within the bounds set
 vs.set_bounds(lower_bound=MIN, upper_bound=MAX)
 
 my_sequence = [(MAX / 2, 2, 10, "QuadEaseIn"),
-               (MAX, 0.5, 9, "QuadEaseOut"),
-               (MIN, 0.5, 8, "SineEaseInOut")]
+               (MIN, 2.0, 10, "QuadEaseOut"),
+               (MAX, 2.0, 10, "SineEaseInOut")]
 
 running = True
 #print("starting  position",vs.position)

examples/sequence_simple_servo.py

@@ -1,3 +1,7 @@
+# sequence_simple_servo.py
+#
+# an example of using the VarSpeedPython class to have a series of moves in a sequence
+#
 import time
 import board
 import pwmio
@@ -11,9 +15,9 @@
 #
 # init_position = initial start position
 # result = float, int
-vs = Vspeed(init_position=MAX, result="int")
+vs = Vspeed(init_position=MIN, result="int")
 # make the output of the function be within the bounds set
-vs.set_bounds(lower_bound=min, upper_bound=max)
+vs.set_bounds(lower_bound=MIN, upper_bound=MAX)
 
 # create a PWMOut object on Pin D2.
 pwm = pwmio.PWMOut(board.D2, duty_cycle=2 ** 15, frequency=50)
@@ -22,11 +26,11 @@
 my_servo = servo.Servo(pwm)
 
 # set the servo to a known starting point
-my_servo.angle = vs.position
+my_servo.angle = MIN
 
 my_sequence = [(MAX / 2, 2, 10, "QuadEaseIn"),
-               (MAX, 0.5, 9, "QuadEaseOut"),
-               (MIN, 0.5, 8, "SineEaseInOut")]
+               (MIN, 2.0, 10, "QuadEaseOut"),
+               (MAX, 2.0, 10, "SineEaseInOut")]
 
 running = True
 while running:
@@ -39,7 +43,7 @@
     #         if 1, play once
     #         if >1, loop sequence that many times
     #
-    position, running, changed = vs.sequence(sequence=my_sequence, loop_max=1)
+    position, running, changed = vs.sequence(sequence=my_sequence, loop_max=2)
 
     #print(position, running, changed)
     if changed:

examples/two_sequences_at_once.py

@@ -1,3 +1,7 @@
+# two_sequences_at_once.py
+#
+# runs two sequences in parallel without interfering with each another
+#
 import time
 
 from varspeed import Vspeed
@@ -13,11 +17,11 @@
 vs2 = Vspeed(init_position=MAX, result="int")
 
 # create the sequences
-my_sequence1 = [(0, 0.5, 10, "QuadEaseIn"),
-                (180, 0.5, 10, "QuadEaseOut")]
+my_sequence1 = [(MIN, 1.0, 10, "QuadEaseIn"),
+                (MAX, 1.0, 10, "QuadEaseOut")]
 
-my_sequence2 = [(180, 0.5, 10, "QuadEaseOut"),
-                (0, 0.5, 10, "SineEaseInOut")]
+my_sequence2 = [(MAX, 1.0, 10, "QuadEaseOut"),
+                (MIN, 1.0, 10, "SineEaseInOut")]
 
 running1 = True
 running2 = True

examples/two_sequences_at_once_led.py

@@ -1,3 +1,7 @@
+# two_sequences_at_once_led.py
+#
+# an example of how to use two sequences at the same time without blocking either one
+#
 import board
 import digitalio
 import pwmio
@@ -18,20 +22,20 @@
 # init_position = initial start position
 # result = float, int
 vs1 = Vspeed(init_position=MIN, result="int")
-# make the output of the function be within the bounds set
-vs1.set_bounds(lower_bound=MIN, upper_bound=max)
 vs2 = Vspeed(init_position=MAX, result="int")
-vs2.set_bounds(lower_bound=MIN, upper_bound=max)
+# make the output of the function be within the bounds set
+vs1.set_bounds(lower_bound=MIN, upper_bound=MAX)
+vs2.set_bounds(lower_bound=MIN, upper_bound=MAX)
 
 # set the LED to a known starting point
 led1.duty_cycle = vs1.position
 led2.duty_cycle = vs2.position
 
-my_sequence1 = [(MIN, 1, 100, "QuadEaseIn"),
-                (MAX, 1, 100, "QuadEaseOut")]
+my_sequence1 = [(MIN, 1.0, 10, "QuadEaseIn"),
+                (MAX, 1.0, 10, "QuadEaseOut")]
 
-my_sequence2 = [(MAX, 1, 100, "QuadEaseOut"),
-                (MIN, 1, 100, "QuadEaseIn")]
+my_sequence2 = [(MAX, 1.0, 10, "QuadEaseOut"),
+                (MIN, 1.0, 10, "SineEaseInOut")]
 
 running1 = True
 running2 = True
@@ -50,7 +54,8 @@
     if changed1:
         #print(f'Sequence Num: {vs1.seq_pos}, Step: {vs1.step}, Position: {position1}')
         led1.duty_cycle = position1
-        position2, running2, changed2 = vs2.sequence(
+
+    position2, running2, changed2 = vs2.sequence(
             sequence=my_sequence2, loop_max=0)
 
     if changed2:

examples/two_sequences_at_once_servo.py

@@ -1,3 +1,7 @@
+# two_sequences_at_once_servo.py
+#
+# an example of how to use two sequences at the same time without blocking either one
+#
 import time
 import board
 import pwmio
@@ -22,9 +26,9 @@
 # result = float, int
 vs1 = Vspeed(init_position=MIN, result="int")
 # make the output of the function be within the bounds set
-vs1.set_bounds(lower_bound=MIN, upper_bound=max)
+vs1.set_bounds(lower_bound=MIN, upper_bound=MAX)
 vs2 = Vspeed(init_position=MAX, result="int")
-vs2.set_bounds(lower_bound=MIN, upper_bound=max)
+vs2.set_bounds(lower_bound=MIN, upper_bound=MAX)
 
 # set the servo to a known starting point
 my_servo1.angle = vs1.position