Enum follow_heating::brain::modes::heating_mode::HeatingMode

pub enum HeatingMode {
    Off(OffMode),
    TurningOn(TurningOnMode),
    On(OnMode),
    Mixed(MixedMode),
    PreCirculate(PreCirculateMode),
    Equalise(EqualiseMode),
    TryCirculate(TryCirculateMode),
    Circulate(CirculateMode),
    DhwOnly(DhwOnlyMode),
}

Variants

Off(OffMode)

Everything off

TurningOn(TurningOnMode)

Heat pump turning on, pump going but no heating is happening.

On(OnMode)

Heat pump fully on, circulation pump also going.

Mixed(MixedMode)

Both heating and hot water.

PreCirculate(PreCirculateMode)

First step in chain PreCirculate -> TryCirculate -> Circulate Let heat dissipate slightly out of radiators before circulating

Equalise(EqualiseMode)

Circulate the heating but not the tank to get a good reading

TryCirculate(TryCirculateMode)

Circulate for a short time in order to get a good temperature reading

Circulate(CirculateMode)

Turn off the heat pump and run through tank until we reach the bottom of the working temperature.

DhwOnly(DhwOnlyMode)

Heat the hot water up to a certain temperature.

Implementations

impl HeatingMode

pub fn off() -> Self

pub fn update( &mut self, _shared_data: &mut SharedData, rt: &Runtime, config: &PythonBrainConfig, io_bundle: &mut IOBundle, info_cache: &mut InfoCache, time_provider: &impl TimeProvider ) -> Result<Option<HeatingMode>, BrainFailure>

pub fn enter( &mut self, config: &PythonBrainConfig, runtime: &Runtime, io_bundle: &mut IOBundle ) -> Result<(), BrainFailure>

pub fn exit_to( self, next_heating_mode: &HeatingMode, io_bundle: &mut IOBundle ) -> Result<(), BrainFailure>

pub fn transition_to( &mut self, to: HeatingMode, config: &PythonBrainConfig, rt: &Runtime, io_bundle: &mut IOBundle ) -> Result<(), BrainFailure>

pub fn get_entry_preferences(&self) -> &EntryPreferences

Trait Implementations

impl Debug for HeatingMode

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

Formats the value using the given formatter.

impl PartialEq for HeatingMode

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for HeatingMode