Motivation
Overview
Preliminary Diagrams and Planning
Build Instructions: Hardware Components
Physical Assembly of Music Box
Code Setup
Operation Instructions
Next Steps/Future Improvements
Acknowledgements

Published November 13, 2020 © GPL3+

Programmable Music Box

Music boxes are a lot more fun when you can choose the song yourself!

BeginnerFull instructions provided5 hours1,213

Things used in this project

Hardware components

BeagleBoard.org PocketBeagle

Adafruit Breadboard-Friendly PCB Mount Mini Speaker - 8 Ohm 0.2W

SparkFun Servo - Generic Continuous Rotation (Micro Size)

SparkFun Pushbutton switch 12mm

SparkFun 7-Segment Serial Display - Red

Female Header 8 Position 1 Row (0.1")

Jumper wires (generic)

Resistor 1k ohm

Copper Board

Hand tools and fabrication machines

Soldering iron (generic)

Story

Motivation

I've always loved playing around with music boxes, and actually have a collection at home. There's something so novel about being able to press a button, or take a couple turns of a crank, and suddenly have music playing in your hands! This programmable music box is modelled after a more "traditional" music box (take for example, this one). When you buy a traditional programmable music box, you get a crank-based music box, special paper, and a special hole punch to punch holes in that paper. The places where you punch holes in the paper "catch" each string as it's fed through the music box, and that's how you make sound.

The issue with this, though, is that these can be kinda expensive. And, beyond that, you need special paper, and once you run out of that paper, you gotta buy more. I wanted to make something that you can build at home, out of cheap parts, and that you don't need an special paper for!

Overview

Per above, this music box operates on a similar mechanism to the above music box; you get to choose what notes are played by punching holes in paper, and then feeding it into the box. However, there are a couple major differences:

1. Instead of using a hand crank to feed the paper through, this is accomplished here through a continuous rotation servo, which can be turned on and off through the press of a button! This change was mainly motivated by the fact that I really wanted to use a servo in this project.

2. Each hole is detected in the following way. First, 2 wires are soldered to each end of a copper plate so that it can be connected to ground. Then, 7 wires are placed on top of the copper plate; these wires are connected to their own analog-in pin on the PocketBeagle (one for each note: A, B, C, D, E, F, G). The hole-punched paper is passed through on top of the copper plate, and under these wires; when there is paper between the copper plate and these wires, then the value read by the analog-in pins will float up and down randomly. When there is a hole, the wire will momentarily be in contact with the grounded copper plate, and hence the analog-in pins will read a 0 (or somewhere close to that).

Hence, all you have to do is feed paper onto the copper plate, press the button to start, and watch the music start playing!

Preliminary Diagrams and Planning

Before beginning to put the project, together, I first made a list of what features I wanted the music box to have:

1. Multiple speakers to play multiple sounds at once

2. An on/off button

3. A servo to drive the paper

4. An LCD display to give the status of the music box

These are all visualized in the block diagrams below:

System Block Diagram

Power Block Diagram

Note that there are only 6 wires connected to analog in pins, whereas earlier, 7 pins were mentioned (one for each note between A-G). Unfortunately, since the PocketBeagle only has 6 AIN 1.8V pins, one of these notes had to be left out.

The actual wiring of all of these components can be seen in the Fritzing schematic below:

Fritzing Schematic for Music Box

Build Instructions: Hardware Components

Speakers

The music box includes 3 speakers, which means that up to 3 notes can be played simultaneously by the music box. This is depicted below:

Speaker Setup

One end of each speaker is hooked to ground, while the other is attached to a PWM output. In particular, I used the PWM0-A, PWM1-A, and PWM2-B pins on the PocketBeagle. This worked out fine, except for one small issue: for some reason, the the PWM0-A pin on my PocketBeagle is unable to output a signal at a frequency other than exactly 400 Hz. Having looked online, this seems to a very uncommon issue, with no clear resolution. Given that, I've decided to leave in this 3rd speaker with the expectation that anyone else who tries this project is unlikely to run into the same issue.

Also note the fact that we only have 3 speakers means only 3 notes can be played at a time. In the event that more than 3 notes are read by the music box (ie. due to too many holes being punched in a row), the code is set up to randomly choose 3.

4-Digit7-SegmentDisplay

The purpose of the 4-digit 7-segment display is so that the user can know if the device is on or off. The display will show "off" when the music box is off, and "go" if the music box is on ("go" is chosen instead of "on" because the 7-segment display cannot display an "n"). In my setup, this display was wired to the I2C1 pins on the PocketBeagle, with the appropriate pull-up resistors included for the SDA and SCL lines, as well as power and ground hooked up as appropriate:

HT16K33 Setup

Button

As mentioned above, a button was used to allow the user to turn the music box on and off:

Button Setup

One terminal of the button is connected to both a pull-up resistor as well as GPIO 59 on the PocketBeagle, which has been configured into an GPIO_IN pin in the code below. The other end is connected to ground. Hence, the GPIO pin will read a "1" when the button is not pressed, and a "0" when the button is pressed. Hence, the code can simply detect for a "0" to see if the button is pressed.

ContinuousRotationServo

The continuous rotation servo, as mentioned above, serves as the "crank" that moves the paper through the page. This was wired up as typical, with the "signal" pin of the servo wired to the PWM0-B pin on the PocketBeagle. The rate of rotation is fixed, at 400Hz and duty cycle of 25.

Beyond just the hardware component, the servo was wrapped in rubber bands to make sure that it can actually "catch" and move the paper while rotating. This is displayed below:

Continuous Rotation Servo Setup

HeaderPins

The most important part of the whole setup are the actual wires that detect notes! Each of these wires was connected to a different Analog-In pin; in particular, the pins used were P1_19, P1_21, P1_23, P1_25, P1_27, P2_36. These wires were connected to header pins just so that they could easily be held in place. This is depicted below:

Header Pin Setup

(Note that there are 7 wires in the pictures, whereas only 6 are actually connected to the PocketBeagle -- the 7th extra wire was left in mostly just to preserve spacing).

As mentioned before, since these wires are not connected to anything most of the time, the simply float. However, when they come into contact with the grounded copper plate, the Analog-in they are connected to will read 0!

CopperPlate

The final component is simply a grounded copper plate. The copper plate used was the same kind you might find being used for a PCB mill. I soldered a wire to each side of the copper plate, and then plugged in each of these wires to ground on the PocketBeagle:

Soldered Wire to Copper Plate

Physical Assembly of Music Box

After connecting all the electrical components, it's time to assemble everything into the actual music box!

First, take the copper plate, and superglue two piece of cardboard to form the sides of the music box, close enough so that the header pins can be securely wedged between:

Then, superglue the continuous rotation servo to one side of the music box, at the exact height so that the servo "arms" just barely touch the copper plate:

And that's it, we're done!

Code Setup

1. Use the latest PocketBeagle image from BeagleBoard.org

2. Download this project_01 folder from this repo, unzip, and then move into the Cloud9 IDE on your own PocketBeagle

3. Ensure you have Python as well as the Python AdaFruit_BBIO package installed locally. If not, the steps to execute are:

sudo apt-get install build-essential python-dev python-setuptools python-pip python-smbus-y
sudo apt-get install python-pip
sudo apt-get install python3-pip
sudo pip install Adafruit_BBIO

4. Navigate to the project_01 folder, and change the permissions on the run script

chmod 755 run

5. Use Chron so that program will run on autoboot in the following steps

Navigate to your local cloud9 folder
Type "mkdir logs"
Type "sudo crontab -e"
Add to the end of the file:

@reboot sleep 30 && sh <full path to 'run' script> > /var/lib/cloud9/logs/cronlog2>&1

6. Reboot the PocketBeagle, and the code will auto-run after 30 seconds of waiting!

Operation Instructions

1. Hole punch paper to obtain desired song

(It should be pretty obvious that I don't own a hole puncher)

2. Feed the paper into the music box, far enough in so that part of it lies under the continuous rotation servo

3. Turn on PocketBeagle, and wait for 30 seconds for the program to auto-start up

4. Press the button to turn on, and enjoy the music!

Here's a video demonstration (note that the header pins need to be in pretty good contact with the copper plate for this to work; my header pins were kinda warped from experimenting with the setup too much, so in this video I have to push them down myself):

Next Steps/Future Improvements

A few notes about the limitations of this project that are evident from the video

Sometimes, the pins linger over a hole for too long, and this registers as multiple notes
When multiple notes are registered together too quickly, this creates a buffer in the backlog for the speakers, which creates a delay between the music box and the actual sound being played

These would be the two main fixes this project needs. Other changes I'd want to make for this project, moving forward, are:

Create a more robust housing for the device (either using a laser cutter, or 3D printer)
Reduce the delay between the time the music box detects a hole, and the time the speaker is played
Find a way to incorporate more notes (i.e. include notes with accidentals)
Add a volume control
Add a way to control the speed of the continuous rotation servo

Acknowledgements

Finally, a special thanks to Professor Erik Welsh (https://www.hackster.io/welsh) for all the help on making this project possible!

Code

"""
--------------------------------------------------------------------------
Music Box
--------------------------------------------------------------------------
License:   
Copyright 2020 Michael Tang
Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this 
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, 
this list of conditions and the following disclaimer in the documentation 
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors 
may be used to endorse or promote products derived from this software without 
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--------------------------------------------------------------------------
Software for running a programmable music box.
Main Components used:
  - HT16K33 Display
  - 1 push button
  - 3 speakers
  - 1 Micro-size continuous rotation servo
  - Copper plate
Uses:
  - HT16K33 display library developed by Erik Welsh
  - motor.py (in folder) for running thread for continuous rotation servo
  - speaker.py (in folder) for running thread for speaker
"""
from speaker import *
from motor import *
import Adafruit_BBIO.GPIO as GPIO
import Adafruit_BBIO.ADC as ADC
import threading

import ht16k33 as HT16K33

# ------------------------------------------------------------------------
# Constants
# ------------------------------------------------------------------------
# threshold sets what voltages our pins need to hit for a sound to be played
THRESHOLD = 500

# ------------------------------------------------------------------------
# Global variables
# ------------------------------------------------------------------------
# determines whether our music box is on or off; is controlled by the Button thread, and affects the MusicBox class
music_box_on = False

class MusicBox():
    # pins corresponding to each speaker, and a list for storing each speaker's threads
    speaker_0 = None
    speaker_1 = None
    speaker_2 = None
    speaker_threads = []
    
    # dict to store pins corresponding to each note
    note_pins = {}
    
    # object representing 7-segment display
    display = None
    
    # object representing motor
    motor = None
    motor_thread = None
    
    def __init__(self, speaker_0="P1_36", speaker_1="P2_3", speaker_2="P2_1", C="P1_27", D="P1_19", E="P1_21", F="P1_23", G="P1_25", A="P2_35", B="P2_36", i2c_bus=1, i2c_address=0x70, motor="P1_33"):
        """
        Intializes variables to appropriate pins
        """
        # initialize speaker pins
        self.speaker_0 = speaker_0
        self.speaker_1 = speaker_1
        self.speaker_2 = speaker_2

        # initialize note pins
        #self.note_pins['A'] = A
        self.note_pins['B'] = B
        self.note_pins['C'] = C
        self.note_pins['D'] = D
        self.note_pins['E'] = E
        self.note_pins['F'] = F
        self.note_pins['G'] = G
        
        # initialize 7-segment display
        self.display = HT16K33.HT16K33(i2c_bus, i2c_address)
        
        # Initialize motor pin
        self.motor = motor
        
        # setup all of the pins
        self._setup()
    
    def _setup(self):
        """
        Sets up device for initial use
        """
        # Initialize Display
        self.set_display_off()
        
        # Initialize Analog Inputs
        ADC.setup()
        
        # Initialize Motor
        self.motor_thread = RunMotor(self.motor)       
        self.motor_thread.start()
        
        # Setup speaker threads into a dictionary
        self.speaker_threads = [PlayNote(self.speaker_0), PlayNote(self.speaker_1), PlayNote(self.speaker_2)]
        for thread in self.speaker_threads:
            thread.start()
            
    
    def run(self):
        """
        Runs music box
        """
        while(True):
            # only start running music box if button has been pressed to on
            if music_box_on:
                self.turn_on()
                
                # check each input pin to see if certain notes are being played (need 4 consecutive values to be high)
                on = []
                for note in self.note_pins.keys():
                    if self.check_threshold(self.note_pins[note]):
                        on.append(note)
                        
                # only take first 3 notes detected (as we have 3 speakers)
                for i, note in enumerate(on[:3]):
                    self.speaker_threads[i].add_note(note)
            
            # if button is pressed to off, then turn off the music box
            else:
                self.turn_off()
    
    def check_threshold(self, pin):
        """
        Checks if an input has hit under threshold voltage (ie. it is toggled on when
        voltage is low enough
        
        Input: analog input pin to check
        Output: true if input has hit threshold voltage
        """
        measured = []
        # read 3 times to average out noise in pin reading
        for i in range(3):
            measured.append(ADC.read_raw(pin))
        return max(measured) <= THRESHOLD
        
    def set_display_on(self):
        """
        Set display to "on"
        """
        self.display.set_digit_raw(0, 0x6F)        # "G"
        self.display.set_digit_raw(1, 0x3F)        # "O"
        self.display.set_digit_raw(2, 0x00)        # " "
        self.display.set_digit_raw(3, 0x00)        # " "
        
    def set_display_off(self):
        """
        Set display to "off"
        """
        self.display.set_digit_raw(0, 0x3F)        # "O"
        self.display.set_digit_raw(1, 0x71)        # "F"
        self.display.set_digit_raw(2, 0x71)        # "F"
        self.display.set_digit_raw(3, 0x00)        # " "
        
    def turn_off(self):
        """
        Sets music box to off mode
        """
        # set display to off
        self.set_display_off()
        
        # stop motor
        self.motor_thread.pause()
        
    def turn_on(self):
        """
        Sets music box to on mode
        """
        # set display to on
        self.set_display_on()
        
        # start motor
        self.motor_thread.unpause()
        
    def cleanup(self):
        """
        Clean up threads
        """
        # Stop speaker threads
        for speaker_thread in self.speaker_threads:
            speaker_thread.end()
        
        # Stop motor thread
        self.motor_thread.end()
        
        # Clean up threads
        main_thread = threading.currentThread()
        for thread in threading.enumerate():
            if thread is not main_thread:
                thread.join()
        
        # Set Display to show program is complete
        self.display.set_digit(0, 13)        # "D"
        self.display.set_digit(1, 14)        # "E"
        self.display.set_digit(2, 10)        # "A"
        self.display.set_digit(3, 13)        # "D"
        
class BoxButton(threading.Thread):
    button = None
    # False corresponds to off, True corresponds to on
    prev_state = False
    stop = False
    
    def __init__(self, button="P2_2"):
        """
        Initialize thread as well as class fields to appropriate pins
        """
        threading.Thread.__init__(self)
        self.button = button
        
        # Initialize button
        GPIO.setup(self.button, GPIO.IN)
        
    def run(self):
        """
        Runs button by having it continuous checking for it to turn on/off
        """
        # make sure we can set global variable
        global music_box_on
        
        while not self.stop:
            # check if button is pressed
            if GPIO.input(self.button) == 0:
                # if prev_state was false, then it was just turned on
                if self.prev_state == False:
                    # previous state now becomes on
                    self.prev_state = True
                    music_box_on = True
                    
                # if prev_state was true, then it was fjust turned off
                else:
                    self.prev_state = False
                    music_box_on = False
                    
                # pause for a bit so it doesn't read a single click as multiple
                time.sleep(0.2)
    
    def end(self):
        """
        Stops thread
        """
        self.stop = True

if __name__ == '__main__':
    # Initialize all objects necessary to run music box
    box = MusicBox()
    button = BoxButton()
    button.start()
    
    try:
        box.run()
    # program terminates upon KeyBoard Interrupt
    except KeyboardInterrupt:
        # Initiate cleanup 
        box.cleanup()
        button.end()
        
        # Stop threads
        main_thread = threading.currentThread()
        for thread in threading.enumerate():
            if thread is not main_thread:
                thread.join()

"""
--------------------------------------------------------------------------
Continuous Servo Motor Functionality
--------------------------------------------------------------------------
License:   
Copyright 2020 Michael Tang
Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this 
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, 
this list of conditions and the following disclaimer in the documentation 
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors 
may be used to endorse or promote products derived from this software without 
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--------------------------------------------------------------------------
Python file that contains class to operate motor servo. Intended to work using
any continuous rotation servo.
"""

import Adafruit_BBIO.PWM as PWM
import threading

class RunMotor(threading.Thread):
    motor = None
    stop = False
    halt = True
    
    def __init__(self, motor):
        """
        Initializes thread and pin connected to continuous servo motor
        """
        threading.Thread.__init__(self)
        self.motor = motor
    
    def run(self):
        """
        Servo runs by continuuously waiting for a stop signal
        """
        # wait for stop to be signalled
        while True:
            # if halt command is given, pause the motor's operation
            if self.halt:
                PWM.stop(self.motor)
            # if stop command is given, terminate the motor's operation
            if self.stop:
                PWM.stop(self.motor)
                break
                
    def pause(self):
        """
        Pause the motor
        """
        self.halt = True
        
    def unpause(self):
        """
        Unpause the motor
        """
        self.halt = False
        # start motor
        PWM.start(self.motor, 25, 400)
                
    def end(self):
        """
        Stop the thread
        """
        self.stop = True

#!/bin/bash
# --------------------------------------------------------------------------
# Msuic Box - Configure Pins
# --------------------------------------------------------------------------
# License:   
# Copyright 2020 Michael Tang
# 
# Redistribution and use in source and binary forms, with or without 
# modification, are permitted provided that the following conditions are met:
# 
# 1. Redistributions of source code must retain the above copyright notice, this 
# list of conditions and the following disclaimer.
# 
# 2. Redistributions in binary form must reproduce the above copyright notice, 
# this list of conditions and the following disclaimer in the documentation 
# and/or other materials provided with the distribution.
# 
# 3. Neither the name of the copyright holder nor the names of its contributors 
# may be used to endorse or promote products derived from this software without 
# specific prior written permission.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# --------------------------------------------------------------------------
# 
# Configure pins for digital Music Box:
#   - PWM0 A / P1_36 (doesn't work for some reason)
#   - PWM0 B / P1_33 (for motor servo)
#   - PWM1 A / P2_1 (for speaker)
#   - PWM1 B / Pw_3 (for speaker)
#   - I2C1
# 
# --------------------------------------------------------------------------

# PWMs
config-pin P1_36 pwm    # for speaker
config-pin P1_33 pwm    # for motor
config-pin P2_01 pwm    # for speaker
config-pin P2_03 pwm    # for speaker


# I2C1 (for 7-seg display)
config-pin P2_09 i2c
config-pin P2_11 i2c

# Button
config-pin P2_02 gpio

#!/bin/bash
# --------------------------------------------------------------------------
# Music Box - Run Script
# --------------------------------------------------------------------------
# License:   
# Copyright 2020 Michael Tang
# 
# Redistribution and use in source and binary forms, with or without 
# modification, are permitted provided that the following conditions are met:
# 
# 1. Redistributions of source code must retain the above copyright notice, this 
# list of conditions and the following disclaimer.
# 
# 2. Redistributions in binary form must reproduce the above copyright notice, 
# this list of conditions and the following disclaimer in the documentation 
# and/or other materials provided with the distribution.
# 
# 3. Neither the name of the copyright holder nor the names of its contributors 
# may be used to endorse or promote products derived from this software without 
# specific prior written permission.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# --------------------------------------------------------------------------
# 
# Run Music Box in /var/lib/cloud9/ENGI301/project_01
# 
# --------------------------------------------------------------------------
cd /var/lib/cloud9/ENGI301/project_01
./configure_pins.sh
python3 music_box.py

"""
--------------------------------------------------------------------------
Speaker Sound Functionality
--------------------------------------------------------------------------
License:   
Copyright 2020 Michael Tang
Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this 
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, 
this list of conditions and the following disclaimer in the documentation 
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors 
may be used to endorse or promote products derived from this software without 
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--------------------------------------------------------------------------
Python threading class designed to provide speaker functionality. Designed to work
with any speaker that operates using PWM.
"""
import Adafruit_BBIO.ADC as ADC
import Adafruit_BBIO.PWM as PWM
import time
import threading
        
class PlayNote(threading.Thread):
    speaker = None
    freq_to_note = {'C' : 261, 'D' : 294, 'E' : 330, 'F' : 249, 'G' : 392, 'A' : 440, 'B': 494}
    stop = False
    notes = []
    
    def __init__(self, speaker):
        """
        Initialize thread and speaker pin
        """
        threading.Thread.__init__(self)
        self.speaker = speaker

    def run(self):
        """
        Keep speaker on continuous loop, waiting for a new note to play
        """
        while not self.stop:
            if self.notes:
                note = self.notes.pop(0)
                PWM.start(self.speaker, 5, self.freq_to_note[note])
                time.sleep(0.5)
            else:
                PWM.stop(self.speaker)
    
    def add_note(self, note):
        """
        Adds a note to speaker's note buffer, which will be played as soon as possible
        """
        self.notes.append(note)
    
    def end(self):
        """
        Stop the thread
        """
        self.stop = True

# -*- coding: utf-8 -*-
"""
--------------------------------------------------------------------------
HT16K33 I2C Library
--------------------------------------------------------------------------
License:   
Copyright 2018 Erik Welsh
Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this 
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, 
this list of conditions and the following disclaimer in the documentation 
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors 
may be used to endorse or promote products derived from this software without 
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--------------------------------------------------------------------------
Software API:
  HT16K33(bus, address=0x70)
    - Provide i2c bus that dispaly is on
    - Provide i2c address for the display
    
    clear()
      - Sets value of display to "0000"
    
    update(value)
      - Update the value on the display.  Value must be between 0 and 9999. 
      
  
--------------------------------------------------------------------------
Background Information: 
 
  * Using seven-segment digit LED display for Adafruit's HT16K33 I2C backpack:
    * http://adafruit.com/products/878
    * https://learn.adafruit.com/assets/36420
    * https://cdn-shop.adafruit.com/datasheets/ht16K33v110.pdf
    
    * Base code (adapted below):
        * https://github.com/emcconville/HT16K33/blob/master/FourDigit.py
        * https://github.com/emcconville/HT16K33/blob/master/_HT16K33.py
        * https://github.com/adafruit/Adafruit_Python_LED_Backpack/blob/master/Adafruit_LED_Backpack/HT16K33.py
        * https://github.com/adafruit/Adafruit_Python_LED_Backpack/blob/master/Adafruit_LED_Backpack/SevenSegment.py
        * https://github.com/adafruit/Adafruit_Python_LED_Backpack/blob/master/examples/sevensegment_test.py
"""
import os


# ------------------------------------------------------------------------
# Constants
# ------------------------------------------------------------------------
HEX_DIGITS                  = [0x3f, 0x06, 0x5b, 0x4f,    # 0, 1, 2, 3
                               0x66, 0x6d, 0x7d, 0x07,    # 4, 5, 6, 7
                               0x7f, 0x6f, 0x77, 0x7c,    # 8, 9, A, b
                               0x39, 0x5e, 0x79, 0x71]    # C, d, E, F

CLEAR_DIGIT                 = 0x7F
POINT_VALUE                 = 0x80

DIGIT_ADDR                  = [0x00, 0x02, 0x06, 0x08]
COLON_ADDR                  = 0x04
                      
HT16K33_BLINK_CMD           = 0x80
HT16K33_BLINK_DISPLAYON     = 0x01
HT16K33_BLINK_OFF           = 0x00
HT16K33_BLINK_2HZ           = 0x02
HT16K33_BLINK_1HZ           = 0x04
HT16K33_BLINK_HALFHZ        = 0x06

HT16K33_SYSTEM_SETUP        = 0x20
HT16K33_OSCILLATOR          = 0x01

HT16K33_BRIGHTNESS_CMD      = 0xE0
HT16K33_BRIGHTNESS_HIGHEST  = 0x0F
HT16K33_BRIGHTNESS_DARKEST  = 0x00


# ------------------------------------------------------------------------
# Functions / Classes
# ------------------------------------------------------------------------
class HT16K33():
    """ Class to manage a HT16K33 I2C display """
    bus     = None
    address = None
    command = None
    
    def __init__(self, bus, address=0x70):
        """ Initialize variables and set up display """
        self.bus     = bus
        self.address = address
        self.command = "/usr/sbin/i2cset -y {0} {1}".format(bus, address)
        
        self.setup(blink=HT16K33_BLINK_OFF, brightness=HT16K33_BRIGHTNESS_HIGHEST)
    
    # End def
    
    def setup(self, blink, brightness):
        """Initialize the display itself"""
        # i2cset -y 1 0x70 0x21
        os.system("{0} {1}".format(self.command, (HT16K33_SYSTEM_SETUP | HT16K33_OSCILLATOR)))
        # i2cset -y 1 0x70 0x81
        os.system("{0} {1}".format(self.command, (HT16K33_BLINK_CMD | blink | HT16K33_BLINK_DISPLAYON)))
        # i2cset -y 1 0x70 0xEF
        os.system("{0} {1}".format(self.command, (HT16K33_BRIGHTNESS_CMD | brightness)))

    # End def    


    def encode(self, data, double_point=False):
        """Encode data to TM1637 format.
        
        This function will convert the data from decimal to the TM1637 data fromt
        
        :param value: Value must be between 0 and 15
        
        Will throw a ValueError if number is not between 0 and 15.
        """
        ret_val = 0
        
        try:
            if (data != CLEAR_DIGIT):
                if double_point:
                    ret_val = HEX_DIGITS[data] + POINT_VALUE
                else:
                    ret_val = HEX_DIGITS[data]
        except:
            raise ValueError("Digit value must be between 0 and 15.")
    
        return ret_val

    # End def


    def set_digit(self, digit_number, data, double_point=False):
        """Update the given digit of the display."""
        os.system("{0} {1} {2}".format(self.command, DIGIT_ADDR[digit_number], self.encode(data, double_point)))    

    # End def


    def set_digit_raw(self, digit_number, data, double_point=False):
        """Update the given digit of the display using raw data value"""
        os.system("{0} {1} {2}".format(self.command, DIGIT_ADDR[digit_number], data))    

    # End def


    def set_colon(self, enable):
        """Set the colon on the display."""
        if enable:
            os.system("{0} {1} {2}".format(self.command, COLON_ADDR, 0x02))
        else:
            os.system("{0} {1} {2}".format(self.command, COLON_ADDR, 0x00))

    # End def        


    def clear(self):
        """Clear the display to read '0000'"""
        self.set_colon(False)

        self.set_digit(3, 0)
        self.set_digit(2, 0)
        self.set_digit(1, 0)
        self.set_digit(0, 0)

    # End def


    def update(self, value):
        """Update the value on the display.  
        
        This function will clear the display and then set the appropriate digits
        
        :param value: Value must be between 0 and 9999.
        
        Will throw a ValueError if number is not between 0 and 9999.
        """
        if ((value < 0) or (value > 9999)):
            raise ValueError("Value is not between 0 and 9999")
        
        self.set_digit(3, (value % 10))
        self.set_digit(2, (value // 10) % 10)
        self.set_digit(1, (value // 100) % 10)
        self.set_digit(0, (value // 1000) % 10)

    # End def

# End class


# ------------------------------------------------------------------------
# Main script
# ------------------------------------------------------------------------

if __name__ == '__main__':
    import time

    delay = 0.1
    
    print("Test HT16K33 Display:")
    
    display = HT16K33(1, 0x70)

    for i in range(0, 10):
        display.update(i)
        time.sleep(delay)

    for i in range(0, 100, 10):
        display.update(i)
        time.sleep(delay)

    for i in range(0, 1000, 100):
        display.update(i)
        time.sleep(delay)
        
    for i in range(0, 10000, 1000):
        display.update(i)
        time.sleep(delay)

    for value in [0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80, 0x00]:
        display.set_digit_raw(0, value)
        time.sleep(delay)

    display.set_colon(True)
    time.sleep(1)

    display.clear()    
    print("Test Finished.")

Credits

Michael Tang

1 project • 0 followers

Programmable Music Box

Things used in this project

Hardware components

Hand tools and fabrication machines

Story

Motivation

Overview

Preliminary Diagrams and Planning

Build Instructions: Hardware Components

Physical Assembly of Music Box

Code Setup

Operation Instructions

Next Steps/Future Improvements

Acknowledgements

Schematics

Music Box Fritzing Schematic

Code

music_box.py

motor.py

configure_pins.sh

run

speaker.py

ht16k33.py

Music Box Project Repo

Credits

Michael Tang

Comments

Embed the widget on your own site

Programmable Music Box

Programmable Music Box

Things used in this project

Hardware components

Hand tools and fabrication machines

Story

Motivation

Overview

Preliminary Diagrams and Planning

Build Instructions: Hardware Components

Physical Assembly of Music Box

Code Setup

Operation Instructions

Next Steps/Future Improvements

Acknowledgements

Schematics

Music Box Fritzing Schematic

Code

music_box.py

motor.py

configure_pins.sh

run

speaker.py

ht16k33.py

Music Box Project Repo

Credits

Michael Tang

Comments

Related channels and tags