wms_state.h

Go to the documentation of this file.

/* Copyright 2017 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#ifndef APP_LIB_STATE_H_
#define APP_LIB_STATE_H_
 
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
#include <limits.h>
 
#include "wms_app.h"
#include "wms_settings.h" // For app_lib_settings_net_channel_t
 
#define APP_LIB_STATE_NAME 0x02f9c165 
 
 
#define APP_LIB_STATE_VERSION 0x20F
 
#define APP_LIB_STATE_INVALID_ROUTE_COST UINT8_MAX
 
#define APP_LIB_STATE_COST_UNKNOWN  0
 
#define APP_LIB_STATE_LINKREL_UNKNOWN   0
 
 
typedef enum
{
    APP_LIB_STATE_NEIGHBOR_IS_NEXT_HOP  = 0,
    APP_LIB_STATE_NEIGHBOR_IS_MEMBER    = 1,
    APP_LIB_STATE_NEIGHBOR_IS_CLUSTER   = 2,
} app_lib_state_nbor_type_e;
 
typedef enum
{
    APP_LIB_STATE_DIRADV_SUPPORTED      = 0,
    APP_LIB_STATE_DIRADV_NOT_SUPPORTED  = 1,
    APP_LIB_STATE_DIRADV_UNKNOWN        = 2,
} app_lib_state_diradv_support_e;
 
typedef enum
{
    APP_LIB_STATE_SCAN_NBORS_ALL = 0,
    APP_LIB_STATE_SCAN_NBORS_ONLY_REQUESTED = 1,
} app_lib_state_scan_nbors_type_e;
 
typedef struct
{
    uint32_t address;
    uint16_t last_update;
    uint8_t link_reliability;
    int8_t  norm_rssi;
    uint8_t cost;
    app_lib_settings_net_channel_t channel;
    uint8_t type;
    int8_t  tx_power;
    int8_t  rx_power;
    uint8_t diradv_support;
} app_lib_state_nbor_info_t;
 
typedef struct
{
    uint32_t number_nbors;
    app_lib_state_nbor_info_t * nbors;
} app_lib_state_nbor_list_t;
 
typedef enum
{
    APP_LIB_STATE_STARTED = 0,                  
    APP_LIB_STATE_STOPPED = 1,                  
    APP_LIB_STATE_NODE_ADDRESS_NOT_SET = 2,     
    APP_LIB_STATE_NETWORK_ADDRESS_NOT_SET = 4,  
    APP_LIB_STATE_NETWORK_CHANNEL_NOT_SET = 8,  
    APP_LIB_STATE_ROLE_NOT_SET = 16,            
    APP_LIB_STATE_APP_CONFIG_DATA_NOT_SET = 32, 
    APP_LIB_STATE_ACCESS_DENIED = 128           
} app_lib_state_stack_state_e;
 
typedef enum
{
    APP_LIB_STATE_ROUTE_STATE_INVALID = 0,      
    APP_LIB_STATE_ROUTE_STATE_PENDING = 1,      
    APP_LIB_STATE_ROUTE_STATE_VALID = 2         
} app_lib_state_route_state_e;
 
typedef enum
{
    APP_LIB_STATE_BEACON_TYPE_NB = 0,   
    APP_LIB_STATE_BEACON_TYPE_CB = 1,   
} app_lib_state_beacon_type_e;
 
typedef struct
{
    app_addr_t  address; 
 
    int8_t      rssi;
    int8_t      txpower;
    bool        is_sink; 
    bool        is_ll;   
    uint8_t     cost;    
    uint8_t     type;    
 
    bool        is_da_support;
    bool        is_secured;
} app_lib_state_beacon_rx_t;
 
typedef struct
{
    app_addr_t  address;
    uint8_t     hops_left;
} app_lib_state_hops_adjust_t;
 
typedef struct
{
    app_lib_state_route_state_e     state;
    app_addr_t                      sink;
    app_addr_t                      next_hop;
    app_lib_settings_net_channel_t  channel;
    uint8_t                         cost;
} app_lib_state_route_info_t;
 
typedef enum
{
    APP_LIB_STATE_INSTALL_QUALITY_ERROR_NONE    = 0x00,
    APP_LIB_STATE_INSTALL_QUALITY_ERROR_NOROUTE = 0x01,
    APP_LIB_STATE_INSTALL_QUALITY_ERROR_NONBORS = 0x02,
    APP_LIB_STATE_INSTALL_QUALITY_ERROR_BADRSSI = 0x04,
} install_quality_error_code_e;
 
typedef struct
{
    uint8_t quality;
    uint8_t error_codes;
} app_lib_state_install_quality_t;
 
typedef enum
{
    // Scan originated by application (by using call @ref
    // app_lib_state_start_scan_nbors_f "lib_state->startScanNbors()")
    SCAN_TYPE_APP_ORIGINATED = 0x00,
    // Scan originated by stack
    SCAN_TYPE_STACK_ORIGINATED = 0x01,
} app_lib_state_scan_type_e;
 
typedef struct
{
    // Type of scan, @ref app_lib_state_scan_type_e
    uint8_t scan_type;
} app_lib_state_on_scan_start_info_t;
 
typedef struct
{
    // Type (originator) of the scan
    app_lib_state_scan_type_e scan_type;
    // Scan completion status: complete (true) or aborted (false)
    bool complete;
} app_lib_state_neighbor_scan_info_t;
 
typedef void (*app_lib_state_on_beacon_cb_f)
    (const app_lib_state_beacon_rx_t * beacon);
 
typedef app_res_e (*app_lib_state_start_stack_f)(void);
 
typedef app_res_e (*app_lib_state_stop_stack_f)(void);
 
typedef uint8_t (*app_lib_state_get_stack_state_f)(void);
 
typedef app_res_e (*app_lib_state_get_access_cycle_f)(uint16_t * ac_value_p);
 
typedef enum
{
    APP_LIB_STATE_STACK_EVENT_STACK_STOPPED = 0,
    APP_LIB_STATE_STACK_EVENT_STACK_STARTED = 1,
    APP_LIB_STATE_STACK_EVENT_SCAN_STARTED = 2,
    APP_LIB_STATE_STACK_EVENT_SCAN_STOPPED = 3,
    APP_LIB_STATE_STACK_EVENT_SCRAT_XFER_STARTED = 4,
    APP_LIB_STATE_STACK_EVENT_SCRAT_XFER_STOPPED = 5,
    APP_LIB_STATE_STACK_EVENT_ROUTE_CHANGED = 6,
    APP_LIB_STATE_STACK_EVENT_CON_FALLBCK = 7  
} app_lib_stack_event_e;
 
typedef void (*app_lib_state_on_stack_event_cb_f)
    (app_lib_stack_event_e event, void *param);
 
typedef app_res_e (*app_lib_state_set_stack_event_cb_f)
    (app_lib_state_on_stack_event_cb_f cb);
 
typedef app_res_e (*app_lib_state_start_scan_nbors_f)(void);
 
typedef app_res_e (*app_lib_state_get_nbors_f)
    (app_lib_state_nbor_list_t * nbors_list);
 
typedef app_res_e
    (*app_lib_state_set_on_beacon_cb_f)(app_lib_state_on_beacon_cb_f cb);
 
typedef app_res_e (*app_lib_state_get_sink_cost_f)(uint8_t * cost_p);
 
typedef app_res_e (*app_lib_state_set_sink_cost_f)(const uint8_t cost);
 
 
 
typedef app_res_e (*app_lib_state_get_route_f)
    (app_lib_state_route_info_t * info);
 
typedef app_res_e (*app_lib_state_scan_stop_f)(void);
 
typedef app_res_e (*app_lib_state_get_install_quality_f)
    (app_lib_state_install_quality_t * qual_out);
 
typedef app_lib_settings_net_channel_t (*app_lib_state_get_cluster_channel_t)
    (void);
 
typedef struct
{
    app_lib_state_start_stack_f                     startStack;
    app_lib_state_stop_stack_f                      stopStack;
    app_lib_state_get_stack_state_f                 getStackState;
    app_lib_state_get_access_cycle_f                getAccessCycle;
    app_lib_state_start_scan_nbors_f                startScanNbors;
    app_lib_state_get_nbors_f                       getNbors;
    app_lib_state_set_on_beacon_cb_f                setOnBeaconCb;
    app_lib_state_get_sink_cost_f                   getSinkCost;
    app_lib_state_set_sink_cost_f                   setSinkCost;
    app_lib_state_get_route_f                       getRouteInfo;
    app_lib_state_scan_stop_f                       stopScanNbors;
    app_lib_state_get_install_quality_f             getInstallQual;
    app_lib_state_set_stack_event_cb_f              setOnStackEventCb;
    app_lib_state_get_cluster_channel_t             getClusterChannel;
} app_lib_state_t;
 
#endif /* APP_LIB_STATE_H_ */