ESPHome  2024.6.1
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
esphome::remote_base::ABBWelcomeData Class Reference

#include <abbwelcome_protocol.h>

Public Member Functions

 ABBWelcomeData ()
 
 ABBWelcomeData (std::initializer_list< uint8_t > data)
 
 ABBWelcomeData (const std::vector< uint8_t > &data)
 
 ABBWelcomeData (const ABBWelcomeData &)=default
 
uint8_t * data ()
 
const uint8_t * data () const
 
uint8_t size () const
 
bool is_valid () const
 
void set_retransmission (bool retransmission)
 
bool get_retransmission () const
 
void set_three_byte_address (bool three_byte_address)
 
uint8_t get_three_byte_address () const
 
uint8_t get_address_length () const
 
void set_message_type (uint8_t message_type)
 
uint8_t get_message_type () const
 
void set_destination_address (uint32_t address)
 
uint32_t get_destination_address () const
 
void set_source_address (uint32_t address)
 
uint32_t get_source_address () const
 
void set_message_id (uint8_t message_id)
 
uint8_t get_message_id () const
 
void set_data (std::vector< uint8_t > data)
 
std::vector< uint8_t > get_data () const
 
uint8_t get_data_size () const
 
void finalize ()
 
std::string to_string (uint8_t max_print_bytes=255) const
 
bool operator== (const ABBWelcomeData &rhs) const
 
uint8_t & operator[] (size_t idx)
 
const uint8_t & operator[] (size_t idx) const
 

Data Fields

bool auto_message_id {false}
 

Protected Member Functions

uint8_t calc_cs_ () const
 

Protected Attributes

std::array< uint8_t, 12+MAX_DATA_LENGTH > data_
 

Detailed Description

Definition at line 33 of file abbwelcome_protocol.h.

Constructor & Destructor Documentation

◆ ABBWelcomeData() [1/4]

esphome::remote_base::ABBWelcomeData::ABBWelcomeData ( )
inline

Definition at line 36 of file abbwelcome_protocol.h.

◆ ABBWelcomeData() [2/4]

esphome::remote_base::ABBWelcomeData::ABBWelcomeData ( std::initializer_list< uint8_t >  data)
inline

Definition at line 42 of file abbwelcome_protocol.h.

◆ ABBWelcomeData() [3/4]

esphome::remote_base::ABBWelcomeData::ABBWelcomeData ( const std::vector< uint8_t > &  data)
inline

Definition at line 47 of file abbwelcome_protocol.h.

◆ ABBWelcomeData() [4/4]

esphome::remote_base::ABBWelcomeData::ABBWelcomeData ( const ABBWelcomeData )
default

Member Function Documentation

◆ calc_cs_()

uint8_t esphome::remote_base::ABBWelcomeData::calc_cs_ ( ) const
protected

Definition at line 14 of file abbwelcome_protocol.cpp.

◆ data() [1/2]

uint8_t* esphome::remote_base::ABBWelcomeData::data ( )
inline

Definition at line 56 of file abbwelcome_protocol.h.

◆ data() [2/2]

const uint8_t* esphome::remote_base::ABBWelcomeData::data ( ) const
inline

Definition at line 57 of file abbwelcome_protocol.h.

◆ finalize()

void esphome::remote_base::ABBWelcomeData::finalize ( )
inline

Definition at line 137 of file abbwelcome_protocol.h.

◆ get_address_length()

uint8_t esphome::remote_base::ABBWelcomeData::get_address_length ( ) const
inline

Definition at line 85 of file abbwelcome_protocol.h.

◆ get_data()

std::vector<uint8_t> esphome::remote_base::ABBWelcomeData::get_data ( ) const
inline

Definition at line 129 of file abbwelcome_protocol.h.

◆ get_data_size()

uint8_t esphome::remote_base::ABBWelcomeData::get_data_size ( ) const
inline

Definition at line 134 of file abbwelcome_protocol.h.

◆ get_destination_address()

