Files
ZephCore/zephcore/app/RepeaterDataStore.h
T
liquidraver 38f815a0a1 server roles, event loops, companion transports, storage and prefs.json
Server roles (slice 7)
- CommonCLI split into upstream's shape; region CLI moved into CommonCLI;
  ClientACL, RegionMap, TransportKeyStore and both server meshes in
  upstream shape over an Arduino compat shim (helpers/compat: Arduino.h,
  Stream/Print, Serial, SHA256, FILESYSTEM/File over Zephyr fs)
- room server processAck port; `get acl` prints as upstream
- room: default name Room-XXXX, display/input rotation, live radio UI refresh

Event loops (slice 7b)
- repeater and room server share server_main_common with a ServerRole
  descriptor; shared event bits in src/mesh_events.h
- room server deadline-driven (idle wakes 2.2/s -> 0.08/s); companion
  loop() runs on housekeeping (closes the lazy contact-flush gap)
- `get loop.wakes` in debug builds (CONFIG_ZEPHCORE_LOOP_WAKE_STATS)

Companion transports and WiFi (slice 8)
- upstream MultiSerialInterface: BLE, USB/UART and TCP are each a
  BaseSerialInterface, every connected transport gets every frame;
  CompanionSerial holds a lossless reply; shared frame_txq for BLE/TCP
- SerialCompanionTransport and LinuxTCPTransport replaced by
  TcpCompanionTransport; ZephyrBLE split (gatt layout, DFU)
- WiFi companion (upstream wifi.ssid/pwd/enabled CLI, TCP port 5000) on
  boards declaring `capabilities: wifi` in zephcore.yml: the PSRAM
  ESP32-S3 boards, plus Heltec V3 (140 contacts), Wireless Tracker (130)
  and both C6 boards (280); ESP32-S3 without PSRAM gets bounded WiFi
  buffers and a measured 72 KB heap; PSRAM boards' internal heap 72 KB
- TCP queues: own depth (ZEPHCORE_TCP_QUEUE_SIZE=8), RX waits instead
  of dropping
- RAM: companion ClientACL dropped; main/BT-TX/TCP stacks sized from
  measured peaks (-7 KB nRF companions, -9 KB ESP32 companions)
- ESP32 WiFi stopped working under ~200 frames/s unicast. Fixed by:
  patches/zephyr/0017 never block the WiFi task in the RX callback;
  patches/zephyr/0018 lock shared_multi_heap (heap corruption with the
  WiFi heap in PSRAM); patches/modules/hal_espressif/0001 backport of
  hal_espressif af97fb02df (PSRAM realloc)

Storage and prefs (slice 9)
- prefs are now prefs.json through upstream's ConfigSerializer (ported
  verbatim), with upstream's key names for shared fields and ZephCore's
  own under "zc"; on first boot the binary new_prefs / repeater prefs is
  migrated and kept, so a downgrade still boots with the old settings
- helpers/PrefsCodec: both legacy binary layouts (companion 272 B,
  server 311 B) as Zephyr-free codecs; sanitizeNodePrefs is the only
  validator
- fix: server prefs could be replaced by a truncated file when a write
  failed; identity, prefs and channel writes go through one checked
  atomic replace (ZephyrFsUtil)
- fix: a corrupt cad_auto byte turned adaptive CAD off instead of the
  default on
- fix: a deliberate 300 s GPS duty on a repeater was rewritten to 48 h
  on every boot (that migration now runs on legacy files only)
- one identity loader for all roles (IdentityFile); an unusable key
  file is always parked as .bad before regenerating
- server store no longer stamps repeater defaults on room server and
  observer; companion first-boot volume policy moved into the store
  (adoptVolume)
- ZephyrDataStore 1435 -> ~850 lines
2026-09-25 08:34:21 +02:00

65 lines
2.2 KiB
C++

/*
* SPDX-License-Identifier: MIT
* RepeaterDataStore - Filesystem storage for repeater
*
* Uses /lfs/repeater/ prefix to keep data separate from companion, so the
* two prefs layouts (311 B here, 272 B there, different field order; see
* helpers/PrefsCodec.h) can never be read through each other.
*
* The roles are NOT interchangeable: booting a repeater onto a companion
* volume formats it, and vice versa. They are different kinds of node, and
* they share one 128 KB LittleFS volume - a companion's contacts and blob
* cache would crowd out repeater writes (-ENOSPC), not corrupt them. Save
* your identity before switching roles.
*/
#pragma once
#include <cstdint>
#include <stddef.h>
#include <mesh/Identity.h>
#include <helpers/NodePrefs.h>
#include <helpers/ClientACL.h>
#include <helpers/RegionMap.h>
class RepeaterDataStore {
public:
RepeaterDataStore();
/* Initialize filesystem and repeater directory */
bool begin();
/* Identity management */
bool loadIdentity(mesh::LocalIdentity& id);
bool saveIdentity(const mesh::LocalIdentity& id);
/* Prefs management */
bool loadPrefs(NodePrefs& prefs);
bool savePrefs(const NodePrefs& prefs);
/* The /lfs/repeater directory as a FILESYSTEM, for the storage code ported
* from upstream (ClientACL, RegionMap), which names files from its root. */
FILESYSTEM* getFS() { return &_fs; }
/* Factory reset - erase all repeater data */
bool formatFileSystem();
/* True if this LittleFS volume already holds THIS role's data. False
* means the volume belongs to something else - a fresh chip, a companion,
* or a node that was running Arduino MeshCore, whose nRF52 filesystems
* overlap our lfs_partition (devdocs/HANDOVER_lfs_arduino_overlap.md).
* Callers format on false; see the note on BASE_PATH below. */
bool hasRoleData() const;
/* Get base path for repeater storage */
const char* getBasePath() const;
private:
bool _initialized;
/* Legacy binary prefs (PrefsCodec): read once to migrate, then kept for
* firmware from before prefs.json. */
bool loadLegacyPrefs(const char* path, NodePrefs& prefs);
static constexpr const char* BASE_PATH = "/lfs/repeater";
ZephyrFS _fs{BASE_PATH};
};