mirror of
https://github.com/kuhyx/wake-alarm.git
synced 2026-11-10 18:07:05 +01:00
Krzysztof kuhy Rudnicki
e67cef0c54
The PC no longer wakes anyone -- the phone does. This deletes the alarm window, the audio escalation, the sink/reactivation machinery, the power-key inhibitor, the escape hatch, the curtains, the smart plug, the brightness and DDC/CI control, the hibernate path (shutdown wrapper + rtcwake + sleep hook) and the challenge set: 30 modules, 34 test files, ~5k lines. What stays is the part that still earns its keep: the per-minute trigger reads the alarm the phone published and starts morning-routine.service, so the workout lock still runs at the right time. THE ONE LOAD-BEARING BEHAVIOUR CHANGE. Deleting _alarm.py orphaned the only writer of wake_state.json, and _trigger gated on it via was_alarm_dismissed_today(). With that gone -- and was_workout_logged_today() already permanently False, since WORKOUT_LOG_FILE does not exist -- both gates would have been dead and the routine restarted on every tick for the rest of the 60-minute catch-up window. The unit is Type=simple, so a start while it runs is a no-op, but the moment the workout lock finished the next tick would relaunch it on top of the user. So _trigger now writes its own once-per-day latch (save_trigger_fired / was_trigger_fired_today) and gates on that. Collapsing the catch-up window instead was rejected: that window is the entire reason a suspended or just-booted machine still fires. It also replaces the deleted sleep hook, via Persistent=true. _trigger also imported should_refire from _alarm_session, which was on the delete list. Since start_session lived only in _alarm.py, no session record is ever written again and the branch was unreachable, not merely unused. WAKE_STATE_FILE is now redirected in tests/conftest.py rather than per-file. The trigger tests never redirected it, because until this commit nothing on that path wrote anything -- and a per-file redirect is exactly the kind that gets forgotten when a new writer appears, with a silent failure: a green suite that quietly stamped the live state file. Verified by mtime that it did not. Cross-repo, same change: morning_routine._orchestrator loses its alarm leg and its --with-alarm flag. Leaving an orchestrator pointing at a deleted module caused a month-long silent failure once already. uninstall.sh is new, and matters more than it looks. /usr/local/bin/shutdown is root-owned and shadows /usr/bin/shutdown; deleting this repo would leave it in place, and with the alarm cache gone it falls through to rtcwake + hibernate -- so "shutdown now" would silently stop being a poweroff, every day, forever. /etc/sudoers.d/wake-alarm is deliberately NOT removed: screen-locker's own _wake_alarm.py still needs passwordless rtcwake. 159 tests pass at 100% branch coverage; all 26 pre-commit hooks green. Verified by running it: _sync --show and _trigger --dry-run both resolve. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PcdngP688mW6rJye3LRkSN
79 lines
3.0 KiB
Markdown
79 lines
3.0 KiB
Markdown
# wake_alarm
|
|
|
|
**The phone is the alarm.** `phone_app/` arms and rings it, and getting past it
|
|
means walking between two NFC tags and answering three questions. This repo's
|
|
Python half no longer wakes anyone: all it does is read the alarm time the
|
|
phone published and start the morning routine (the workout lock) at that time.
|
|
|
|
## The dismiss sequence
|
|
|
|
Strict, ordered, and latched — every stage required, and a stage once passed
|
|
never reverts:
|
|
|
|
```
|
|
tag 1 -> 25 steps + 2 min -> tag 2 -> 3 challenges
|
|
```
|
|
|
|
The two tags must be *distinct* and live in different rooms; the same id in
|
|
both slots is refused at registration. Answers are cumulative, so a wrong one
|
|
costs the attempt and nothing else.
|
|
|
|
**One fallback, deliberately narrow.** After 5 minutes of ringing — or
|
|
immediately if NFC is off or fewer than two tags are registered — the two *tag*
|
|
stages are skipped and the challenge count rises to 6. The walk is never
|
|
skipped. Without a hatch of some kind, a dead tag at 06:00 leaves an alarm that
|
|
cannot be switched off at all.
|
|
|
|
Details, and the things that are a hard crash or a silent no-ring:
|
|
**`DOCS-phone-alarm.md`**.
|
|
|
|
## The PC half
|
|
|
|
A per-minute systemd user timer (`wake-alarm-trigger.timer`) reads the alarm
|
|
the phone published through the shared `crdt_sync` transport, and at that time
|
|
starts `morning-routine.service`, which runs the workout lock. It records a
|
|
once-per-day latch so the rest of the catch-up window does not restart it.
|
|
|
|
That is all it does. There is no alarm window, no audio, no smart plug, no
|
|
`rtcwake`, and no `shutdown` wrapper.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
bash install.sh # trigger timer
|
|
bash uninstall.sh # removes it, and any retired waking machinery
|
|
```
|
|
|
|
`install.sh` installs the package into system Python's user site-packages (the
|
|
units run `/usr/bin/python` directly, not a venv — see `CLAUDE.md`) and enables
|
|
the timer. It also clears the retired pieces an older install left behind,
|
|
notably `/usr/local/bin/shutdown`, which is root-owned and would otherwise keep
|
|
turning `shutdown now` into a hibernate forever.
|
|
|
|
Reading the phone's alarm uses the shared `~/.config/crdt-sync/firebase.json`.
|
|
The GitHub mirror (fallback only) needs a `repo`-scoped token at
|
|
`~/.config/wake_alarm/sync.json` as `{"token": "..."}`.
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
python -m wake_alarm._sync --show # what alarm time the PC resolves
|
|
python -m wake_alarm._trigger --dry-run # what the next tick would do
|
|
journalctl --user -fu wake-alarm-trigger.service # watch it live
|
|
```
|
|
|
|
## Development
|
|
|
|
```bash
|
|
python -m venv .venv && .venv/bin/pip install -r requirements.txt
|
|
.venv/bin/pre-commit install && .venv/bin/pre-commit install --hook-type pre-push
|
|
.venv/bin/python -m pytest wake_alarm/tests/ --cov=wake_alarm --cov-branch --cov-fail-under=100
|
|
cd phone_app && flutter test && flutter analyze
|
|
```
|
|
|
|
The dev venv lacks `gatelock`, so anything importing `_state` (including
|
|
`_trigger`) needs `/usr/bin/python3`, not `.venv/bin/python`.
|
|
|
|
See `CLAUDE.md` for the sync resolution chain, the cross-repo coupling to
|
|
`morning_routine`, and production deployment gotchas.
|