settings.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_SETTINGS_H_
#define APP_LIB_SETTINGS_H_
 
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "app/app.h"
 
#define APP_LIB_SETTINGS_NAME 0x74ced676 
 
 
#define APP_LIB_SETTINGS_VERSION 0x205
 
#define APP_LIB_SETTINGS_AES_KEY_NUM_BYTES  16
 
// Device address definition is in app/app.h */
 
typedef uint32_t app_lib_settings_net_addr_t;
 
typedef uint8_t app_lib_settings_net_channel_t;
 
typedef enum
{
    APP_LIB_SETTINGS_ROLE_SINK = 0,
    APP_LIB_SETTINGS_ROLE_HEADNODE,
    APP_LIB_SETTINGS_ROLE_SUBNODE,
    APP_LIB_SETTINGS_ROLE_ADVERTISER = 4,
} app_lib_settings_base_role_e;
 
typedef enum
{
    APP_LIB_SETTINGS_ROLE_FLAG_LL = 0x10,
    APP_LIB_SETTINGS_ROLE_FLAG_RESV = 0x20,
    APP_LIB_SETTINGS_ROLE_FLAG_AUTOROLE = 0x40,
} app_lib_settings_flag_role_e;
 
#define APP_LIB_SETTINGS_BASE_ROLE_MASK 0x0f
 
#define APP_LIB_SETTINGS_FLAG_ROLE_MASK 0xf0
 
typedef uint8_t app_lib_settings_role_t;
 
__STATIC_INLINE app_lib_settings_role_t
    app_lib_settings_create_role(app_lib_settings_base_role_e base,
                                 app_lib_settings_flag_role_e flags)
{
    app_lib_settings_role_t role = (base & APP_LIB_SETTINGS_BASE_ROLE_MASK) |
                                   (flags & APP_LIB_SETTINGS_FLAG_ROLE_MASK);
    return role;
}
 
__STATIC_INLINE app_lib_settings_base_role_e
    app_lib_settings_get_base_role(app_lib_settings_role_t role)
{
    return role & APP_LIB_SETTINGS_BASE_ROLE_MASK;
}
 
__STATIC_INLINE app_lib_settings_role_t
    app_lib_settings_get_flags_role(app_lib_settings_role_t role)
{
    return role & APP_LIB_SETTINGS_FLAG_ROLE_MASK;
}
 
typedef bool
    (*app_lib_settings_is_group_cb_f)(app_addr_t group_addr);
 
typedef app_res_e
    (*app_lib_settings_reset_all_f)(void);
 
typedef app_res_e
    (*app_lib_settings_get_feature_lock_bits_f)(uint32_t * bits_p);
 
typedef app_res_e
    (*app_lib_settings_set_feature_lock_bits_f)(uint32_t bits);
 
typedef app_res_e
    (*app_lib_settings_get_feature_lock_key_f)(uint8_t * key_p);
 
typedef app_res_e
    (*app_lib_settings_set_feature_lock_key_f)(const uint8_t * key_p);
 
typedef app_res_e
    (*app_lib_settings_get_node_address_f)(app_addr_t * addr_p);
 
typedef app_res_e
    (*app_lib_settings_set_node_address_f)(app_addr_t addr);
 
typedef app_res_e
    (*app_lib_settings_get_network_address_f)(app_lib_settings_net_addr_t * addr_p);
 
typedef app_res_e
    (*app_lib_settings_set_network_address_f)(app_lib_settings_net_addr_t addr);
 
typedef app_res_e
    (*app_lib_settings_get_network_channel_f)(app_lib_settings_net_channel_t * channel_p);
 
typedef app_res_e
    (*app_lib_settings_set_network_channel_f)(app_lib_settings_net_channel_t channel);
 
typedef app_res_e
    (*app_lib_settings_get_node_role_f)(app_lib_settings_role_t * role_p);
 
typedef app_res_e
    (*app_lib_settings_set_node_role_f)(app_lib_settings_role_t role);
 
typedef app_res_e
    (*app_lib_settings_get_authentication_key_f)(uint8_t * key_p);
 
typedef app_res_e
    (*app_lib_settings_set_authentication_key_f)(const uint8_t * key_p);
 
typedef app_res_e
    (*app_lib_settings_get_encryption_key_f)(uint8_t * key_p);
 
typedef app_res_e
    (*app_lib_settings_set_encryption_key_f)(const uint8_t * key_p);
 
