esphome::ir_rf_base::IrRfCallData Class Reference

Raw timings of a transmit call, in one of three caller-owned forms. More...

#include <ir_rf_base.h>

Inheritance diagram for esphome::ir_rf_base::IrRfCallData:

Public Member Functions
const std::vector< int32_t > &	get_raw_timings () const
	Get the raw timings (only valid if set via set_raw_timings)
bool	has_raw_timings () const
	Check if raw timings have been set (any format)
bool	is_packed () const
	Check if using packed data format.
bool	is_base64url () const
	Check if using base64url data format.
const std::string &	get_base64url_data () const
	Get the base64url data string.
const uint8_t *	get_packed_data () const
	Get packed data (only valid if set via set_raw_timings_packed)
uint16_t	get_packed_length () const
uint16_t	get_packed_count () const
uint32_t	get_repeat_count () const
	Get the repeat count.
bool	wants_api_reply () const
	True for a frame an API client is waiting on.

Protected Attributes
uint32_t	repeat_count_ {1}
api::APIConnection *	api_connection_ {nullptr}
const std::vector< int32_t > *	raw_timings_ {nullptr}
const std::string *	base64url_ptr_ {nullptr}
const uint8_t *	packed_data_ {nullptr}
uint16_t	packed_length_ {0}
uint16_t	packed_count_ {0}

Detailed Description

Raw timings of a transmit call, in one of three caller-owned forms.

Definition at line 30 of file ir_rf_base.h.

Member Function Documentation

get_base64url_data()

const std::string & esphome::ir_rf_base::IrRfCallData::get_base64url_data ( ) const

inline

Get the base64url data string.

Definition at line 43 of file ir_rf_base.h.

get_packed_count()

uint16_t esphome::ir_rf_base::IrRfCallData::get_packed_count ( ) const

inline

Definition at line 47 of file ir_rf_base.h.

get_packed_data()

const uint8_t * esphome::ir_rf_base::IrRfCallData::get_packed_data ( ) const

inline

Get packed data (only valid if set via set_raw_timings_packed)

Definition at line 45 of file ir_rf_base.h.

get_packed_length()

uint16_t esphome::ir_rf_base::IrRfCallData::get_packed_length ( ) const

inline

Definition at line 46 of file ir_rf_base.h.

get_raw_timings()

const std::vector< int32_t > & esphome::ir_rf_base::IrRfCallData::get_raw_timings ( ) const

inline

Get the raw timings (only valid if set via set_raw_timings)

Definition at line 33 of file ir_rf_base.h.

get_repeat_count()

uint32_t esphome::ir_rf_base::IrRfCallData::get_repeat_count ( ) const

inline

Get the repeat count.

Definition at line 49 of file ir_rf_base.h.

has_raw_timings()

bool esphome::ir_rf_base::IrRfCallData::has_raw_timings ( ) const

inline

Check if raw timings have been set (any format)

Definition at line 35 of file ir_rf_base.h.

is_base64url()

bool esphome::ir_rf_base::IrRfCallData::is_base64url ( ) const

inline

Check if using base64url data format.

Definition at line 41 of file ir_rf_base.h.

is_packed()

bool esphome::ir_rf_base::IrRfCallData::is_packed ( ) const

inline

Check if using packed data format.

Definition at line 39 of file ir_rf_base.h.

wants_api_reply()

bool esphome::ir_rf_base::IrRfCallData::wants_api_reply ( ) const

inline

True for a frame an API client is waiting on.

Definition at line 53 of file ir_rf_base.h.

Field Documentation

api_connection_

api::APIConnection* esphome::ir_rf_base::IrRfCallData::api_connection_ {nullptr}

protected

Definition at line 59 of file ir_rf_base.h.

base64url_ptr_

const std::string* esphome::ir_rf_base::IrRfCallData::base64url_ptr_ {nullptr}

protected

Definition at line 64 of file ir_rf_base.h.

packed_count_

uint16_t esphome::ir_rf_base::IrRfCallData::packed_count_ {0}

protected

Definition at line 68 of file ir_rf_base.h.

packed_data_

const uint8_t* esphome::ir_rf_base::IrRfCallData::packed_data_ {nullptr}

protected

Definition at line 66 of file ir_rf_base.h.

packed_length_

uint16_t esphome::ir_rf_base::IrRfCallData::packed_length_ {0}

protected

Definition at line 67 of file ir_rf_base.h.

raw_timings_

const std::vector<int32_t>* esphome::ir_rf_base::IrRfCallData::raw_timings_ {nullptr}

protected

Definition at line 62 of file ir_rf_base.h.

repeat_count_

uint32_t esphome::ir_rf_base::IrRfCallData::repeat_count_ {1}

protected

Definition at line 57 of file ir_rf_base.h.

---

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

• esphome/components/ir_rf_base/ir_rf_base.h