ZAURA Datasheet, PDF (35/99 Pages) –

ZAURA RF Wireless Library
Programmer’s Reference Manual
23
ZAURA RF Wireless API Reference
This section describes the ZAURA RF Wireless Library APIs.
ZAURA_RF_Init
Description The ZAURA_RF_Init API is used to initialize the ZARA RF Wireless
Library and prepare the radio for use. If the Shell Library
(ZAURA_RF_Shell.lib) is linked to the project it will also be initial-
ized by the call to ZAURA_RF_Init. This function must be called
before any other ZAURA RF Library or Shell Library API function is
called. The first time an application calls this function
ZAURA_RF_SUCCESS is returned. Subsequent calls will return
ZAURA_RF_FAILURE and will not re-initialize the library.
During the initialization process the ZAURA RF Library configures
the Z8F2480 GPIO pins, initializes the Module’s network and user
parameters and configures the initial state of the radio.
The ZAURA RF Module is intended to be integrated with customer
defined hardware platforms that may require some of the Z8F2480
GPIO pins to be configured in an application-specific manner. There-
fore the ZAURA RF Library calls the user-defined
ZAURA_RF_GpioConfig API to establish a platform-specific GPIO
configuration. After calling ZAURA_RF_GpioConfig the Library
configures the set of GPIO pins required for exclusive use of the Mod-
ule and (if appropriate) the ZAURA RF Shell.
The Module.s network configuration is determined by the values
assigned to the ZAURA_RF_Params structure or values stored in
Flash (see ZAURA_RF_SetParams). To determine which set of
parameters are used the ZAURA RF Library first checks if the param-
eters stored in Flash are valid (see ZAURA RF Configuration). If they
are valid, then the library will modify the ZAURA_RF_Params struc-
ture to use the values from Flash. If the values in Flash are invalid, the
ZAURA RF Library will use the values in the ZAURA_RF_Params
structure at the time the ZAURA_RF_Init API was called (defaults
specified in the ZAURA_RF_Conf.c file).
After the Module’s network parameters have been configured, the
ZAURA_RF_Init API will initialize the value of the
ZAURA_RF_UserParams structure with values read from Flash
(always assumed to be valid). Applications may modify the
RM006003-1011
ZAURA RF Wireless API Reference