nRF5 SDK for Mesh v3.2.0  08c60f6

Data Structures

struct  config_msg_key_index_24_t
 24-bit key index type. More...
 
union  config_model_id_t
 Model ID type for configuration messages. More...
 
struct  config_msg_appkey_add_t
 Message format for the AppKey Add message. More...
 
struct  config_msg_appkey_update_t
 Message format for the AppKey Update message. More...
 
struct  config_msg_appkey_delete_t
 Message format for the AppKey Delete message. More...
 
struct  config_msg_appkey_status_t
 Message format for the AppKey Status message. More...
 
struct  config_msg_appkey_get_t
 Message format for the AppKey Get message. More...
 
struct  config_msg_appkey_list_t
 Message format for the AppKey List message. More...
 
struct  config_msg_default_ttl_set_t
 Message format for the Default TTL Set message. More...
 
struct  config_msg_default_ttl_status_t
 Message format for the Default TTL Status message. More...
 
struct  config_msg_net_beacon_set_t
 Message format for the Config Beacon Set message. More...
 
struct  config_msg_net_beacon_status_t
 Message format for the Config Beacon Status message. More...
 
struct  config_publication_params_t
 Publication parameters. More...
 
struct  config_msg_publication_get_t
 Message format for the Model Publication Get message. More...
 
struct  config_msg_publication_set_t
 Message format for the Model Publication Set message. More...
 
struct  config_msg_publication_virtual_set_t
 Message format for the Model Publication Virtual Set message. More...
 
struct  config_msg_publication_status_t
 Message format for the Model Publication Status message. More...
 
struct  config_msg_subscription_add_del_owr_t
 Message format for the Model Subscription Add/Delete/Overwrite messages. More...
 
struct  config_msg_subscription_virtual_add_del_owr_t
 Message format for the Model Subscription Virtual Add/Delete/Overwrite messages. More...
 
struct  config_msg_subscription_delete_all_t
 Message format for the Model Subscription Delete All message. More...
 
struct  config_msg_subscription_status_t
 Message format for the Model Subscription Status message. More...
 
struct  config_msg_netkey_add_update_t
 Message format for the Network Key Add/Update messages. More...
 
struct  config_msg_netkey_delete_t
 Message format for the Network Key Delete message. More...
 
struct  config_msg_netkey_status_t
 Message format for the Network Key Status message. More...
 
struct  config_msg_proxy_status_t
 Message format for the GATT Proxy Status message. More...
 
struct  config_msg_proxy_set_t
 Message format for the GATT Proxy Set message. More...
 
struct  config_msg_friend_set_t
 Message format for the Friend Set message. More...
 
struct  config_msg_friend_status_t
 Message format for the Friend Status message. More...
 
struct  config_msg_key_refresh_phase_get_t
 Message format for the Key Refresh Phase Get message. More...
 
struct  config_msg_key_refresh_phase_set_t
 Message format for the Key Refresh Phase Set message. More...
 
struct  config_msg_key_refresh_phase_status_t
 Message format for the Key Refresh Phase Status message. More...
 
struct  config_msg_heartbeat_publication_set_t
 Message format for the Heartbeat Publication Set message. More...
 
struct  config_msg_heartbeat_publication_status_t
 Message format for the Heartbeat Publication Status message. More...
 
struct  config_msg_heartbeat_subscription_set_t
 Message format for the Heartbeat Subscription Set message. More...
 
struct  config_msg_heartbeat_subscription_status_t
 Message format for the Heartbeat Subscription Status message. More...
 
struct  config_msg_app_bind_unbind_t
 Message format for the Model App Bind/Unbind message. More...
 
struct  config_msg_app_status_t
 Message format for the Model App Status message. More...
 
struct  config_msg_identity_get_t
 Message format for the Node Identity Get message. More...
 
struct  config_msg_identity_set_t
 Message format for the Node Identity Set message. More...
 
struct  config_msg_identity_status_t
 Message format for the Node Identity Status message. More...
 
struct  config_msg_composition_data_get_t
 Message format for the Composition Data Get message. More...
 
struct  config_msg_composition_data_status_t
 Message format for the Composition Data Status message. More...
 
struct  config_msg_relay_status_t
 Message format for the Relay Status message. More...
 
struct  config_msg_relay_set_t
 Message format for the Relay Set message. More...
 
struct  config_msg_network_transmit_set_t
 Message format for the Network Transmit Set message. More...
 
