Skip to content

Commit 48c4321

Browse files
author
lee
committed
Runbook: document PICLOCK_SYNC_DOT and list all three installer flags in §2
1 parent d8d9309 commit 48c4321

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

‎SOFTWARE_RUNBOOK.md‎

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,19 @@ Get a checkout of this repo onto the Pi
8888
sudo scripts/install.sh
8989
```
9090

91+
The installer takes three optional feature flags, combinable as needed (e.g.
92+
`sudo scripts/install.sh --homekit --schedule`):
93+
94+
- `--homekit` — installs the HomeKit deps into the venv and enables the Lightbulb
95+
accessory, so the display can be controlled from the Home app / Siri (§4).
96+
- `--schedule` — enables the in-app day/night schedule (blank the display by day,
97+
wake it in the evening, dim it at night; times and levels tunable — §5).
98+
- `--reboot` — enables a monthly midday reboot that returns the appliance to a
99+
known-good state (§6).
100+
101+
Each flag fully toggles its feature: re-running the installer without a flag disables
102+
that feature, so pass every flag you want active on each run.
103+
91104
Creates `clocker` (system user, `i2c` group, no sudo), creates the `clockctl` group (gates
92105
the `piclockctl` control socket — see §3), deploys to `/opt/piclock`, builds the venv,
93106
installs + enables `piclock.service`, installs `piclockctl` to `/usr/local/bin`, and
@@ -134,7 +147,8 @@ The commands travel over a Unix socket (`/run/piclock/ctl.sock`, mode 0660) gate
134147
`sudo usermod -aG clockctl <user>` (log out/in to pick it up).
135148

136149
Config via `PICLOCK_*` env (in the unit): `PICLOCK_24H=1`, `PICLOCK_BRIGHTNESS=0..15`,
137-
`PICLOCK_BLINK=0/1`, `PICLOCK_DISPLAY=null` (run without hardware), and
150+
`PICLOCK_BLINK=0/1`, `PICLOCK_SYNC_DOT=0/1` (lower-left dot lit while NTP-synced, dark when
151+
free-running; on by default), `PICLOCK_DISPLAY=null` (run without hardware), and
138152
`PICLOCK_WAKE_BRIGHTNESS` / `PICLOCK_NIGHT_BRIGHTNESS` (0-15 levels the optional day/night
139153
schedule applies at its wake and dim edges — see §5; the schedule's on/off switch and times
140154
live in its drop-in, also §5). The unit sets

0 commit comments

Comments
 (0)