Symbols

loading...

Files

loading...

Summary Syntax Arguments References Call Tree Data Use

SourceVuESP-IDF Framework and ExamplesESP-IDFi2c_master_read_byte()

i2c_master_read_byte() function

Queue a "read byte" command to the commands list. A single byte will be read on the I2C bus. This function shall only be called in I2C master mode. Call `i2c_master_cmd_begin()` to send all queued commands

Syntax

Show:

Summary

Declaration

Definition

esp_err_t i2c_master_read_byte(i2c_cmd_handle_t cmd_handle, uint8_t *data, i2c_ack_type_t ack);

Implemented in i2c.c:1349

Arguments

Argument

Description

cmd_handle

I2C commands list

data

Pointer where the received byte will the stored. This buffer shall remain **valid** until the transaction is finished.

ack

ACK signal

Return value

- ESP_OK Success - ESP_ERR_INVALID_ARG Parameter error - ESP_ERR_NO_MEM The static buffer used to create `cmd_handler` is too small - ESP_FAIL No more memory left on the heap

References

Code

Location

Referrer

esp_err_t i2c_master_read_byte(i2c_cmd_handle_t cmd_handle, uint8_t *data, i2c_ack_type_t ack)

esp_err_t i2c_master_read_byte(i2c_cmd_handle_t cmd_handle, uint8_t *data, i2c_ack_type_t ack);

ret = i2c_master_read_byte(cmd_handle, data, I2C_MASTER_NACK);

i2c_master_read()

ret = i2c_master_read_byte(cmd_handle, data + data_len - 1, I2C_MASTER_NACK);

i2c_master_read()

Call Tree

i2c_master_read_byte() is called by 1 function and calls 3 functions:

i2c_master_read()

i2c_master_read_byte()

esp_log_timestamp()

esp_log_write()

i2c_cmd_link_append()

Data Use

i2c_master_read_byte() reads 9 variables:

esp_log_level_t::ESP_LOG_ERROR

esp_log_level_t::ESP_LOG_WARN

esp_log_level_t::ESP_LOG_INFO

esp_log_level_t::ESP_LOG_DEBUG

esp_log_level_t::ESP_LOG_VERBOSE

i2c_ack_type_t::I2C_MASTER_NACK

i2c_ack_type_t::I2C_MASTER_LAST_NACK

i2c_ack_type_t::I2C_MASTER_ACK_MAX

i2c_master_read_byte()

Class Tree

All items filtered out

All items filtered out

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Lifecycle

All items filtered out

All items filtered out