Struct Version1DataFrame

pub struct Version1DataFrame {
    pub system_secs: u32,
    pub system_millis: u16,
    pub system_nanos: u16,
    pub global_sequence: u32,
    pub sensor_sequence: u32,
    pub sensor_tag: u16,
    pub value: SensorData,
}

A sensor data frame.

Fields

system_secs: u32

A time in seconds since begin of a measurement, or since startup time.

If unsupported, set to u32::MAX.

system_millis: u16

The sub-second milliseconds.

If unsupported, set to u16::MAX.

system_nanos: u16

The sub-millisecond nanoseconds.

If unsupported, set to u16::MAX.

global_sequence: u32

A sequence identifier, monotonically increasing.

This value can be used to detect package loss on the receiver side. It should increase on every transmitted package, across all sensor.

If unsupported, set to u32::MAX.

sensor_sequence: u32

A sensor sequence identifier, monotonically increasing.

This value should increase whenever new data became available for the specific sensor, not when it was actually transmitted.

If unsupported, set to u32::MAX.

sensor_tag: u16

A device-specific tag for a specific sensor.

This value should be identical across all readings from the same sensor. This is to ensure that multiple sensors of the same type, e.g. multiple accelerometers, can be told apart on the host side.

value: SensorData

The sensor reading.

Implementations

impl Version1DataFrame

pub fn new<D>( system_secs: u32, system_millis: u16, system_nanos: u16, global_sequence: u32, sensor_sequence: u32, sensor_tag: u16, value: D, ) -> Self

where D: Into<SensorData>,

Creates a new instance of the version 1 data frame.

pub const fn new_with( system_secs: u32, system_millis: u16, system_nanos: u16, global_sequence: u32, sensor_sequence: u32, sensor_tag: u16, value: SensorData, ) -> Self

Creates a new instance of the version 1 data frame.

Trait Implementations

impl Clone for Version1DataFrame

fn clone(&self) -> Version1DataFrame

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DataFrame for Version1DataFrame

type ProtocolVersion = Version1

The protocol version used by this data frame.

fn is_meta(&self) -> bool

Indicates whether the data resembles metadata.

fn target(&self) -> SensorId

Gets the target Sensor ID for this frame. This takes care of handling metadata frames correctly, as they embed their target IDs.

fn into_versioned(self) -> VersionedDataFrame<Self::ProtocolVersion, Self>

Wraps this data frame into a VersionedDataFrame using the specified ProtocolVersion.

impl Debug for Version1DataFrame

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decode for Version1DataFrame

fn decode<__D: Decoder>(decoder: &mut __D) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Encode for Version1DataFrame

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl Format for Version1DataFrame

where SensorData: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl From<&Version1DataFrame> for SensorId

fn from(value: &Version1DataFrame) -> Self

Converts to this type from the input type.

impl PartialEq for Version1DataFrame

fn eq(&self, other: &Version1DataFrame) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Version1DataFrame> for AccelerometerI16

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Version1DataFrame) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Version1DataFrame> for EulerAnglesF32

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Version1DataFrame) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Version1DataFrame> for GyroscopeI16

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Version1DataFrame) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Version1DataFrame> for HeadingI16

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Version1DataFrame) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Version1DataFrame> for Identification

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Version1DataFrame) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Version1DataFrame> for LinearRangeInfo

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Version1DataFrame) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Version1DataFrame> for MagnetometerI16

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Version1DataFrame) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Version1DataFrame> for OrientationQuaternionF32

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Version1DataFrame) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Version1DataFrame> for SystemClockFrequency

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Version1DataFrame) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Version1DataFrame> for TemperatureI16

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Version1DataFrame) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Version1DataFrame