I2C Host

Description

Functions to setup and control I²C hosts.

All I²C host related functions require an I2C host handle to identify the I²C host, see opening a device.

Some I²C addresses may be reserved for internal use in the instrument, these addresses can not be controlled via the I²C host routines. Use I2CIsInternalAddress() to check whether an address is used internally.

Modules
	Reading data
	Functions to read data from an I2C device.
	Writing data
	Functions to write data to an I2C device.
	Speed
	Functions to control the I2C clock speed.

Functions
bool8_t	I2CIsInternalAddress (TpDeviceHandle_t hDevice, uint16_t wAddress)
	Check whether an address is used internally. More...

Function Documentation

bool8_t I2CIsInternalAddress	(	TpDeviceHandle_t	hDevice,
		uint16_t	wAddress
	)

Check whether an address is used internally.

Parameters

[in]	hDevice	A device handle identifying the I2C host.
[in]	wAddress	An I2C device address.

Returns

BOOL8_TRUE if the address is used internally, BOOL8_FALSE otherwise.

Status values

INVALID_HANDLE	The handle is not a valid I2C host handle.
DEVICE_GONE	The device indicated by the device handle is no longer available.
LIBRARY_NOT_INITIALIZED	The library is not initialized, see LibInit().
SUCCESS	The function executed successfully.

Since

0.4.0