typedef app_res_e
    (*app_lib_settings_get_ac_range_f)(uint16_t * ac_min_value_p,
                                       uint16_t * ac_max_value_p);
 
typedef app_res_e
    (*app_lib_settings_set_ac_range_f)(uint16_t ac_min_value,
                                       uint16_t ac_max_value);
 
typedef app_res_e
    (*app_lib_settings_get_offline_scan_f)(uint16_t * max_scan_p);
 
typedef app_res_e
    (*app_lib_settings_set_offline_scan_f)(uint16_t max_scan);
 
typedef app_res_e
    (*app_lib_settings_get_channel_map_f)(uint32_t * channelmap_p);
 
typedef app_res_e
    (*app_lib_settings_set_channel_map_f)(uint32_t channelmap);
 
typedef app_res_e
    (*app_lib_settings_get_network_channel_limits_f)(uint16_t * min_value_p,
                                                     uint16_t * max_value_p);
 
typedef app_res_e
    (*app_lib_settings_get_ac_range_limits_f)(uint16_t * min_value_p,
                                              uint16_t * max_value_p);
 
typedef app_res_e
    (*app_lib_settings_set_group_query_cb_f)(app_lib_settings_is_group_cb_f cb);
 
typedef app_res_e
    (*app_lib_settings_get_reserved_channels_f)(uint8_t * channels_p,
                                                size_t num_bytes);
 
typedef app_res_e
    (*app_lib_settings_set_reserved_channels_f)(const uint8_t * channels_p,
                                                size_t num_bytes);
 
typedef bool (*app_lib_settings_is_valid_network_address_f)
                                            (app_lib_settings_net_addr_t addr);
 
typedef bool (*app_lib_settings_is_valid_network_channel_f)(uint8_t channel);
 
typedef bool (*app_lib_settings_is_valid_node_address_f)(app_addr_t addr);
 
typedef bool (*app_lib_settings_is_valid_node_role_f)(app_lib_settings_role_t role);
 
 
typedef struct
{
    app_lib_settings_reset_all_f                    resetAll;
    app_lib_settings_get_feature_lock_bits_f        getFeatureLockBits;
    app_lib_settings_set_feature_lock_bits_f        setFeatureLockBits;
    app_lib_settings_get_feature_lock_key_f         getFeatureLockKey;
    app_lib_settings_set_feature_lock_key_f         setFeatureLockKey;
    app_lib_settings_get_node_address_f             getNodeAddress;
    app_lib_settings_set_node_address_f             setNodeAddress;
    app_lib_settings_get_network_address_f          getNetworkAddress;
    app_lib_settings_set_network_address_f          setNetworkAddress;
    app_lib_settings_get_network_channel_f          getNetworkChannel;
    app_lib_settings_set_network_channel_f          setNetworkChannel;
    app_lib_settings_get_node_role_f                getNodeRole;
    app_lib_settings_set_node_role_f                setNodeRole;
    app_lib_settings_get_authentication_key_f       getAuthenticationKey;
    app_lib_settings_set_authentication_key_f       setAuthenticationKey;
    app_lib_settings_get_encryption_key_f           getEncryptionKey;
    app_lib_settings_set_encryption_key_f           setEncryptionKey;
    app_lib_settings_get_ac_range_f                 getAcRange;
    app_lib_settings_set_ac_range_f                 setAcRange;
    app_lib_settings_get_offline_scan_f             getOfflineScan;
    app_lib_settings_set_offline_scan_f             setOfflineScan;
    app_lib_settings_get_channel_map_f              getChannelMap;
    app_lib_settings_set_channel_map_f              setChannelMap;
    app_lib_settings_get_network_channel_limits_f   getNetworkChannelLimits;
    app_lib_settings_get_ac_range_limits_f          getAcRangeLimits;
    app_lib_settings_set_group_query_cb_f           registerGroupQuery;
    app_lib_settings_get_reserved_channels_f        getReservedChannels;
    app_lib_settings_set_reserved_channels_f        setReservedChannels;
    app_lib_settings_is_valid_network_address_f     isValidNetworkAddress;
    app_lib_settings_is_valid_network_channel_f     isValidNetworkChannel;
    app_lib_settings_is_valid_node_address_f        isValidNodeAddress;
    app_lib_settings_is_valid_node_role_f           isValidNodeRole;
} app_lib_settings_t;
 
#endif /* APP_LIB_SETTINGS_H_ */