Files
ZephCore/zephcore/app/CompanionSerial.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

74 lines
2.1 KiB
C++

/*
* SPDX-License-Identifier: MIT
* The companion's _serial: upstream's MultiSerialInterface, plus the one rule
* ZephCore adds on top of it — a lossless reply is never lost to a full
* transport.
*
* A reply (code < 0x80) the transports could not take is held here and
* reported as sent, so callers that retry (contact and message sync) do not
* send it twice. While it is held, nothing else is written and no command is
* read: the app sees replies in order. retry() pushes it out once a transport
* has room; drop() discards it when the session ends. Pushes (>= 0x80) stay
* lossy. Main thread only.
*/
#pragma once
#include <string.h>
#include <helpers/BaseSerialInterface.h>
class CompanionSerial : public BaseSerialInterface {
BaseSerialInterface &_inner;
uint16_t _held_len = 0; /* 0 = nothing held */
uint8_t _held[MAX_FRAME_SIZE];
public:
explicit CompanionSerial(BaseSerialInterface &inner) : _inner(inner) {}
void enable() override { _inner.enable(); }
void disable() override { _inner.disable(); }
bool isEnabled() const override { return _inner.isEnabled(); }
bool isConnected() const override { return _inner.isConnected(); }
void loop() override { _inner.loop(); }
bool isWriteBusy() const override { return _held_len != 0 || _inner.isWriteBusy(); }
size_t writeFrame(const uint8_t src[], size_t len) override
{
if (len == 0 || len > MAX_FRAME_SIZE || _held_len != 0) {
return 0;
}
/* Nobody to hold it for; holding would stall the next session */
if (!_inner.isConnected()) {
return 0;
}
if (_inner.writeFrame(src, len) == len) {
return len;
}
if (src[0] < 0x80) {
memcpy(_held, src, len);
_held_len = (uint16_t)len;
return len;
}
return 0;
}
size_t checkRecvFrame(uint8_t dest[]) override
{
return _held_len != 0 ? 0 : _inner.checkRecvFrame(dest);
}
/* Send the held reply if a transport has room now. */
void retry()
{
if (_held_len == 0) {
return;
}
if (!_inner.isConnected() || _inner.writeFrame(_held, _held_len) == _held_len) {
_held_len = 0;
}
}
void drop() { _held_len = 0; }
bool holding() const { return _held_len != 0; }
};