Remotely configure a mesh device by communicating with the remote device's Config server model. More...

Data Structures
struct	config_publication_state_t
	Publication state parameter structure. More...

union	config_msg_t
	Union of possible status message responses. More...

struct	config_client_event_t
	Configuration client event structure. More...

Macros
#define	CONFIG_CLIENT_ACKED_TRANSACTION_TIMEOUT (SEC_TO_US(60))
	Acknowledged message transaction timeout.

Typedefs
typedef void(*	config_client_event_cb_t) (config_client_event_type_t event_type, const config_client_event_t *p_event, uint16_t length)
	Configuration client event callback type. More...

Enumerations
enum	config_client_event_type_t { CONFIG_CLIENT_EVENT_TYPE_TIMEOUT, CONFIG_CLIENT_EVENT_TYPE_CANCELLED, CONFIG_CLIENT_EVENT_TYPE_MSG }
	Configuration client event types. More...

Functions
uint32_t	config_client_init (config_client_event_cb_t event_cb)
	Initializes the configuration client. More...

uint32_t	config_client_server_set (dsm_handle_t server_devkey_handle, dsm_handle_t server_address_handle)
	Sets the configuration server to configure. More...

uint32_t	config_client_server_bind (dsm_handle_t server_devkey_handle)
	Binds the configuration client to a server. More...

uint32_t	config_client_composition_data_get (uint8_t page_number)
	Sends a composition data GET request. More...

uint32_t	config_client_appkey_add (uint16_t netkey_index, uint16_t appkey_index, const uint8_t *p_appkey)
	Sends an application key add request. More...

uint32_t	config_client_appkey_delete (uint16_t netkey_index, uint16_t appkey_index)
	Sends an application key delete request. More...

uint32_t	config_client_appkey_get (uint16_t netkey_index)
	Sends an application key(s) get request. More...

uint32_t	config_client_appkey_update (uint16_t netkey_index, uint16_t appkey_index, const uint8_t *p_appkey)
	Sends an application key update request. More...

uint32_t	config_client_netkey_add (uint16_t netkey_index, const uint8_t *p_netkey)
	Sends a network key add request. More...

uint32_t	config_client_netkey_delete (uint16_t netkey_index)
	Sends a network key delete request. More...

uint32_t	config_client_netkey_get (void)
	Sends a network key(s) get request. More...

uint32_t	config_client_netkey_update (uint16_t netkey_index, const uint8_t *p_netkey)
	Sends a network key update request. More...

uint32_t	config_client_model_publication_get (uint16_t element_address, access_model_id_t model_id)
	Sends a publication get request. More...

uint32_t	config_client_model_publication_set (const config_publication_state_t *p_publication_state)
	Sends a model publication set request. More...

uint32_t	config_client_model_subscription_add (uint16_t element_address, nrf_mesh_address_t address, access_model_id_t model_id)
	Sends a subscription add request. More...

uint32_t	config_client_model_subscription_delete (uint16_t element_address, nrf_mesh_address_t address, access_model_id_t model_id)
	Sends a subscription delete request. More...

uint32_t	config_client_model_subscription_delete_all (uint16_t element_address, access_model_id_t model_id)
	Sends a subscription delete all request. More...

uint32_t	config_client_model_subscription_get (uint16_t element_address, access_model_id_t model_id)
	Sends a subscription get request. More...

uint32_t	config_client_model_subscription_overwrite (uint16_t element_address, nrf_mesh_address_t address, access_model_id_t model_id)
	Sends a subscription overwrite request. More...

uint32_t	config_client_model_app_bind (uint16_t element_address, uint16_t appkey_index, access_model_id_t model_id)
	Sends a application bind request. More...

uint32_t	config_client_model_app_get (uint16_t element_address, access_model_id_t model_id)
	Sends an application get request. More...

uint32_t	config_client_model_app_unbind (uint16_t element_address, uint16_t appkey_index, access_model_id_t model_id)
	Sends a application unbind request. More...

uint32_t	config_client_default_ttl_get (void)
	Sends a default TTL get request. More...

uint32_t	config_client_default_ttl_set (uint8_t ttl)
	Sends a default TTL set request. More...

uint32_t	config_client_relay_get (void)
	Sends a relay state get request. More...

