i2c_master_cmd_begin() function

Send all the queued commands on the I2C bus, in master mode. The task will be blocked until all the commands have been sent out. The I2C port is protected by mutex, so this function is thread-safe. This function shall only be called in I2C master mode.

Syntax

Show:

Summary

Declaration

Definition

from i2c.h:415

esp_err_t i2c_master_cmd_begin(i2c_port_t i2c_num, i2c_cmd_handle_t cmd_handle, TickType_t ticks_to_wait);

Implemented in i2c.c:1531

Arguments

Argument

Description

i2c_num

I2C port number

cmd_handle

I2C commands list

ticks_to_wait

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.

Examples

i2c_master_cmd_begin() is referenced by 7 libraries and example projects:

References

from examples

i2c_master_cmd_begin() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle