Composition data part of the config model. More...

Data Structures
struct	config_composition_data_header_t
	Composition data header. More...

struct	config_composition_element_header_t
	Access element header fields in the composition data. More...

Macros
#define	CONFIG_SIG_MODEL_ID_SIZE (2)
	Number of bytes used to represent a Bluetooth SIG model identifier in the composition data. More...

#define	CONFIG_VENDOR_MODEL_ID_SIZE (4)
	Number of bytes used to represent a vendor specific model identifier in the composition data. More...

#define	CONFIG_MODEL_ID_SIZE_MAX (CONFIG_VENDOR_MODEL_ID_SIZE)
	Size of the largest model identifier. More...

#define	COMPOSITION_DATA_LENGTH_MIN
	Minimum size of a composition data status block. More...

#define	CONFIG_COMPOSITION_DATA_SIZE
	The (maximum) size of the composition data block. More...

Enumerations
enum	config_feature_bit_t { CONFIG_FEATURE_RELAY_BIT = (1 << 0), CONFIG_FEATURE_PROXY_BIT = (1 << 1), CONFIG_FEATURE_FRIEND_BIT = (1 << 2), CONFIG_FEATURE_LOW_POWER_BIT = (1 << 3) }
	Configuration feature bits. More...

Functions
void	config_composition_data_get (uint8_t p_data, uint16_t p_size)
	Gets the composition data block. More...

Detailed Description

Composition data part of the config model.

The composition data is the presentation of the model and element composition of a mesh device.

Macro Definition Documentation

◆ CONFIG_SIG_MODEL_ID_SIZE

#define CONFIG_SIG_MODEL_ID_SIZE (2)

Number of bytes used to represent a Bluetooth SIG model identifier in the composition data.

Definition at line 52 of file composition_data.h.

◆ CONFIG_VENDOR_MODEL_ID_SIZE

#define CONFIG_VENDOR_MODEL_ID_SIZE (4)

Number of bytes used to represent a vendor specific model identifier in the composition data.

Definition at line 54 of file composition_data.h.

◆ CONFIG_MODEL_ID_SIZE_MAX

#define CONFIG_MODEL_ID_SIZE_MAX (CONFIG_VENDOR_MODEL_ID_SIZE)

Size of the largest model identifier.

Definition at line 56 of file composition_data.h.

◆ COMPOSITION_DATA_LENGTH_MIN

#define COMPOSITION_DATA_LENGTH_MIN

Value:

(sizeof(config_msg_composition_data_status_t) + \
                                     sizeof(config_composition_data_header_t) + \
                                     sizeof(config_composition_element_header_t) + \
                                     CONFIG_SIG_MODEL_ID_SIZE)
config_composition_data_header_t
Composition data header. 
Definition: composition_data.h:67
config_composition_element_header_t
Access element header fields in the composition data. 
Definition: composition_data.h:82
config_msg_composition_data_status_t
Message format for the Composition Data Status message. 
Definition: config_messages.h:492

Minimum size of a composition data status block.

Definition at line 59 of file composition_data.h.

◆ CONFIG_COMPOSITION_DATA_SIZE

#define CONFIG_COMPOSITION_DATA_SIZE

Value:

(sizeof(config_composition_data_header_t) +                         \
     (ACCESS_ELEMENT_COUNT) * sizeof(config_composition_element_header_t) + \
     (ACCESS_MODEL_COUNT) * CONFIG_MODEL_ID_SIZE_MAX)                   \
ACCESS_MODEL_COUNT
#define ACCESS_MODEL_COUNT
The number of models in the application. 
Definition: nrf_mesh_config_app.h:86
config_composition_data_header_t
Composition data header. 
Definition: composition_data.h:67
config_composition_element_header_t
Access element header fields in the composition data. 
Definition: composition_data.h:82
CONFIG_MODEL_ID_SIZE_MAX
#define CONFIG_MODEL_ID_SIZE_MAX
Size of the largest model identifier. 
Definition: composition_data.h:56
ACCESS_ELEMENT_COUNT
#define ACCESS_ELEMENT_COUNT
The number of elements in the application. 
Definition: nrf_mesh_config_app.h:94

The (maximum) size of the composition data block.

Definition at line 95 of file composition_data.h.

Enumeration Type Documentation

◆ config_feature_bit_t

enum config_feature_bit_t

Configuration feature bits.

Enumerator
CONFIG_FEATURE_RELAY_BIT	This node supports the relay feature.
CONFIG_FEATURE_PROXY_BIT	This node supports the proxy feature.
CONFIG_FEATURE_FRIEND_BIT	This node supports the friend feature.
CONFIG_FEATURE_LOW_POWER_BIT	This node supports the low power feature.

Definition at line 102 of file composition_data.h.

Function Documentation

◆ config_composition_data_get()

void config_composition_data_get	(	uint8_t *	p_data,
		uint16_t *	p_size
	)

Gets the composition data block.

Parameters

[in,out]	p_data	Pointer to block of memory to write the composition data.
[in,out]	p_size	Size of the data block. Actual size is written back to the variable.

Return values

NRF_SUCCESS	Successfully wrote the composition data block.
NRF_ERROR_NULL	Function parameter was NULL.
NRF_ERROR_INVALID_LENGTH	Data block size too small.

Composition data module

nRF5 SDK for Mesh v5.0.0

Data Structures

Macros

Enumerations

Functions