Files
aes67-ESP32-P4/components/aes67_web/include/aes67_cfg.h
T
bsncubed dcea39b216 Step 6.2: role hand-over, session_ver bump on GM change
- aes67_cfg: cfg_set_number(group, key, value, apply) for firmware-side
  changes, stored in NVS like a POST; apply can be skipped.
- aes67_sdp_sap: once a second, a change of the PTP GM (ts-refclk) bumps
  aes67.session_ver without re-applying the aes67 group (no stream
  restart); SAP then re-announces. Runs whether or not SAP is on.
- Verified with ptp4l as a normal clock (p1 128): board auto (p1 250)
  steps down to SLAVE (session_ver 1->2); role master p1 100 via API ->
  board MASTER at once (->3); back to auto p1 250 -> ptp4l takes over
  within ~1 s, board SLAVE again (->4).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-25 08:08:00 +10:00

34 lines
2.0 KiB
C

// Config registry and store (cJSON in NVS), part of aes67_web.
// Each component registers its group; /api/config is built from the registry.
#pragma once
#include <stdbool.h>
#include <stddef.h>
#include "cJSON.h"
#include "esp_err.h"
// Validate a candidate group object. On failure write "key: reason" to err and return false.
typedef bool (*cfg_validate_cb_t)(const cJSON *group, char *err, size_t err_len);
// Called with the new group values after a successful save (apply live where possible).
typedef void (*cfg_apply_cb_t)(const cJSON *group);
// Project defaults merged over a group's core defaults. Call before that group is registered.
esp_err_t cfg_override_defaults(const char *group, const char *json);
// Register a group. Stored values (NVS) are loaded immediately, merged over the defaults.
esp_err_t cfg_register(const char *group, const char *defaults_json,
cfg_validate_cb_t validate, cfg_apply_cb_t apply);
// Copy of a group's current values; caller frees with cJSON_Delete. NULL if not registered.
cJSON *cfg_get(const char *group);
// Firmware-side change of one number (e.g. aes67.session_ver): stored like a POST, no validation.
// apply = false skips the group's apply callback (e.g. to avoid restarting the stream).
esp_err_t cfg_set_number(const char *group, const char *key, double value, bool apply);
// Validation helpers for validate callbacks. Each returns false and fills err on failure.
bool cfg_check_num(const cJSON *g, const char *key, double min, double max, char *err, size_t n);
bool cfg_check_int(const cJSON *g, const char *key, double min, double max, char *err, size_t n);
bool cfg_check_num_in(const cJSON *g, const char *key, const double *vals, int count, char *err, size_t n);
bool cfg_check_enum(const cJSON *g, const char *key, const char *const *opts, char *err, size_t n);
bool cfg_check_str(const cJSON *g, const char *key, size_t min_len, size_t max_len, char *err, size_t n);
bool cfg_check_ipv4(const cJSON *g, const char *key, bool allow_empty, char *err, size_t n);