Struct riot_sys::phydat_t

source ·
#[repr(C)]
pub struct phydat_t { pub val: [i16; 3], pub unit: u8, pub scale: i8, }
Expand description

@brief Generic data structure for expressing physical values

Physical data is expressed in a 3-dimensional tuple of values. In addition to the data fields, this struct contains further the (physical) unit and the scale factor of the data. The unit is expressed as constant. The scale factor is expressed as power of 10 (10^factor).

The combination of signed 16-bit numbers with and the scale factor gives us a very high dynamic range (from -3210^-131 to 3210^130). In a wider sense we are saving the values as fixed floating points…

The scale factor is identical for all 3 values.

In a traditional (scientific) computational system the obvious choice for the used data type would be to use floats. We are however on heavily resource constrained (even 8-bit) embedded systems, so we use int16_t here. As most sensor are in some way ADC based, they normally do not use a higher accuracy than 12-14bit, so using 16-bit integers to represent this data is good enough in most cases.

Fields§

§val: [i16; 3]

< the 3 generic dimensions of data

§unit: u8

< the (physical) unit of the data

§scale: i8

< the scale factor, 10^scale

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.