uint32_t esphome::remote_base::ABBWelcomeData::get_destination_address ( ) const
inline

Definition at line 98 of file abbwelcome_protocol.h.

◆ get_message_id()

uint8_t esphome::remote_base::ABBWelcomeData::get_message_id ( ) const
inline

Definition at line 121 of file abbwelcome_protocol.h.

◆ get_message_type()

uint8_t esphome::remote_base::ABBWelcomeData::get_message_type ( ) const
inline

Definition at line 87 of file abbwelcome_protocol.h.

◆ get_retransmission()

bool esphome::remote_base::ABBWelcomeData::get_retransmission ( ) const
inline

Definition at line 74 of file abbwelcome_protocol.h.

◆ get_source_address()

uint32_t esphome::remote_base::ABBWelcomeData::get_source_address ( ) const
inline

Definition at line 114 of file abbwelcome_protocol.h.

◆ get_three_byte_address()

uint8_t esphome::remote_base::ABBWelcomeData::get_three_byte_address ( ) const
inline

Definition at line 84 of file abbwelcome_protocol.h.

◆ is_valid()

bool esphome::remote_base::ABBWelcomeData::is_valid ( ) const
inline

Definition at line 62 of file abbwelcome_protocol.h.

◆ operator==()

bool esphome::remote_base::ABBWelcomeData::operator== ( const ABBWelcomeData rhs) const
inline

Definition at line 162 of file abbwelcome_protocol.h.

◆ operator[]() [1/2]

uint8_t& esphome::remote_base::ABBWelcomeData::operator[] ( size_t  idx)
inline

Definition at line 170 of file abbwelcome_protocol.h.

◆ operator[]() [2/2]

const uint8_t& esphome::remote_base::ABBWelcomeData::operator[] ( size_t  idx) const
inline

Definition at line 171 of file abbwelcome_protocol.h.

◆ set_data()

void esphome::remote_base::ABBWelcomeData::set_data ( std::vector< uint8_t >  data)
inline

Definition at line 122 of file abbwelcome_protocol.h.

◆ set_destination_address()

void esphome::remote_base::ABBWelcomeData::set_destination_address ( uint32_t  address)
inline

Definition at line 88 of file abbwelcome_protocol.h.

◆ set_message_id()

void esphome::remote_base::ABBWelcomeData::set_message_id ( uint8_t  message_id)
inline

Definition at line 120 of file abbwelcome_protocol.h.

◆ set_message_type()

void esphome::remote_base::ABBWelcomeData::set_message_type ( uint8_t  message_type)
inline

Definition at line 86 of file abbwelcome_protocol.h.

◆ set_retransmission()

void esphome::remote_base::ABBWelcomeData::set_retransmission ( bool  retransmission)
inline

Definition at line 67 of file abbwelcome_protocol.h.

◆ set_source_address()

void esphome::remote_base::ABBWelcomeData::set_source_address ( uint32_t  address)
inline

Definition at line 104 of file abbwelcome_protocol.h.

◆ set_three_byte_address()

void esphome::remote_base::ABBWelcomeData::set_three_byte_address ( bool  three_byte_address)
inline

Definition at line 77 of file abbwelcome_protocol.h.

◆ size()

uint8_t esphome::remote_base::ABBWelcomeData::size ( ) const
inline

Definition at line 58 of file abbwelcome_protocol.h.

◆ to_string()

std::string esphome::remote_base::ABBWelcomeData::to_string ( uint8_t  max_print_bytes = 255) const
inline

Definition at line 145 of file abbwelcome_protocol.h.

Field Documentation

◆ auto_message_id

bool esphome::remote_base::ABBWelcomeData::auto_message_id {false}

Definition at line 54 of file abbwelcome_protocol.h.

◆ data_

std::array<uint8_t, 12 + MAX_DATA_LENGTH> esphome::remote_base::ABBWelcomeData::data_
protected

Definition at line 174 of file abbwelcome_protocol.h.


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