mirror of
https://github.com/rstrouse/ESPSomfy-RTS.git
synced 2026-10-31 13:52:15 +01:00
fix: protocol 2 core review findings
From the review of #99: - A sync could stall when a client took a slot the moment another left: loop() used up the new client's sync on the old one. The slots move to ProtoSlots, a pure module with native tests, and loop() takes a slot's wants only for the client it read (takeWants). - Deleting a group sends its shades, whose inGroup changed. Deleting a shade unlinks it from its groups and sends them, so a new shade given its id doesn't join them. - next and sync with an id get an ok reply, and a message in pieces gets one bad request, not one per piece. - Feeds check for loop() before they write the event buffer, and log an event too large, as events do. - editChanges() (ModelEditor, native tests) says what clients get after an edit; the edit result carries the shade a group gained or lost. order() takes a sort_list_t. - The frame writers move to ProtoFrame. Renames: pf to proto_field_t, the X-macro letters to TYPE/FIELD/ERR/FEED, proto_request_t to proto_message_t, REQ_* to WANTS_*, fmt to eventJson. The event bodies share sendItem(), the connection type name lives in ESPNetwork, and the loop() task check in SocketEmitter. - e2e: the heap floor check skips when the low since boot is already under it; tests for replies to next and sync and a long message. - SECURITY_PLAN.md splits step 1 into 1a-1d. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
cjkas
parent
d869bb53d5
commit
dc2f1478b6
29 changed files with 1087 additions and 670 deletions
|
|
@ -1,5 +1,6 @@
|
|||
#include "esp_log.h"
|
||||
#include "ProtoSync.h"
|
||||
#include "ProtoFrame.h"
|
||||
|
||||
static const char *TAG = "Proto";
|
||||
|
||||
|
|
@ -7,81 +8,81 @@ static const char *TAG = "Proto";
|
|||
* Items
|
||||
********************************************************************/
|
||||
void protoRoom(ProtoWriter &w, const room_snapshot_t &room) {
|
||||
w.add(pf::roomId, room.roomId);
|
||||
w.add(pf::name, room.name);
|
||||
w.add(pf::sortOrder, room.sortOrder);
|
||||
w.add(proto_field_t::roomId, room.roomId);
|
||||
w.add(proto_field_t::name, room.name);
|
||||
w.add(proto_field_t::sortOrder, room.sortOrder);
|
||||
}
|
||||
void protoShadeState(ProtoWriter &w, const shade_snapshot_t &shade) {
|
||||
w.add(pf::shadeId, shade.shadeId);
|
||||
w.add(pf::position, shade.position);
|
||||
w.add(pf::target, shade.target);
|
||||
w.add(pf::direction, shade.direction);
|
||||
w.add(pf::myPos, shade.myPos);
|
||||
w.add(pf::tiltPosition, shade.tiltPosition);
|
||||
w.add(pf::tiltTarget, shade.tiltTarget);
|
||||
w.add(pf::tiltDirection, shade.tiltDirection);
|
||||
w.add(pf::myTiltPos, shade.myTiltPos);
|
||||
w.add(pf::flags, shade.flags);
|
||||
w.add(pf::lastRollingCode, shade.lastRollingCode);
|
||||
w.add(proto_field_t::shadeId, shade.shadeId);
|
||||
w.add(proto_field_t::position, shade.position);
|
||||
w.add(proto_field_t::target, shade.target);
|
||||
w.add(proto_field_t::direction, shade.direction);
|
||||
w.add(proto_field_t::myPos, shade.myPos);
|
||||
w.add(proto_field_t::tiltPosition, shade.tiltPosition);
|
||||
w.add(proto_field_t::tiltTarget, shade.tiltTarget);
|
||||
w.add(proto_field_t::tiltDirection, shade.tiltDirection);
|
||||
w.add(proto_field_t::myTiltPos, shade.myTiltPos);
|
||||
w.add(proto_field_t::flags, shade.flags);
|
||||
w.add(proto_field_t::lastRollingCode, shade.lastRollingCode);
|
||||
}
|
||||
void protoShade(ProtoWriter &w, const shade_snapshot_t &shade) {
|
||||
protoShadeState(w, shade);
|
||||
w.add(pf::roomId, shade.roomId);
|
||||
w.add(pf::name, shade.name);
|
||||
w.add(pf::remoteAddress, shade.remoteAddress);
|
||||
w.add(pf::upTime, shade.upTime);
|
||||
w.add(pf::downTime, shade.downTime);
|
||||
w.add(pf::tiltTime, shade.tiltTime);
|
||||
w.add(pf::stepSize, shade.stepSize);
|
||||
w.add(pf::paired, shade.paired);
|
||||
w.add(pf::tiltType, shade.tiltType);
|
||||
w.add(pf::shadeType, shade.shadeType);
|
||||
w.add(pf::bitLength, shade.bitLength);
|
||||
w.add(pf::proto, shade.proto);
|
||||
w.add(pf::flipCommands, shade.flipCommands);
|
||||
w.add(pf::flipPosition, shade.flipPosition);
|
||||
w.add(pf::inGroup, shade.inGroup);
|
||||
w.add(pf::sunSensor, shade.sunSensor);
|
||||
w.add(pf::light, shade.light);
|
||||
w.add(pf::simMy, shade.simMy);
|
||||
w.add(pf::repeats, shade.repeats);
|
||||
w.add(pf::sortOrder, shade.sortOrder);
|
||||
w.add(pf::gpioUp, shade.gpioUp);
|
||||
w.add(pf::gpioDown, shade.gpioDown);
|
||||
w.add(pf::gpioMy, shade.gpioMy);
|
||||
w.add(pf::gpioLLTrigger, shade.gpioLLTrigger);
|
||||
w.add(proto_field_t::roomId, shade.roomId);
|
||||
w.add(proto_field_t::name, shade.name);
|
||||
w.add(proto_field_t::remoteAddress, shade.remoteAddress);
|
||||
w.add(proto_field_t::upTime, shade.upTime);
|
||||
w.add(proto_field_t::downTime, shade.downTime);
|
||||
w.add(proto_field_t::tiltTime, shade.tiltTime);
|
||||
w.add(proto_field_t::stepSize, shade.stepSize);
|
||||
w.add(proto_field_t::paired, shade.paired);
|
||||
w.add(proto_field_t::tiltType, shade.tiltType);
|
||||
w.add(proto_field_t::shadeType, shade.shadeType);
|
||||
w.add(proto_field_t::bitLength, shade.bitLength);
|
||||
w.add(proto_field_t::proto, shade.proto);
|
||||
w.add(proto_field_t::flipCommands, shade.flipCommands);
|
||||
w.add(proto_field_t::flipPosition, shade.flipPosition);
|
||||
w.add(proto_field_t::inGroup, shade.inGroup);
|
||||
w.add(proto_field_t::sunSensor, shade.sunSensor);
|
||||
w.add(proto_field_t::light, shade.light);
|
||||
w.add(proto_field_t::simMy, shade.simMy);
|
||||
w.add(proto_field_t::repeats, shade.repeats);
|
||||
w.add(proto_field_t::sortOrder, shade.sortOrder);
|
||||
w.add(proto_field_t::gpioUp, shade.gpioUp);
|
||||
w.add(proto_field_t::gpioDown, shade.gpioDown);
|
||||
w.add(proto_field_t::gpioMy, shade.gpioMy);
|
||||
w.add(proto_field_t::gpioLLTrigger, shade.gpioLLTrigger);
|
||||
if(shade.linkedRemoteCount == 0) return;
|
||||
w.beginList(pf::linkedRemotes);
|
||||
w.beginList(proto_field_t::linkedRemotes);
|
||||
for(uint8_t i = 0; i < shade.linkedRemoteCount; i++) {
|
||||
w.beginItem();
|
||||
w.add(pf::remoteAddress, shade.linkedRemotes[i].remoteAddress);
|
||||
w.add(pf::lastRollingCode, shade.linkedRemotes[i].lastRollingCode);
|
||||
w.add(proto_field_t::remoteAddress, shade.linkedRemotes[i].remoteAddress);
|
||||
w.add(proto_field_t::lastRollingCode, shade.linkedRemotes[i].lastRollingCode);
|
||||
w.endItem();
|
||||
}
|
||||
w.endList();
|
||||
}
|
||||
void protoGroup(ProtoWriter &w, const group_snapshot_t &group) {
|
||||
w.add(pf::groupId, group.groupId);
|
||||
w.add(pf::roomId, group.roomId);
|
||||
w.add(pf::name, group.name);
|
||||
w.add(pf::remoteAddress, group.remoteAddress);
|
||||
w.add(pf::lastRollingCode, group.lastRollingCode);
|
||||
w.add(pf::bitLength, group.bitLength);
|
||||
w.add(pf::proto, group.proto);
|
||||
w.add(pf::sunSensor, group.sunSensor);
|
||||
w.add(pf::flipCommands, group.flipCommands);
|
||||
w.add(pf::flags, group.flags);
|
||||
w.add(pf::repeats, group.repeats);
|
||||
w.add(pf::sortOrder, group.sortOrder);
|
||||
w.add(proto_field_t::groupId, group.groupId);
|
||||
w.add(proto_field_t::roomId, group.roomId);
|
||||
w.add(proto_field_t::name, group.name);
|
||||
w.add(proto_field_t::remoteAddress, group.remoteAddress);
|
||||
w.add(proto_field_t::lastRollingCode, group.lastRollingCode);
|
||||
w.add(proto_field_t::bitLength, group.bitLength);
|
||||
w.add(proto_field_t::proto, group.proto);
|
||||
w.add(proto_field_t::sunSensor, group.sunSensor);
|
||||
w.add(proto_field_t::flipCommands, group.flipCommands);
|
||||
w.add(proto_field_t::flags, group.flags);
|
||||
w.add(proto_field_t::repeats, group.repeats);
|
||||
w.add(proto_field_t::sortOrder, group.sortOrder);
|
||||
if(group.linkedShadeCount == 0) return;
|
||||
w.beginList(pf::linkedShades);
|
||||
w.beginList(proto_field_t::linkedShades);
|
||||
for(uint8_t i = 0; i < group.linkedShadeCount; i++) w.item(group.linkedShades[i]);
|
||||
w.endList();
|
||||
}
|
||||
void protoGroupState(ProtoWriter &w, uint8_t groupId, uint8_t flags, int8_t direction) {
|
||||
w.add(pf::groupId, groupId);
|
||||
w.add(pf::flags, flags);
|
||||
w.add(pf::direction, direction);
|
||||
w.add(proto_field_t::groupId, groupId);
|
||||
w.add(proto_field_t::flags, flags);
|
||||
w.add(proto_field_t::direction, direction);
|
||||
}
|
||||
|
||||
/*********************************************************************
|
||||
|
|
@ -98,24 +99,24 @@ sync_cursor_t beginSync(bool withSchema) {
|
|||
return cur;
|
||||
}
|
||||
|
||||
static pf sectionField(sync_section_t section) {
|
||||
static proto_field_t sectionField(sync_section_t section) {
|
||||
switch(section) {
|
||||
case sync_section_t::types: return pf::types;
|
||||
case sync_section_t::fields: return pf::fields;
|
||||
case sync_section_t::errors: return pf::errors;
|
||||
case sync_section_t::feeds: return pf::feeds;
|
||||
case sync_section_t::header: return pf::header;
|
||||
case sync_section_t::rooms: return pf::rooms;
|
||||
case sync_section_t::shades: return pf::shades;
|
||||
case sync_section_t::groups: return pf::groups;
|
||||
case sync_section_t::repeaters: return pf::repeaters;
|
||||
default: return pf::status;
|
||||
case sync_section_t::types: return proto_field_t::types;
|
||||
case sync_section_t::fields: return proto_field_t::fields;
|
||||
case sync_section_t::errors: return proto_field_t::errors;
|
||||
case sync_section_t::feeds: return proto_field_t::feeds;
|
||||
case sync_section_t::header: return proto_field_t::header;
|
||||
case sync_section_t::rooms: return proto_field_t::rooms;
|
||||
case sync_section_t::shades: return proto_field_t::shades;
|
||||
case sync_section_t::groups: return proto_field_t::groups;
|
||||
case sync_section_t::repeaters: return proto_field_t::repeaters;
|
||||
default: return proto_field_t::status;
|
||||
}
|
||||
}
|
||||
static uint8_t sectionSlots(sync_section_t section) {
|
||||
switch(section) {
|
||||
case sync_section_t::types: return protoTypeCount();
|
||||
case sync_section_t::fields: return static_cast<uint8_t>(pf::count);
|
||||
case sync_section_t::fields: return static_cast<uint8_t>(proto_field_t::count);
|
||||
case sync_section_t::errors: return protoErrorCount();
|
||||
case sync_section_t::feeds: return protoFeedCount();
|
||||
case sync_section_t::rooms: return SOMFY_MAX_ROOMS;
|
||||
|
|
@ -139,7 +140,7 @@ static bool writeItem(SyncSource &src, ProtoWriter &w, sync_section_t section, u
|
|||
case sync_section_t::errors: namedRow(json, protoErrorAt(slot)); return true;
|
||||
case sync_section_t::feeds: namedRow(json, protoFeedAt(slot)); return true;
|
||||
case sync_section_t::fields: {
|
||||
const proto_field_info_t &f = protoField(static_cast<pf>(slot));
|
||||
const proto_field_info_t &f = protoField(static_cast<proto_field_t>(slot));
|
||||
const char kind[2] = {f.kind, '\0'};
|
||||
json.beginArray();
|
||||
json.addElem(f.key);
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue