wms_joining.h

Go to the documentation of this file.

/* Copyright 2019 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#ifndef APP_LIB_JOINING_H_
#define APP_LIB_JOINING_H_
 
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "wms_app.h"
#include "wms_settings.h"  // For app_lib_settings_net_addr_t and
                           // app_lib_settings_net_channel_t
#include "wms_time.h"     // For app_lib_time_timestamp_coarse_t
 
#define APP_LIB_JOINING_NAME    0x000a2336 
 
 
#define APP_LIB_JOINING_VERSION 0x200
 
#define APP_LIB_JOINING_MIN_INTERVAL    100
 
#define APP_LIB_JOINING_MAX_INTERVAL    8000
 
#define APP_LIB_JOINING_MIN_TIMEOUT     100
 
#define APP_LIB_JOINING_MAX_TIMEOUT     10000
 
#define APP_LIB_JOINING_MAX_PAYLOAD_NUM_BYTES   64
 
typedef enum
{
    APP_LIB_JOINING_RX_STATUS_DONE = 0,
    APP_LIB_JOINING_RX_STATUS_STOPPED = 1,
    APP_LIB_JOINING_RX_STATUS_INTERRUPTED = 2,
    APP_LIB_JOINING_RX_STATUS_OUT_OF_SPACE = 3
} app_lib_joining_rx_status_e;
 
typedef struct
{
    uint32_t interval;
    app_lib_settings_net_addr_t addr;
    app_lib_settings_net_channel_t channel;
    int8_t tx_power;
    uint32_t type;
    const void * payload;
    size_t payload_num_bytes;
} app_lib_joining_beacon_tx_param_t;
 
struct app_lib_joining_received_beacon_s
{
    struct app_lib_joining_received_beacon_s * next;
    size_t num_bytes;
    uint32_t type;
    uint8_t * payload;
    size_t payload_num_bytes;
    app_lib_time_timestamp_coarse_t time;
    app_lib_settings_net_addr_t addr;
    app_lib_settings_net_channel_t channel;
    int8_t rssi;
    int8_t tx_power;
};
 
typedef struct app_lib_joining_received_beacon_s
    app_lib_joining_received_beacon_t;
 
typedef void (*app_lib_joining_beacon_rx_cb_f)(
    app_lib_joining_rx_status_e status,
    const app_lib_joining_received_beacon_t * beacons,
    size_t num_beacons);
 
typedef struct
{
    app_lib_joining_beacon_rx_cb_f cb;
    uint32_t max_exec_time_us;
    app_lib_settings_net_addr_t addr;
    app_lib_settings_net_channel_t channel;
    uint32_t timeout;
    size_t max_num_beacons;
    void * buffer;
    size_t num_bytes;
} app_lib_joining_beacon_rx_param_t;
 
typedef app_res_e (*app_lib_joining_start_joining_beacon_tx_f)(
    const app_lib_joining_beacon_tx_param_t * param);
 
typedef app_res_e (*app_lib_joining_stop_joining_beacon_tx_f)(void);
 
typedef app_res_e (*app_lib_joining_start_joining_beacon_rx_f)(
    const app_lib_joining_beacon_rx_param_t * param);
 
typedef app_res_e (*app_lib_joining_stop_joining_beacon_rx_f)(void);
 
typedef app_res_e (*app_lib_joining_start_joining_process_f)(
    app_lib_settings_net_addr_t addr,
    app_lib_settings_net_channel_t channel);
 
typedef app_res_e (*app_lib_joining_stop_joining_process_f)(void);
 
typedef app_res_e (*app_lib_joining_enable_remote_api_f)(bool enable);
 
typedef app_res_e (*app_lib_joining_enable_proxy_f)(bool enable);
 
typedef struct
{
    app_lib_joining_start_joining_beacon_tx_f startJoiningBeaconTx;
    app_lib_joining_stop_joining_beacon_tx_f stopJoiningBeaconTx;
    app_lib_joining_start_joining_beacon_rx_f startJoiningBeaconRx;
    app_lib_joining_stop_joining_beacon_rx_f stopJoiningBeaconRx;
    app_lib_joining_start_joining_process_f startJoiningProcess;
    app_lib_joining_stop_joining_process_f stopJoiningProcess;
    app_lib_joining_enable_remote_api_f enableRemoteApi;
    app_lib_joining_enable_proxy_f enableProxy;
} app_lib_joining_t;
 
#endif /* APP_LIB_JOINING_H_ */