squishbox 1.0.0__tar.gz

squishbox-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Bill Peterson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

squishbox-1.0.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: squishbox
+Version: 1.0.0
+Summary: LCD + button hardware interface
+Author-email: Bill Peterson <bill@geekfunklabs.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/GeekFunkLabs/squishbox
+Project-URL: Issues, https://github.com/GeekFunkLabs/squishbox/issues
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: gpiod
+Requires-Dist: pyyaml
+Requires-Dist: alsa-midi
+Requires-Dist: evdev
+Provides-Extra: full
+Requires-Dist: fluidpatcher; extra == "full"
+Requires-Dist: gi; extra == "full"
+Dynamic: license-file
+
+# SquishBox
+
+- [Official Documentation](https://geekfunklabs.github.io/squishbox)
+- [Source Repository](https://github.com/GeekFunkLabs/squishbox)
+
+The SquishBox is a compact add-on board and enclosure for Raspberry Pi
+(primarily Pi 3B+ and Pi 4) that combines:
+
+- high-quality stereo DAC with 1/4" outputs
+- MIDI in/out via TRS minijacks
+- 16x2 character LCD
+- pushbutton rotary encoder
+- breakout GPIO for extra controls, LEDs, and peripherals
+
+This creates a portable embedded platform for audio projects such as synths,
+sound modules, pedalboard utilities, sequencers, and music players.
+
+The software package includes ready-to-run applications plus a simple Python API
+for building your own.
+
+## Building/Obtaining
+
+This repository includes schematics, PCB fabrication files, BOMs, and enclosure
+models for users who want to build their own hardware.
+
+Kits and pre-built units are also available from the Geek Funk Labs
+[store](https://geekfunklabs.com/store).
+
+## Installing
+
+The SquishBox software targets Raspberry Pi OS 13 (Trixie) on Pi 3B+/4.
+Other platforms may work but are not officially tested.
+
+To install on a fresh or existing system, log in as a regular user and run:
+
+```bash
+curl -sL geekfunklabs.com/squishbox | bash
+```
+
+Answer the prompts, wait for install to complete,
+and reboot the Pi to activate the LCD/button interface.
+
+## Using the SquishBox
+
+On first boot, the SquishBox starts a launcher that lets the user choose
+an app to run or modify system settings.
+Selections can be made by turning the rotary encoder.
+Tapping the rotary encoder confirms a choice.
+Pressing and holding the encoder will cancel or return to the previous
+screen in most situations.
+To safely shut down the SquishBox before disconnecting power,
+use the "Shutdown" option in the "Exit" menu.
+
+## Writing SquishBox Apps
+
+The squishbox python package provides access to the LCD,
+controls (buttons/encoders), outputs,
+and a set of menu-driven interaction helpers.
+Here is a simple example app:
+
+```python
+import squishbox
+
+sb = squishbox.SquishBox()
+
+sb.lcd.clear()
+sb.lcd.write("Audio Test", row=0)
+
+while True:
+    i, option = sb.menu_choose(["Noise", "Sine", "Exit"], row=1)
+
+    if option == "Noise":
+        sb.shell_cmd("speaker-test -l2 -c2")
+
+    elif option == "Sine":
+        sb.shell_cmd("speaker-test -l2 -c2 -tsine")
+
+    elif option == "Exit":
+        break
+```
+
+## Support and Feature Requests
+
+The SquishBox is under active development, and feature requests are
+welcome. 
+
+Please post requests/questions to Discussions on GitHub,
+and open issues or pull requests for bugs.
+

squishbox-1.0.0/README.md

@@ -0,0 +1,89 @@
+# SquishBox
+
+- [Official Documentation](https://geekfunklabs.github.io/squishbox)
+- [Source Repository](https://github.com/GeekFunkLabs/squishbox)
+
+The SquishBox is a compact add-on board and enclosure for Raspberry Pi
+(primarily Pi 3B+ and Pi 4) that combines:
+
+- high-quality stereo DAC with 1/4" outputs
+- MIDI in/out via TRS minijacks
+- 16x2 character LCD
+- pushbutton rotary encoder
+- breakout GPIO for extra controls, LEDs, and peripherals
+
+This creates a portable embedded platform for audio projects such as synths,
+sound modules, pedalboard utilities, sequencers, and music players.
+
+The software package includes ready-to-run applications plus a simple Python API
+for building your own.
+
+## Building/Obtaining
+
+This repository includes schematics, PCB fabrication files, BOMs, and enclosure
+models for users who want to build their own hardware.
+
+Kits and pre-built units are also available from the Geek Funk Labs
+[store](https://geekfunklabs.com/store).
+
+## Installing
+
+The SquishBox software targets Raspberry Pi OS 13 (Trixie) on Pi 3B+/4.
+Other platforms may work but are not officially tested.
+
+To install on a fresh or existing system, log in as a regular user and run:
+
+```bash
+curl -sL geekfunklabs.com/squishbox | bash
+```
+
+Answer the prompts, wait for install to complete,
+and reboot the Pi to activate the LCD/button interface.
+
+## Using the SquishBox
+
+On first boot, the SquishBox starts a launcher that lets the user choose
+an app to run or modify system settings.
+Selections can be made by turning the rotary encoder.
+Tapping the rotary encoder confirms a choice.
+Pressing and holding the encoder will cancel or return to the previous
+screen in most situations.
+To safely shut down the SquishBox before disconnecting power,
+use the "Shutdown" option in the "Exit" menu.
+
+## Writing SquishBox Apps
+
+The squishbox python package provides access to the LCD,
+controls (buttons/encoders), outputs,
+and a set of menu-driven interaction helpers.
+Here is a simple example app:
+
+```python
+import squishbox
+
+sb = squishbox.SquishBox()
+
+sb.lcd.clear()
+sb.lcd.write("Audio Test", row=0)
+
+while True:
+    i, option = sb.menu_choose(["Noise", "Sine", "Exit"], row=1)
+
+    if option == "Noise":
+        sb.shell_cmd("speaker-test -l2 -c2")
+
+    elif option == "Sine":
+        sb.shell_cmd("speaker-test -l2 -c2 -tsine")
+
+    elif option == "Exit":
+        break
+```
+
+## Support and Feature Requests
+
+The SquishBox is under active development, and feature requests are
+welcome. 
+
+Please post requests/questions to Discussions on GitHub,
+and open issues or pull requests for bugs.
+

squishbox-1.0.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "squishbox"
+version = "1.0.0"
+description = "LCD + button hardware interface"
+readme = "README.md"
+license = "MIT"
+license-files = [
+    "LICENSE",
+]
+authors = [
+    { name = "Bill Peterson", email = "bill@geekfunklabs.com" }
+]
+requires-python = ">=3.10"
+dependencies = [
+    "gpiod", "pyyaml", "alsa-midi", "evdev"
+]
+
+[project.optional-dependencies]
+full = ["fluidpatcher", "gi"]
+
+[project.urls]
+Homepage = "https://github.com/GeekFunkLabs/squishbox"
+Issues = "https://github.com/GeekFunkLabs/squishbox/issues"
+
+[tool.setuptools.package-data]
+"squishbox.data" = ["**/*.yaml"]
+

squishbox-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

squishbox-1.0.0/src/squishbox/__init__.py

@@ -0,0 +1,25 @@
+"""SquishBox Raspberry Pi interface
+
+This module provides classes and functions for creating python applications
+for the `SquishBox <https://www.geekfunklabs.com/products/squishbox>`_ ,
+a Raspberry Pi add-on that provides an LCD, pushbutton rotary encoder,
+sound card, and MIDI input/output.
+
+Requires:
+- gpiod
+- yaml
+"""
+
+from importlib.metadata import version, PackageNotFoundError
+
+from .config import CONFIG
+from .squishbox import SquishBox
+
+
+__all__ = ["SquishBox", "CONFIG"]
+
+try:
+    __version__ = version("squishbox")
+except PackageNotFoundError:
+    __version__ = "0.0.0-dev"
+