This module implements the remote provisioning server (PB-remote server) model. More...
Data Structures | |
| struct | pb_remote_server_t |
| Remote provisioning server context structure. More... | |
Macros | |
| #define | PB_REMOTE_SERVER_MODEL_ID (0x0004) |
| Remote provisioning server model identifier. More... | |
| #define | PB_REMOTE_SERVER_UUID_LIST_SIZE (3) |
| Size of the remote server UUID list. More... | |
| #define | PB_REMOTE_SERVER_ACKED_TRANSACTION_TIMEOUT (SEC_TO_US(60)) |
| Acknowledged message transaction timeout. | |
Functions | |
| uint32_t | pb_remote_server_init (pb_remote_server_t *p_server, uint16_t element_index) |
| Initializes the remote provisioning server model. More... | |
| uint32_t | pb_remote_server_enable (pb_remote_server_t *p_server) |
| Enables the remote provisioning server. More... | |
| uint32_t | pb_remote_server_disable (pb_remote_server_t *p_server) |
| Disables the remote provisioning server. More... | |
| uint32_t | pb_remote_server_return_to_scan_set (pb_remote_server_t *p_server, bool state) |
| Sets the return to scan state. More... | |
| uint32_t | pb_remote_server_prov_bearer_set (pb_remote_server_t *p_server, prov_bearer_t *p_prov_bearer) |
| Sets the provisioning bearer for the remote provisioning server. More... | |
Detailed Description
This module implements the remote provisioning server (PB-remote server) model.
For conceptual information, see Remote provisioning (PB-remote).
Initializing the Remote Provisioning Server
Remote Provisioning Server state diagram
Macro Definition Documentation
◆ PB_REMOTE_SERVER_MODEL_ID
| #define PB_REMOTE_SERVER_MODEL_ID (0x0004) |
Remote provisioning server model identifier.
Definition at line 60 of file pb_remote_server.h.
◆ PB_REMOTE_SERVER_UUID_LIST_SIZE
| #define PB_REMOTE_SERVER_UUID_LIST_SIZE (3) |
Size of the remote server UUID list.
Definition at line 62 of file pb_remote_server.h.
Enumeration Type Documentation
◆ pb_remote_server_state_t
Remote Provisioning Server states.
Definition at line 71 of file pb_remote_server.h.
Function Documentation
◆ pb_remote_server_init()
| uint32_t pb_remote_server_init | ( | pb_remote_server_t * | p_server, |
| uint16_t | element_index | ||
| ) |
Initializes the remote provisioning server model.
- Note
- This function is expected to be called once for a remote server.
- Parameters
-
[in,out] p_server Remote server context structure pointer. [in] element_index Element index to bind the remote server model.
- Return values
-
NRF_SUCCESS Successfully initialized the model. NRF_ERROR_NULL NULL pointer supplied to function. NRF_ERROR_NO_MEM No more memory available to allocate model. NRF_ERROR_FORBIDDEN Multiple model instances per element is not allowed. NRF_ERROR_NOT_FOUND Invalid element index. NRF_ERROR_INVALID_STATE Model was already initialized.
◆ pb_remote_server_enable()
| uint32_t pb_remote_server_enable | ( | pb_remote_server_t * | p_server | ) |
Enables the remote provisioning server.
- Parameters
-
[in,out] p_server Remote server context pointer.
- Return values
-
NRF_SUCCESS Successfull enabled remote server. NRF_ERROR_NULL NULL pointer in function arguments. NRF_ERROR_INVALID_STATE A remote server may only enabled in the PB_REMOTE_SERVER_STATE_DISABLED state.
◆ pb_remote_server_disable()
| uint32_t pb_remote_server_disable | ( | pb_remote_server_t * | p_server | ) |
Disables the remote provisioning server.
- Parameters
-
[in,out] p_server Remote server context pointer.
- Return values
-
NRF_SUCCESS Successfully disabled remote server. NRF_ERROR_NULL NULL pointer in function arguments. NRF_ERROR_INVALID_STATE A remote server may only disabled in the PB_REMOTE_SERVER_STATE_IDLE, PB_REMOTE_SERVER_STATE_SCANNING or PB_REMOTE_SERVER_STATE_SCANNING_FILTER states.
◆ pb_remote_server_return_to_scan_set()
| uint32_t pb_remote_server_return_to_scan_set | ( | pb_remote_server_t * | p_server, |
| bool | state | ||
| ) |
Sets the return to scan state.
- Parameters
-
[in,out] p_server Remote server context pointer. [in] state Enable or disable the return to scanning mode.
- Return values
-
NRF_SUCCESS Successfully set return to scan state. NRF_ERROR_NULL NULL pointer in function arguments.
◆ pb_remote_server_prov_bearer_set()
| uint32_t pb_remote_server_prov_bearer_set | ( | pb_remote_server_t * | p_server, |
| prov_bearer_t * | p_prov_bearer | ||
| ) |
Sets the provisioning bearer for the remote provisioning server.
- Parameters
-
[in,out] p_server Remote server context pointer. [in,out] p_prov_bearer Provisioning bearer pointer.
- Return values
-
NRF_SUCCESS Successfully set provisioning bearer. NRF_ERROR_NULL One or more parameters were NULL