uint32_t	config_client_relay_set (config_relay_state_t relay_state, uint8_t retransmit_count, uint8_t retransmit_interval_steps)
	Sends a relay state set request. More...

uint32_t	config_client_network_transmit_get (void)
	Sends a network transmit get request. More...

uint32_t	config_client_network_transmit_set (uint8_t transmit_count, uint8_t transmit_interval_steps)
	Sends a network transmit set request. More...

uint32_t	config_client_net_beacon_get (void)
	Sends a secure network beacon state get request. More...

uint32_t	config_client_net_beacon_set (config_net_beacon_state_t state)
	Sends a secure network beacon state set request. More...

uint32_t	config_client_node_reset (void)
	Sends a node reset request. More...

uint32_t	config_client_key_refresh_phase_get (uint16_t netkey_index)
	Gets the current key refresh phase of a node. More...

uint32_t	config_client_key_refresh_phase_set (uint16_t netkey_index, nrf_mesh_key_refresh_phase_t phase)
	Sets the current key refresh phase of a node. More...

uint32_t	config_client_friend_get (void)
	Gets the current Friend state of a node. More...

uint32_t	config_client_friend_set (config_friend_state_t state)
	Sets the Friend state of a node. More...

uint32_t	config_client_gatt_proxy_get (void)
	Gets the current GATT Proxy state of a node. More...

uint32_t	config_client_gatt_proxy_set (config_gatt_proxy_state_t state)
	Sets the GATT Proxy state of a node. More...

uint32_t	config_client_node_identity_get (uint16_t netkey_index)
	Gets the current Node Identity state of a node. More...

uint32_t	config_client_node_identity_set (uint16_t netkey_index, config_identity_state_t state)
	Sets the current Node Identity state of a node. More...

uint32_t	config_client_heartbeat_publication_get (void)
	Gets the heartbeat publication state value of a node. More...

uint32_t	config_client_heartbeat_publication_set (const config_msg_heartbeat_publication_set_t *p_publication)
	Sets the heartbeat publication state value of a node. More...

uint32_t	config_client_heartbeat_subscription_get (void)
	Gets the heartbeat subscription state value of a node. More...

uint32_t	config_client_heartbeat_subscription_set (const config_msg_heartbeat_subscription_set_t *p_subscription)
	Sets the heartbeat subscription state value of a node. More...

uint32_t	config_client_low_power_node_polltimeout_get (uint16_t lpn_address)
	Gets the current value of the PollTimeout timer of the Low Power node. More...

void	config_client_pending_msg_cancel (void)
	Cancel any ongoing reliable message transfer.

Detailed Description

Remotely configure a mesh device by communicating with the remote device's Config server model.

Typedef Documentation

◆ config_client_event_cb_t

typedef void(* config_client_event_cb_t) (config_client_event_type_t event_type, const config_client_event_t *p_event, uint16_t length)

Configuration client event callback type.

Parameters

[in]	event_type	Event type.
[in]	p_event	Pointer to event data, may be `NULL`.

Definition at line 141 of file config_client.h.

Enumeration Type Documentation

◆ config_client_event_type_t

enum config_client_event_type_t

Configuration client event types.

Definition at line 94 of file config_client.h.

Function Documentation

◆ config_client_init()

uint32_t config_client_init ( config_client_event_cb_t event_cb )

Initializes the configuration client.

Warning: This function can only be called once.

Parameters

[in] event_cb Event callback pointer.

Return values

NRF_SUCCESS	Successfully initialized client and added to the access layer.
NRF_ERROR_NULL	`event_cb` was `NULL`.
NRF_ERROR_NO_MEM	ACCESS_MODEL_COUNT number of models already allocated.

◆ config_client_server_set()

uint32_t config_client_server_set	(	dsm_handle_t	server_devkey_handle,
		dsm_handle_t	server_address_handle
	)

Sets the configuration server to configure.

Note: The address should be the address of the root element of the node (element 0).; The configuration client will handle the switching of device key implicitly.; The device key must be bound the client.

Parameters

[in]	server_devkey_handle	Device key handle for the remote server.
[in]	server_address_handle	Handle for the address of the remote server.

Return values

NRF_SUCCESS
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_server_bind()

