feat: ping drivers and push groups from the devices modal

POST /devices/ping broadcasts an ESP-NOW PING_REQ, collects the drivers'
PING_RSP for timeout_s and registers or renames the ones that answer. A
reply also counts as the driver being heard, so group updates go to it
again. POST /devices/groups sends every ESP-NOW driver its groups and
reports the acks. The devices modal gets the Ping drivers and Update
groups buttons from main, with per-driver ping dots.

UI files are now served with Cache-Control: no-cache and the firmware
build hash as ETag, so a browser picks up a new UI right after an update
instead of a day later.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
jimmyandClaude Opus 5.5 committed 2026-11-03 17:53:56 +13:00
1 parent e7f238aebc
commit 19fea0b0a1
10 files changed
+559 -29

No files matched your search

+67 -10
View File
@@ -814,31 +814,40 @@ static esp_err_t send_cmd(const uint8_t mac[6], const uint8_t *env, size_t len,
// GROUPS packet: the ids of every zone whose driver names include `name`. An empty list replaces
// whatever the driver stored, so it is only sent when allow_empty is set (a zone or device was edited);
// a driver that merely announced itself and is in no zone keeps the groups it already has.
static void send_groups(const uint8_t mac[6], const char *name, bool allow_empty)
// GROUPS packet for a driver: [4C][02][count] then per zone [len][zone id]. Returns its length;
// *count gets the number of zones.
static size_t build_groups(uint8_t pkt[REL_FRAG_MAX], const char *name, int *count)
{
uint8_t pkt[REL_FRAG_MAX];
size_t off = 3;
int count = 0;
*count = 0;
const cJSON *z;
cJSON_ArrayForEach(z, store_coll("zone"))
{
const cJSON *names = cJSON_GetObjectItem(z, "names");
size_t gl = strlen(z->string);
if (cJSON_IsArray(names) && name_seen(names, cJSON_GetArraySize(names), name) && off + 1 + gl <= sizeof(pkt) &&
if (cJSON_IsArray(names) && name_seen(names, cJSON_GetArraySize(names), name) && off + 1 + gl <= REL_FRAG_MAX &&
gl < 16) {
pkt[off++] = gl;
memcpy(pkt + off, z->string, gl);
off += gl;
count++;
(*count)++;
}
}
if (count == 0 && !allow_empty) {
return;
}
pkt[0] = 0x4C;
pkt[1] = 0x02; // GROUPS
pkt[2] = count;
rel_send(mac, pkt, off, false, 1);
pkt[2] = *count;
return off;
}
static void send_groups(const uint8_t mac[6], const char *name, bool allow_empty)
{
uint8_t pkt[REL_FRAG_MAX];
int count;
size_t len = build_groups(pkt, name, &count);
if (count == 0 && !allow_empty) {
return;
}
rel_send(mac, pkt, len, false, 1);
}
static bool hex_mac(const char *s, uint8_t mac[6])
@@ -902,6 +911,54 @@ void engine_groups_changed(void)
store_unlock();
}
#define PUSH_MAX 32
void engine_groups_push_all(int *total, int *sent, int *failed)
{
struct {
uint8_t mac[6];
uint16_t seq;
bool queued;
} out[PUSH_MAX];
int n = 0;
store_lock();
const cJSON *d;
cJSON_ArrayForEach(d, store_coll("device"))
{
const cJSON *name = cJSON_GetObjectItem(d, "name"), *addr = cJSON_GetObjectItem(d, "address");
const cJSON *tr = cJSON_GetObjectItem(d, "transport");
const char *hex = cJSON_IsString(addr) ? addr->valuestring : d->string;
if (n < PUSH_MAX && cJSON_IsString(name) && cJSON_IsString(tr) && !strcmp(tr->valuestring, "espnow") &&
hex_mac(hex, out[n].mac)) {
uint8_t pkt[REL_FRAG_MAX];
int count;
size_t len = build_groups(pkt, name->valuestring, &count);
out[n].queued = false;
for (int i = 0; i < 400 && !out[n].queued; i++) { // wait for room, as tx() does
esp_err_t err = rel_send_seq(out[n].mac, pkt, len, false, 1, &out[n].seq);
out[n].queued = err == ESP_OK;
if (err != ESP_ERR_NO_MEM) {
break;
}
vTaskDelay(pdMS_TO_TICKS(5));
}
n++;
}
}
store_unlock();
// All are in flight at once; then collect each outcome (rel gives up after about 2 s)
*total = n;
*sent = *failed = 0;
for (int i = 0; i < n; i++) {
bool ok = out[i].queued && rel_wait(out[i].mac, out[i].seq, 3000) == ESP_OK;
if (ok) {
(*sent)++;
} else {
(*failed)++;
}
}
}
// A driver said hello at boot: register it, then tell it which zones it belongs to
static void on_announce(const uint8_t mac[6], const uint8_t *pkt, int len)
{
+3
View File
@@ -32,3 +32,6 @@ cJSON *engine_seq_status(void);
// Zones or devices changed: re-send group membership to every registered ESP-NOW driver
void engine_groups_changed(void);
// POST /devices/groups: send every ESP-NOW driver its groups, including silent ones, and wait for the
// acks. Call without the store lock held.
void engine_groups_push_all(int *total, int *sent, int *failed);
+24 -1
View File
@@ -23,6 +23,7 @@
#define M_RESYNC 0x23
#define M_ECHO 0x24
#define M_OTA_STATUS 0x26
#define M_PING_RSP 0x06
#define F_ACK 1
#define F_COMMIT 2
#define HDR 9
@@ -279,6 +280,13 @@ void rel_set_ota_status_cb(rel_ota_status_cb_t cb)
s_ota_status_cb = cb;
}
static rel_ping_cb_t s_ping_cb;
void rel_set_ping_cb(rel_ping_cb_t cb)
{
s_ping_cb = cb;
}
void rel_set_announce_cb(rel_announce_cb_t cb)
{
s_announce_cb = cb;
@@ -294,7 +302,8 @@ static void recv_cb(const esp_now_recv_info_t *info, const uint8_t *data, int le
// care about is a link reply inside 0x4C
bool announce = (data[0] == WIRE_MAGIC && data[1] == M_ANNOUNCE) || data[0] == '{';
bool reply = data[0] == WIRE_MAGIC &&
(data[1] == M_ACK || data[1] == M_RESYNC || data[1] == M_ECHO || data[1] == M_OTA_STATUS);
(data[1] == M_ACK || data[1] == M_RESYNC || data[1] == M_ECHO || data[1] == M_OTA_STATUS ||
data[1] == M_PING_RSP);
if (!announce && !reply) {
return;
}
@@ -332,6 +341,20 @@ static void handle_rx(const rx_t *rx)
}
return;
}
if (rx->data[1] == M_PING_RSP) {
// The driver is there: count it as heard, so group updates go to it again
xSemaphoreTake(s_lock, portMAX_DELAY);
peer_t *pe = peer_get(rx->mac, true);
if (pe) {
pe->last_ack_us = esp_timer_get_time();
pe->fails = 0;
}
xSemaphoreGive(s_lock);
if (s_ping_cb) {
s_ping_cb(rx->mac, rx->data, rx->len);
}
return;
}
if (rx->len < 10) { // [4C][21][0][seq u16][cnt][mask u32]
return;
}
+6
View File
@@ -14,6 +14,7 @@
// resync [4C][23][ver u16] (driver -> us)
// echo [4C][24][beat_idx u16] (driver -> us, bench)
// ota [4C][26][sess u16][op][code] + arg (driver -> us, see drv_ota.h)
// ping [4C][06][ping_id u32][len][name] (driver -> us, reply to [4C][05][ping_id])
#define REL_FRAG_MAX 238 // inner packet bytes per frame; 4C 03/04 wrappers plus an envelope fit in one
#define REL_MAX_FRAGS 32
@@ -58,6 +59,11 @@ void rel_set_announce_cb(rel_announce_cb_t cb);
// A driver's OTA status reply (0x26), called from the rel task
typedef void (*rel_ota_status_cb_t)(const uint8_t mac[6], const uint8_t *pkt, int len);
void rel_set_ota_status_cb(rel_ota_status_cb_t cb);
// A driver's PING_RSP ([4C][06][ping_id u32][name len][name]), called from the rel task. Drivers
// answer a broadcast PING_REQ ([4C][05][ping_id u32]) after a random 50-500 ms.
typedef void (*rel_ping_cb_t)(const uint8_t mac[6], const uint8_t *pkt, int len);
void rel_set_ping_cb(rel_ping_cb_t cb);
void rel_stats(rel_stats_t *out);
// Milliseconds since the driver last acked; -1 if never. fails = consecutive unacked messages
+180
View File
@@ -9,6 +9,9 @@
#include "engine.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "esp_random.h"
#include "esp_timer.h"
#include "espnow_tx.h"
#include "rel.h"
#include "store.h"
@@ -289,6 +292,175 @@ static esp_err_t identify(httpd_req_t *req, const cJSON *dev, const char *mac)
return api_message(req, "200 OK", "Identify sent");
}
/* ------------------------------------------------------------------- ping */
#define PING_MAX 32
typedef struct {
uint8_t mac[6];
char name[33];
int rtt_ms;
} ping_rsp_t;
static struct {
uint32_t id; // 0 = no ping running
int64_t sent_us;
int count;
ping_rsp_t rsp[PING_MAX];
} s_ping;
static portMUX_TYPE s_ping_mux = portMUX_INITIALIZER_UNLOCKED;
// Rel task: [4C][06][ping_id u32 LE][len][name]
static void on_ping_rsp(const uint8_t mac[6], const uint8_t *pkt, int len)
{
if (len < 7) {
return;
}
uint32_t id = pkt[2] | (pkt[3] << 8) | (pkt[4] << 16) | ((uint32_t)pkt[5] << 24);
int nl = pkt[6] < len - 7 ? pkt[6] : len - 7;
int64_t now = esp_timer_get_time();
portENTER_CRITICAL(&s_ping_mux);
if (id && id == s_ping.id && s_ping.count < PING_MAX) {
bool seen = false;
for (int i = 0; i < s_ping.count && !seen; i++) {
seen = !memcmp(s_ping.rsp[i].mac, mac, 6);
}
if (!seen) {
ping_rsp_t *r = &s_ping.rsp[s_ping.count++];
memcpy(r->mac, mac, 6);
nl = nl < (int)sizeof(r->name) - 1 ? nl : (int)sizeof(r->name) - 1;
memcpy(r->name, pkt + 7, nl);
r->name[nl] = 0;
r->rtt_ms = (int)((now - s_ping.sent_us) / 1000);
}
}
portEXIT_CRITICAL(&s_ping_mux);
}
// Add a driver that answered but is not registered yet, or take its new name. True when stored.
static bool register_from_ping(const char *hex, const char *name)
{
char label[48];
snprintf(label, sizeof(label), "%s", name);
if (!label[0]) {
snprintf(label, sizeof(label), "led-%s", hex);
}
cJSON *devs = store_coll("device");
cJSON *rec = cJSON_GetObjectItem(devs, hex);
if (!rec) {
rec = cJSON_AddObjectToObject(devs, hex);
cJSON_AddStringToObject(rec, "id", hex);
cJSON_AddStringToObject(rec, "name", label);
cJSON_AddStringToObject(rec, "type", "led");
cJSON_AddStringToObject(rec, "transport", "espnow");
cJSON_AddStringToObject(rec, "address", hex);
return true;
}
const cJSON *old = cJSON_GetObjectItem(rec, "name");
if (is_espnow(rec) && (!cJSON_IsString(old) || strcmp(old->valuestring, label))) {
api_set(rec, "name", cJSON_CreateString(label));
return true;
}
return false;
}
// POST /devices/ping {timeout_s}: broadcast PING_REQ and collect replies for timeout_s (0.5-30, default 3)
static esp_err_t ping_devices(httpd_req_t *req)
{
static bool hooked; // replies only matter while a ping runs, so the callback is set on first use
if (!hooked) {
rel_set_ping_cb(on_ping_rsp);
hooked = true;
}
cJSON *body = api_body_opt(req);
if (!body) {
return ESP_OK;
}
const cJSON *t = cJSON_GetObjectItem(body, "timeout_s");
if (t && !cJSON_IsNull(t) && !cJSON_IsNumber(t)) {
cJSON_Delete(body);
return api_error(req, "400 Bad Request", "Invalid timeout_s");
}
double timeout_s = cJSON_IsNumber(t) ? t->valuedouble : 3.0;
timeout_s = timeout_s < 0.5 ? 0.5 : (timeout_s > 30 ? 30 : timeout_s);
cJSON_Delete(body);
portENTER_CRITICAL(&s_ping_mux);
bool busy = s_ping.id != 0;
uint32_t id = (esp_random() | 1);
if (!busy) {
s_ping.id = id;
s_ping.count = 0;
s_ping.sent_us = esp_timer_get_time();
}
portEXIT_CRITICAL(&s_ping_mux);
if (busy) {
return api_error(req, "409 Conflict", "a ping is already running");
}
uint8_t pkt[6] = { 0x4C, 0x05, id & 255, (id >> 8) & 255, (id >> 16) & 255, id >> 24 };
esp_err_t err = espnow_tx_send(NULL, pkt, sizeof(pkt));
vTaskDelay(pdMS_TO_TICKS(20));
espnow_tx_send(NULL, pkt, sizeof(pkt)); // a second copy against a lost broadcast; replies are deduplicated
if (err == ESP_OK) {
store_unlock(); // replies take up to timeout_s; HTTP and the sequencer keep going
vTaskDelay(pdMS_TO_TICKS((int)(timeout_s * 1000)));
store_lock();
}
static ping_rsp_t got[PING_MAX];
portENTER_CRITICAL(&s_ping_mux);
int n = s_ping.count;
memcpy(got, s_ping.rsp, n * sizeof(got[0]));
s_ping.id = 0;
portEXIT_CRITICAL(&s_ping_mux);
if (err != ESP_OK) {
return api_error(req, "503 Service Unavailable", "Send failed");
}
cJSON *o = cJSON_CreateObject(), *responses;
cJSON_AddTrueToObject(o, "ok");
cJSON_AddNumberToObject(o, "ping_id", id);
cJSON_AddNumberToObject(o, "timeout_s", timeout_s);
responses = cJSON_AddObjectToObject(o, "responses");
int registered = 0;
for (int i = 0; i < n; i++) {
char hex[13];
const uint8_t *m = got[i].mac;
snprintf(hex, sizeof(hex), "%02x%02x%02x%02x%02x%02x", m[0], m[1], m[2], m[3], m[4], m[5]);
cJSON *r = cJSON_AddObjectToObject(responses, hex);
cJSON_AddStringToObject(r, "mac", hex);
cJSON_AddStringToObject(r, "name", got[i].name);
cJSON_AddNumberToObject(r, "rtt_ms", got[i].rtt_ms);
registered += register_from_ping(hex, got[i].name);
}
cJSON_AddNumberToObject(o, "registered", registered);
if (registered) {
store_save("device");
engine_groups_changed();
}
return api_json(req, "200 OK", o, true);
}
// POST /devices/groups: push group membership to every ESP-NOW driver and report the acks
static esp_err_t push_groups(httpd_req_t *req)
{
int total, sent, failed;
store_unlock(); // waits up to a few seconds for acks
engine_groups_push_all(&total, &sent, &failed);
store_lock();
if (!total) {
cJSON *o = cJSON_CreateObject();
cJSON_AddFalseToObject(o, "ok");
cJSON_AddStringToObject(o, "error", "No ESP-NOW devices in registry");
return api_json(req, "400 Bad Request", o, true);
}
cJSON *o = cJSON_CreateObject();
cJSON_AddBoolToObject(o, "ok", failed == 0);
cJSON_AddNumberToObject(o, "total", total);
cJSON_AddNumberToObject(o, "sent", sent);
cJSON_AddNumberToObject(o, "failed", failed);
return api_json(req, failed ? "503 Service Unavailable" : "200 OK", o, true);
}
// Per-driver delivery health from the acked link
static esp_err_t device_status(httpd_req_t *req)
{
@@ -321,6 +493,14 @@ bool devices_route(httpd_req_t *req, int n, api_seg_t seg, esp_err_t *ret)
*ret = device_status(req);
return true;
}
if (n == 2 && method == HTTP_POST && !strcmp(seg[1], "ping")) {
*ret = ping_devices(req);
return true;
}
if (n == 2 && method == HTTP_POST && !strcmp(seg[1], "groups")) {
*ret = push_groups(req);
return true;
}
if (n == 1) {
if (method == HTTP_GET) {
cJSON *o = cJSON_CreateObject(), *d;
+27 -6
View File
@@ -1,8 +1,10 @@
#include "web.h"
#include <stddef.h>
#include <stdio.h>
#include <stdint.h>
#include <string.h>
#include "esp_app_desc.h"
#include "esp_log.h"
static const char *TAG = "web";
@@ -98,8 +100,21 @@ void web_each(const char *prefix, void (*fn)(const char *name, void *ctx), void
}
}
// Every file changes only with the firmware, so the build's hash is the ETag: browsers revalidate on
// each load (no-cache) and get a 304 until the next update, instead of running a stale UI for a day.
static const char *etag(void)
{
static char tag[20];
if (!tag[0]) {
const uint8_t *sha = esp_app_get_description()->app_elf_sha256;
snprintf(tag, sizeof(tag), "\"%02x%02x%02x%02x%02x%02x%02x%02x\"", sha[0], sha[1], sha[2], sha[3], sha[4], sha[5],
sha[6], sha[7]);
}
return tag;
}
// path is the URL-relative name, e.g. "static/zones.js"
static esp_err_t send_gz(httpd_req_t *req, const char *path, bool immutable)
static esp_err_t send_gz(httpd_req_t *req, const char *path)
{
const uint8_t *data;
uint32_t len;
@@ -109,25 +124,31 @@ static esp_err_t send_gz(httpd_req_t *req, const char *path, bool immutable)
if (!find_file(path, &data, &len)) {
return httpd_resp_send_404(req);
}
httpd_resp_set_hdr(req, "Cache-Control", "no-cache");
httpd_resp_set_hdr(req, "ETag", etag());
char inm[24];
if (httpd_req_get_hdr_value_str(req, "If-None-Match", inm, sizeof(inm)) == ESP_OK && !strcmp(inm, etag())) {
httpd_resp_set_status(req, "304 Not Modified");
return httpd_resp_send(req, NULL, 0);
}
httpd_resp_set_type(req, mime_for(path));
httpd_resp_set_hdr(req, "Content-Encoding", "gzip");
httpd_resp_set_hdr(req, "Cache-Control", immutable ? "public, max-age=86400" : "no-cache");
return httpd_resp_send(req, (const char *)data, len);
}
esp_err_t web_send_page(httpd_req_t *req, const char *name)
{
return send_gz(req, name, false);
return send_gz(req, name);
}
static esp_err_t index_handler(httpd_req_t *req)
{
return send_gz(req, "index.html", false);
return send_gz(req, "index.html");
}
static esp_err_t audio_page_handler(httpd_req_t *req)
{
return send_gz(req, "audio.html", false);
return send_gz(req, "audio.html");
}
static esp_err_t static_handler(httpd_req_t *req)
@@ -140,7 +161,7 @@ static esp_err_t static_handler(httpd_req_t *req)
}
memcpy(path, uri, n);
path[n] = 0;
return send_gz(req, path, true);
return send_gz(req, path);
}
static esp_err_t favicon_handler(httpd_req_t *req)