Symbols ![]()
loading...
Files ![]()
loading...
i2c_master_receive() function
Perform a read transaction on the I2C bus. The transaction will be undergoing until it finishes or it reaches the timeout provided.
Syntax
esp_err_t i2c_master_receive(i2c_master_dev_handle_t i2c_dev,
uint8_t *read_buffer,
size_t read_size,
int xfer_timeout_ms);
Implemented in ![]()
i2c_master.c:1221
Return value
- ESP_OK: I2C master receive success - ESP_ERR_INVALID_ARG: I2C master receive parameter invalid. - ESP_ERR_TIMEOUT: Operation timeout(larger than xfer_timeout_ms) because the bus is busy or hardware crash.
Notes
If a callback was registered with `i2c_master_register_event_callbacks`, the transaction will be asynchronous, and thus, this function will return directly, without blocking. You will get finish information from callback. Besides, data buffer should always be completely prepared when callback is registered, otherwise, the data will get corrupt.
Related Functions
Found 9 other functions taking a ![]()
i2c_master_dev_t
argument:
Function
Description
I2C master bus delete device
Add I2C master BUS device.
Perform a write-read transaction on the I2C bus. The transaction will be undergoing until it finishes or it reaches the timeout provided.
Transmit multiple buffers of data over an I2C bus. This function transmits multiple buffers of data over an I2C bus using the specified I2C master device handle. It takes in an array of buffer information structures along with the size of the array and a transfer timeout value in milliseconds.
Perform a write transaction on the I2C bus. The transaction will be undergoing until it finishes or it reaches the timeout provided.
Register I2C transaction callbacks for a master device