What the hub has read from one heater so far. More...

#include <proto_heating.h>

Collaboration diagram for esphome::home_io_control::HeatingReadings:

Public Member Functions
bool	store (HeatingFunction fn, float value)
	Fold one decoded register value into the readings.
bool	has (HeatingFunction fn) const
	Has this register been read yet?

Public Attributes
float	room_temperature_c {NAN}
	Measured room temperature; NaN until read or on a sensor fault.
float	setpoint_c {NAN}
	Comfort setpoint as the heater holds it; NaN until read.
float	max_setpoint_c {NAN}
	Highest setpoint the heater accepts; NaN until read.
int16_t	mode {-1}
	HeatingMode value; -1 until read.
int16_t	regulator {-1}
	HeatingRegulatorState value; -1 until read.
int16_t	window_open {-1}
	0 closed / 1 open; -1 until read.
int16_t	open_window_detection {-1}
	1 detection on / 0 off; -1 until read.
int16_t	level {-1}
	Low byte of the main parameter of a heater commanded with a prefixed value: a heating level, or a setpoint alias.
int32_t	main_parameter {-1}
	The raw current main parameter of a heater commanded with an EXECUTE (a temperature, an alias or a level); -1 until a status reply carried one.

Detailed Description

What the hub has read from one heater so far.

Every field starts as "never read" (NaN, or -1 for the byte registers). Only a decoded reply changes a field, so what an entity shows from here is observed, never predicted.

Definition at line 178 of file proto_heating.h.

Member Function Documentation

◆ has()

bool esphome::home_io_control::HeatingReadings::has ( HeatingFunction fn ) const

nodiscard

Has this register been read yet?

Parameters

fn Register.

Returns: true when the readings hold a value for fn; false for "never read" and for a function the readings do not hold.

Definition at line 279 of file proto_heating.cpp.

◆ store()

bool esphome::home_io_control::HeatingReadings::store	(	HeatingFunction	fn,
		float	value )

Fold one decoded register value into the readings.

Parameters

fn	Register the value was read from.
value	Value as returned by decode_heating_reply().

Returns: true when fn is a register the readings hold (and the field was set).

Definition at line 248 of file proto_heating.cpp.

Member Data Documentation

◆ level

int16_t esphome::home_io_control::HeatingReadings::level {-1}

Low byte of the main parameter of a heater commanded with a prefixed value: a heating level, or a setpoint alias.

-1 until a status reply carried one, and again after a reply that carried a plain temperature. Set by the hub's status path, not by store().

Definition at line 186 of file proto_heating.h.

◆ main_parameter

int32_t esphome::home_io_control::HeatingReadings::main_parameter {-1}

The raw current main parameter of a heater commanded with an EXECUTE (a temperature, an alias or a level); -1 until a status reply carried one.

Set by the hub's status path, not by store().

Definition at line 190 of file proto_heating.h.

◆ max_setpoint_c

float esphome::home_io_control::HeatingReadings::max_setpoint_c {NAN}

Highest setpoint the heater accepts; NaN until read.

Definition at line 181 of file proto_heating.h.

◆ mode

int16_t esphome::home_io_control::HeatingReadings::mode {-1}

HeatingMode value; -1 until read.

Definition at line 182 of file proto_heating.h.

◆ open_window_detection

int16_t esphome::home_io_control::HeatingReadings::open_window_detection {-1}

1 detection on / 0 off; -1 until read.

Definition at line 185 of file proto_heating.h.

◆ regulator

int16_t esphome::home_io_control::HeatingReadings::regulator {-1}

HeatingRegulatorState value; -1 until read.

Definition at line 183 of file proto_heating.h.

◆ room_temperature_c

float esphome::home_io_control::HeatingReadings::room_temperature_c {NAN}

Measured room temperature; NaN until read or on a sensor fault.

Definition at line 179 of file proto_heating.h.

◆ setpoint_c

float esphome::home_io_control::HeatingReadings::setpoint_c {NAN}

Comfort setpoint as the heater holds it; NaN until read.

Definition at line 180 of file proto_heating.h.

◆ window_open

int16_t esphome::home_io_control::HeatingReadings::window_open {-1}

0 closed / 1 open; -1 until read.

Definition at line 184 of file proto_heating.h.

The documentation for this struct was generated from the following files:

components/home_io_control/proto_heating.h
components/home_io_control/proto_heating.cpp

Public Member Functions

Public Attributes