Skip to content

6.3 HTTP and web UI

Jump to bottom
Roland Jax edited this page Oct 10, 2026 · 2 revisions

6.3 HTTP & web UI

Human channel: verify setup, inspect the bus, and manage commands. This page describes views and workflows — the curl-level endpoint reference ships with code (doc/commands.md in the repository).

Views

  • Values — decoded values with ages. Read forces a physical re-poll of one command; writable commands (non-empty write_cmd, 6.2) offer Write. Ages must stay within one poll cycle.
  • Logs — recent telegrams as master / slave hex lines plus decode notes. Tail buffer, not an archive: high line rates overwrite old entries.
  • Metrics — bus/library counters (messages, errors, arbitration, queue drops) plus heap and task tables. First stop when something behaves oddly (see 6.6).
  • Devices — seen bus participants with frequencies; bus scan buttons for discovery.
  • Commands — inspect the installed command set (6.2). Polling itself is scheduled inside the library by each command's interval.
  • Cron — time-of-day write rules (see below).

Cron rules

Cron fires writes on wall-clock schedules — the complement to interval polling (which only reads). Each rule names a command that must have a write_cmd; the value is encoded and validated exactly like an HTTP/MQTT write (garbage is rejected, never sent).

[
  {
    "id": "night-dhw",
    "schedule": "0 23 * * *",
    "command_key": "06",
    "enabled": true,
    "value": 48
  }
]
  • schedule: standard 5-field cron (minute hour day month weekday, ranges and steps supported). Evaluated in local time — SNTP + timezone must be correct (overview: Time section), else rules fire at the wrong hour silently.
  • command_key must exist and carry write_cmd; otherwise the rule errors at fire time.
  • enabled: false parks a rule without deleting it.
  • At most once per minute per rule; max 32 rules. Persisted in LittleFS alongside commands.
  • Config — internal settings: Bus section (6.1), MQTT (6.4), Home Assistant (6.5), SNTP (overview: Time section). Shared settings (WiFi, General, Connection, HTTP headers) behave identically on both firmwares: see Configuration. Saving stages values; Restart to Apply Changes activates them. Passwords are never served back — empty means keep.
  • Upgrade — firmware upload and status.

Workflows

  • Verify a new command: install it, watch Logs for the raw telegram, then Values for the decoded result and its age.
  • Write a value: Values view or HTTP write; needs write_cmd.
  • Diagnose: Metrics counters first (6.6), Logs second.
  • Update firmware: see 4. Upgrading — OTA and HTTP upload work identically on both firmware variants.

Clone this wiki locally