node_configuration.h

Go to the documentation of this file.

/* Copyright 2017 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#ifndef NODECONFIGURATION_H_
#define NODECONFIGURATION_H_
 
#include "api.h"
#include "uniqueId.h"
 
__STATIC_INLINE app_res_e configureNode(
                                app_addr_t my_addr,
                                app_lib_settings_net_addr_t my_network_addr,
                                app_lib_settings_net_channel_t my_network_ch,
                                const uint8_t * my_authentication_key_p,
                                const uint8_t * my_encryption_key_p)
{
    // Check node address
    app_addr_t node_addr;
    app_res_e res;
 
    if (lib_settings->getNodeAddress(&node_addr) != APP_RES_OK)
    {
        // Not set
        res = lib_settings->setNodeAddress(my_addr);
        if (res != APP_RES_OK)
        {
            return res;
        }
 
        // Node address was not set => first time we call this function
        if (my_authentication_key_p != NULL
            && lib_settings->getAuthenticationKey(NULL) != APP_RES_OK)
        {
            // Not set
            res = lib_settings->setAuthenticationKey(my_authentication_key_p);
            if (res != APP_RES_OK)
            {
                return res;
            }
        }
 
        // Node address was not set so first time we call this function
        if (my_encryption_key_p != NULL
            && lib_settings->getEncryptionKey(NULL) != APP_RES_OK)
        {
            // Not set
            res = lib_settings->setEncryptionKey(my_encryption_key_p);
            if (res != APP_RES_OK)
            {
                return res;
            }
        }
    }
 
    // Check network address
    app_lib_settings_net_addr_t network_addr;
    if (lib_settings->getNetworkAddress(&network_addr) != APP_RES_OK)
    {
        // Not set
        res = lib_settings->setNetworkAddress(my_network_addr);
        if (res != APP_RES_OK)
        {
            return res;
        }
    }
 
    // Check network channel
    app_lib_settings_net_channel_t network_ch;
    if (lib_settings->getNetworkChannel(&network_ch) != APP_RES_OK)
    {
        // Not set
        res = lib_settings->setNetworkChannel(my_network_ch);
        if (res != APP_RES_OK)
        {
            return res;
        }
    }
 
    return APP_RES_OK;
}
 
__STATIC_INLINE app_addr_t getUniqueAddress()
{
    app_addr_t address = getUniqueId();
 
    // Check the address is in correct range
    if (address == 0x0)
    {
        // Zero is not a valid address
        address = 1;
    }
    else if ((address & 0xFF000000) == 0x80000000)
    {
        // Address would be in the multicast space
        address &= 0x7ffffffd;
    }
 
    // Workaround:
    // there is a bug in Wirepas reference gateway fixed in version 1.3.
    // It doesn't forward messages from nodes with an address with the
    // MSB set to one.
    // In order to avoid this situation, explicitly reset the highest bit when
    // generating a unique address.
    // If the target network only has gateways with version >= 1.3, or with
    // different gateway implementation it is safe to remove this line
    address &= 0x7fffffff;
 
    return address;
}
 
__STATIC_INLINE app_res_e OverrideNodeConfig(app_addr_t new_addr,
                                             app_lib_settings_role_t new_role,
                                             app_lib_settings_net_addr_t
                                             new_network_addr,
                                             app_lib_settings_net_channel_t
                                             new_network_ch)
{
    app_res_e res;
 
    res = lib_settings->setNodeAddress(new_addr);
    if (res != APP_RES_OK)
    {
        return res;
    }
    res = lib_settings->setNodeRole(new_role);
    if (res != APP_RES_OK)
    {
        return res;
    }
    res = lib_settings->setNetworkAddress(new_network_addr);
    if (res != APP_RES_OK)
    {
        return res;
    }
    res = lib_settings->setNetworkChannel(new_network_ch);
    if (res != APP_RES_OK)
    {
        return res;
    }
 
    return APP_RES_OK;
}
 
/*
 *  Network keys define in mcu/common/start.c and
 *  used only if default_network_cipher_key and default_network_authen_key
 *  are defined in one of the config.mk (set to NULL otherwise)
 */
extern const uint8_t * authen_key_p;
extern const uint8_t * cipher_key_p;
 
__STATIC_INLINE app_res_e configureNodeFromBuildParameters()
{
#if defined(NETWORK_ADDRESS) & defined(NETWORK_CHANNEL)
    return configureNode(getUniqueAddress(),
                         NETWORK_ADDRESS,
                         NETWORK_CHANNEL,
                         authen_key_p,
                         cipher_key_p);
#else
    return APP_RES_NOT_IMPLEMENTED;
#endif
}
 
#endif /* NODECONFIGURATION_H_ */