mirror of
https://github.com/rstrouse/ESPSomfy-RTS.git
synced 2026-11-01 14:22:12 +01:00
dc2f1478b6
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>
54 lines
2.1 KiB
C++
54 lines
2.1 KiB
C++
#ifndef PROTO_SOCKET_H
|
|
#define PROTO_SOCKET_H
|
|
#include <ESPAsyncWebServer.h>
|
|
#include "ProtoSchema.h"
|
|
#include "ModelEditor.h"
|
|
|
|
class SomfyShade;
|
|
class SomfyGroup;
|
|
class SomfyRoom;
|
|
|
|
// The socket protocol 2 endpoint, ws://host/ws on port 80 (docs/PROTOCOL.md,
|
|
// docs/adr/0005-one-websocket-protocol.md). It runs next to the old socket on
|
|
// port 8080 until the web UI and Home Assistant have moved over.
|
|
//
|
|
// async_tcp only reads what clients send and answers with fixed frames that
|
|
// hold nothing of the shade model (hello, errors, ok). Everything formatted
|
|
// from the model goes out from loop(), in the socket event buffer. The
|
|
// clients' slots and syncs are in ProtoSlots.
|
|
class ProtoSocket {
|
|
public:
|
|
// Adds /ws to the server. From setup(), on loop()'s task.
|
|
void begin(AsyncWebServer &server);
|
|
// Moves each client's sync on. loop() only.
|
|
void loop();
|
|
bool hasClients() const;
|
|
// Events, loop() only.
|
|
void shadeState(SomfyShade &shade);
|
|
void shade(SomfyShade &shade);
|
|
void shadeRemoved(uint8_t shadeId);
|
|
void group(SomfyGroup &group);
|
|
void groupState(SomfyGroup &group);
|
|
void groupRemoved(uint8_t groupId);
|
|
void room(SomfyRoom &room);
|
|
void roomRemoved(uint8_t roomId);
|
|
// roomOrder, shadeOrder or groupOrder: the list's ids, in sort order.
|
|
void order(sort_list_t list);
|
|
void repeaters();
|
|
void shadeCommand(SomfyShade &shade, const char *command, const char *source, uint32_t sourceAddress);
|
|
void memory();
|
|
void wifi();
|
|
void ethernet();
|
|
// A feed event: write its fields into the writer between the two. Only
|
|
// when subscribed() says someone is, which is also only on loop().
|
|
bool subscribed(proto_feed_t feed) const;
|
|
ProtoWriter beginFeed(proto_type_t type);
|
|
void endFeed(proto_feed_t feed);
|
|
static void wsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventType type, void *arg, uint8_t *data, size_t len);
|
|
private:
|
|
// On loop()'s task, with a client to send to: nothing is formatted for
|
|
// nobody, or off the task that owns the event buffer.
|
|
bool sending() const;
|
|
};
|
|
extern ProtoSocket protoSocket;
|
|
#endif
|