node_configuration.h File Reference

Go to the source code of this file.

Functions
__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)
	Helper function to initially setup a node if not already configured. This configuration can be modified later with remote API. More...
__STATIC_INLINE app_addr_t	getUniqueAddress ()
	Helper function to generate a unique unicast address. More...
__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)
	Helper function to apply new configuration on a node. Will override old configuration. More...
__STATIC_INLINE app_res_e	configureNodeFromBuildParameters ()
	Wrapper on top of configureNode to get parameters from build system and hardcoded values from chip (for unique node address) The value must be defined in app confik.mk file at build time. More...

Variables
const uint8_t *	authen_key_p
const uint8_t *	cipher_key_p

Function Documentation

configureNode()

__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
	)

Helper function to initially setup a node if not already configured. This configuration can be modified later with remote API.

Example on use. Address, network address and channel is set if they are not yet set:

#define NETWORK_ADDRESS  0x123456
#define NETWORK_CHANNEL  1
 
static const uint8_t authen_key[16] = {0x11,...,0xff}
static const uint8_t cipher_key[16] = {0x11,...,0xff}
 
void App_init(const app_global_functions_t * functions)
{
    // Basic configuration of the node with a unique node address
    if (configureNode(getUniqueAddress(),
                      NETWORK_ADDRESS,
                      NETWORK_CHANNEL,
                      authen_key,
                      cypher_key) != APP_RES_OK)
    {
        // Could not configure the node
        // It should not happen except if one of the config value is invalid
        return;
    }
    ...
}

Parameters

my_addr	Node Address to set if not present
my_network_addr	Network address to set if not present
my_network_ch	Network channel to set if not present
my_authentication_key_p	Authentication key to set if not present. If NULL, it is not set.
my_encryption_key_p	Encryption key to set if not present. If NULL, it is not set.

Returns

APP_RES_OK if the configuration is successful, an error code otherwise

Note

Only unset parameters are set

Keys are only set if node address was not set before calling this function to avoid setting a key in case the keys were removed intentionally from remote api

Definition at line 63 of file node_configuration.h.

{
    // 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;
}

configureNodeFromBuildParameters()

__STATIC_INLINE app_res_e configureNodeFromBuildParameters

(

)

Wrapper on top of configureNode to get parameters from build system and hardcoded values from chip (for unique node address) The value must be defined in app confik.mk file at build time.

Returns

APP_RES_OK if the configuration is successful, an error code otherwise

Note

Calling this function without setting a network address and channel in your config.mk will result in an error at execution time

Examples

appconfig/app.c, custom_app/app.c, minimal_app/app.c, scheduler/app.c, and shared_data/app.c.

Definition at line 224 of file node_configuration.h.

{
#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
}

getUniqueAddress()

__STATIC_INLINE app_addr_t getUniqueAddress

(

)

Helper function to generate a unique unicast address.

Returns

A unique unicast address generated from chip unique id

Definition at line 139 of file node_configuration.h.

{
    app_addr_t address = getUniqueId();
 
    // Check the address is in correct range
    if ((address & 0xFF000000) == 0x80000000)
    {
        // Address would be in the multicast space
        address &= 0x7fffffff;
    }
 
    if (address == 0x0)
    {
        // Zero is not a valid address
        address = 1;
    }
 
    return address;
}

OverrideNodeConfig()

__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
	)

Helper function to apply new configuration on a node. Will override old configuration.

Parameters

new_addr	Node Address to set
new_role	Node Role to set
new_network_addr	Network address to set
new_network_ch	Network channel to set

Returns

APP_RES_OK if the configuration is successful, an error code otherwise

Definition at line 173 of file node_configuration.h.

{
    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;
}

Variable Documentation

authen_key_p

const uint8_t* authen_key_p

cipher_key_p

const uint8_t* cipher_key_p