uploaded 2 hours ago
Portable Wiremux protocol core for ESP-IDF components
readme (zh)
# wiremux-core 面向 ESP-IDF 用户发布的平台无关 Wiremux 协议核心。 `wiremux-core` 包含以下 C 实现： - 带 CRC32 校验的 `WMUX` frame 编码和解码。 - protobuf-compatible mux envelope。 - device manifest 编码。 - batch record 编码和解码。 - heatshrink-style 和 LZ4-compatible payload compression helper。 该包由 Wiremux 仓库中的 `sources/core/c` 生成。源码目录仍保持平台无关；ESP Component Registry 发布包只在 release 时生成。 ## 添加依赖 大多数应用应该直接依赖 `esp-wiremux`，而不是直接使用 `wiremux-core`： ```yaml dependencies: magicdian/esp-wiremux: "2604.29.4" ``` 只有在编写另一个 ESP-IDF adapter component 时，才建议直接依赖 `wiremux-core`： ```yaml dependencies: magicdian/wiremux-core: "2604.29.4" ``` ## API 入口 ```c #include "wiremux_frame.h" #include "wiremux_envelope.h" #include "wiremux_manifest.h" #include "wiremux_batch.h" #include "wiremux_compression.h" ``` 该 component 需要 ESP-IDF v5.4 或更新版本。 ## 源码 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