uint32_t config_client_server_bind ( dsm_handle_t server_devkey_handle )

Binds the configuration client to a server.

Note: This function should be called for each new device that is to be configured.

Parameters

[in] server_devkey_handle Device key handle for the remote server.

Return values

NRF_SUCCESS	Successfully bound the server to the client.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_INVALID_STATE	Client not initialized.
NRF_ERROR_INVALID_PARAM	Invalid application key handle.

◆ config_client_composition_data_get()

uint32_t config_client_composition_data_get ( uint8_t page_number )

Sends a composition data GET request.

Note: Response: CONFIG_OPCODE_COMPOSITION_DATA_STATUS

Parameters

[in] page_number Device composition page number to be requested from the server

Note: Page 0x00 is the only mandatory page in Mesh 1.0. It is possible to read all supported Composition Data Pages by reading 0xFF first, and then reading one less than the returned page number until the page number is 0x00.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_appkey_add()

uint32_t config_client_appkey_add	(	uint16_t	netkey_index,
		uint16_t	appkey_index,
		const uint8_t *	p_appkey
	)

Sends an application key add request.

Note: Response: CONFIG_OPCODE_APPKEY_STATUS

Parameters

[in]	netkey_index	Network key index.
[in]	appkey_index	Application key index.
[in]	p_appkey	Pointer to NRF_MESH_KEY_SIZE byte application key.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_appkey_delete()

uint32_t config_client_appkey_delete	(	uint16_t	netkey_index,
		uint16_t	appkey_index
	)

Sends an application key delete request.

Note: Response: CONFIG_OPCODE_APPKEY_STATUS

Parameters

[in]	netkey_index	Network key index.
[in]	appkey_index	Application key index.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_appkey_get()

uint32_t config_client_appkey_get ( uint16_t netkey_index )

Sends an application key(s) get request.

Note: Response: CONFIG_OPCODE_APPKEY_LIST

Parameters

[in] netkey_index Network key index.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_appkey_update()

uint32_t config_client_appkey_update	(	uint16_t	netkey_index,
		uint16_t	appkey_index,
		const uint8_t *	p_appkey
	)

Sends an application key update request.

Note: Response: CONFIG_OPCODE_APPKEY_STATUS

Parameters

[in]	netkey_index	Network key index.
[in]	appkey_index	Application key index.
[in]	p_appkey	Pointer to NRF_MESH_KEY_SIZE byte application key.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_netkey_add()

uint32_t config_client_netkey_add	(	uint16_t	netkey_index,
		const uint8_t *	p_netkey
	)

Sends a network key add request.

Note: Response: CONFIG_OPCODE_NETKEY_STATUS

Parameters

[in]	netkey_index	Network key index.
[in]	p_netkey	Pointer to NRF_MESH_KEY_SIZE byte network key.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_netkey_delete()

uint32_t config_client_netkey_delete ( uint16_t netkey_index )

Sends a network key delete request.

Note: Response: CONFIG_OPCODE_NETKEY_STATUS

Parameters

[in] netkey_index Network key index.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_netkey_get()

uint32_t config_client_netkey_get ( void )

Sends a network key(s) get request.

Note: Response: CONFIG_OPCODE_NETKEY_LIST

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_netkey_update()

uint32_t config_client_netkey_update	(	uint16_t	netkey_index,
		const uint8_t *	p_netkey
	)

Sends a network key update request.

Note: Response: CONFIG_OPCODE_NETKEY_STATUS

Parameters

[in]	netkey_index	Network key index.
[in]	p_netkey	Pointer to NRF_MESH_KEY_SIZE byte network key.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_model_publication_get()

uint32_t config_client_model_publication_get	(	uint16_t	element_address,
		access_model_id_t	model_id
	)

Sends a publication get request.

Note: Response: CONFIG_OPCODE_MODEL_PUBLICATION_STATUS

Parameters

[in]	element_address	Element address of the model.
[in]	model_id	Model identifier.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_model_publication_set()

uint32_t config_client_model_publication_set ( const config_publication_state_t * p_publication_state )

Sends a model publication set request.

Note: Response: CONFIG_OPCODE_MODEL_PUBLICATION_STATUS

Parameters

