Struct Condition 

pub struct Condition {
    pub topic: String,
    pub compare: Compare,
    pub threshold: f32,
    pub hysteresis: f32,
}

A line drawn through one topic’s readings, with the release band that stops it firing over and over.

In a rule file it is the when object, which names the line with below or above:

{ "topic": "garden/bed-1/moisture", "below": 30.0, "hysteresis": 5.0 }

The condition becomes true the moment a reading crosses the threshold in the named direction, and stops holding once a reading has come back past the threshold by the hysteresis; readings in between leave it as it was. That is a Trigger, and trigger builds it.

Fields

topic: String

The topic whose readings are watched, exactly as the node publishes to it.

compare: Compare

Which side of the threshold the condition holds on.

threshold: f32

The line a reading crosses.

hysteresis: f32

How far back past the line a reading must come for the condition to clear.

Implementations

impl Condition

pub fn above(topic: impl Into<String>, threshold: f32) -> Self

A condition that holds while a topic’s readings are above a line.

Arguments

• topic - the topic whose readings are watched.
• threshold - the line.

Returns

The condition, with no release band yet.

pub fn below(topic: impl Into<String>, threshold: f32) -> Self

A condition that holds while a topic’s readings are below a line.

Arguments

• topic - the topic whose readings are watched.
• threshold - the line.

Returns

The condition, with no release band yet.

pub fn with_hysteresis(self, hysteresis: f32) -> Self

Sets the release band on the far side of the line.

Arguments

• hysteresis - how far back past the line a reading must come to clear the condition.

Returns

The condition, for chaining.

pub fn trigger(&self) -> Trigger

Builds the trigger that decides this condition, reading by reading.

Returns

A trigger that starts cleared.

Trait Implementations

impl Clone for Condition

fn clone(&self) -> Condition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Condition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Condition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Condition

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Condition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Condition