BT Mesh Provisioner UI Application Component#

BT Mesh Provisioner UI Application component provides user interface functionality for provisioning applications in Bluetooth Mesh networks.

Enumerations#

enum

ui_state_e {

UI_MENU

UI_WAITING_FOR_CMD

UI_CMD_PROCESSING

UI_WAITING_FOR_INPUT

UI_EXIT

}

UI state.

Typedefs#

typedef enum ui_state_e

sl_ui_state

UI state.

Functions#

sl_status_t

btmesh_app_prov_ui_handle_remote_prov_cmd(char cmd_id)

sl_ui_state

btmesh_app_prov_ui_get_ui_state(void)

bool

btmesh_app_prov_ui_get_input_buffer(char **ui_input_buffer)

Macros#

#define

EXIT_COMMAND 'q'

#define

SCAN_COMMAND 's'

#define

PROVISION_COMMAND 'p'

#define

NODELIST_COMMAND 'l'

#define

NODEINFO_COMMAND 'i'

#define

REMOVE_NODE_COMMAND 'r'

#define

KEY_REFRESH_COMMAND 'k'

#define

KEY_EXPORT_COMMAND 'x'

#define

RESET_COMMAND 'e'

#define

PROV_UI_MENU undefined

Enumeration Documentation#

ui_state_e#

ui_state_e

UI state.

Enumerator
UI_MENU
UI_WAITING_FOR_CMD
UI_CMD_PROCESSING
UI_WAITING_FOR_INPUT
UI_EXIT

Typedef Documentation#

sl_ui_state#

typedef enum ui_state_e sl_ui_state

UI state.

Function Documentation#

btmesh_app_prov_ui_handle_remote_prov_cmd#

sl_status_t btmesh_app_prov_ui_handle_remote_prov_cmd (char cmd_id)

Parameters

Type	Direction	Argument Name	Description
char	[in]	cmd_id	Command id

Remote provisioning related command handler

btmesh_app_prov_ui_get_ui_state#

sl_ui_state btmesh_app_prov_ui_get_ui_state (void )

Parameters

Type	Direction	Argument Name	Description
void	N/A

Get UI state

btmesh_app_prov_ui_get_input_buffer#

bool btmesh_app_prov_ui_get_input_buffer (char ** ui_input_buffer)

Parameters

Type	Direction	Argument Name	Description
char **	[out]	ui_input_buffer	data read from input console

Get buffer with input console content

Macro Definition Documentation#

EXIT_COMMAND#

#define EXIT_COMMAND

Value:

'q'

SCAN_COMMAND#

#define SCAN_COMMAND

Value:

's'

PROVISION_COMMAND#

#define PROVISION_COMMAND

Value:

'p'

NODELIST_COMMAND#

#define NODELIST_COMMAND

Value:

'l'

NODEINFO_COMMAND#

#define NODEINFO_COMMAND

Value:

'i'

REMOVE_NODE_COMMAND#

#define REMOVE_NODE_COMMAND

Value:

'r'

KEY_REFRESH_COMMAND#

#define KEY_REFRESH_COMMAND

Value:

'k'

KEY_EXPORT_COMMAND#

#define KEY_EXPORT_COMMAND

Value:

'x'

RESET_COMMAND#

#define RESET_COMMAND

Value:

'e'

PROV_UI_MENU#

#define PROV_UI_MENU

Value:

"Please select a functionality\n\n" \

"s - Scan available nodes\n" \

"p - Provision a beaconing node\n" \

"l - List nodes in the network\n" \

"i - Information about a node in the network\n" \

"r - Remove node from the network\n" \

"k - Refresh the network key and app key\n" \

"x - Export the network keys, app keys and device keys\n" \

"e - Reset provisioner node and exit application\n" \

"q - Exit application\n\n"