nRF5 SDK for Mesh v3.2.0  08c60f6

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.
 

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_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...
 
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_typeEvent type.
[in]p_eventPointer to event data, may be NULL.

Definition at line 140 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_cbEvent callback pointer.
Return values
NRF_SUCCESSSuccessfully initialized client and added to the access layer.
NRF_ERROR_NULLevent_cb was NULL.
NRF_ERROR_NO_MEMACCESS_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_handleDevice key handle for the remote server.
[in]server_address_handleHandle for the address of the remote server.
Return values
NRF_SUCCESS
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_INVALID_STATEClient 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_handleDevice key handle for the remote server.
Return values
NRF_SUCCESSSuccessfully bound the server to the client.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_INVALID_STATEClient not initialized.
NRF_ERROR_INVALID_PARAMInvalid 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_numberDevice 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_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_indexNetwork key index.
[in]appkey_indexApplication key index.
[in]p_appkeyPointer to NRF_MESH_KEY_SIZE byte application key.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_indexNetwork key index.
[in]appkey_indexApplication key index.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_indexNetwork key index.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_indexNetwork key index.
[in]appkey_indexApplication key index.
[in]p_appkeyPointer to NRF_MESH_KEY_SIZE byte application key.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_indexNetwork key index.
[in]p_netkeyPointer to NRF_MESH_KEY_SIZE byte network key.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_indexNetwork key index.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_indexNetwork key index.
[in]p_netkeyPointer to NRF_MESH_KEY_SIZE byte network key.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_addressElement address of the model.
[in]model_idModel identifier.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_statePublication state parameter struct pointer.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_addressElement address of the model.
[in]addressAddress to add to the subscription list.
[in]model_idModel ID of the model.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_addressElement address of the model.
[in]addressAddress to add to the subscription list.
[in]model_idModel ID of the model.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_addressElement address of the model.
[in]model_idModel ID of the model.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_addressElement address of the model.
[in]model_idModel ID of the model.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_addressElement address of the model.
[in]addressAddress to add to the subscription list.
[in]model_idModel ID of the model.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_addressElement address of the model.
[in]appkey_indexApplication key index to bind/unbind.
[in]model_idModel ID of the model.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_addressElement address of the model.
[in]model_idModel ID of the model.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_addressElement address of the model.
[in]appkey_indexApplication key index to bind/unbind.
[in]model_idModel ID of the model.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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]ttlDefault TTL value. Must be less than NRF_MESH_TTL_MAX.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_stateRelay state.
[in]retransmit_countNumber of times to re-transmit relayed packets.
[in]retransmit_interval_stepsNumber of 10 ms steps between each re-transmission.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient not initialized.
NRF_ERROR_INVALID_PARAMInvalid 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_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_countNumber of times to re-transmit originated packets.
[in]transmit_interval_stepsNumber of 10 ms steps between each re-transmission.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient not initialized.
NRF_ERROR_INVALID_PARAMInvalid 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_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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]stateNew secure network beacon state.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_indexNetwork key index.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_indexNetwork key index.
[in]phaseKey refresh phase to set for the node.
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_publicationPointer to the config_msg_heartbeat_publication_set_t structure
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient 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_subscriptionPointer to the config_msg_heartbeat_subscription_set_t structure
Return values
NRF_SUCCESSSuccessfully sent request.
NRF_ERROR_BUSYThe client is in a transaction. Try again later.
NRF_ERROR_NO_MEMNot enough memory available for sending request.
NRF_ERROR_INVALID_STATEClient not initialized.