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. | |
Remotely configure a mesh device by communicating with the remote device's Config server model.
| 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.
| [in] | event_type | Event type. |
| [in] | p_event | Pointer to event data, may be NULL. |
Definition at line 141 of file config_client.h.
Configuration client event types.
Definition at line 94 of file config_client.h.
| uint32_t config_client_init | ( | config_client_event_cb_t | event_cb | ) |
Initializes the configuration client.
| [in] | event_cb | Event callback pointer. |
| 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. |
| uint32_t config_client_server_set | ( | dsm_handle_t | server_devkey_handle, |
| dsm_handle_t | server_address_handle | ||
| ) |
Sets the configuration server to configure.
| [in] | server_devkey_handle | Device key handle for the remote server. |
| [in] | server_address_handle | Handle for the address of the remote server. |
| NRF_SUCCESS | |
| NRF_ERROR_BUSY | The client is in a transaction. Try again later. |
| NRF_ERROR_INVALID_STATE | Client not initialized. |
| uint32_t config_client_server_bind | ( | dsm_handle_t | server_devkey_handle | ) |
Binds the configuration client to a server.
| [in] | server_devkey_handle | Device key handle for the remote server. |
| 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. |
| uint32_t config_client_composition_data_get | ( | uint8_t | page_number | ) |
Sends a composition data GET request.
| [in] | page_number | Device composition page number to be requested from the server |
| 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. |
| 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.
| [in] | netkey_index | Network key index. |
| [in] | appkey_index | Application key index. |
| [in] | p_appkey | Pointer to NRF_MESH_KEY_SIZE byte application key. |
| 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. |
| uint32_t config_client_appkey_delete | ( | uint16_t | netkey_index, |
| uint16_t | appkey_index | ||
| ) |
Sends an application key delete request.
| [in] | netkey_index | Network key index. |
| [in] | appkey_index | Application key index. |
| 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. |
| uint32_t config_client_appkey_get | ( | uint16_t | netkey_index | ) |
Sends an application key(s) get request.
| [in] | netkey_index | Network key index. |
| 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. |
| 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.
| [in] | netkey_index | Network key index. |
| [in] | appkey_index | Application key index. |
| [in] | p_appkey | Pointer to NRF_MESH_KEY_SIZE byte application key. |
| 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. |
| uint32_t config_client_netkey_add | ( | uint16_t | netkey_index, |
| const uint8_t * | p_netkey | ||
| ) |
Sends a network key add request.
| [in] | netkey_index | Network key index. |
| [in] | p_netkey | Pointer to NRF_MESH_KEY_SIZE byte network key. |
| 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. |
| uint32_t config_client_netkey_delete | ( | uint16_t | netkey_index | ) |
Sends a network key delete request.
| [in] | netkey_index | Network key index. |
| 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. |
| uint32_t config_client_netkey_get | ( | void | ) |
Sends a network key(s) get request.
| 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. |
| uint32_t config_client_netkey_update | ( | uint16_t | netkey_index, |
| const uint8_t * | p_netkey | ||
| ) |
Sends a network key update request.
| [in] | netkey_index | Network key index. |
| [in] | p_netkey | Pointer to NRF_MESH_KEY_SIZE byte network key. |
| 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. |
| uint32_t config_client_model_publication_get | ( | uint16_t | element_address, |
| access_model_id_t | model_id | ||
| ) |
Sends a publication get request.
| [in] | element_address | Element address of the model. |
| [in] | model_id | Model identifier. |
| 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. |
| uint32_t config_client_model_publication_set | ( | const config_publication_state_t * | p_publication_state | ) |
Sends a model publication set request.
| [in] | p_publication_state | Publication state parameter struct pointer. |
| 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. |
| 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.
| [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. |
| 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. |
| 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.
| [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. |
| 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. |
| uint32_t config_client_model_subscription_delete_all | ( | uint16_t | element_address, |
| access_model_id_t | model_id | ||
| ) |
Sends a subscription delete all request.
| [in] | element_address | Element address of the model. |
| [in] | model_id | Model ID of the model. |
| 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. |
| uint32_t config_client_model_subscription_get | ( | uint16_t | element_address, |
| access_model_id_t | model_id | ||
| ) |
Sends a subscription get request.
| [in] | element_address | Element address of the model. |
| [in] | model_id | Model ID of the model. |
| 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. |
| 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.
| [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. |
| 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. |
| 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.
| [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. |
| 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. |
| uint32_t config_client_model_app_get | ( | uint16_t | element_address, |
| access_model_id_t | model_id | ||
| ) |
Sends an application get request.
| [in] | element_address | Element address of the model. |
| [in] | model_id | Model ID of the model. |
| 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. |
| 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.
| [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. |
| 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. |
| uint32_t config_client_default_ttl_get | ( | void | ) |
Sends a default TTL get request.
| 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. |
| uint32_t config_client_default_ttl_set | ( | uint8_t | ttl | ) |
Sends a default TTL set request.
| [in] | ttl | Default TTL value. Must be less than NRF_MESH_TTL_MAX. |
| 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. |
| uint32_t config_client_relay_get | ( | void | ) |
Sends a relay state get request.
| 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. |
| 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.
| [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. |
| 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. |
| uint32_t config_client_network_transmit_get | ( | void | ) |
Sends a network transmit get request.
| 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. |
| uint32_t config_client_network_transmit_set | ( | uint8_t | transmit_count, |
| uint8_t | transmit_interval_steps | ||
| ) |
Sends a network transmit set request.
| [in] | transmit_count | Number of times to re-transmit originated packets. |
| [in] | transmit_interval_steps | Number of 10 ms steps between each re-transmission. |
| 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. |
| uint32_t config_client_net_beacon_get | ( | void | ) |
Sends a secure network beacon state get request.
| 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. |
| uint32_t config_client_net_beacon_set | ( | config_net_beacon_state_t | state | ) |
Sends a secure network beacon state set request.
| [in] | state | New secure network beacon state. |
| 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. |
| uint32_t config_client_node_reset | ( | void | ) |
Sends a node reset request.
| 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. |
| uint32_t config_client_key_refresh_phase_get | ( | uint16_t | netkey_index | ) |
Gets the current key refresh phase of a node.
| [in] | netkey_index | Network key index. |
| 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. |
| 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.
| [in] | netkey_index | Network key index. |
| [in] | phase | Key refresh phase to set for the node. |
| 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. |
| uint32_t config_client_friend_get | ( | void | ) |
Gets the current Friend state of a node.
| 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. |
| uint32_t config_client_friend_set | ( | config_friend_state_t | state | ) |
Sets the Friend state of a node.
| [in] | state | New Friend state. |
| 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. |
| uint32_t config_client_gatt_proxy_get | ( | void | ) |
Gets the current GATT Proxy state of a node.
| 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. |
| uint32_t config_client_gatt_proxy_set | ( | config_gatt_proxy_state_t | state | ) |
Sets the GATT Proxy state of a node.
| [in] | state | New Friend state. |
| 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. |
| uint32_t config_client_node_identity_get | ( | uint16_t | netkey_index | ) |
Gets the current Node Identity state of a node.
| [in] | netkey_index | Network key index. |
| 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. |
| 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.
| [in] | netkey_index | Network key index. |
| [in] | state | Node Identity state to set for the node. |
| 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. |
| uint32_t config_client_heartbeat_publication_get | ( | void | ) |
Gets the heartbeat publication state value of a node.
| 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. |
| 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.
| [in] | p_publication | Pointer to the config_msg_heartbeat_publication_set_t structure |
| 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. |
| uint32_t config_client_heartbeat_subscription_get | ( | void | ) |
Gets the heartbeat subscription state value of a node.
| 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. |
| 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.
| [in] | p_subscription | Pointer to the config_msg_heartbeat_subscription_set_t structure |
| 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. |
| 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.
| [in] | lpn_address | Address of the Low Power node. |
| 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. |