Function esp_idf_sys::i2c_master_transmit
source ยท pub unsafe extern "C" fn i2c_master_transmit(
i2c_dev: i2c_master_dev_handle_t,
write_buffer: *const u8,
write_size: usize,
xfer_timeout_ms: c_int,
) -> esp_err_t
Expand description
@brief Perform a write transaction on the I2C bus. The transaction will be undergoing until it finishes or it reaches the timeout provided.
@note 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.
@param[in] i2c_dev I2C master device handle that created by i2c_master_bus_add_device
.
@param[in] write_buffer Data bytes to send on the I2C bus.
@param[in] write_size Size, in bytes, of the write buffer.
@param[in] xfer_timeout_ms Wait timeout, in ms. Note: -1 means wait forever.
@return
- ESP_OK: I2C master transmit success
- ESP_ERR_INVALID_ARG: I2C master transmit parameter invalid.
- ESP_ERR_TIMEOUT: Operation timeout(larger than xfer_timeout_ms) because the bus is busy or hardware crash.