src.nth.io/

summaryrefslogtreecommitdiff
path: root/main/state_machine.h
diff options
context:
space:
mode:
Diffstat (limited to 'main/state_machine.h')
-rw-r--r--main/state_machine.h5
1 files changed, 2 insertions, 3 deletions
diff --git a/main/state_machine.h b/main/state_machine.h
index 8caf670..22aebad 100644
--- a/main/state_machine.h
+++ b/main/state_machine.h
@@ -6,7 +6,6 @@
esp_err_t state_machine_init(void);
// Transition to AWAKE or ASLEEP. Idempotent: no-op if already there.
-// Returns ESP_ERR_INVALID_STATE if the device is unconfigured.
// Side-effects (under one critical section):
// AWAKE -> backlight on, idle timer (re)armed
// ASLEEP -> backlight off, idle timer cancelled, framebuffer discarded
@@ -14,8 +13,8 @@ esp_err_t state_machine_set(viewport_run_state_t target);
// Device-initiated variant (tap, idle timer expiry). Drives the same
// transition as state_machine_set() and additionally enqueues a
-// {viewport,state} POST to <scrypted>/state via state_client.
-// Silently no-ops if the device is unconfigured.
+// {viewport,state} POST to <scrypted>/state via state_client when a
+// `scrypted` URL is configured.
void state_machine_set_local(viewport_run_state_t target);
// Called by /frame after a successful paint. Restarts the idle timer