wms_data.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_DATA_H_
#define APP_LIB_DATA_H_
 
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "wms_app.h"
 
#define APP_LIB_DATA_NAME 0x0003f161 
 
 
#define APP_LIB_DATA_VERSION    0x211
 
typedef uint16_t app_lib_data_tracking_id_t;
 
#define APP_LIB_DATA_NO_TRACKING_ID (app_lib_data_tracking_id_t)(-1)
 
#define APP_LIB_DATA_MAX_APP_CONFIG_NUM_BYTES   80
 
typedef enum
{
    APP_LIB_DATA_QOS_NORMAL = 0,
    APP_LIB_DATA_QOS_HIGH   = 1,
} app_lib_data_qos_e;
 
typedef enum
{
    APP_LIB_DATA_SEND_FLAG_NONE   = 0,
    APP_LIB_DATA_SEND_FLAG_TRACK = 1,
    APP_LIB_DATA_SEND_SET_HOP_LIMITING = 4,
    APP_LIB_DATA_SEND_FLAG_UNACK_CSMA_CA = 8,
    APP_LIB_DATA_SEND_NW_CH_ONLY = 16,
    APP_LIB_DATA_SEND_FRAGMENTED_PACKET = 32,
} app_lib_data_send_flags_e;
 
typedef enum
{
    APP_LIB_DATA_SEND_RES_SUCCESS = 0,
    APP_LIB_DATA_SEND_RES_INVALID_STACK_STATE = 1,
    APP_LIB_DATA_SEND_RES_INVALID_QOS = 2,
    APP_LIB_DATA_SEND_RES_INVALID_FLAGS = 3,
    APP_LIB_DATA_SEND_RES_OUT_OF_MEMORY = 4,
    APP_LIB_DATA_SEND_RES_INVALID_DEST_ADDRESS = 5,
    APP_LIB_DATA_SEND_RES_INVALID_NUM_BYTES = 6,
    APP_LIB_DATA_SEND_RES_OUT_OF_TRACKING_IDS = 7,
    APP_LIB_DATA_SEND_RES_INVALID_TRACKING_ID = 8,
    APP_LIB_DATA_SEND_RES_RESERVED_ENDPOINT = 9,
    APP_LIB_DATA_SEND_RES_ACCESS_DENIED = 10,
    APP_LIB_DATA_SEND_RES_INVALID_HOP_LIMIT = 11,
    APP_LIB_DATA_SEND_RES_UNINITIALIZED = 12,
    APP_LIB_DATA_SEND_RES_INVALID_FRAGMENT_INFO = 13,
} app_lib_data_send_res_e;
 
typedef enum
{
    APP_LIB_DATA_RECEIVE_RES_HANDLED     = 0,
    APP_LIB_DATA_RECEIVE_RES_NOT_FOR_APP = 1,
    APP_LIB_DATA_RECEIVE_RES_NO_SPACE    = 2,
} app_lib_data_receive_res_e;
 
typedef enum
{
    APP_LIB_DATA_APP_CONFIG_RES_SUCCESS              = 0,
    APP_LIB_DATA_APP_CONFIG_RES_INVALID_ROLE         = 1,
    APP_LIB_DATA_APP_CONFIG_RES_INVALID_APP_CONFIG   = 2,
    APP_LIB_DATA_APP_CONFIG_RES_INVALID_SEQ          = 3,
    APP_LIB_DATA_APP_CONFIG_RES_INVALID_INTERVAL     = 4,
    APP_LIB_DATA_APP_CONFIG_RES_INVALID_NULL_POINTER = 5,
    APP_LIB_DATA_APP_CONFIG_RES_OUT_OF_MEMORY        = 6,
} app_lib_data_app_config_res_e;
 
typedef enum
{
    APP_LIB_DATA_FRAGMENTED_MODE_ENABLED = 0,
    APP_LIB_DATA_FRAGMENTED_MODE_DISABLED  = 1,
} app_lib_data_fragmented_mode_e;
 
 
#define APP_LIB_DATA_RX_HOPS_UNDETERMINED 0
 
typedef struct
{
    uint16_t packet_id;
    uint16_t fragment_offset;
    bool last_fragment;
} app_lib_data_fragment_t;
 
typedef struct
{
    const uint8_t * bytes;
    size_t num_bytes;
    app_addr_t src_address;
    uint32_t delay;
    app_lib_data_qos_e qos;
    uint8_t src_endpoint;
    uint8_t dest_endpoint;
    uint8_t hops;
    app_addr_t dest_address;
    app_addr_t mac_src_address;
    int8_t tx_power;
    int8_t rssi;
    uint32_t delay_hp;
    app_lib_data_fragment_t * fragment_info;
} app_lib_data_received_t;
 
typedef struct
{
    const uint8_t * bytes;
    size_t num_bytes;
    app_addr_t dest_address;
    app_lib_data_tracking_id_t tracking_id;
    app_lib_data_qos_e qos;
    uint8_t flags;
    uint8_t src_endpoint;
    uint8_t dest_endpoint;
    uint8_t hop_limit;
    app_lib_data_fragment_t fragment_info;
} app_lib_data_to_send_t;
 
typedef struct
{
    app_addr_t dest_address;
    uint32_t queue_time;
    app_lib_data_tracking_id_t tracking_id;
    uint8_t src_endpoint;
    uint8_t dest_endpoint;
    bool success;
} app_lib_data_sent_status_t;
 
typedef app_lib_data_receive_res_e
    (*app_lib_data_data_received_cb_f)(const app_lib_data_received_t * data);
 
typedef void
    (*app_lib_data_data_sent_cb_f)(const app_lib_data_sent_status_t * status);
 
