5 ms·
I was looking at MessagePack for communicating to and from my STM32F1-based microcontroller project from the PC controller software I'd be writing. At least the
by magicalhippo 7y ago
I was looking at MessagePack for communicating to and from my STM32F1-based microcontroller project from the PC controller software I'd be writing. At least the official C library was not optimized for memory usage and code size. I also considered BSON, but it also lacked suitable libraries.
So I ended up using JSON. Yes the message sizes are larger in byte size with JSON but using the jsmn[1] parser I could avoid dynamic memory usage and code size was small. The jsmn parser outputs an array of tokens that point to the buffer holding the message (ie start and end of key name etc), so overhead is quite limited.
For JSON output I modified json-maker[2]. It already allowed for static memory usage and rather small code size, but I changed it to support a write-callback so I could send output directly over the data link, so I didn't have to buffer the whole message. This is nice when sending larger arrays of data for example.
Combined it took about 10kB of program (flash) memory, of which float to string support is about 50%. Memory usage is determined by how larger incoming messages I'd need, for now 1kB is plenty.
A nice advantage of using JSON is that it's very easy to debug over UART.
Though having compact messages would be nice for wireless stuff and similar, so does anyone know of a MessagePack C/C++ library that is microcontroller friendly?
[1]: https://github.com/zserge/jsmn https://github.com/zserge/jsmn
[2]: https://github.com/rafagafe/json-maker https://github.com/rafagafe/json-maker
- TickleSteve 7y agoNot messagepack, but if protobuf is ok, then nanopb has given me good results on uC projects.
- magicalhippo 7y agoAh, that looks pretty spiffy, thanks!
- SAI_Peregrinus 7y agoI'll second nanopb as pretty good. Used it on an STM32F4.
- SlowRobotAhead 7y agoIt’s good. But it’s a one man show and you are very much in this is how it’s done realm. I threw away NanoPB in favor of TinyCBOR and haven’t looked back.
- ludocode 7y agoMy MessagePack implementation is designed for embedded: https://github.com/ludocode/mpack https://github.com/ludocode/mpack It can be built to a very small code size, especially when you disable libc, allocations, etc. There are some people using it on embedded devices like Arduino. There's someone working on a port to 8-bit microcontrollers that don't have a 64-bit float, so you may want to look into that as well; see the open issue for it on the GitHub link above.
- jrg_lcsf 7y agoNo idea if it suits your needs, but here's my pet project for microcontroller friendly communication protocols: https://github.com/jean-roland/LCSF_C_Stack https://github.com/jean-roland/LCSF_C_Stack
- osteele 7y agoArduinoJson https://arduinojson.org https://arduinojson.org supports MessagePack. I haven't looked at its static or runtime memory requirements.
- matthewaveryusa 7y agoThis library is very small and you need to implement your own I/O via well-defined functions. The parser itself does not use any library (including libc): https://github.com/camgunz/cmp https://github.com/camgunz/cmp
- liamdiprose 7y agoProtobufs/nanopb would be my go-to for minimal message size. If you want small code size, CBOR seems like a good bet: > The Concise Binary Object Representation (CBOR) is a data format whose design goals include the possibility of extremely small code size, fairly small message size, and extensibility without the need for version negotiation. [1] This [2] C-implementation fits in under 1KiB of ARM code. [1]: https://cbor.io/ https://cbor.io/ [2]: https://github.com/cabo/cn-cbor https://github.com/cabo/cn-cbor
- RantyDave 7y agoI, too, love cbor. https://github.com/RantyDave/cppbor https://github.com/RantyDave/cppbor
- jopsen 7y agoCBOR is also used on WebAuthn, usage in a web spec means to me that someone smart considered it a sane choice -- and more importantly that the format is here to stay.
- SlowRobotAhead 7y agoCBOR’s RFC: https://tools.ietf.org/html/rfc7049 https://tools.ietf.org/html/rfc7049 And Amazon has picked it up as a first class citizen in some of their IoT Core features. It’s definitely here to stay.
- kbumsik 7y agoIt's great CBOR is accepted in wider area, but I am personally curious why WebAuthn choose CBOR instead of JSON. WebAuthn is a web browser feature, and why W3C would introduce a new data exchange format in their specs? Maybe WebAuthn needed a binary data type?
- jopsen 7y agoI'm guessing a binary format is nice when interacting with a device.. Anybody know if (and why) U2F uses CBOR?
- justinmk 7y ago> MessagePack ... official C library was not optimized for memory usage and code size But libmpack is: https://github.com/libmpack/libmpack https://github.com/libmpack/libmpack - libmpack serialization/deserialization API is callback-based, making it simple to serialize/deserialize directly from/to application-specific objects - libmpack does no allocation at all, and provides some helpers to simplify dynamic allocation by the user, if required. - C89