ESPHome  2024.11.0
Public Member Functions | Data Fields
esphome::opentherm::OpenthermData Struct Reference

Structure to hold Opentherm data packet content. More...

#include <opentherm.h>

Public Member Functions

 OpenthermData ()
 
float f88 ()
 
void f88 (float value)
 
uint16_t u16 ()
 
void u16 (uint16_t value)
 
int16_t s16 ()
 
void s16 (int16_t value)
 

Data Fields

uint8_t type
 
uint8_t id
 
uint8_t valueHB
 
uint8_t valueLB
 

Detailed Description

Structure to hold Opentherm data packet content.

Use f88(), u16() or s16() functions to get appropriate value of data packet accoridng to id of message.

Definition at line 176 of file opentherm.h.

Constructor & Destructor Documentation

◆ OpenthermData()

esphome::opentherm::OpenthermData::OpenthermData ( )
inline

Definition at line 182 of file opentherm.h.

Member Function Documentation

◆ f88() [1/2]

float esphome::opentherm::OpenthermData::f88 ( )
Returns
float representation of data packet value

Definition at line 573 of file opentherm.cpp.

◆ f88() [2/2]

void esphome::opentherm::OpenthermData::f88 ( float  value)
Parameters
floatnumber to set as value of this data packet

Definition at line 575 of file opentherm.cpp.

◆ s16() [1/2]

int16_t esphome::opentherm::OpenthermData::s16 ( )
Returns
signed 16b integer representation of data packet value

Definition at line 587 of file opentherm.cpp.

◆ s16() [2/2]

void esphome::opentherm::OpenthermData::s16 ( int16_t  value)
Parameters
signed16b integer number to set as value of this data packet

Definition at line 592 of file opentherm.cpp.

◆ u16() [1/2]

uint16_t esphome::opentherm::OpenthermData::u16 ( )
Returns
unsigned 16b integer representation of data packet value

Definition at line 577 of file opentherm.cpp.

◆ u16() [2/2]

void esphome::opentherm::OpenthermData::u16 ( uint16_t  value)
Parameters
unsigned16b integer number to set as value of this data packet

Definition at line 582 of file opentherm.cpp.

Field Documentation

◆ id

uint8_t esphome::opentherm::OpenthermData::id

Definition at line 178 of file opentherm.h.

◆ type

uint8_t esphome::opentherm::OpenthermData::type

Definition at line 177 of file opentherm.h.

◆ valueHB

uint8_t esphome::opentherm::OpenthermData::valueHB

Definition at line 179 of file opentherm.h.

◆ valueLB

uint8_t esphome::opentherm::OpenthermData::valueLB

Definition at line 180 of file opentherm.h.


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