gurix
3a7b6ac7a3
Drop the injected AlarmSound Protocol and the wecker.Sound class. Each style now owns its tone by using pygame directly; the runner owns only the audio engine lifecycle (mixer init/quit), button sampling, and cleanup. This is the seam for future styles that handle their own tone — a 'talk' style would just import pygame and play speech, with no shared interface to extend. - styles/base.py: AlarmStyle.__init__(set_led, music_file) + start() + update() - styles/blink.py: start() loads+plays music via pygame.mixer.music - styles/simple.py: owns its beep — synthesises a square-wave buffer in module (stdlib array+math) and plays it via pygame.mixer.Sound - wecker.py: setup() brings up the mixer only; run_alarm constructs the style and guards start() with a clean log+exit on failure Tests: a shared tests/conftest.py stubs RPi.GPIO/pygame in sys.modules before any SUT import (order-independent, removes duplicated inline mocking); the wecker mock_pygame fixture patches one fresh pygame mock into wecker + both style modules so assertions see the same calls. README: tone-ownership and plugin-contract updated.
40 lines
1.4 KiB
Python
40 lines
1.4 KiB
Python
from abc import ABC, abstractmethod
|
|
from typing import Callable
|
|
|
|
|
|
class AlarmStyle(ABC):
|
|
"""A pluggable alarm behaviour.
|
|
|
|
A style owns *its own ringing tone*: it uses the audio engine (pygame)
|
|
directly and decides when the alarm stops and what the LED does. It never
|
|
touches hardware directly: ``set_led`` is injected by the runner, and the
|
|
runner owns the audio engine lifecycle (mixer init/quit). Styles stay
|
|
import-safe in the API process — ``import pygame`` does not initialise
|
|
audio, so the API can import styles just to validate names.
|
|
|
|
Lifecycle: construct once with ``set_led``/``music_file``; call ``start()``
|
|
to begin ringing (kick off the tone and initial LED); then call ``update``
|
|
every tick. Return ``False`` from ``update`` to stop the alarm.
|
|
"""
|
|
|
|
def __init__(
|
|
self, set_led: Callable[[bool], None], music_file: str | None = None
|
|
):
|
|
self.set_led = set_led
|
|
self.music_file = music_file
|
|
|
|
def start(self) -> None:
|
|
"""Begin ringing. Override to start the style's tone / initial LED."""
|
|
|
|
@abstractmethod
|
|
def update(self, now: float, is_pressed: bool) -> bool:
|
|
"""Advance the style by one tick.
|
|
|
|
Args:
|
|
now: current time (``time.time()`` from the runner).
|
|
is_pressed: whether the button is currently held down.
|
|
|
|
Returns:
|
|
True to keep ringing, False to stop.
|
|
"""
|