[in] p_publication_state Publication state parameter struct pointer.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_model_subscription_add()

uint32_t config_client_model_subscription_add	(	uint16_t	element_address,
		nrf_mesh_address_t	address,
		access_model_id_t	model_id
	)

Sends a subscription add request.

Note: Response: CONFIG_OPCODE_MODEL_SUBSCRIPTION_STATUS

Parameters

[in]	element_address	Element address of the model.
[in]	address	Address to add to the subscription list.
[in]	model_id	Model ID of the model.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_model_subscription_delete()

uint32_t config_client_model_subscription_delete	(	uint16_t	element_address,
		nrf_mesh_address_t	address,
		access_model_id_t	model_id
	)

Sends a subscription delete request.

Note: Response: CONFIG_OPCODE_MODEL_SUBSCRIPTION_STATUS

Parameters

[in]	element_address	Element address of the model.
[in]	address	Address to add to the subscription list.
[in]	model_id	Model ID of the model.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_model_subscription_delete_all()

uint32_t config_client_model_subscription_delete_all	(	uint16_t	element_address,
		access_model_id_t	model_id
	)

Sends a subscription delete all request.

Note: Response: CONFIG_OPCODE_MODEL_SUBSCRIPTION_STATUS

Parameters

[in]	element_address	Element address of the model.
[in]	model_id	Model ID of the model.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_model_subscription_get()

uint32_t config_client_model_subscription_get	(	uint16_t	element_address,
		access_model_id_t	model_id
	)

Sends a subscription get request.

Note: Response for SIG models: CONFIG_OPCODE_SIG_MODEL_SUBSCRIPTION_LIST; Response for vendor models: CONFIG_OPCODE_VENDOR_MODEL_SUBSCRIPTION_LIST

Parameters

[in]	element_address	Element address of the model.
[in]	model_id	Model ID of the model.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_model_subscription_overwrite()

uint32_t config_client_model_subscription_overwrite	(	uint16_t	element_address,
		nrf_mesh_address_t	address,
		access_model_id_t	model_id
	)

Sends a subscription overwrite request.

Note: Response: CONFIG_OPCODE_MODEL_SUBSCRIPTION_STATUS

Warning: This will clear the subscription list of the model.

Parameters

[in]	element_address	Element address of the model.
[in]	address	Address to add to the subscription list.
[in]	model_id	Model ID of the model.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_model_app_bind()

uint32_t config_client_model_app_bind	(	uint16_t	element_address,
		uint16_t	appkey_index,
		access_model_id_t	model_id
	)

Sends a application bind request.

Note: Response: CONFIG_OPCODE_MODEL_APP_STATUS

Parameters

[in]	element_address	Element address of the model.
[in]	appkey_index	Application key index to bind/unbind.
[in]	model_id	Model ID of the model.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_model_app_get()

uint32_t config_client_model_app_get	(	uint16_t	element_address,
		access_model_id_t	model_id
	)

Sends an application get request.

Note: Response for SIG models: CONFIG_OPCODE_SIG_MODEL_APP_LIST; Response for vendor models: CONFIG_OPCODE_VENDOR_MODEL_APP_LIST

Parameters

[in]	element_address	Element address of the model.
[in]	model_id	Model ID of the model.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_model_app_unbind()

uint32_t config_client_model_app_unbind	(	uint16_t	element_address,
		uint16_t	appkey_index,
		access_model_id_t	model_id
	)

Sends a application unbind request.

Note: Response: CONFIG_OPCODE_MODEL_APP_STATUS

Parameters

[in]	element_address	Element address of the model.
[in]	appkey_index	Application key index to bind/unbind.
[in]	model_id	Model ID of the model.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_default_ttl_get()

uint32_t config_client_default_ttl_get ( void )

Sends a default TTL get request.

Note: Response: CONFIG_OPCODE_DEFAULT_TTL_STATUS

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_default_ttl_set()

uint32_t config_client_default_ttl_set ( uint8_t ttl )

Sends a default TTL set request.

Note: Response: CONFIG_OPCODE_DEFAULT_TTL_STATUS

Parameters

[in] ttl Default TTL value. Must be less than NRF_MESH_TTL_MAX.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_relay_get()

uint32_t config_client_relay_get ( void )

Sends a relay state get request.

