This header file defines the provisioning server interface for the MeshX BLE Mesh stack. It includes data structures, enumerations, and function declarations for managing BLE Mesh provisioning operations, including node and provisioner functionalities. More...
Go to the source code of this file.
Typedefs | |
| typedef control_task_msg_handle_t | prov_srv_cb_t |
| typedef control_task_msg_evt_provision_t | prov_evt_t |
| typedef struct meshx_ble_mesh_prov_srv_param | meshx_prov_srv_param_t |
Enumerations | |
| enum | meshx_prov_bearer_t { MESHX_PROV_ADV = (1UL << (0)) , MESHX_PROV_GATT = (1UL << (1)) } |
| enum | meshx_prov_oob_info_t { MESHX_PROV_OOB_OTHER = (1UL << (0)) , MESHX_PROV_OOB_URI = (1UL << (1)) , MESHX_PROV_OOB_2D_CODE = (1UL << (2)) , MESHX_PROV_OOB_BAR_CODE = (1UL << (3)) , MESHX_PROV_OOB_NFC = (1UL << (4)) , MESHX_PROV_OOB_NUMBER = (1UL << (5)) , MESHX_PROV_OOB_STRING = (1UL << (6)) , MESHX_PROV_CERT_BASED = (1UL << (7)) , MESHX_PROV_RECORDS = (1UL << (8)) , MESHX_PROV_OOB_ON_BOX = (1UL << (11)) , MESHX_PROV_OOB_IN_BOX = (1UL << (12)) , MESHX_PROV_OOB_ON_PAPER = (1UL << (13)) , MESHX_PROV_OOB_IN_MANUAL = (1UL << (14)) , MESHX_PROV_OOB_ON_DEV = (1UL << (15)) } |
Functions | |
| meshx_err_t | meshx_prov_srv_notify_plat_event (meshx_prov_srv_param_t *param) |
| Notify the model event to the application. | |
| meshx_err_t | meshx_plat_init_prov (const uint8_t *uuid) |
| Initialize provisioning parameters. | |
| meshx_ptr_t | meshx_plat_get_prov (void) |
| Get the provisioning parameters. | |
| bool | meshx_prov_srv_is_provisioned (void) |
| Checks if the device is provisioned. | |
Detailed Description
This header file defines the provisioning server interface for the MeshX BLE Mesh stack. It includes data structures, enumerations, and function declarations for managing BLE Mesh provisioning operations, including node and provisioner functionalities.
Copyright (c) 2024 - 2025 MeshX
The file provides definitions for provisioning events, callback parameters, and provisioning bearer and OOB information types. It also includes APIs for initializing and retrieving provisioning parameters.
Typedef Documentation
◆ meshx_prov_srv_param_t
| typedef struct meshx_ble_mesh_prov_srv_param meshx_prov_srv_param_t |
◆ prov_evt_t
This enum value is associated with bt_mesh_prov_bearer_t in mesh_main.h
◆ prov_srv_cb_t
Enumeration Type Documentation
◆ meshx_prov_bearer_t
| enum meshx_prov_bearer_t |
| Enumerator | ||
|---|---|---|
| MESHX_PROV_ADV | (1UL << (0)) | |
| MESHX_PROV_GATT | (1UL << (1)) | |
◆ meshx_prov_oob_info_t
Function Documentation
◆ meshx_plat_get_prov()
| meshx_ptr_t meshx_plat_get_prov | ( | void | ) |
Get the provisioning parameters.
This function returns a pointer to the global provisioning parameters.
- Returns
- Pointer to the global provisioning parameters.
◆ meshx_plat_init_prov()
| meshx_err_t meshx_plat_init_prov | ( | const uint8_t * | uuid | ) |
Initialize provisioning parameters.
This function initializes the provisioning parameters by copying the UUID from the provided server configuration and registering the provisioning callback.
- Parameters
-
uuid Pointer to the UUID of the device.
- Returns
- MESHX_SUCCESS: Success
- MESHX_FAIL: Failed to register provisioning callback
◆ meshx_prov_srv_is_provisioned()
| bool meshx_prov_srv_is_provisioned | ( | void | ) |
Checks if the device is provisioned.
This function returns whether the device has been provisioned.
- Returns
- bool true if provisioned, false otherwise.
◆ meshx_prov_srv_notify_plat_event()
| meshx_err_t meshx_prov_srv_notify_plat_event | ( | meshx_prov_srv_param_t * | param | ) |
Notify the model event to the application.
- Note
- This API is not to be defined in Platform Port layer and shall be called by the respective platform event handler to notify the MeshX of a model event.
This function notifies the application of a model event by invoking the registered provisioning callback with the provided event parameters.
- Parameters
-
[in] param Pointer to the event parameters structure.
- Returns
- MESHX_SUCCESS: Success
- MESHX_FAIL: Failed to notify model event
Generated on for MeshX by
1.16.1