Logo
UNICENS V2.3.0-4567
User Manual and API Reference
Ucs_Return_t Ucs_I2c_ReadPort ( Ucs_Inst_t self,
uint16_t  node_address,
uint16_t  port_handle,
uint8_t  slave_address,
uint8_t  data_len,
uint16_t  timeout,
Ucs_I2c_ReadPortResCb_t  result_fptr 
)

Reads a block of bytes from an I2C device at a specified I2C address.

 This function corresponds with the INIC function INIC.I2CPortRead.
Parameters
selfThe UNICENS instance pointer
node_addressAddress of the target device. Use the UCS_ADDR_LOCAL_NODE macro to target the local device.
The following address ranges are supported:
  • [0x10 ... 0x2FF]
  • [0x500 ... 0xFEF]
  • UCS_ADDR_LOCAL_NODE
port_handlePort resource handle.
 I2CPortHandle
slave_addressThe 7-bit I2C slave address of the peripheral to be read.
 SlaveAddress
data_lenNumber of bytes to be read from the address.
 Length
timeoutThe timeout for the I2C Port read.
 Timeout
result_fptrRequired result callback function pointer.
Returns
Possible return values are shown in the table below.
Value Description
UCS_RET_SUCCESS No error
UCS_RET_ERR_PARAM At least one parameter is wrong.
UCS_RET_ERR_BUFFER_OVERFLOW No message buffer is available.
UCS_RET_ERR_API_LOCKED API is currently locked.
UCS_RET_ERR_NOT_SUPPORTED API is not supported in the current Network Supervisor Mode.
UCS_RET_ERR_NOT_INITIALIZED UNICENS is not initialized.
 See also section Example for Ucs_I2c_ReadPort for an example implementation.