Note: Response: CONFIG_OPCODE_RELAY_STATUS

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_relay_set()

uint32_t config_client_relay_set	(	config_relay_state_t	relay_state,
		uint8_t	retransmit_count,
		uint8_t	retransmit_interval_steps
	)

Sends a relay state set request.

Note: Response: CONFIG_OPCODE_RELAY_STATUS

Parameters

[in]	relay_state	Relay state.
[in]	retransmit_count	Number of times to re-transmit relayed packets.
[in]	retransmit_interval_steps	Number of 10 ms steps between each re-transmission.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.
NRF_ERROR_INVALID_PARAM	Invalid parameter values. See CONFIG_RETRANSMIT_COUNT_MAX and CONFIG_RETRANSMIT_INTERVAL_STEPS_MAX.

◆ config_client_network_transmit_get()

uint32_t config_client_network_transmit_get ( void )

Sends a network transmit get request.

Note: Response: CONFIG_OPCODE_NETWORK_TRANSMIT_STATUS

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_network_transmit_set()

uint32_t config_client_network_transmit_set	(	uint8_t	transmit_count,
		uint8_t	transmit_interval_steps
	)

Sends a network transmit set request.

Note: Response: CONFIG_OPCODE_NETWORK_TRANSMIT_STATUS

Parameters

[in]	transmit_count	Number of times to re-transmit originated packets.
[in]	transmit_interval_steps	Number of 10 ms steps between each re-transmission.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.
NRF_ERROR_INVALID_PARAM	Invalid parameter values. See CONFIG_RETRANSMIT_COUNT_MAX and CONFIG_RETRANSMIT_INTERVAL_STEPS_MAX.

◆ config_client_net_beacon_get()

uint32_t config_client_net_beacon_get ( void )

Sends a secure network beacon state get request.

Note: Response: CONFIG_OPCODE_BEACON_STATUS

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_net_beacon_set()

uint32_t config_client_net_beacon_set ( config_net_beacon_state_t state )

Sends a secure network beacon state set request.

Note: Response: CONFIG_OPCODE_BEACON_STATUS

Parameters

[in] state New secure network beacon state.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_node_reset()

uint32_t config_client_node_reset ( void )

Sends a node reset request.

Note: Response: CONFIG_OPCODE_NODE_RESET_STATUS

Warning: This will "un-provision" the node and remove it from the network.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_key_refresh_phase_get()

uint32_t config_client_key_refresh_phase_get ( uint16_t netkey_index )

Gets the current key refresh phase of a node.

Note: Response: CONFIG_OPCODE_KEY_REFRESH_PHASE_STATUS

Parameters

[in] netkey_index Network key index.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_key_refresh_phase_set()

uint32_t config_client_key_refresh_phase_set	(	uint16_t	netkey_index,
		nrf_mesh_key_refresh_phase_t	phase
	)

Sets the current key refresh phase of a node.

Note: Response: CONFIG_OPCODE_KEY_REFRESH_PHASE_STATUS

Parameters

[in]	netkey_index	Network key index.
[in]	phase	Key refresh phase to set for the node.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_friend_get()

uint32_t config_client_friend_get ( void )

Gets the current Friend state of a node.

Note: Response: CONFIG_OPCODE_FRIEND_STATUS

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_friend_set()

uint32_t config_client_friend_set ( config_friend_state_t state )

Sets the Friend state of a node.

Note: Response: CONFIG_OPCODE_FRIEND_STATUS

Parameters

[in] state New Friend state.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_gatt_proxy_get()

uint32_t config_client_gatt_proxy_get ( void )

Gets the current GATT Proxy state of a node.

Note: Response: CONFIG_OPCODE_GATT_PROXY_STATUS

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_gatt_proxy_set()

uint32_t config_client_gatt_proxy_set ( config_gatt_proxy_state_t state )

Sets the GATT Proxy state of a node.

Note: Response: CONFIG_OPCODE_GATT_PROXY_STATUS

Parameters

[in] state New Friend state.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_node_identity_get()

uint32_t config_client_node_identity_get ( uint16_t netkey_index )

Gets the current Node Identity state of a node.

Note: Response: CONFIG_OPCODE_NODE_IDENTITY_STATUS

Parameters

