Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 1.42 KB

README.md

File metadata and controls

32 lines (25 loc) · 1.42 KB

SBP JSON Comprehension Libraries

We have several tools that produce a representation of SBP in JSON format. Particularly, we have a native binary tool sbp2json, which is released as cross platform binaries (for example, see the "assets" of the libsbp 3.4.7 release). Also, since this tool is Rust based, it can be compiled and utilized on any platform that Rust supports.

For other platforms, we have a Python version of the sbp2json tool, which allows a user to simply run pip3 install sbp on any platform that supports Python. The user can then invoke the tool with Python's "module as a script" feature (PEP 338), for example:

socat tcp:<piksi_ip_addr>:55555 | python -m sbp2json

The libraries here are generated using JSON Schema in combination with the QuickType tool to injest the output of sbp2json and produce "native" objects which allow users to fully utilize whatever type checking their language provides. This also enables "developer assistance" technologies like IntelliSense for exploring SBP message types during development.

See javascript/README.md for a quick usage example. Also see HOWTO.md for information on how to update these definitions if needed.