Wirepas SDK
sleep.h
Go to the documentation of this file.
1 /* Copyright 2019 Wirepas Ltd. All Rights Reserved.
2  *
3  * See file LICENSE.txt for full license details.
4  *
5  */
6 
29 #ifndef APP_LIB_SLEEP_H_
30 #define APP_LIB_SLEEP_H_
31 
32 #include <stdlib.h>
33 #include <stdint.h>
34 #include <stdbool.h>
35 
36 #include "app/app.h"
37 
39 #define APP_LIB_LONGSLEEP_NAME 0x02f20818
40 
41 
42 #define APP_LIB_LONGSLEEP_VERSION 0x201
43 
47 typedef enum
48 {
52 
83 typedef app_res_e (*app_lib_sleep_stack_for_time_f)(uint32_t seconds,
84  uint32_t appconf_wait_s);
85 
86 
99 
108 
119 typedef uint32_t (*app_lib_sleep_get_wakeup_f)(void);
120 
126 typedef void (*applib_wakeup_callback_f)(void);
127 
134 typedef
136 
149 typedef uint32_t (*app_lib_sleep_get_gotosleep)(void);
150 
154 typedef struct
155 {
163 
164 #endif /* APP_LIB_SLEEP_H_ */
app_lib_sleep_get_sleep_state_f
app_lib_sleep_stack_state_e(* app_lib_sleep_get_sleep_state_f)(void)
Get sleep state of stack.
Definition: sleep.h:107
app_lib_sleep_t::getSleepLatestGotosleep
app_lib_sleep_get_gotosleep getSleepLatestGotosleep
Definition: sleep.h:161
app_lib_sleep_t::getSleepState
app_lib_sleep_get_sleep_state_f getSleepState
Definition: sleep.h:158
app_lib_sleep_t::setOnWakeupCb
app_lib_sleep_wakeup_callback_f setOnWakeupCb
Definition: sleep.h:160
app_lib_sleep_wakeup_callback_f
void(* app_lib_sleep_wakeup_callback_f)(applib_wakeup_callback_f callback)
Set callback function to be called before stack wakes up.
Definition: sleep.h:135
app_lib_sleep_get_gotosleep
uint32_t(* app_lib_sleep_get_gotosleep)(void)
Get latest time used before stack enters to sleep after NRLS sleep request given.
Definition: sleep.h:149
app_lib_sleep_t::sleepStackforTime
app_lib_sleep_stack_for_time_f sleepStackforTime
Definition: sleep.h:156
APP_LIB_SLEEP_STOPPED
@ APP_LIB_SLEEP_STOPPED
Sleep is stopped.
Definition: sleep.h:49
applib_wakeup_callback_f
void(* applib_wakeup_callback_f)(void)
Callback called before stack wakes up.
Definition: sleep.h:126
app_lib_sleep_wakeup_stack_f
app_res_e(* app_lib_sleep_wakeup_stack_f)(void)
Wakeup stack from sleep.
Definition: sleep.h:98
app.h
app_lib_sleep_t
List of library functions.
Definition: sleep.h:154
app_lib_sleep_t::wakeupStack
app_lib_sleep_wakeup_stack_f wakeupStack
Definition: sleep.h:157
app_lib_sleep_get_wakeup_f
uint32_t(* app_lib_sleep_get_wakeup_f)(void)
Returns remaining sleep time.
Definition: sleep.h:119
APP_LIB_SLEEP_STARTED
@ APP_LIB_SLEEP_STARTED
Sleep is started.
Definition: sleep.h:50
app_res_e
app_res_e
Definition: app.h:201
app_lib_sleep_stack_for_time_f
app_res_e(* app_lib_sleep_stack_for_time_f)(uint32_t seconds, uint32_t appconf_wait_s)
Start stack sleeping period for a given time.
Definition: sleep.h:83
app_lib_sleep_stack_state_e
app_lib_sleep_stack_state_e
Stack state flags.
Definition: sleep.h:47
app_lib_sleep_t::getStackWakeup
app_lib_sleep_get_wakeup_f getStackWakeup
Definition: sleep.h:159