Websocket-Firmware-Protocol

What problem does it solve?

Building reliable communication between a web application and embedded firmware often leads to custom, fragile protocols. This Skill defines a robust, JSON-based WebSocket protocol for firmware communication, providing clear message formats, command structures, and event types, ensuring seamless, real-time interaction and reducing integration complexity.

Core Features & Use Cases

• JSON-Based Messaging: Human-readable and easy-to-debug message frames for commands, events, and responses.
• Event-Driven & Request-Response: Supports immediate broadcasting of firmware changes and acknowledged command execution.
• Bidirectional Communication: Enables both client-to-firmware commands and firmware-to-client status updates.
• Use Case: Integrate a web-based control panel with an ESP32 device, synchronize real-time sensor data from firmware to a dashboard, or implement remote configuration for embedded systems.

Quick Start

Example: Sending an event from firmware

#include "cJSON.h" void send_event(const char *event_name, const char *json_data) { cJSON *msg = cJSON_CreateObject(); cJSON_AddStringToObject(msg, "type", "event"); cJSON_AddStringToObject(msg, "cmd", event_name); if (json_data) { cJSON *data = cJSON_Parse(json_data); if (data) { cJSON_AddItemToObject(msg, "data", data); } } char *str = cJSON_Print(msg); websocket_send(str); free(str); cJSON_Delete(msg); }