Crate serial_sensors_proto

serial-sensors-proto

A simple wire format for transmitting MEMS sensor data and friends.

The approach is threefold:

• The protocol is a little bit extensible in sensor and data types and supports 1-, 3- and 4-dimensional readings.
• Data packets are serialized using bincode first, then byte-stuffed using corncobs (i.e. using Consistent Overhead Byte Stuffing, COBS).

Crate features

• unsafe - Enables representation of fundamental data types as slices.
• micromath - Enables conversion to and from micromath vector types.
• quaternion - Forwarded to micromath to enable quaternion support.
• defmt - Enables deferred formatting support via defmt.

Modules

types

Provides standard sensor types.

versions

Versioned types.

Structs

Identifier

Identification data as UTF-8 bytes.

LinearRanges

Value interpretation information for linear value readings with uniform behavior across all axes.

ScalarData

Scalar data.

SensorId

Identifies a sensor. See also SensorIds.

SensorIds

Provides generic SensorId implementations.

Vector2Data

A two-dimensional vector.

Vector3Data

A three-dimensional vector.

Vector4Data

A four-dimensional vector, Quaternion, etc.

VersionedDataFrame

A versioned data frame.

Enums

ComponentLookupError

A component lookup error.

DeserializationError

A deserialization error.

IdentifierCode

Identifies the type of identifier.

SensorData

Data formats.

SerializationError

A serialization error.

ValueType

Sensor type tags.

Traits

CompileTimeTypeInformation

Sensor type information.

DataFrame

Marker type for data frames.

ProtocolVersion

A protocol version.

RuntimeTypeInformation

Sensor type information.

Functions

deserialize

Deserializes data after applying byte un-stuffing.

serialize

Serializes data and applies byte stuffing.