Commit Graph
19 Commits
Author SHA1 Message Date
gurix 000b204215 refactor: keep style-specific config off the base class via **kwargs
The base AlarmStyle contract carried music_file, forcing SimpleStyle to
accept a parameter it never uses. Move style-specific config to the
subclass: the base __init__ takes only set_led (**kwargs swallows the rest);
each style declares the keyword args it actually uses (BlinkStyle: music_file;
SimpleStyle: none). The runner passes config as keyword args and each style
keeps only what it needs, so the base contract never grows as styles are
added — a future 'talk' style adds talk_file to its own signature, not to the
base. README plugin contract updated.
2026-08-02 22:09:46 +02:00
gurix 3a7b6ac7a3 refactor: styles own their ringing tone directly (Pattern C)
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.
2026-08-02 21:50:00 +02:00
gurix 92eba762ce feat: styles own their ringing tone (simple beeps, blink plays music)
Move audio ownership out of the shared runner and into each style via an
injected Sound capability (play_music(path) / play_beep()). The runner now
only owns button sampling and cleanup; the style kicks off its own tone in
start() and drives the LED.

- simple: a repeating square-wave beep (ordinary alarm-clock tone), no music
  file required. The beep is synthesised in memory as signed-16-bit stereo
  PCM (stdlib array+math) and played via pygame.mixer.Sound — no shipped
  audio asset, no new dependency.
- blink: unchanged behaviour — music on an endless loop from --music-file /
  MUSIC_FILE / the default track, via pygame.mixer.music.
- AlarmStyle contract gains sound + music_file in __init__ and a start()
  lifecycle hook; AlarmSound Protocol documents the audio seam for future
  styles that handle their own tone.
- setup() no longer loads music (that is the style's job now).

README updated: per-style ringing tone, the --music-file note (blink only),
and the extended plugin contract.
2026-08-02 16:29:40 +02:00
gurix 670119f93e docs: document alarm styles and per-alarm style selection
Add an Alarm Styles section (simple vs blink), show --style in manual usage,
and update the GraphQL examples (setAlarm/getAlarms/startRinging) to include
the style field/argument. Note backward compat for legacy cron entries.
2026-07-31 16:20:50 +02:00
gurix a67f57c37e refactor: remove command field from GraphQL Alarm type
command is generated internally and has no informational value to API
consumers, so stop exposing it on getAlarms/getAlarm/setAlarm.
2026-06-22 10:04:48 +02:00
gurix b2bb5bdaf9 docs: document API security considerations and rate-limiting recommendation 2026-06-18 17:22:55 +02:00
gurix dfc9f0cd94 feat: make alarm music file configurable via env var and CLI arg 2026-06-18 17:01:26 +02:00
gurix 124a6a4916 fix: remove custom command from setAlarm to prevent command injection 2026-06-18 15:23:14 +02:00
Markus Graf 41d8ffc404 refactor: rename startWecker/stopWecker mutations to startRinging/stopRinging
'Wecker' is a Swiss-German term with no meaning in English.
Renaming to startRinging/stopRinging for better clarity.
2026-05-19 15:28:44 +02:00
Markus Graf df7bec1054 feat: add startWecker and stopWecker mutations to start/stop alarm via API
- Add startWecker mutation: starts wecker.py via subprocess if not already ringing
- Add stopWecker mutation: kills the running wecker process via SIGTERM if ringing
- Both mutations handle the 'already ringing' / 'not ringing' edge cases gracefully
- Update README with API documentation for the new mutations
- Add comprehensive tests (unit + GraphQL endpoint)
2026-05-19 15:22:48 +02:00
Markus Graf 558c4ff5b6 Add isRinging query to check alarm state via API
Features:
- New GraphQL query 'isRinging' returns true/false if wecker is active
- Checks the wecker process via PID file (PID_FILE in common.py)

DRY refactoring:
- Extract PID_FILE into shared common.py module
- Both wecker.py and api/schema.py import from common
- DRY enforcement tests verify identity (is) not just equality

Tests:
- test_is_ringing_returns_false_when_not_running
- test_is_ringing_returns_true_when_running
- test_pid_file_defined_once_across_modules (DRY enforcement)
- test_pid_file_same_shared_constant_in_api (DRY enforcement)
- Cleaned up unused imports in test_single_instance.py

Docs:
- Updated README.md with isRinging query documentation
2026-05-19 15:15:05 +02:00
Markus Graf 64947deeb1 fix: use append (>>) instead of overwrite (>) for cron logs and add missing dependencies
- Fixed api/schema.py to generate cron jobs using '>> wecker.log' so logs aren't truncated.
- Added test_bugfix_default_command_uses_append_for_logs in tests/test_api.py to prevent regression.
- Added RPi.GPIO and pygame to pyproject.toml via 'uv add' to fix ModuleNotFoundError in cron jobs.
- Updated README.md to reflect that system python packages are no longer needed.
2026-05-11 22:08:57 +02:00
Markus Graf ff79224560 feat: make command parameter optional in set_alarm mutation 2026-05-11 15:05:29 +02:00
Markus Graf 1a9bcd7158 docs: update README with systemd instructions and tailscale ip 2026-05-09 22:24:51 +02:00
Markus Graf 90001675ce docs: update README with graphql api documentation and uv setup 2026-05-09 22:18:43 +02:00
Markus Graf a00a79ff86 docs: move author section to bottom of README 2026-05-01 07:36:11 +02:00
Markus Graf 0c9108686b docs: document ALSA audio error fix for cron and update agent instructions 2026-05-01 07:33:25 +02:00
Markus Graf dd4b3367b0 docs: Add cronjob setup instructions to README 2026-04-30 13:41:40 +02:00
Markus Graf f44e0c5fdb Initial commit: Add smart arcade button alarm clock 2026-04-30 13:32:32 +02:00