locks.md: document durable sync architecture + nightly backup

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Claude
2026-07-05 19:41:42 +00:00
parent 0333046891
commit 6226a56591
2 changed files with 32 additions and 15 deletions
+31 -14
View File
@@ -10,23 +10,40 @@ Slot 1 = Fritz family, 2 = cleaner, 4 = carpenter, 5 = backup.
</overview>
<sync>
`script.lock_sync_all_codes` (mode: queued) walks slots 18; for each slot it
calls `zwave_js.set_lock_usercode` on BOTH locks — the slot's code if its
`_enabled` boolean is on, otherwise the slot-1 family code (hardcoded in the
script's default branches). `automation.lock_slot_N_sync_both_locks` (per slot)
also pushes on helper change. An error on any step ABORTS the script — later
slots and the second lock do not sync.
All code writes go through `script.lock_sync_slot` (fields: `slot` 18), the
single source of truth. Per slot it: resolves the code (slot's own code if
`_enabled` on, else the slot-1 family code), REFUSES non-4-10-digit codes
(persistent notification "slot N SKIPPED", nothing written), then per lock does
a UserCode CC `get` (repopulates the Z-Wave value cache so a missing cached
slot can't error) followed by `zwave_js.set_lock_usercode` — every zwave call
`continue_on_error` so one lock/slot never blocks the rest.
The `input_boolean.lock_code_slot_N_*` / `input_text.lock_code_slot_N_*` /
`input_boolean.lock_slotN_lodge/bunkhouse_enabled` entities are unavailable
leftovers from earlier schemes — ignore.
- `script.lock_sync_all_codes` — warns (persistent + `notify.mobile_app_donavan_s_iphone_16_pro`)
if a lock's `*_node_status` sensor isn't alive/asleep, then runs
`lock_sync_slot` for slots 18.
- `automation.lock_slot_N_sync_both_locks` (×8) — trigger on the slot's
`_enabled` OR `_code` helper change → `lock_sync_slot` for that slot.
- `automation.lock_codes_full_sync_self_heal` — full sync daily 04:00 and
10 min after HA start, so transient failures heal within a day.
Disabled slots are overwritten with the family code (design choice), so the
family code exists in multiple lock slots.
</sync>
<troubleshooting>
Error `userCode for code slot N not found` from `zwave_js.set_lock_usercode`
= Z-Wave JS value cache has no userCode value for that slot (never
queried/interviewed), NOT a lock or code problem. Fix by forcing a UserCode CC
read to repopulate the cache, then re-run the sync script:
`zwave_js.invoke_cc_api {device_id, command_class: "99", method_name: "get", parameters: [N]}`.
(2026-07-05: lodge slot 3 hit this; gets were run for slots 18 on both locks.)
= Z-Wave JS value cache has no userCode value for that slot, NOT a lock or code
problem. The sync script's pre-`get` prevents it; manual fix:
`zwave_js.invoke_cc_api {device_id, command_class: "99", method_name: "get", parameters: [N]}`
then re-run the sync.
</troubleshooting>
<backup>
Scripts/automations/dashboards/helper-definitions are mirrored to
`dfritz/home-assistant` repo under `lodge/` (API export — the lodge HA has no
SSH). Nightly Gitea Actions workflow `.gitea/workflows/backup-ha.yaml` IN THIS
SKILL REPO (secrets `HA_TOKEN` + `GIT_TOKEN` on skills/thelonglakelodge; ops
lacks rights to put secrets on dfritz/home-assistant) exports and pushes only
on change; failure emails via action/notify-email. Manual run: the workflow's
`workflow_dispatch`, or `HA_TOKEN=... lodge/backup.sh` in the mirror repo.
</backup>