Added a new audio example, and tweaks to others

Author: ZodiusInfuser

examples/README.md

@@ -4,7 +4,7 @@
   - [Read ADCs](#read-adcs)
   - [Set GPIOs](#set-gpios)
   - [Read GPIOs](#read-gpios)
-  - [Read Encoders](#read-encoders)  
+  - [Read Encoders](#read-encoders)
   - [Read Internals](#read-internals)
   - [LED Rainbow](#led-rainbow)
   - [Reset Inventor](#reset-inventor)
@@ -30,6 +30,7 @@
   - [Servo Wave](#servo-wave)
   - [Calibration](#calibration)
 - [Audio Examples](#audio-examples)
+  - [Play Sound](#play-sound)
   - [Motor Song](#motor-song)
   - [Random Droid](#random-droid)
 - [Extra Examples](#extra-examples)
@@ -201,6 +202,12 @@ Shows how to configure Inventor HAT Mini's servos with different common calibrat
 
 ## Audio Examples
 
+### Play Sound
+[audio/play_sound.py](audio/play_sound.py)
+
+Play a WAV audio file from your Inventor HAT Mini!
+
+
 ### Motor Song
 [audio/motor_song.py](audio/motor_song.py)
 

examples/audio/ahoy.wav

@@ -0,0 +1,32 @@
+import pygame
+from inventorhatmini import InventorHATMini
+
+"""
+Play a WAV audio file from your Inventor HAT Mini!
+
+Press "User" to play the sound.
+
+Note: WAV files need to be signed 16-bit
+"""
+
+# Create a new InventorHATMini
+board = InventorHATMini(init_leds=False)
+
+# Initialise PyGame so we can play sounds with it
+pygame.init()
+
+# Load the sound from file
+ahoy = pygame.mixer.Sound("./ahoy.wav")
+
+# Loop forever
+while True:
+    if board.switch_pressed():
+        # Play the sound
+        channel = ahoy.play()
+        print("Playing ... ", end="")
+
+        # Wait for the sound to finish playing
+        while channel.get_busy():
+            pass
+
+        print("Done")

examples/audio/play_sound.py

@@ -12,7 +12,7 @@
 Press "User" to play a random word out of the speaker.
 """
 
-# Constnats
+# Constants
 MIN_WORD_LENGTH = 3     # The smallest word size
 MAX_WORD_LENGTH = 10    # The largest word size
 WAIT_TIME = 0.25        # The time (in seconds) to wait after playing a word, before accepting user input again
@@ -24,14 +24,14 @@
 
 # Generate the characters from `c1` to `c2`, inclusive.
 def char_range(c1, c2):
-    for c in range(ord(c1), ord(c2)+1):
+    for c in range(ord(c1), ord(c2) + 1):
         yield chr(c)
 
 
 # Generate a random word from the letters a to z.
 def random_string(word_length=5, no_repeat=True):
     chars = list(char_range("a", "z"))
-    word =""
+    word = ""
     char_count = 0
     while char_count != word_length:
         char = chars[random.randint(0, 25)]
@@ -40,7 +40,7 @@ def random_string(word_length=5, no_repeat=True):
         else:
             word += char
             char_count += 1
-    print(word)
+    print("Saying:", word)
     return word
 
 

examples/audio/random_droid.py

@@ -15,7 +15,7 @@
 board = InventorHATMini(init_leds=False)
 
 # Create an Encoder object using two GPIO pins
-enc = board.encoder_from_gpios(CHANNEL, GPIO_1, GPIO_2)
+enc = board.encoder_from_gpio_pins(CHANNEL, GPIO_1, GPIO_2)
 
 # Uncomment the below line (and the top imports) to
 # reverse the counting direction of the encoder

examples/extras/gpio_encoder.py

@@ -1,5 +1,5 @@
 import time
-from inventorhatmini import InventorHATMini, NUM_SERVOS
+from inventorhatmini import InventorHATMini, NUM_SERVOS, LED_SERVO_1
 from ioexpander import IN  # or IN_PU of a pull-up is wanted
 
 """
@@ -31,9 +31,9 @@
         # Set the neighbouring LED to a colour based on
         # the input, with Green for high and Blue for low
         if value:
-            board.leds.set_hsv(i, 0.333, 1.0, BRIGHTNESS)
+            board.leds.set_hsv(i + LED_SERVO_1, 0.333, 1.0, BRIGHTNESS)
         else:
-            board.leds.set_hsv(i, 0.666, 1.0, BRIGHTNESS)
+            board.leds.set_hsv(i + LED_SERVO_1, 0.666, 1.0, BRIGHTNESS)
 
     # Print a new line
     print()

examples/extras/read_servo_pins.py

@@ -1,6 +1,7 @@
 import time
+import math
 from inventorhatmini import InventorHATMini, SERVO_2, SERVO_3
-# from ioexpander.common import REVERSED_DIR
+from ioexpander.common import NORMAL_DIR  # REVERSED_DIR
 
 """
 Shows how to use Inventor HAT Mini's Servo headers to control an externally connected motor driver.
@@ -23,7 +24,7 @@
 board = InventorHATMini(init_servos=False, init_leds=False)
 
 # Create an Encoder object using two GPIO pins
-motor = board.motor_from_servo_pins(CHANNEL, SERVO_2, SERVO_3, direction=NORMAL_DIR)
+motor = board.motor_from_servo_pins(SERVO_2, SERVO_3, direction=DIRECTION)
 
 
 offset = 0.0
@@ -46,7 +47,7 @@ def sleep_until(end_time):
     offset += SPEED / 1000.0
 
     # Update the motor
-    angle = (i + offset) * math.pi
+    angle = offset * math.pi
     motor.speed(math.sin(angle) * SPEED_EXTENT)
 
     # Sleep until the next update, accounting for how long the above operations took to perform

examples/extras/servo_pin_motor.py

@@ -1,5 +1,5 @@
 import time
-from inventorhatmini import InventorHATMini, NUM_SERVOS
+from inventorhatmini import InventorHATMini, NUM_SERVOS, LED_SERVO_1
 from ioexpander import OUT
 
 """
@@ -28,17 +28,17 @@
 
     # Set each servos in turn and print its value
     for i in range(NUM_SERVOS):
-
+        # Set the pin to high if this is the current servo pin, otherwise low
         value = (i == current_servo)
-        board.servo_pin_value(value)
+        board.servo_pin_value(i, value)
         print(SERVO_NAMES[i], " = ", value, sep="", end=", ")
 
         # Set the neighbouring LED to a colour based on
         # the output, with Green for high and Blue for low
         if value:
-            board.leds.set_hsv(i, 0.333, 1.0, BRIGHTNESS)
+            board.leds.set_hsv(i + LED_SERVO_1, 0.333, 1.0, BRIGHTNESS)
         else:
-            board.leds.set_hsv(i, 0.666, 1.0, BRIGHTNESS)
+            board.leds.set_hsv(i + LED_SERVO_1, 0.666, 1.0, BRIGHTNESS)
 
     # Print a new line
     print()
@@ -50,5 +50,9 @@
 
     time.sleep(0.5)
 
+# Set all the servo pins back to low
+for i in range(NUM_SERVOS):
+    board.servo_pin_value(i, False)
+
 # Turn off the LED bars
 board.leds.clear()

examples/extras/set_servo_pins.py

@@ -19,14 +19,14 @@
 
 # Setup each GPIO as an analog input
 for i in range(NUM_GPIOS):
-    board.gpio_mode(i, ADC)
+    board.gpio_pin_mode(i, ADC)
 
 # Read the ADCs until the user button is pressed
 while not board.switch_pressed():
 
     # Read each ADC in turn and print its voltage
     for i in range(NUM_GPIOS):
-        voltage = board.gpio_value(i)
+        voltage = board.gpio_pin_value(i)
         print(ADC_NAMES[i], " = ", round(voltage, 3), sep="", end=", ")
 
         # Set the neighbouring LED to a colour based on the

examples/read_adcs.py

@@ -1,5 +1,5 @@
 import time
-from inventorhatmini import InventorHATMini, NUM_GPIOS
+from inventorhatmini import InventorHATMini, NUM_GPIOS, LED_GPIO_1
 from ioexpander import IN  # or IN_PU of a pull-up is wanted
 
 """
@@ -18,22 +18,22 @@
 
 # Setup each GPIO as an input
 for i in range(NUM_GPIOS):
-    board.gpio_mode(i, IN)  # or IN_PU of a pull-up is wanted
+    board.gpio_pin_mode(i, IN)  # or IN_PU of a pull-up is wanted
 
 # Read the GPIOs until the user button is pressed
 while not board.switch_pressed():
 
     # Read each GPIO in turn and print its value
     for i in range(NUM_GPIOS):
-        value = board.gpio_value(i)
+        value = board.gpio_pin_value(i)
         print(GPIO_NAMES[i], " = ", value, sep="", end=", ")
 
         # Set the neighbouring LED to a colour based on
         # the input, with Green for high and Blue for low
         if value:
-            board.leds.set_hsv(i, 0.333, 1.0, BRIGHTNESS)
+            board.leds.set_hsv(i + LED_GPIO_1, 0.333, 1.0, BRIGHTNESS)
         else:
-            board.leds.set_hsv(i, 0.666, 1.0, BRIGHTNESS)
+            board.leds.set_hsv(i + LED_GPIO_1, 0.666, 1.0, BRIGHTNESS)
 
     # Print a new line
     print()