i2c_master_get_bus_handle() function

Retrieves the I2C master bus handle for a specified I2C port number. This function retrieves the I2C master bus handle for the given I2C port number. Please make sure the handle has already been initialized, and this function would simply returns the existing handle. Note that the returned handle still can't be used concurrently

Syntax

Show:

Summary

Declaration

Definition

from i2c_master.h:277

esp_err_t i2c_master_get_bus_handle(i2c_port_num_t port_num, i2c_master_bus_handle_t *ret_handle);

Implemented in i2c_master.c:1145

Arguments

Argument

Description

port_num

I2C port number for which the handle is to be retrieved.

ret_handle

Pointer to a variable where the retrieved handle will be stored.

Return value

- ESP_OK: Success. The handle is retrieved successfully. - ESP_ERR_INVALID_ARG: Invalid argument, such as invalid port number - ESP_ERR_INVALID_STATE: Invalid state, such as the I2C port is not initialized.

Examples

References

from examples

i2c_master_get_bus_handle() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle