https://github.com/vhrdtech/wire_weaver
Lightweight microcontroller API code generator with support for rich data types (including unsized types in no_std) and seamless backward/forward compatibility.
https://github.com/vhrdtech/wire_weaver
api mcu no-alloc no-std rpc rust wire-format
Last synced: 3 months ago
JSON representation
Lightweight microcontroller API code generator with support for rich data types (including unsized types in no_std) and seamless backward/forward compatibility.
- Host: GitHub
- URL: https://github.com/vhrdtech/wire_weaver
- Owner: vhrdtech
- Created: 2020-01-01T11:19:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-12-23T16:13:00.000Z (3 months ago)
- Last Synced: 2025-12-25T00:22:53.710Z (3 months ago)
- Topics: api, mcu, no-alloc, no-std, rpc, rust, wire-format
- Language: Rust
- Homepage: https://vhrdtech.github.io/wire_weaver/
- Size: 3.65 MB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WireWeaver
> WireWeaver is an API code generator for microcontrollers, supporting user-defined types, methods, properties, streams,
> and traits.
> It handles unsized types like Vec and String even in no_std environments without an allocator,
> and ensures full backward and forward compatibility between devices across format versions.
Currently only Rust language is supported, with the idea to handle device communications in Rust and provide higher
level bindings for Python, C++ and other languages. C support is tentatively planned to be implemented directly, to run
e.g., on TMS320 DSPs.
Current state is - approaching alpha release.
## TLDR
Documentation with a step-by-step guide is
available [here](https://vhrdtech.github.io/wire_weaver/).
Supported:
* RPC - functions with any number of arguments of any type, returning any type
* Streams of bytes or objects
* Properties of any type
* Traits
* Blocking and async mode
* USB without drivers on Windows, Linux and macOS
* soon: WebSocket and UDP support
* soon: CAN bus support
Traits can be made "global" by publishing them on crates.io.
Useful for things like logging, GPIO control or firmware update, allowing code reuse across projects.
Wire format used (called shrink_wrap) is binary and designed to use bits and nibbles to make it compact without
compression.
See comparison to other formats in [examples/compare_wire_formats](./examples/compare_wire_formats).
## Standard library
Common data types and traits are located in the [ww_stdlib](https://github.com/vhrdtech/ww_stdlib) repository.
Notable ones are:
* `ww_date_time` - ISO 8601 date and time with optional time zone and nanoseconds, as small as 32 bits. Also NaiveDate
and NaiveTime.
* `ww_version` - SemVer version (including pre and build strings).
* `ww_numeric` - Various numeric types, including offset-scale and subtypes.
* `ww_si` - SI units and derived values.
* `ww_gpio` - GPIO control data types and remote bridging API.
* `ww_can_bus` - CAN Bus types and bridging API.
* `ww_dfu` - Firmware update API.
* `ww_log_bare_metal` - Logging types and API for no_std bare metal targets.
* `ww_self` - Dynamic access to APIs (API model AST in shrink_wrap format).
## Quick start
Easiest way to start using WireWeaver is through one of the templates below, which contain firmware for several
development boards, API, client and Python bindings crates.
If you do not have physical hardware at hand, there is virtual device support.
### Microcontroller API over USB template
[WireWeaver template](https://github.com/vhrdtech/wire_weaver_template)
This is a minimal example showing an MCU firmware with USB, common no_std API crate, server on the MCU and client in
Rust and Python.
### Microcontroller API over Ethernet template
TODO
### Setup from scratch
See [Project setup]() page in the docs, which explains how setup projects in more detail for both std and no_std use.
### Low level wire format use
TODO
## Wire format
wire_weaver uses wire format called [shrink_wrap](https://github.com/romixlab/shrink_wrap) -
compact zero-copy wire format for microcontrollers using no allocator and supporting dynamic types.
If you only want to serialize and deserialize some data types, it can be used stand-alone.
## Crate naming
`wire_weaver_` prefix is used on core crates that implement all the functionality.
`ww_` prefix is used on crates using WireWeaver to provide standard library types and traits. Use it as well if you
think that your crate is useful across multiple projects.
Standard library is in [ww_stdlib](https://github.com/vhrdtech/ww_stdlib) repository, contributions are welcome!