Functions to initialize the driver.

How to initialise the driver. More...

Collaboration diagram for Functions to initialize the driver.:

Functions
tsl2591_returnCode_t	tsl2591_initialise (void(*callBack)(tsl2591_returnCode_t))
	Initialise the driver. More...
tsl2591_returnCode_t	tsl2591_destroy (void)
	Destroy the TSL2591 driver. More...

Detailed Description

How to initialise the driver.

Function Documentation

tsl2591_destroy()

tsl2591_returnCode_t tsl2591_destroy

(

void

)

Destroy the TSL2591 driver.

Destroys the driver after use. The HEAP memory used for the driver will be freed again.

Note

The driver should only be destroyed when it is not needed anymore.

Returns

tsl2591_returnCode_t

Return values

TSL2591_OK	The driver is destroyed.
TSL2591_DRIVER_NOT_INITIALISED	The driver must be initialised before it can be destroyed.

tsl2591_initialise()

tsl2591_returnCode_t tsl2591_initialise

(

void(*)(tsl2591_returnCode_t)

callBack

)

Initialise the driver.

Initialise the TSL2591 Driver.

Note

This function will only initialise the driver! Be sure to enabled/powered up (tsl2591_enable) the sensor before it can perform measuring's.

Parameters

[in]

callBack

function pointer to call back function, or NULL if no call back function is used.

The call back function must have this signature:

void function_name(tsl2591_returnCode_t rc)

The callback function will be called every time a command involving communication with the sensor is completed.