struct  config_msg_network_transmit_status_t
 Message format for the Network Transmit Status message. More...
 
struct  config_msg_model_app_get_t
 Message format for the SIG/Vendor Model App Get message. More...
 
struct  config_msg_sig_model_app_list_t
 Message format for the SIG Model App List message. More...
 
struct  config_msg_vendor_model_app_list_t
 Message format for the Vendor Model App List message. More...
 
struct  config_msg_model_subscription_get_t
 Message format for the SIG/Vendor Model Subscription Get message. More...
 
struct  config_msg_sig_model_subscription_list_t
 Message format for the SIG Model Subscription List message. More...
 
struct  config_msg_vendor_model_subscription_list_t
 Message format for the Vendor Model Subscription List message. More...
 
struct  config_msg_low_power_node_polltimeout_get_t
 Message format for the Low Power node PollTimeout Get message. More...
 
struct  config_msg_low_power_node_polltimeout_status_t
 Message format for the Low Power node PollTimeout Status message. More...
 

Macros

#define CONFIG_RETRANSMIT_COUNT_MAX   ((1 << 3) - 1)
 Maximum re-transmit count.
 
#define CONFIG_RETRANSMIT_INTERVAL_STEPS_MAX   ((1 << 5) - 1)
 Maximum number of re-transmit interval steps.
 
#define CONFIG_RETRANSMIT_INTERVAL_STEP_TO_MS(STEP)   ((STEP) * 10)
 Gets the retransmit interval in milliseconds from the number of steps.
 
#define CONFIG_RETRANSMIT_INTERVAL_MS_TO_STEP(MS)   ((MS) / 10)
 Gets the retransmit interval steps from the interval in milliseconds.
 
#define CONFIG_MSG_KEY_INDEX_12_MASK   0x0fff
 Mask used for setting or extracting 12-bit key indexes.
 

Typedefs

typedef uint16_t config_msg_key_index_12_t
 12-bit key index type. More...
 

Enumerations

enum  config_net_beacon_state_t { CONFIG_NET_BEACON_STATE_DISABLED = 0, CONFIG_NET_BEACON_STATE_ENABLED = 1 }
 Possible values for the network beacon state. More...
 
enum  config_gatt_proxy_state_t { CONFIG_GATT_PROXY_STATE_RUNNING_DISABLED = 0x00, CONFIG_GATT_PROXY_STATE_RUNNING_ENABLED = 0x01, CONFIG_GATT_PROXY_STATE_UNSUPPORTED = 0x02 }
 Possible values for the GATT Proxy state. More...
 
enum  config_friend_state_t { CONFIG_FRIEND_STATE_SUPPORTED_DISABLED = 0x00, CONFIG_FRIEND_STATE_SUPPORTED_ENABLED = 0x01, CONFIG_FRIEND_STATE_UNSUPPORTED = 0x02 }
 Possible values for the Friend state. More...
 
enum  config_identity_state_t { CONFIG_IDENTITY_STATE_STOPPED = 0x00, CONFIG_IDENTITY_STATE_RUNNING = 0x01, CONFIG_IDENTITY_STATE_UNSUPPORTED = 0x02 }
 Possible values for the identity state. More...
 
enum  config_relay_state_t { CONFIG_RELAY_STATE_SUPPORTED_DISABLED = 0x00, CONFIG_RELAY_STATE_SUPPORTED_ENABLED = 0x01, CONFIG_RELAY_STATE_UNSUPPORTED = 0x02 }
 Values for the relay state. More...
 

Functions

static void config_msg_key_index_24_set (config_msg_key_index_24_t *p_idx24, uint16_t key_id_1, uint16_t key_id_2)
 Sets the value of the keys in a 24-bit index struct. More...
 
static void config_msg_key_index_24_get (const config_msg_key_index_24_t *p_idx24, uint16_t *p_key_id_1, uint16_t *p_key_id_2)
 Gets the value of one or both of the keys in a 24-bit index struct. More...
 
static void config_msg_model_id_set (config_model_id_t *p_dst, const access_model_id_t *p_src, bool is_sig)
 Sets the value of the model id for different kind of models (SIG or vendor). More...
 

Detailed Description

Message format definitions for the Config models.

Typedef Documentation

◆ config_msg_key_index_12_t

typedef uint16_t config_msg_key_index_12_t

12-bit key index type.

This provides room to store one 12-bit key in two bytes. Use the dedicated functions to manipulate this structure.

