BLE Mesh Health Server Interface

Detailed Description

Interface for BLE Mesh Model Health Server functions.

Summary

The BLE Mesh interface for the BLE Mesh Model Health Server (BLE MESH HEALTH SERVER) middleware provides BLE Mesh Model Health Server functionality.

Data Structures
struct	rm_ble_mesh_model_health_callback_args_t
struct	rm_ble_mesh_health_server_self_test_t
struct	rm_ble_mesh_health_server_cfg_t
struct	rm_ble_mesh_health_server_api_t
struct	rm_ble_mesh_health_server_instance_t

Typedefs
typedef void(*	rm_ble_mesh_health_server_self_test_function) (uint8_t test_id, uint16_t company_id)
typedef void	rm_ble_mesh_health_server_ctrl_t

Enumerations
enum	rm_ble_mesh_health_server_events_t

---

Data Structure Documentation

rm_ble_mesh_model_health_callback_args_t

struct rm_ble_mesh_model_health_callback_args_t

Mesh model health server callback parameter definition

Data Fields
void const *	p_context
rm_ble_mesh_access_model_handle_t *	p_handle	Access model handle.
rm_ble_mesh_health_server_events_t	event_type	Application events defined for Health Server Model.
uint8_t *	p_event_data	Event data.
uint16_t	event_data_length	Event data length.

rm_ble_mesh_health_server_self_test_t

struct rm_ble_mesh_health_server_self_test_t

Health Server Self Test Function Structure.

Data Fields
uint8_t	test_id	Test ID
rm_ble_mesh_health_server_self_test_function	self_test_fn	Self Test Function

rm_ble_mesh_health_server_cfg_t

struct rm_ble_mesh_health_server_cfg_t

BLE mesh model health server configuration parameters.

Data Fields
rm_ble_mesh_access_instance_t const *	p_access_instance
	Access Layer instance structure. More...
rm_ble_mesh_health_server_self_test_t *	p_self_tests
	Health Server self test function structure.
uint16_t	company_id
	Company ID.
uint32_t	num_self_tests
	Number of self test.
void const *	p_context
	Placeholder for user data. Passed to the user callback in ble_abs_callback_args_t.
void const *	p_extend
	Placeholder for user extension.

Field Documentation

p_access_instance

rm_ble_mesh_access_instance_t const* rm_ble_mesh_health_server_cfg_t::p_access_instance

Access Layer instance structure.

the parameters for initialization.

rm_ble_mesh_health_server_api_t

struct rm_ble_mesh_health_server_api_t

Shared Interface definition for BLE MESH

Data Fields
fsp_err_t(*	open )(rm_ble_mesh_health_server_ctrl_t *const p_ctrl, rm_ble_mesh_health_server_cfg_t const *const p_cfg)
fsp_err_t(*	close )(rm_ble_mesh_health_server_ctrl_t *const p_ctrl)
fsp_err_t(*	reportFault )(rm_ble_mesh_health_server_ctrl_t *const p_ctrl, const rm_ble_mesh_access_model_handle_t *const p_model_handle, uint8_t test_id, uint16_t company_id, uint8_t fault_code)
fsp_err_t(*	publishCurrentStatus )(rm_ble_mesh_health_server_ctrl_t *const p_ctrl, uint8_t *p_status, uint16_t length)

Field Documentation

open

fsp_err_t(* rm_ble_mesh_health_server_api_t::open) (rm_ble_mesh_health_server_ctrl_t *const p_ctrl, rm_ble_mesh_health_server_cfg_t const *const p_cfg)

API to open health server model.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_cfg	Pointer to configuration structure.

close

fsp_err_t(* rm_ble_mesh_health_server_api_t::close) (rm_ble_mesh_health_server_ctrl_t *const p_ctrl)

API to close health server model.

Parameters

[in]

p_ctrl

Pointer to control structure.

reportFault

fsp_err_t(* rm_ble_mesh_health_server_api_t::reportFault) (rm_ble_mesh_health_server_ctrl_t *const p_ctrl, const rm_ble_mesh_access_model_handle_t *const p_model_handle, uint8_t test_id, uint16_t company_id, uint8_t fault_code)

API to report self-test fault.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_model_handle	Pointer to model handle identifying the health server model instance.
[in]	test_id	Identifier of the self-test.
[in]	company_id	Company identifier.
[in]	fault_code	Fault value indicating the error.

publishCurrentStatus

fsp_err_t(* rm_ble_mesh_health_server_api_t::publishCurrentStatus) (rm_ble_mesh_health_server_ctrl_t *const p_ctrl, uint8_t *p_status, uint16_t length)

API to publish current status.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_status	Pointer to current status.
[in]	length	Status data length.

rm_ble_mesh_health_server_instance_t

struct rm_ble_mesh_health_server_instance_t

This structure encompasses everything that is needed to use an instance of this interface.

Data Fields
rm_ble_mesh_health_server_ctrl_t *	p_ctrl	Pointer to the control structure for this instance.
rm_ble_mesh_health_server_cfg_t const *	p_cfg	Pointer to the configuration structure for this instance.
rm_ble_mesh_health_server_api_t const *	p_api	Pointer to the API structure for this instance.

Typedef Documentation

rm_ble_mesh_health_server_self_test_function

typedef void(* rm_ble_mesh_health_server_self_test_function) (uint8_t test_id, uint16_t company_id)

Health Server Self Test Function.

rm_ble_mesh_health_server_ctrl_t

typedef void rm_ble_mesh_health_server_ctrl_t

BLE MESH HEALTH SERVER control block. Allocate an instance specific control block to pass into the BLE mesh model health server API calls.

Enumeration Type Documentation

rm_ble_mesh_health_server_events_t

enum rm_ble_mesh_health_server_events_t

This section lists the Application Events defined for Health Server Model

Enumerator
RM_BLE_MESH_HEALTH_SERVER_SERVER_ATTENTION_START	Attention Start
RM_BLE_MESH_HEALTH_SERVER_SERVER_ATTENTION_RESTART	Attention Restart
RM_BLE_MESH_HEALTH_SERVER_SERVER_ATTENTION_STOP	Attention Stop