[in] netkey_index Network key index.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_node_identity_set()

uint32_t config_client_node_identity_set	(	uint16_t	netkey_index,
		config_identity_state_t	state
	)

Sets the current Node Identity state of a node.

Note: Response: CONFIG_OPCODE_NODE_IDENTITY_STATUS

Parameters

[in]	netkey_index	Network key index.
[in]	state	Node Identity state to set for the node.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_heartbeat_publication_get()

uint32_t config_client_heartbeat_publication_get ( void )

Gets the heartbeat publication state value of a node.

Note: Response: CONFIG_OPCODE_HEARTBEAT_PUBLICATION_STATUS

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_heartbeat_publication_set()

uint32_t config_client_heartbeat_publication_set ( const config_msg_heartbeat_publication_set_t * p_publication )

Sets the heartbeat publication state value of a node.

Note: Response: CONFIG_OPCODE_HEARTBEAT_PUBLICATION_STATUS

Parameters

[in] p_publication Pointer to the config_msg_heartbeat_publication_set_t structure

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_heartbeat_subscription_get()

uint32_t config_client_heartbeat_subscription_get ( void )

Gets the heartbeat subscription state value of a node.

Note: Response: CONFIG_OPCODE_HEARTBEAT_SUBSCRIPTION_STATUS

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_heartbeat_subscription_set()

uint32_t config_client_heartbeat_subscription_set ( const config_msg_heartbeat_subscription_set_t * p_subscription )

Sets the heartbeat subscription state value of a node.

Note: Response: CONFIG_OPCODE_HEARTBEAT_SUBSCRIPTION_STATUS

Parameters

[in] p_subscription Pointer to the config_msg_heartbeat_subscription_set_t structure

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

◆ config_client_low_power_node_polltimeout_get()

uint32_t config_client_low_power_node_polltimeout_get ( uint16_t lpn_address )

Gets the current value of the PollTimeout timer of the Low Power node.

Note: Response: CONFIG_OPCODE_LOW_POWER_NODE_POLLTIMEOUT_STATUS

Parameters

[in] lpn_address Address of the Low Power node.

Return values

NRF_SUCCESS	Successfully sent request.
NRF_ERROR_BUSY	The client is in a transaction. Try again later.
NRF_ERROR_NO_MEM	Not enough memory available for sending request.
NRF_ERROR_INVALID_STATE	Client not initialized.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ config_client_event_cb_t

Enumeration Type Documentation

◆ config_client_event_type_t

Function Documentation

◆ config_client_init()

◆ config_client_server_set()

◆ config_client_server_bind()

◆ config_client_composition_data_get()

◆ config_client_appkey_add()

◆ config_client_appkey_delete()

◆ config_client_appkey_get()

◆ config_client_appkey_update()

◆ config_client_netkey_add()

◆ config_client_netkey_delete()

◆ config_client_netkey_get()

◆ config_client_netkey_update()

◆ config_client_model_publication_get()

◆ config_client_model_publication_set()

◆ config_client_model_subscription_add()

◆ config_client_model_subscription_delete()

◆ config_client_model_subscription_delete_all()

◆ config_client_model_subscription_get()

◆ config_client_model_subscription_overwrite()

◆ config_client_model_app_bind()

◆ config_client_model_app_get()

◆ config_client_model_app_unbind()

◆ config_client_default_ttl_get()

◆ config_client_default_ttl_set()

◆ config_client_relay_get()

◆ config_client_relay_set()

◆ config_client_network_transmit_get()

◆ config_client_network_transmit_set()

◆ config_client_net_beacon_get()

◆ config_client_net_beacon_set()

◆ config_client_node_reset()

◆ config_client_key_refresh_phase_get()

◆ config_client_key_refresh_phase_set()

◆ config_client_friend_get()

◆ config_client_friend_set()

◆ config_client_gatt_proxy_get()

◆ config_client_gatt_proxy_set()

◆ config_client_node_identity_get()

◆ config_client_node_identity_set()

◆ config_client_heartbeat_publication_get()

◆ config_client_heartbeat_publication_set()

◆ config_client_heartbeat_subscription_get()

◆ config_client_heartbeat_subscription_set()

◆ config_client_low_power_node_polltimeout_get()