HF Interface Wrapper 0.1.0-dev
Embedded C++ hardware abstraction layer
Loading...
Searching...
No Matches
hf_i2c_custom_command_t Struct Reference

Custom I2C command for non-standard protocols. More...

#include <EspTypes_I2C.h>

Public Member Functions

 hf_i2c_custom_command_t (hf_i2c_command_type_t type, uint16_t addr=0) noexcept
 Constructor for basic command.
 
 hf_i2c_custom_command_t (uint32_t delay_microseconds) noexcept
 Constructor for delay command.
 

Public Attributes

hf_i2c_command_type_t command_type
 Command type.
 
uint16_t device_addr
 Device address for the command.
 
std::vector< uint8_t > data
 Command data (if applicable)
 
uint32_t delay_us
 Delay in microseconds (for DELAY command)
 
uint32_t timeout_ms
 Timeout for the command.
 
size_t expected_read_size
 Expected read size for READ commands.
 
uint32_t flags
 Command-specific flags.
 

Detailed Description

Custom I2C command for non-standard protocols.

Provides flexibility for implementing custom I2C sequences.

Constructor & Destructor Documentation

◆ hf_i2c_custom_command_t() [1/2]

hf_i2c_custom_command_t::hf_i2c_custom_command_t ( hf_i2c_command_type_t type,
uint16_t addr = 0 )
inlineexplicitnoexcept

Constructor for basic command.

◆ hf_i2c_custom_command_t() [2/2]

hf_i2c_custom_command_t::hf_i2c_custom_command_t ( uint32_t delay_microseconds)
inlineexplicitnoexcept

Constructor for delay command.

Member Data Documentation

◆ command_type

hf_i2c_command_type_t hf_i2c_custom_command_t::command_type

Command type.

◆ data

std::vector<uint8_t> hf_i2c_custom_command_t::data

Command data (if applicable)

◆ delay_us

uint32_t hf_i2c_custom_command_t::delay_us

Delay in microseconds (for DELAY command)

◆ device_addr

uint16_t hf_i2c_custom_command_t::device_addr

Device address for the command.

◆ expected_read_size

size_t hf_i2c_custom_command_t::expected_read_size

Expected read size for READ commands.

◆ flags

uint32_t hf_i2c_custom_command_t::flags

Command-specific flags.

◆ timeout_ms

uint32_t hf_i2c_custom_command_t::timeout_ms

Timeout for the command.


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