Misc APIs

This group includes APIs which are not belong to any task.

Functions
at_ble_status_t	at_ble_enable_sleep (bool en_sleep)
	Enable/disable deep sleep. More...
at_ble_status_t	at_ble_event_get (at_ble_events_t *event, void *params, uint32_t timeout)
	extracts the next event form the event queue More...
at_ble_status_t	at_ble_event_user_defined_post (void *params)
	Posts a user defined custom event into the event queue, allowing the user code to process other events in the same event handling loop. More...

at_ble_status_t at_ble_enable_sleep

(

bool

en_sleep

)

Enable/disable deep sleep.

Sleep is enabled by default.

Parameters

[in]

en_sleep

true to enable deep sleep or false to disable it

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

at_ble_status_t at_ble_event_get	(	at_ble_events_t *	event,
		void *	params,
		uint32_t	timeout
	)

extracts the next event form the event queue

Parameters

[out]	event	The received event
[out]	params	Received event data
[in]	timeout	Time in millisecond this function will block waiting of an event (0xFFFFFFFF to block indefinitely) in this case, if the user wishes to unblock the function at_ble_event_user_defined_post can be used

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

Parameters

[out]	event	The received event
[out]	params	Received event data
[in]	timeout	Time in millisecond this function will block waiting of an event (0xFFFFFFFF to block indefinitely) in this case, if the user wishes to unblock the function at_ble_event_user_defined_post can be used

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_FAILURE Generic error

References AT_BLE_CUSTOM_EVENT, AT_BLE_SUCCESS, data, event_get(), handle_ble_event(), event::msg_id, NULL, event::src_id, and status.

at_ble_status_t at_ble_event_user_defined_post

(

void *

params

)

Posts a user defined custom event into the event queue, allowing the user code to process other events in the same event handling loop.

Events will be received with the as AT_BLE_CUSTOM_EVENT

Parameters

[in]

params

Parameters sent to the custom event

Returns

AT_BLE_SUCCESS operation completed successfully

AT_BLE_FAILURE Generic error.

Events will be received with the as AT_BLE_CUSTOM_EVENT

Parameters

[in]

params

Parameters sent to the custom event

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_FAILURE Generic error

References AT_BLE_SUCCESS, and event_post().