Skip to main content

openember-msgs protocol

openember-msgs is the shared message-protocol repository for OpenEmber and EmberLite. It holds .proto definitions, Nanopb options, and generation entry points — not the runtimes themselves.

Core principles:

  • Versioned separately: message definitions are maintained and tagged in openember-msgs.
  • Runtime-specific bindings: OpenEmber uses C++ Protobuf; EmberLite uses Nanopb C.
  • Zenoh routes, Protobuf shapes: Zenoh keys decide where messages go; Protobuf types define payload layout.
  • No copied protos: OpenEmber and EmberLite should not each maintain a private .proto tree.

Current packages​

PackagePurpose
common/v1Shared types (Header, Status, QosProfile, Metric, BoolStamped, …)
node/v1Node info, heartbeat, registry
lifecycle/v1Lifecycle state and transitions
diagnostics/v1Health / diagnostics
parameter/v1Parameter get/set/events
log/v1Structured logs
device/v1Device info and status
runtime/v1Process start/stop events
sensor/v1IMU, temperature, GNSS samples and status; generic ScalarSample
actuator/v1Joint commands, state, actuator health
power/v1Battery / power state and control
geometry/v1Planar pose and twist (Pose2D, Twist2D; see Turtle Demo)
host/v1Host resource snapshot (HostResourceSnapshot: CPU / memory / load / disk; published by services/host_monitor on /host/resources)

Shared helper types​

TypePackagePurpose
BoolStampedcommon/v1Header-stamped boolean (e-stop, enable flags, …)
ScalarSamplesensor/v1Header-stamped scalar: quantity + value + unit (humidity, illuminance, soil moisture, CO₂, … when no dedicated type exists yet)

These are cross-product helpers, not tied to a single demo. Source of truth: the corresponding .proto files in openember-msgs.

Both OpenEmber and EmberLite gate protocol generation with OPENEMBER_ENABLE_MSGS. Source selection is FETCH (default, pulls main) or LOCAL (path via OPENEMBER_MSGS_LOCAL_SOURCE).

Where to configure​

In OpenEmber Kconfig:

Communication / Messages

Typical CMake overrides:

cmake -S . -B build \
-DOPENEMBER_MSGS_SOURCE=LOCAL \
-DOPENEMBER_MSGS_LOCAL_SOURCE=/path/to/openember-msgs

Disable when unused:

cmake -S . -B build -DOPENEMBER_ENABLE_MSGS=OFF