typedef void (*app_lib_data_new_app_config_cb_f)(const uint8_t * bytes,
                                                 uint8_t seq,
                                                 uint16_t interval);
 
typedef app_res_e
    (*app_lib_data_set_data_received_cb_f)(app_lib_data_data_received_cb_f cb);
 
typedef app_res_e
    (*app_lib_data_set_data_sent_cb_f)(app_lib_data_data_sent_cb_f cb);
 
typedef app_res_e
    (*app_lib_data_set_new_app_config_cb_f)
    (app_lib_data_new_app_config_cb_f cb);
 
typedef struct
{
    size_t max_data_size;
    size_t max_fragment_size;
} app_lib_data_data_size_t;
 
 
typedef app_lib_data_data_size_t
    (*app_lib_data_get_data_max_num_bytes_f)(void);
 
typedef size_t
    (*app_lib_data_get_num_buffers_f)(void);
 
typedef app_res_e
    (*app_lib_data_get_num_free_buffers_f)(size_t * num_buffers_p);
 
typedef app_lib_data_send_res_e
    (*app_lib_data_send_data_f)(const app_lib_data_to_send_t * data);
 
typedef void
    (*app_lib_data_allow_reception_f)(bool allow);
 
typedef app_lib_data_app_config_res_e
    (*app_lib_data_read_app_config_f)(uint8_t * bytes,
                                      uint8_t * seq,
                                      uint16_t * interval);
 
typedef size_t
    (*app_lib_data_get_app_config_num_bytes_f)(void);
 
 
typedef app_lib_data_app_config_res_e
    (*app_lib_data_write_app_config_data_f)(const uint8_t * bytes);
 
typedef enum
{
    APP_LIB_DATA_CONFIG_DATA_RES_SUCCESS = 0,
    APP_LIB_DATA_CONFIG_DATA_RES_INVALID_ROLE = 1,
    APP_LIB_DATA_CONFIG_DATA_RES_INVALID_ENDPOINT = 2,
    APP_LIB_DATA_CONFIG_DATA_RES_INVALID_NULL_POINTER = 3,
    APP_LIB_DATA_CONFIG_DATA_RES_OUT_OF_MEMORY = 4,
    APP_LIB_DATA_CONFIG_DATA_RES_INVALID_CONTENT = 5,
    APP_LIB_DATA_CONFIG_DATA_RES_INVALID_INPUT = 6,
    APP_LIB_DATA_CONFIG_DATA_RES_NOT_SUPPORTED = 7,
    APP_LIB_DATA_CONFIG_DATA_RES_INTERNAL_ERROR = 8,
} app_lib_data_config_data_res_e;
 
typedef struct
{
    uint8_t * bytes;
    uint16_t endpoint;
    uint8_t length;
} app_lib_config_data_item_t;
 
typedef app_lib_data_config_data_res_e (*app_lib_data_set_config_data_item_f)(
    const app_lib_config_data_item_t * item);
 
typedef app_lib_data_config_data_res_e (*app_lib_data_get_config_data_item_f)(
    app_lib_config_data_item_t * item);
 
 
typedef uint8_t (*app_lib_data_get_all_config_data_endpoints_f)(uint16_t * endpoints, uint8_t max_items);
 
typedef void (*app_lib_data_new_config_data_item_cb_f)(
    const app_lib_config_data_item_t * item);
 
typedef app_res_e
    (*app_lib_data_set_new_config_data_item_cb_f)
    (app_lib_data_new_config_data_item_cb_f cb);
 
typedef app_lib_data_app_config_res_e
    (*app_lib_data_write_diagnostic_interval_f)(uint16_t interval);
 
typedef app_res_e
    (*app_lib_data_disable_boot_diagnostics_f)(void);
 
#define APP_DATA_DISABLE_LOCAL_MULTICAST 0
 
typedef struct app_lib_data_local_mc_info_t
{
    uint8_t hops_left;
} app_lib_data_local_mc_info_t;
 
typedef app_res_e
    (*app_lib_data_set_local_mc_f) (const app_lib_data_local_mc_info_t * info);
 
typedef app_res_e
    (*app_lib_data_set_fragmented_mode_f)(const app_lib_data_fragmented_mode_e mode);
 
typedef struct
{
    app_lib_data_set_data_received_cb_f setDataReceivedCb;
    app_lib_data_set_data_sent_cb_f setDataSentCb;
    app_lib_data_set_new_app_config_cb_f setNewAppConfigCb;
    app_lib_data_get_data_max_num_bytes_f getDataMaxNumBytes;
    app_lib_data_get_num_buffers_f getNumBuffers;
    app_lib_data_get_num_free_buffers_f getNumFreeBuffers;
    app_lib_data_send_data_f sendData;
    app_lib_data_allow_reception_f allowReception;
    app_lib_data_read_app_config_f readAppConfig;
    app_lib_data_get_app_config_num_bytes_f getAppConfigNumBytes;
    app_lib_data_write_app_config_data_f writeAppConfigData;
    app_lib_data_write_diagnostic_interval_f writeDiagnosticInterval;
    app_lib_data_set_local_mc_f setLocalMulticastInfo;
    app_lib_data_set_fragmented_mode_f setFragmentMode;
    app_lib_data_set_config_data_item_f setConfigDataItem;
    app_lib_data_get_config_data_item_f getConfigDataItem;
    app_lib_data_set_new_config_data_item_cb_f setConfigDataItemReceivedCb;
    app_lib_data_get_all_config_data_endpoints_f getAllConfigDataEndpoints;
    app_lib_data_disable_boot_diagnostics_f disableBootDiagnostics;
} app_lib_data_t;
 
#endif /* APP_LIB_DATA_H_ */