Functions | |
| uint32_t | serial_handler_prov_init (void) |
| Initializes the serial provisioning interface. More... | |
| void | serial_handler_prov_pkt_in (const serial_packet_t *p_packet) |
| Callback function for when a serial packet has been received. More... | |
| uint32_t | serial_handler_prov_context_get (uint8_t index, nrf_mesh_prov_ctx_t **pp_prov_ctx) |
| Gets the provisioning context with the given index. More... | |
| uint32_t | serial_handler_prov_keys_get (const uint8_t **pp_public_key, const uint8_t **pp_private_key) |
| Gets the pointers to the stored public and private keys. More... | |
| uint32_t | serial_handler_prov_oob_caps_get (const nrf_mesh_prov_oob_caps_t **pp_caps) |
| Gets the Out-Of-Band capabilities. More... | |
Detailed Description
Function Documentation
◆ serial_handler_prov_init()
| uint32_t serial_handler_prov_init | ( | void | ) |
Initializes the serial provisioning interface.
- Return values
-
NRF_SUCCESS The serial interface for provisioning was successfully initialized. NRF_ERROR_INTERNAL The ECDH module failed to generate keys.
◆ serial_handler_prov_pkt_in()
| void serial_handler_prov_pkt_in | ( | const serial_packet_t * | p_packet | ) |
Callback function for when a serial packet has been received.
- Parameters
-
p_packet Pointer to the incoming serial packet.
◆ serial_handler_prov_context_get()
| uint32_t serial_handler_prov_context_get | ( | uint8_t | index, |
| nrf_mesh_prov_ctx_t ** | pp_prov_ctx | ||
| ) |
Gets the provisioning context with the given index.
- Parameters
-
[in] index Index of provisioning context. [in,out] pp_prov_ctx Pointer to provisioning context pointer.
- Return values
-
NRF_SUCCESS Successfully returned provisioning context. NRF_ERROR_NOT_FOUND Invalid provisioning context index.
◆ serial_handler_prov_keys_get()
| uint32_t serial_handler_prov_keys_get | ( | const uint8_t ** | pp_public_key, |
| const uint8_t ** | pp_private_key | ||
| ) |
Gets the pointers to the stored public and private keys.
- Parameters
-
[in,out] pp_public_key Pointer to store the public key pointer. [in,out] pp_private_key Pointer to store the private key pointer.
- Return values
-
NRF_SUCCESS Successfully returned the key pointers.
◆ serial_handler_prov_oob_caps_get()
| uint32_t serial_handler_prov_oob_caps_get | ( | const nrf_mesh_prov_oob_caps_t ** | pp_caps | ) |
Gets the Out-Of-Band capabilities.
- Parameters
-
[in,out] pp_caps Pointer to OOB capabilities context pointer.
- Return values
-
NRF_SUCCESS Successfully returned the OOB capabilities pointer.