Rtos API example

Embed: (wiki syntax)

« Back to documentation index

link_configuration Struct Reference

link_configuration Struct Reference

Thread network configuration. More...

#include <thread_management_if.h>

Data Fields

uint8_t name [16]
 Name of the Thread network.
uint8_t master_key [16]
 Master key of the thread network.
uint8_t PSKc [16]
 PSKc value that is calculated from commissioning credentials credentials,XPANID and network name.
uint8_t mesh_local_ula_prefix [8]
 Mesh local ula prefix.
uint8_t mesh_local_eid [8]
 Mesh local extented id.
uint8_t extented_pan_id [8]
 Extended pan id.
uint8_t extended_random_mac [8]
 Extended random mac which is generated during commissioning.
uint8_t channel_mask [8]
 channel page and mask only supported is page 0
uint8_t channel_page
 channel page supported pages 0
char * PSKc_ptr
 Commissioning credentials.
uint8_t PSKc_len
 Length of PSKc.
uint16_t key_rotation
 Key rotation time in hours.
uint32_t key_sequence
 Key sequence counter.
uint16_t panId
 network id
uint8_t Protocol_id
 current protocol id
uint8_t version
 current protocol version
uint16_t rfChannel
 current rf channel
uint8_t securityPolicy
 Commission Security Policy.
uint64_t timestamp
 commissioning data set timestamp.

Detailed Description

Thread network configuration.

You can use this structure in start-up in case of a static configuration. This data can also be read after joining the Thread network. If this data is not provided to the stack, the device starts the commissioning process to join the Thread network.

If the data is provided, all fields must be initialised to 0.

If XPANID and MASTER KEY are provided, the device starts out-of-band commissioning. The values must be initialised to other than 0. If mesh_local_eid is initialised to 0 it is randomized at start-up. If extended_random_mac is initialised to 0 it is randomized at start-up.

If timestamp values are set to 0 it triggers a network configuration update when joining the network.

Definition at line 57 of file thread_management_if.h.


Field Documentation

uint8_t channel_mask[8]

channel page and mask only supported is page 0

Definition at line 65 of file thread_management_if.h.

uint8_t channel_page

channel page supported pages 0

Definition at line 66 of file thread_management_if.h.

uint8_t extended_random_mac[8]

Extended random mac which is generated during commissioning.

Definition at line 64 of file thread_management_if.h.

uint8_t extented_pan_id[8]

Extended pan id.

Definition at line 63 of file thread_management_if.h.

uint16_t key_rotation

Key rotation time in hours.

Definition at line 69 of file thread_management_if.h.

uint32_t key_sequence

Key sequence counter.

Definition at line 70 of file thread_management_if.h.

uint8_t master_key[16]

Master key of the thread network.

Definition at line 59 of file thread_management_if.h.

uint8_t mesh_local_eid[8]

Mesh local extented id.

Definition at line 62 of file thread_management_if.h.

Mesh local ula prefix.

Definition at line 61 of file thread_management_if.h.

uint8_t name[16]

Name of the Thread network.

Definition at line 58 of file thread_management_if.h.

uint16_t panId

network id

Definition at line 71 of file thread_management_if.h.

uint8_t Protocol_id

current protocol id

Definition at line 72 of file thread_management_if.h.

uint8_t PSKc[16]

PSKc value that is calculated from commissioning credentials credentials,XPANID and network name.

Definition at line 60 of file thread_management_if.h.

uint8_t PSKc_len

Length of PSKc.

Definition at line 68 of file thread_management_if.h.

char* PSKc_ptr

Commissioning credentials.

TODO! think if we need the actual credentials

Definition at line 67 of file thread_management_if.h.

uint16_t rfChannel

current rf channel

Definition at line 74 of file thread_management_if.h.

uint8_t securityPolicy

Commission Security Policy.

Definition at line 75 of file thread_management_if.h.

uint64_t timestamp

commissioning data set timestamp.

[48 bit timestamp seconds]-[15 bit timestamp ticks]-[U bit]

Definition at line 76 of file thread_management_if.h.

uint8_t version

current protocol version

Definition at line 73 of file thread_management_if.h.