Skip to content

Home

Jump to bottom
Rylan Meilutis edited this page Feb 10, 2026 · 14 revisions

Sedsprintf_rs Documentation

Sedsprintf_rs is a Rust telemetry transport and logging library with a shared schema, compact wire format, routing, and multi-language bindings (C/C++ and Python). It targets embedded and host environments and supports optional compression for senders and payloads.

See Changelogs for version highlights and release notes.

Start here (easy overview)

These pages are written for readers who want a clear mental model before digging into code.

How-to guides (practical steps)

Step-by-step setup and usage by language.

Technical reference (deep dive)

Detailed pages that describe internals, data structures, and formats.

Repo layout (high level)

  • src/ (source | mirror): core Rust library (schema, packet types, serialization, router/relay).
  • sedsprintf_macros/ (source | mirror): proc-macros that generate schema constants.
  • telemetry_config.json (source | mirror): schema source of truth (endpoints + data types).
  • build.rs (source | mirror): generates C header and Python .pyi from the schema.
  • C-Headers/ (source | mirror): generated C header (sedsprintf.h).
  • python-files/ (source | mirror): Python package assets and generated .pyi.
  • c-example-code/ (source | mirror) and python-example/ (source | mirror): runnable examples.

Data flow at a glance

log(data)        rx(bytes)
    |               |
    v               v
  Router <---- deserialize ---- wire ---- serialize ----> Router
    |  \                                         |  \
    |   \-- local endpoints                      |   \-- local endpoints
    |                                            |
    +-- tx(bytes) ------------------------------>+

Core ideas:

  • Telemetry packets carry a schema-defined type, endpoints, sender name, and payload.
  • Routers deliver packets to local endpoints and optionally relay them outward.
  • The schema (DataType/DataEndpoint) is generated from telemetry_config.json (source | mirror).

If you want an implementation-level tour, go to Technical-Architecture.

Clone this wiki locally