DlnI2cMasterRead() Function

The DlnI2cMasterRead() function reads data from the specified I²C slave device.

Syntax

C/C++

DLN_RESULT DlnI2cMasterRead(
   HDLN handle,
   uint8_t port,
   uint8_t slaveDeviceAddress,
   uint8_t memoryAddressLength,
   uint32_t memoryAddress,
   uint16_t bufferLength,
   uint8_t* buffer
);

Parameters

handle: A handle to the DLN-series adapter.
port: A number of the I²C master port.
slaveDeviceAddress: A 7-bit number, assigned to each I²C slave device. For additional details refer to the I²C slave address section.
memoryAddressLength: An internal address length. If set to zero, no internal address is sent.
memoryAddress: An internal I²C slave device address. For details, read Using Internal Addresses.
bufferLength: The size of the message buffer (in the range from 1 to 256 bytes).
buffer: A pointer to an array of unsigned 8-bit integers that receives data from the I²C slave device during the function execution. The array must contain at least bufferLength elements.

Return Value

DLN_RES_SUCCESS (0x00): The function executed the I²C read operation successfully.
DLN_RES_INVALID_PORT_NUMBER (0xA8): The port number is not valid. Use the DlnI2cMasterGetPortCount() function to find the maximum possible port number.
DLN_RES_DISABLED (0xB7): The function cannot execute the I²C read operation because the specified I²C master port is not active. Use the DlnI2cMasterEnable()function to activate the I²C master port.

Remarks

The DlnI2cMasterRead() function is defined in the dln_i2c_master.h file.