i2c_master_read_from_device() function

Perform a read to a device connected to a particular I2C port. This function is a wrapper to `i2c_master_start()`, `i2c_master_write()`, `i2c_master_read()`, etc... It shall only be called in I2C master mode.

Syntax

Show:

Summary

Declaration

Definition

from i2c.h:214

esp_err_t i2c_master_read_from_device(i2c_port_t i2c_num, uint8_t device_address, uint8_t* read_buffer, size_t read_size, TickType_t ticks_to_wait);

Implemented in i2c.c:1060

Arguments

Argument

Declared as

Description

i2c_num

i2c_port_t

I2C port number to perform the transfer on

device_address

uint8_t

I2C device's 7-bit address

read_buffer

uint8_t*

Buffer to store the bytes received on the bus

read_size

size_t

Size, in bytes, of the read buffer

ticks_to_wait

TickType_t

Maximum ticks to wait before issuing a timeout.

Return value

- ESP_OK Success - ESP_ERR_INVALID_ARG Parameter error - ESP_FAIL Sending command error, slave hasn't ACK the transfer. - ESP_ERR_INVALID_STATE I2C driver not installed or not in master mode. - ESP_ERR_TIMEOUT Operation timeout because the bus is busy.