Boards

circuitpython/README.md

@@ -2,7 +2,10 @@
 
 This directory contains a copy of all the CircuitPython images and libraries that
 this project is tested against and supports. Currently, the project is being built
-against CircuitPython 9.0.5.
+against:
+
+* CircuitPython 9.0.5 - confirmed
+* CircuitPython 9.1.2 - testing in progress
 
 The CircuitPython libraries that are required for the project have been extracted
 out into the `lib` directory for easy access.

halloween/2024/boards/single/code.py

@@ -0,0 +1,90 @@
+# Test code for the single microcontroller board. Tests:
+# * Button - triggers sound when pressed
+# * Ultrasonic sensor - triggers sound when detects
+# * Audio - plays lion.mp3
+
+import time
+
+from interactive.audio import AudioController
+from interactive.button import ButtonController
+from interactive.environment import are_pins_available
+from interactive.log import set_log_level, INFO, info
+from interactive.memory import report_memory_usage_and_free
+from interactive.polyfills.audio import new_mp3_player
+from interactive.polyfills.button import new_button
+from interactive.polyfills.ultrasonic import new_ultrasonic
+from interactive.runner import Runner
+from interactive.ultrasonic import UltrasonicController
+
+REPORT_RAM = are_pins_available()
+
+BUTTON_PIN = None
+
+AUDIO_PIN = None
+AUDIO_FILE = "lion.mp3"
+
+ULTRASONIC_TRIGGER_PIN = None
+ULTRASONIC_ECHO_PIN = None
+
+if are_pins_available():
+    # noinspection PyPackageRequirements
+    import board
+
+    BUTTON_PIN = board.GP26
+
+    ULTRASONIC_TRIGGER_PIN = board.GP16
+    ULTRASONIC_ECHO_PIN = board.GP17
+
+    AUDIO_PIN = board.GP22
+
+if __name__ == '__main__':
+
+    set_log_level(INFO)
+
+    if REPORT_RAM:
+        report_memory_usage_and_free("Before creating Objects")
+
+    runner = Runner()
+
+    ultrasonic = new_ultrasonic(ULTRASONIC_TRIGGER_PIN, ULTRASONIC_ECHO_PIN)
+
+
+    async def trigger_handler(distance: float, actual: float) -> None:
+        info(f"Distance {distance} handler triggered: {actual}")
+        audio_controller.queue(AUDIO_FILE)
+
+
+    controller = UltrasonicController(ultrasonic)
+    controller.add_trigger(100, trigger_handler, 5)
+    controller.register(runner)
+
+
+    async def single_click_handler() -> None:
+        info(f"Distance: {ultrasonic.distance}")
+        audio_controller.queue(AUDIO_FILE)
+
+
+    button = new_button(BUTTON_PIN)
+    button_controller = ButtonController(button)
+    button_controller.add_single_click_handler(single_click_handler)
+    button_controller.register(runner)
+
+    audio = new_mp3_player(AUDIO_PIN, AUDIO_FILE)
+    audio_controller = AudioController(audio)
+    audio_controller.register(runner)
+
+    # Allow the application to only run for a defined number of seconds.
+    finish = time.monotonic() + 1200
+
+
+    async def callback() -> None:
+        runner.cancel = time.monotonic() > finish
+
+
+    if REPORT_RAM:
+        report_memory_usage_and_free("Before running Runner")
+
+    runner.run(callback)
+
+    if REPORT_RAM:
+        report_memory_usage_and_free("After running Runner")

interactive/audio.py

@@ -9,6 +9,8 @@ class AudioController:
     played through the Audio instance. Basic controls to pause, resume and
     stop are provided along with a cancel option which stops the music and
     clears the queue.
+
+    Instances of this class will need to register() with a Runner in order to work.
     """
 
     def __init__(self, audio: Audio):

interactive/buzzer.py

@@ -6,6 +6,14 @@
 
 
 class BuzzerController:
+    """
+    BuzzerController provides a trivial method to play tones through a simple buzzer;
+    such as a little piezo buzzer. BuzzerController works well with simply melodies
+    that can be provided with the Melody and MelodySequence classes. For more complex
+    audio through mp3 files, use the AudioController class.
+
+    Instances of this class will need to register() with a Runner in order to work.
+    """
 
     def __init__(self, buzzer: Buzzer):
         if buzzer is None:
@@ -60,7 +68,7 @@ def __off(self) -> None:
 
     def register(self, runner: Runner) -> None:
         """
-        Registers this Buzzercontroller instance as a task with the provided Runner.
+        Registers this BuzzerController instance as a task with the provided Runner.
 
         :param runner: the runner to register with.
         """

interactive/configuration.py

@@ -6,8 +6,13 @@
 from interactive.log import set_log_level, INFO, log
 from interactive.memory import report_memory_usage
 
+FIELD_NAME = "name"
+FIELD_ROLE = "role"
+FIELD_COORDINATOR = "coordinator"
+
 NODE_NAME = "<hostname>"
 NODE_ROLE = "<host role>"
+NODE_COORDINATOR = None  # The I.P. Address of the coordinator node.
 
 REPORT_RAM = False
 REPORT_RAM_PERIOD = 5  # This is the period in seconds between each report.
@@ -57,7 +62,7 @@
 class Config:
     """
     Holds the configuration settings required for constructing an instance of
-    Interactive.
+    Interactive. It's here to avoid circular dependencies.
     """
 
     def __init__(self):
@@ -141,3 +146,15 @@ def get_node_config(network=False, button=True, buzzer=True, audio=True, ultraso
         config.trigger_duration = TRIGGER_DURATION
 
     return config
+
+
+def details() -> dict:
+    """
+    Returns details of the node. This will include its name, role and coordinator
+    values. These are essentially the items not returned in the configuration.
+    """
+    return {
+        FIELD_NAME: NODE_NAME,
+        FIELD_ROLE: NODE_ROLE,
+        FIELD_COORDINATOR: NODE_COORDINATOR
+    }

interactive/control.py

@@ -1,5 +1,6 @@
 # This file contains common control values that are "hard-coded" and not expected
-# to be changed by configuration.
+# to be changed by configuration. The frequency values here are the number of times
+# per second that is required.
 
 NS_PER_SECOND = 1_000_000_000
 
@@ -19,3 +20,9 @@
 BUTTON_SHORT_DURATION_MS = 200
 # The timeframe to consider a button being pressed should register as a long press.
 BUTTON_LONG_DURATION_MS = 2000
+
+# * * * * *    N E T W O R K    * * * * *
+NETWORK_PORT_MICROCONTROLLER = 80
+NETWORK_PORT_DESKTOP = 5001
+NETWORK_HOST_DESKTOP = "127.0.0.1"
+NETWORK_HEARTBEAT_FREQUENCY = 1 / 60  # every 60 seconds.