Merge pull request #1 from dcooperdalrymple/dev

Merging new features from dev for v0.2.0.

Author: relic-se

.gitignore

@@ -17,6 +17,7 @@ _autosave-*
 *-save.pro
 *-save.kicad_pcb
 fp-info-cache
+*.swp
 
 # Netlist files (exported from Eeschema)
 *.net

Makefile

@@ -9,6 +9,7 @@ LIB = pico_synth_sandbox
 LIB_SRCS := \
 	__init__ \
 	tasks \
+	board \
 	display \
 	encoder \
 	audio \

README.rst

@@ -42,7 +42,7 @@ A few of the provided examples use pre-recorded audio samples for playback. Thes
 Installation
 ------------
 
-1. Download and install CircuitPython bootloader: `instructions & UF2 file <https://circuitpython.org/board/raspberry_pi_pico/>`_.
+1. Download and install CircuitPython bootloader: `instructions & UF2 file <https://circuitpython.org/board/raspberry_pi_pico/>`_. Requires version 9.0.0-alpha6 or greater.
 2. Ensure that your device is connected and mounted as `CIRCUITPYTHON`.
 3. Copy `requirements.txt` to the root folder of your device, make sure that the `circup` tool is installed in your environment with `pip3 install circup`, and run `circup update` to install all necessary libraries onto your device.
 4. Copy the desired code example to the root folder of your device as `code.py` and perform a software reset to run the code.

bin/mpy-cross

@@ -31,7 +31,7 @@ Features
 * Device-level settings using ``settings.toml`` file to generate audio driver, display, MIDI, and other hardware objects
 * Keyboard handling for key priority and voice allocation
 * :class:`pico_synth_sandbox.arpeggiator.Arpeggiator` and :class:`pico_synth_sandbox.sequencer.Sequencer` classes based on :class:`pico_synth_sandbox.timer.Timer` class with support for bpm, step, and gate
-* :class:`pico_synth_sandbox.waveform.Waveform` generator to quickly create numpy arrays
+* `pico_synth_sandbox.waveform` generators to quickly create numpy arrays
 * Voice based structure to simplify note and parameter management among multiple :class:`synthio.Note` instances
 * Multiple :class:`pico_synth_sandbox.voice.Voice` types available:
 

docs/index.rst

@@ -1,7 +1,7 @@
 Software Installation
 =====================
 
-1. Download and install CircuitPython bootloader: `instructions & UF2 file <https://circuitpython.org/board/raspberry_pi_pico/>`_.
+1. Download and install CircuitPython bootloader: `instructions & UF2 file <https://circuitpython.org/board/raspberry_pi_pico/>`_. Requires version 9.0.0-alpha6 or greater.
 2. Ensure that your device is connected and mounted as ``CIRCUITPYTHON``.
 3. Copy ``requirements.txt`` to the root folder of your device, make sure that the ``circup`` tool is installed in your environment with ``pip3 install circup``, and run ``circup update`` to install all necessary libraries onto your device.
 4. Copy the desired code example to the root folder of your device as ``code.py`` and perform a software reset to run the code.

docs/software.rst

@@ -3,11 +3,13 @@
 # GPL v3 License
 
 import time
+from pico_synth_sandbox.board import get_board
 from pico_synth_sandbox.audio import get_audio_driver
 from pico_synth_sandbox.synth import Synth
 from pico_synth_sandbox.voice.oscillator import Oscillator
 
-audio = get_audio_driver()
+board = get_board()
+audio = get_audio_driver(board)
 synth = Synth(audio)
 synth.add_voice(Oscillator())
 

examples/basic.py

@@ -3,10 +3,13 @@
 # GPL v3 License
 
 import pico_synth_sandbox.tasks
+from pico_synth_sandbox.board import get_board
 from pico_synth_sandbox.display import Display
 from pico_synth_sandbox.encoder import Encoder
 
-display = Display()
+board = get_board()
+
+display = Display(board)
 display.enable_horizontal_graph()
 
 value = 0
@@ -22,7 +25,7 @@ def update_value():
     )
 update_value()
 
-encoder = Encoder()
+encoder = Encoder(board)
 def increment():
     global value
     if value < 100:

examples/display-bar-horizontal.py

@@ -3,10 +3,13 @@
 # GPL v3 License
 
 import pico_synth_sandbox.tasks
+from pico_synth_sandbox.board import get_board
 from pico_synth_sandbox.display import Display
 from pico_synth_sandbox.encoder import Encoder
 
-display = Display()
+board = get_board()
+
+display = Display(board)
 display.enable_vertical_graph()
 
 value = 0
@@ -22,7 +25,7 @@ def update_value():
     )
 update_value()
 
-encoder = Encoder()
+encoder = Encoder(board)
 def increment():
     global value
     if value < 100:

examples/display-bar-vertical.py

@@ -3,6 +3,7 @@
 # GPL v3 License
 
 import pico_synth_sandbox.tasks
+from pico_synth_sandbox.board import get_board
 from pico_synth_sandbox.display import Display
 from pico_synth_sandbox.encoder import Encoder
 from pico_synth_sandbox.audio import get_audio_driver
@@ -11,12 +12,14 @@
 from pico_synth_sandbox.keyboard import get_keyboard_driver
 from pico_synth_sandbox.arpeggiator import Arpeggiator
 
-display = Display()
+board = get_board()
+
+display = Display(board)
 display.write("PicoSynthSandbox", (0,0))
 display.write("Loading...", (0,1))
 display.update()
 
-audio = get_audio_driver()
+audio = get_audio_driver(board)
 synth = Synth(audio)
 synth.add_voice(Kick())
 synth.add_voice(Snare())
@@ -26,7 +29,7 @@
 synth.add_voice(closed_hat)
 synth.add_voice(open_hat)
 
-keyboard = get_keyboard_driver()
+keyboard = get_keyboard_driver(board)
 arpeggiator = Arpeggiator()
 keyboard.set_arpeggiator(arpeggiator)
 
@@ -47,7 +50,7 @@ def release(notenum, keynum=None):
 keyboard.set_release(release)
 
 mod_value = 64
-encoder = Encoder()
+encoder = Encoder(board)
 def update_envelope():
     closed_hat.set_time(float(mod_value) / 127.0)
     open_hat.set_time(float(mod_value) / 127.0)