Definition at line 126 of file config_messages.h.

Enumeration Type Documentation

◆ config_net_beacon_state_t

Possible values for the network beacon state.

Enumerator
CONFIG_NET_BEACON_STATE_DISABLED 

The network beacon is disabled.

CONFIG_NET_BEACON_STATE_ENABLED 

The network beacon is enabled.

Definition at line 220 of file config_messages.h.

◆ config_gatt_proxy_state_t

Possible values for the GATT Proxy state.

Enumerator
CONFIG_GATT_PROXY_STATE_RUNNING_DISABLED 

The GATT proxy is running, but disabled.

CONFIG_GATT_PROXY_STATE_RUNNING_ENABLED 

The GATT proxy is running and enabled.

CONFIG_GATT_PROXY_STATE_UNSUPPORTED 

The GATT proxy feature is not supported.

Definition at line 336 of file config_messages.h.

◆ config_friend_state_t

Possible values for the Friend state.

Enumerator
CONFIG_FRIEND_STATE_SUPPORTED_DISABLED 

Friendship is supported, but disabled.

CONFIG_FRIEND_STATE_SUPPORTED_ENABLED 

Friendship is supported and enabled.

CONFIG_FRIEND_STATE_UNSUPPORTED 

Friendship is not supported.

Definition at line 356 of file config_messages.h.

◆ config_identity_state_t

Possible values for the identity state.

Enumerator
CONFIG_IDENTITY_STATE_STOPPED 

The node identity advertisement is stopped.

CONFIG_IDENTITY_STATE_RUNNING 

The node identity advertisement is running.

CONFIG_IDENTITY_STATE_UNSUPPORTED 

Node identity advertising is not supported.

Definition at line 457 of file config_messages.h.

◆ config_relay_state_t

Values for the relay state.

Enumerator
CONFIG_RELAY_STATE_SUPPORTED_DISABLED 

Relaying is supported, but disabled.

CONFIG_RELAY_STATE_SUPPORTED_ENABLED 

Relaying is supported and enabled.

CONFIG_RELAY_STATE_UNSUPPORTED 

Relaying is not supported.

Definition at line 499 of file config_messages.h.

Function Documentation

◆ config_msg_key_index_24_set()

static void config_msg_key_index_24_set ( config_msg_key_index_24_t p_idx24,
uint16_t  key_id_1,
uint16_t  key_id_2 
)
inlinestatic

Sets the value of the keys in a 24-bit index struct.

Parameters
[out]p_idx24Pointer to a 24-bit key index structure.
[in]key_id_1Value to assign to the first key index in the struct.
[in]key_id_2Value to assign th the second key index in the struct.

Definition at line 88 of file config_messages.h.

References config_msg_key_index_24_t::key_id_1_lsb, config_msg_key_index_24_t::key_id_1_msb, config_msg_key_index_24_t::key_id_2_lsb, and config_msg_key_index_24_t::key_id_2_msb.

◆ config_msg_key_index_24_get()

static void config_msg_key_index_24_get ( const config_msg_key_index_24_t p_idx24,
uint16_t *  p_key_id_1,
uint16_t *  p_key_id_2 
)
inlinestatic

Gets the value of one or both of the keys in a 24-bit index struct.

Parameters
[in]p_idx24Pointer to a 24-bit key index structure.
[out]p_key_id_1Pointer to where the first key index in the struct should be returned. This parameter can be set to NULL to skip retrieving the first key ID.
[out]p_key_id_2Pointer to where the second key index in the struct should be returned. This parameter can be set to NULL to skip retrieveing the second key ID.

Definition at line 105 of file config_messages.h.

References config_msg_key_index_24_t::key_id_1_lsb, config_msg_key_index_24_t::key_id_1_msb, config_msg_key_index_24_t::key_id_2_lsb, and config_msg_key_index_24_t::key_id_2_msb.

◆ config_msg_model_id_set()

static void config_msg_model_id_set ( config_model_id_t p_dst,
const access_model_id_t p_src,
bool  is_sig 
)
inlinestatic

Sets the value of the model id for different kind of models (SIG or vendor).

Parameters
[out]p_dstPointer to the packed payload.
[in]p_srcPointer to the access model memory .
[in]is_sigType of the model. True for SIG, false for vendor models.

Definition at line 153 of file config_messages.h.

References config_model_id_t::company_id, access_model_id_t::company_id, config_model_id_t::model_id, and access_model_id_t::model_id.