IoT Drivers  v3.3.0 (S2022)
Engineering in Software Technology
Functions to initialize the driver.

How to initialise the driver. More...

Collaboration diagram for Functions to initialize the driver.:

Functions

hih8120_driverReturnCode_t hih8120_initialise (void)
 Initialise the HIH8120 driver. More...
 
hih8120_driverReturnCode_t hih8120_destroy (void)
 Destroy the HIH8120 driver. More...
 

Detailed Description

How to initialise the driver.

Function Documentation

◆ hih8120_destroy()

hih8120_driverReturnCode_t hih8120_destroy ( void  )

Destroy the HIH8120 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
hih8120DriverReturnCode_t
Return values
HIH8120_OKThe driver is destroyed.
HIH8120_DRIVER_NOT_INITIALISEDThe driver must be initialised before it can be destroyed.

◆ hih8120_initialise()

hih8120_driverReturnCode_t hih8120_initialise ( void  )

Initialise the HIH8120 driver.

Initialise the driver.

Note
The driver must be destroyed when it is not needed anymore
See also
hih8120_destroy.
Returns
hih8120DriverReturnCode_t
Return values
HIH8120_OKThe driver is initialised.
HIH8120_OUT_OF_HEAPThere is not enough HEAP memory to initialise the driver.