states.h

Go to the documentation of this file.

 
#ifndef INFUSE_SDK_INCLUDE_INFUSE_STATES_H_
#define INFUSE_SDK_INCLUDE_INFUSE_STATES_H_
 
#include <stdint.h>
#include <stdbool.h>
 
#include <zephyr/sys/atomic.h>
#include <zephyr/sys/slist.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum infuse_state {
        /* Device is about to reboot */
        INFUSE_STATE_REBOOTING = 1,
        /* Application is active according to KV-store values */
        INFUSE_STATE_APPLICATION_ACTIVE = 2,
        /* Application has a valid time source */
        INFUSE_STATE_TIME_KNOWN = 3,
        /* Device is stationary (not moving) */
        INFUSE_STATE_DEVICE_STATIONARY = 4,
        /* Device is currently sending high-priority data to the cloud */
        INFUSE_STATE_HIGH_PRIORITY_UPLINK = 5,
        /* Device started moving */
        INFUSE_STATE_DEVICE_STARTED_MOVING = 6,
        /* Device stopped moving */
        INFUSE_STATE_DEVICE_STOPPED_MOVING = 7,
        /* Start of application-specific state range */
        INFUSE_STATES_APP_START = 128,
        INFUSE_STATES_END = UINT8_MAX
};
 
/* Required size of atomic array for Infuse-IoT application states */
#define INFUSE_STATES_ARRAY_SIZE ATOMIC_BITMAP_SIZE(INFUSE_STATES_END + 1)
 
#define INFUSE_STATES_ARRAY(name) atomic_t name[INFUSE_STATES_ARRAY_SIZE]
 
struct infuse_state_cb {
        void (*state_set)(enum infuse_state state, bool already, uint16_t timeout, void *user_ctx);
 
        void (*state_cleared)(enum infuse_state state, void *user_ctx);
 
        /* User provided context pointer */
        void *user_ctx;
 
        sys_snode_t node;
};
 
void infuse_state_register_callback(struct infuse_state_cb *cb);
 
bool infuse_state_unregister_callback(struct infuse_state_cb *cb);
 
bool infuse_state_set(enum infuse_state state);
 
bool infuse_state_set_timeout(enum infuse_state state, uint16_t timeout);
 
int infuse_state_get_timeout(enum infuse_state state);
 
bool infuse_state_clear(enum infuse_state state);
 
static inline bool infuse_state_set_to(enum infuse_state state, bool val)
{
        if (val) {
                return infuse_state_set(state);
        } else {
                return infuse_state_clear(state);
        }
}
 
bool infuse_state_get(enum infuse_state state);
 
void infuse_states_snapshot(atomic_t snapshot[INFUSE_STATES_ARRAY_SIZE]);
 
void infuse_states_tick(atomic_t snapshot[INFUSE_STATES_ARRAY_SIZE]);
 
#ifdef __cplusplus
}
#endif
 
#endif /* INFUSE_SDK_INCLUDE_INFUSE_STATES_H_ */