Skip to main content

Sensor

Struct Sensor 

Source
pub struct Sensor {
    pub id: String,
    pub reading: Reading,
    pub battery: Option<f32>,
    pub mode: Mode,
    pub history: Vec<f32>,
    pub events: Vec<EventRecord>,
    pub peer: Option<String>,
    pub lat: Option<f64>,
    pub lon: Option<f64>,
}
Expand description

A single sensor: its current reading, recent history, power, and recent events.

Fields§

§id: String

A stable, human-readable sensor identifier, such as "fridge-1".

§reading: Reading

The sensor’s current reading.

§battery: Option<f32>

The sensor’s battery state of charge in [0.0, 1.0], if it has one.

§mode: Mode

The work cadence the sensor’s node is running at.

§history: Vec<f32>

Recent values of the reading, oldest first, for a sparkline and min/max.

§events: Vec<EventRecord>

The most recent telemetry events for this sensor, newest first.

§peer: Option<String>

The mesh peer (node or station) that hosts this sensor, if any. Sensors sharing a peer name are drawn on one node in the mesh map; an empty peer is the node itself.

§lat: Option<f64>

The sensor’s (or its hosting peer’s) latitude in decimal degrees, if known. When set with lon the mesh map can place the peer by real position.

§lon: Option<f64>

The sensor’s (or its hosting peer’s) longitude in decimal degrees, if known.

Implementations§

Source§

impl Sensor

Source

pub fn new(id: impl Into<String>, reading: Reading) -> Self

Creates a sensor with an id and current reading, no battery, history, or events yet.

§Arguments
  • id - the stable sensor identifier.
  • reading - the sensor’s current reading.
§Returns

An Mode::Active sensor carrying just the reading.

Source

pub fn on_peer(self, peer: impl Into<String>) -> Self

Sets the mesh peer (node or station) that hosts this sensor.

§Arguments
  • peer - the host peer’s name.
§Returns

The sensor, for chaining.

Source

pub fn at(self, lat: f64, lon: f64) -> Self

Sets the sensor’s (or its hosting peer’s) geographic position.

§Arguments
  • lat - latitude in decimal degrees.
  • lon - longitude in decimal degrees.
§Returns

The sensor, for chaining.

Trait Implementations§

Source§

impl Clone for Sensor

Source§

fn clone(&self) -> Sensor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Sensor

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Sensor

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Sensor

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for Sensor

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Sensor

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.