Management

Topics
	Initialization & configuration
	Network management
	System Monitor

Functions
wwd_result_t	wwd_management_set_event_handler (const wwd_event_num_t *event_nums, wwd_event_handler_t handler_func, void *handler_user_data, wwd_interface_t interface)
wwd_result_t	wwd_management_set_event_handler_locally (const wwd_event_num_t *event_nums, wwd_event_handler_t handler_func, void *handler_user_data, wwd_interface_t interface)
wwd_result_t	wwd_management_wifi_off (void)
wwd_result_t	wwd_management_wifi_on (wiced_country_code_t country)
wwd_result_t	wwd_management_wifi_platform_init (wiced_country_code_t country, wiced_bool_t resume_after_deep_sleep)

Detailed Description

WICED Management Functions provides WICED API's to initialize the WICED Platform, Network, enable/disable power save and utility functions to bring network up/ down/suspend and De-initialize WICED by freeing up resources

• WICED initialization, de-initialization
• WICED network initialization, de-initialization
• WICED enable, disable power-save
• WICED configure, re-configure DCT variables
• WICED set-hostname, get-hostname
• WICED network-up, network-down, suspend, resume and utility functions
• WICED core-init, de-init.

User functions for initialization and other management functions for the WICED system

Function Documentation

wwd_management_set_event_handler()

wwd_result_t wwd_management_set_event_handler ( const wwd_event_num_t * event_nums, wwd_event_handler_t handler_func, void * handler_user_data, wwd_interface_t interface )

extern

Registers a handler to receive event callbacks. Subscribe locally and notify Wi-Fi about subscription.

This function registers a callback handler to be notified when a particular event is received.

Alternately the function clears callbacks for given event type.

Note

: Currently each event may only be registered to one handler and there is a limit to the number of simultaneously registered events

Parameters

event_nums	The event types that are to trigger the handler See wwd_event_num_t for available events. Must be defined in a global constant.
handler_func	A function pointer to the new handler callback, or NULL if callbacks are to be disabled for the given event type
handler_user_data	A pointer value which will be passed to the event handler function at the time an event is triggered (NULL is allowed)

Returns

WWD_SUCCESS or Error code

Registers a handler to receive event callbacks. Subscribe locally and notify Wi-Fi about subscription.

This function registers a callback handler to be notified when a particular event is received.

Alternately the function clears callbacks for given event type.

Note

: Currently each event may only be registered to one handler and there is a limit to the number of simultaneously registered events

Parameters

event_nums	An array of event types that is to trigger the handler. The array must be terminated with a WLC_E_NONE event See wwd_event_num_t for available events
handler_func	A function pointer to the new handler callback, or NULL if callbacks are to be disabled for the given event type
handler_user_data	A pointer value which will be passed to the event handler function at the time an event is triggered (NULL is allowed)
interface	The interface to set the handler for.

Returns

WWD result code

wwd_management_set_event_handler_locally()

wwd_result_t wwd_management_set_event_handler_locally ( const wwd_event_num_t * event_nums, wwd_event_handler_t handler_func, void * handler_user_data, wwd_interface_t interface )

extern

Registers locally a handler to receive event callbacks. Does not notify Wi-Fi about event subscription change. Can be used to refresh local callbacks (e.g. after deep-sleep) if Wi-Fi is already notified about them.

This function registers a callback handler to be notified when a particular event is received.

Alternately the function clears callbacks for given event type.

Note

: Currently each event may only be registered to one handler and there is a limit to the number of simultaneously registered events

Parameters

event_nums	The event types that are to trigger the handler See wwd_event_num_t for available events. Must be defined in a global constant.
handler_func	A function pointer to the new handler callback, or NULL if callbacks are to be disabled for the given event type
handler_user_data	A pointer value which will be passed to the event handler function at the time an event is triggered (NULL is allowed)

Returns

WWD_SUCCESS or Error code

Registers locally a handler to receive event callbacks. Does not notify Wi-Fi about event subscription change. Can be used to refresh local callbacks (e.g. after deep-sleep) if Wi-Fi is already notified about them.

This function registers a callback handler to be notified when a particular event is received.

Alternately the function clears callbacks for given event type.

Note

: Currently each event may only be registered to one handler and there is a limit to the number of simultaneously registered events

Parameters

event_nums	An array of event types that is to trigger the handler. The array must be terminated with a WLC_E_NONE event See wwd_event_num_t for available events
handler_func	A function pointer to the new handler callback, or NULL if callbacks are to be disabled for the given event type
handler_user_data	A pointer value which will be passed to the event handler function at the time an event is triggered (NULL is allowed)
interface	The interface to set the handler for.

Returns

WWD result code

wwd_management_wifi_off()

wwd_result_t wwd_management_wifi_off

(

void

)

Turn off the Wi-Fi device

• De-Initialises the required parts of the hardware platform i.e. pins for SDIO/SPI, interrupt, reset, power etc.
• De-Initialises the Wiced thread which arbitrates access to the SDIO/SPI bus

Returns

WWD_SUCCESS if deinitialization is successful, Error code otherwise

Turn off the Wi-Fi device

• De-Initialises the required parts of the hardware platform i.e. pins for SDIO/SPI, interrupt, reset, power etc.
• De-Initialises the WWD thread which arbitrates access to the SDIO/SPI bus

Returns

WWD_SUCCESS if deinitialization is successful, error code otherwise

wwd_management_wifi_on()

wwd_result_t wwd_management_wifi_on

(

wiced_country_code_t

country

)

Turn on the Wi-Fi device

• Initialise Wi-Fi platform
• Program various WiFi parameters and modes

Returns

WWD_SUCCESS if initialization is successful, error code otherwise

Turn on the Wi-Fi device

• Initialize Wi-Fi device
• Program various WiFi parameters and modes

Returns

WWD_SUCCESS if initialization is successful, error code otherwise

wwd_management_wifi_platform_init()

wwd_result_t wwd_management_wifi_platform_init	(	wiced_country_code_t	country,
		wiced_bool_t	resume_after_deep_sleep )

Initialise Wi-Fi platform

• Initialises the required parts of the hardware platform i.e. pins for SDIO/SPI, interrupt, reset, power etc.
• Initialises the Wiced thread which arbitrates access to the SDIO/SPI bus

Returns

WWD_SUCCESS if initialization is successful, Error code otherwise

Initialize Wi-Fi platform

• Initializes the required parts of the hardware platform i.e. pins for SDIO/SPI, interrupt, reset, power etc.
• Initializes the WWD thread which arbitrates access to the SDIO/SPI bus

Returns

WWD_SUCCESS if initialization is successful, error code otherwise