prism-protocol-spec

What problem does it solve?

Designing reliable communication protocols for embedded devices can be complex, requiring careful attention to data integrity and framing. This Skill provides the complete PRISM protocol specification, a byte-oriented, CRC32-validated frame format, enabling developers to implement robust communication between the K1 device and control systems, ensuring data integrity and simplifying integration.

Core Features & Use Cases

• CRC32 Data Integrity: Utilizes standard CRC32 checksums to detect transmission errors, ensuring reliable data exchange.
• Fixed Header + Variable Payload: Defines a clear frame structure with sync markers, length, and payload for easy parsing and encoding.
• Transport Agnostic: Designed to work seamlessly over various transport layers, including serial, WiFi, and WebSocket.
• Use Case: Implement a custom client application to control the K1 device, debug communication issues by verifying frame integrity, or extend the K1 firmware with new commands using a standardized, robust protocol.

Quick Start

Example: Computing CRC32 for a frame

#include "esp32/rom/crc.h" uint32_t compute_crc32(uint8_t *data, uint16_t length) { return crc32_le(0, data, length); }

Verify frame CRC

uint8_t frame[8+N]; uint32_t computed_crc = crc32_le(0, frame, 4+N); # SYNC+LENGTH+PAYLOAD uint32_t received_crc = (frame[4+N]<<24) | ... ; # Extract CRC if (computed_crc != received_crc) { printf("CRC mismatch! "); return -1; # Frame error }