uploaded 1 hour ago
Portable Wiremux protocol core for ESP-IDF components
readme
# wiremux-core Portable Wiremux protocol primitives packaged for ESP-IDF consumers. `wiremux-core` contains the platform-neutral C implementation for: - `WMUX` frame encoding and decoding with CRC32 validation. - Protobuf-compatible mux envelopes. - Device manifest encoding. - Batch record encoding and decoding. - Heatshrink-style and LZ4-compatible payload compression helpers. This package is generated from `sources/core/c` in the Wiremux repository. The source tree remains platform-neutral; the ESP Component Registry package is assembled at release time. ## Add to a Project Most applications should depend on `esp-wiremux` instead of using `wiremux-core` directly: ```yaml dependencies: magicdian/esp-wiremux: "2604.29.4" ``` Use `wiremux-core` directly only when you are writing another ESP-IDF adapter component: ```yaml dependencies: magicdian/wiremux-core: "2604.29.4" ``` ## API Entry Points ```c #include "wiremux_frame.h" #include "wiremux_envelope.h" #include "wiremux_manifest.h" #include "wiremux_batch.h" #include "wiremux_compression.h" ``` The component requires ESP-IDF v5.4 or newer. ## Source Canonical source: https://github.com/magicdian/wiremux/tree/main/sources/core/c Release packaging: https://github.com/magicdian/wiremux/blob/main/tools/esp-registry/generate-packages.sh
Links
- Documentation
-
Repository
f15a326c528f793ff6aff66776603aed21ee6fef
Supports all targets
License: Apache-2.0
To add this component to your project, run:
download archive
idf.py add-dependency "magicdian/wiremux-core^2604.29.4"
Stats
-
Archive size ~ 24.21 KB
-
Downloaded in total 0 times
-
This version: 0 times
Badge
