Detailed Description

Interface for BLE Mesh Access functions.

Summary

The BLE Mesh Access interface for the BLE Mesh Network Access (BLE MESH ACCESS) peripheral provides BLE Mesh Network Access functionality.

Modules
	Application Callback

Data Structures
struct	rm_ble_mesh_access_model_id_t

union	rm_ble_mesh_access_model_id_t.__unnamed__

struct	rm_ble_mesh_access_element_descriptor_t

struct	rm_ble_mesh_access_address_t

struct	rm_ble_mesh_access_publish_info_t

struct	rm_ble_mesh_access_model_req_msg_context_t

struct	rm_ble_mesh_access_req_msg_raw_t

struct	rm_ble_mesh_access_model_req_msg_t

struct	rm_ble_mesh_access_publish_setting_t

struct	rm_ble_mesh_access_pdu_t

struct	rm_ble_mesh_access_model_state_parameter_t

struct	rm_ble_mesh_access_extended_parameter_t

struct	rm_ble_mesh_access_device_entry_t

struct	rm_ble_mesh_access_model_t

struct	rm_ble_mesh_access_server_state_t

struct	rm_ble_mesh_access_provisioned_device_entry_t

struct	rm_ble_mesh_access_associated_keys_t

struct	rm_ble_mesh_access_friend_security_credential_info_t

struct	rm_ble_mesh_access_cfg_t

struct	rm_ble_mesh_access_api_t

struct	rm_ble_mesh_access_instance_t

Macros
#define	RM_BLE_MESH_ACCESS_VADDR_LABEL_UUID_SIZE

#define	RM_BLE_MESH_ACCESS_NETKEY_SIZE

#define	RM_BLE_MESH_ACCESS_APPKEY_SIZE

#define	RM_BLE_MESH_ACCESS_KEY_SIZE

Typedefs
typedef uint8_t	rm_ble_mesh_access_node_id_t

typedef uint8_t	rm_ble_mesh_access_element_handle_t

typedef uint16_t	rm_ble_mesh_access_model_handle_t

typedef uint16_t	rm_ble_mesh_access_model_id_sig_t

typedef uint32_t	rm_ble_mesh_access_model_id_vendor_t

typedef uint32_t	rm_ble_mesh_access_address_handle_t

typedef uint32_t	rm_ble_mesh_access_device_key_handle_t

typedef void	rm_ble_mesh_access_ctrl_t

Enumerations
enum	rm_ble_mesh_access_model_req_msg_type_t

enum	rm_ble_mesh_access_iv_update_test_mode_t

enum	rm_ble_mesh_access_message_opcode_t

enum	rm_ble_mesh_access_model_type_info_t

enum	rm_ble_mesh_access_model_id_info_t

Data Structure Documentation

◆ rm_ble_mesh_access_model_id_t

struct rm_ble_mesh_access_model_id_t

Model ID datatype

Data Fields
union rm_ble_mesh_access_model_id_t	__unnamed__	Vendor/SIG ID
rm_ble_mesh_access_model_type_info_t	type	Model type - SIG or Vendor

◆ rm_ble_mesh_access_model_id_t.unnamed

union rm_ble_mesh_access_model_id_t.__unnamed__

Vendor/SIG ID

◆ rm_ble_mesh_access_element_descriptor_t

struct rm_ble_mesh_access_element_descriptor_t

Element description format.

Data Fields
uint16_t	loc	Location descriptor

◆ rm_ble_mesh_access_address_t

struct rm_ble_mesh_access_address_t

Unicast/Virtual/Group Address.

Data Fields
uint8_t	use_label	Flag - which field to be used
rm_ble_mesh_network_address_t	addr	Address
uint8_t	label[RM_BLE_MESH_ACCESS_LABEL_UUID_LENGTH]	Label UUID

◆ rm_ble_mesh_access_publish_info_t

struct rm_ble_mesh_access_publish_info_t

Access Publication related information

Data Fields
rm_ble_mesh_access_address_t	addr	PublishAddress (Unicast/Virtual/Group)
uint16_t	appkey_index	AppKey Index (when set from remote). AppKey Handle (when set from locally for Configuration Client).
uint8_t	crden_flag	CredentialFlag
uint8_t	ttl	PublishTTL
uint8_t	period	PublishPeriod
uint8_t	rtx_count	PublishRetransmitCount
uint8_t	rtx_interval_steps	PublishRetransmitIntervalSteps
uint8_t	remote	Flag - if called from local or remote

◆ rm_ble_mesh_access_model_req_msg_context_t

struct rm_ble_mesh_access_model_req_msg_context_t

Context of message received for a specific model instance. This is required to send response appropriately.

Data Fields
rm_ble_mesh_access_model_handle_t	handle	Model Handle - for which request is received
rm_ble_mesh_network_address_t	saddr	Source Address - originator of request
rm_ble_mesh_network_address_t	daddr	Destination Address - of the request
rm_ble_mesh_network_subnet_handle_t	subnet_handle	Associated Subnet Identifier
rm_ble_mesh_network_appkey_handle_t	appkey_handle	Associated AppKey Identifier

◆ rm_ble_mesh_access_req_msg_raw_t

struct rm_ble_mesh_access_req_msg_raw_t

Uninterpreted/raw received message for a specific model instance.

Data Fields
uint32_t	opcode	Request Opcode
uint8_t *	data_param	Raw received message
uint16_t	data_len	Raw received message length

◆ rm_ble_mesh_access_model_req_msg_t

struct rm_ble_mesh_access_model_req_msg_t

Requested message type for a specific model instance.

Data Fields
rm_ble_mesh_access_model_req_msg_type_t	type	Flag: GET, SET or Others
uint8_t	to_be_acked	Flag: True or False

◆ rm_ble_mesh_access_publish_setting_t

struct rm_ble_mesh_access_publish_setting_t

Publish setting

Data Fields
uint8_t	ttl	Time to Live
uint8_t	to_publish	Flag to indicate if the message also to be published

◆ rm_ble_mesh_access_pdu_t

struct rm_ble_mesh_access_pdu_t

PDU setting

Data Fields
rm_ble_mesh_network_address_t	src_addr	16 bit Source Address
rm_ble_mesh_network_address_t	dst_addr	16 bit Destination Address
rm_ble_mesh_network_subnet_handle_t	subnet_handle	Subnet Handle
rm_ble_mesh_network_appkey_handle_t	appkey_handle	AppKey Handle
uint8_t	ttl	Time to Live
uint32_t	opcode	Request Opcode
uint8_t *	data_param	Raw received message
uint16_t	data_len	Raw received message length

◆ rm_ble_mesh_access_model_state_parameter_t

struct rm_ble_mesh_access_model_state_parameter_t

Model specific state parameters in a request or response message

Data Fields
uint8_t	state_type	State Type
void *	state	State pointer

◆ rm_ble_mesh_access_extended_parameter_t

struct rm_ble_mesh_access_extended_parameter_t

Additional parameters in a Model specific request or response message

Data Fields
uint8_t	ext_type	State/Extended Type
void *	ext	State/Extended data structure pointer

◆ rm_ble_mesh_access_device_entry_t

struct rm_ble_mesh_access_device_entry_t

Provisioned Device List Data Structure, containing Primary Element Address and number of elements.

Data Fields
rm_ble_mesh_network_address_t	uaddr	Unicast address of the first element
uint8_t	num_elements	Number of Elements

◆ rm_ble_mesh_access_model_t

struct rm_ble_mesh_access_model_t

Data structure for model.

Models could be bluetooth SIG defined or vendor defined.

Data Fields
rm_ble_mesh_access_model_id_t	model_id	Model ID
rm_ble_mesh_access_model_callback_t	model_callback	Callback function pointer to receive packets from the underlying protocol layers
rm_ble_mesh_access_timeout_callback_t	timeout_callback	Callback function called when Publication Timer expires. Set to NULL if model does not support periodic publication.
uint16_t	num_opcodes	Number of Opcodes
const uint32_t *	opcodes	List of Opcodes

◆ rm_ble_mesh_access_server_state_t

struct rm_ble_mesh_access_server_state_t

API to send reply or to update state change

Data Fields
rm_ble_mesh_access_model_req_msg_context_t *	p_context	Context of the message.
rm_ble_mesh_access_model_state_parameter_t *	p_current_state_parameter	Model specific current state parameters.
rm_ble_mesh_access_model_state_parameter_t *	p_target_state_parameter	Model specific target state parameters (NULL: to be ignored).
uint16_t	remaining_time	Time from current state to target state (0: to be ignored).
rm_ble_mesh_access_extended_parameter_t *	p_extended_parameter	Additional parameters (NULL: to be ignored).
uint8_t	reply	If unicast response to be sent.
uint8_t	publish	If state to be published.

◆ rm_ble_mesh_access_provisioned_device_entry_t

struct rm_ble_mesh_access_provisioned_device_entry_t

Provisioned Device List Data Structure, containing Primary Element Address and number of elements.

Data Fields
rm_ble_mesh_network_address_t	uaddr	Unicast address of the first element
uint8_t	num_elements	Number of Elements

◆ rm_ble_mesh_access_associated_keys_t

struct rm_ble_mesh_access_associated_keys_t

Associated key

Data Fields
uint8_t	privacy_key[RM_BLE_MESH_ACCESS_KEY_SIZE]	Privacy key
uint8_t	encrypt_key[RM_BLE_MESH_ACCESS_KEY_SIZE]	Encryption key
uint8_t	beacon_key[RM_BLE_MESH_ACCESS_KEY_SIZE]	Beacon key
uint8_t	is_new_key	Whether new key or not

◆ rm_ble_mesh_access_friend_security_credential_info_t

struct rm_ble_mesh_access_friend_security_credential_info_t

To add Security Credential of a LPN or the Friend.

Data Fields
rm_ble_mesh_network_address_t	lpn_addr	Address of the LPN.
rm_ble_mesh_network_address_t	friend_addr	Address of the Friend.
uint16_t	lpn_counter	Number of Friend Request messages the LPN has sent.
uint16_t	friend_counter	Number of Friend Offer messages the Friend has sent.

◆ rm_ble_mesh_access_cfg_t

struct rm_ble_mesh_access_cfg_t

BLE MESH ACCESS configuration parameters.

Data Fields
uint32_t	channel	Select a channel corresponding to the channel number of the hardware. the parameters for initialization.
rm_ble_mesh_access_element_descriptor_t *	p_element_descriptor	Element description format.
rm_ble_mesh_upper_trans_instance_t const *	p_mesh_upper_trans_instance	Instance structure of upper trans.
rm_ble_mesh_access_element_handle_t	element_number	Element number.
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.

◆ rm_ble_mesh_access_api_t

struct rm_ble_mesh_access_api_t

BLE MESH ACCESS functions implemented at the HAL layer will follow this API.

Data Fields
fsp_err_t(*	open )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_cfg_t const const p_cfg)

fsp_err_t(*	close )(rm_ble_mesh_access_ctrl_t *const p_ctrl)

fsp_err_t(*	registerModel )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_model_t const const p_model, rm_ble_mesh_access_model_handle_t *const p_model_handle)

fsp_err_t(*	getElementHandle )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_address_t elem_addr, rm_ble_mesh_access_element_handle_t const p_handle)

fsp_err_t(*	getElementHandleForModelHandle )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, rm_ble_mesh_access_element_handle_t const p_elem_handle)

fsp_err_t(*	getModelHandle )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_element_handle_t elem_handle, rm_ble_mesh_access_model_id_t model_id, rm_ble_mesh_access_model_handle_t const p_handle)

fsp_err_t(*	publish )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_model_handle_t const const p_handle, rm_ble_mesh_access_req_msg_raw_t const *const p_publish_message, uint8_t reliable)

fsp_err_t(*	reliablePublish )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_model_handle_t const const p_handle, rm_ble_mesh_access_req_msg_raw_t const *const p_publish_message, uint32_t rsp_opcode)

fsp_err_t(*	reply )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_model_req_msg_context_t const const p_req_msg_context, uint8_t ttl, rm_ble_mesh_access_req_msg_raw_t const *const p_req_msg_raw)

fsp_err_t(*	replyAndPublish )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_model_req_msg_context_t const const p_req_msg_context, rm_ble_mesh_access_req_msg_raw_t const const p_req_msg_raw, rm_ble_mesh_access_publish_setting_t const const p_publish_setting)

fsp_err_t(*	sendPdu )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_pdu_t const const p_pdu, uint8_t reliable)

fsp_err_t(*	getCompositionData )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_buffer_t const p_buffer)

fsp_err_t(*	reset )(rm_ble_mesh_access_ctrl_t *const p_ctrl)

fsp_err_t(*	getElementCount )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint8_t const p_count)

fsp_err_t(*	setPrimaryUnicastAddress )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t addr)

fsp_err_t(*	getPrimaryUnicastAddress )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_address_t const p_addr)

fsp_err_t(*	setDefaultTtl )(rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t ttl)

fsp_err_t(*	getDefaultTtl )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint8_t const const p_ttl)

fsp_err_t(*	setIvIndex )(rm_ble_mesh_access_ctrl_t *const p_ctrl, uint32_t iv_index, uint8_t iv_update_flag)

fsp_err_t(*	getIvIndex )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint32_t const p_iv_index, uint8_t *const p_iv_update_flag)

fsp_err_t(*	getIvIndexByIvi )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint8_t ivi, uint32_t const p_iv_index)

fsp_err_t(*	setFeaturesField )(rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t enable, uint8_t feature)

fsp_err_t(*	getFeaturesField )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint8_t const p_enable, uint8_t feature)

fsp_err_t(*	getFeatures )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint8_t const p_features)

fsp_err_t(*	getFriendshipRole )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint8_t const p_friend_role)

fsp_err_t(*	setFriendshipRole )(rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t friend_role)

fsp_err_t(*	addDeviceKey )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint8_t const const p_dev_key, rm_ble_mesh_network_address_t uaddr, uint8_t num_elements)

fsp_err_t(*	getDeviceKey )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint8_t dev_key_index, uint8_t *const p_dev_key)

fsp_err_t(*	removeAllDeviceKeys )(rm_ble_mesh_access_ctrl_t *const p_ctrl)

fsp_err_t(*	getProvisionedDeviceList )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_provisioned_device_entry_t const const p_prov_dev_list, uint16_t *const p_num_entries)

fsp_err_t(*	getDeviceKeyHandle )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_address_t prim_elem_uaddr, rm_ble_mesh_access_device_key_handle_t const p_handle)

fsp_err_t(*	getAppKey )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_appkey_handle_t appkey_handle, uint8_t const p_app_key, uint8_t const p_aid)

fsp_err_t(*	addUpdateNetkey )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint16_t netkey_index, uint32_t opcode, uint8_t const const p_net_key)

fsp_err_t(*	addFriendSecurityCredential )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t friend_index, rm_ble_mesh_access_friend_security_credential_info_t info)

fsp_err_t(*	deleteFriendSecurityCredential )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t friend_index)

fsp_err_t(*	findSubnet )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint16_t netkey_index, rm_ble_mesh_network_subnet_handle_t const p_subnet_handle)

fsp_err_t(*	findMasterSubnet )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t friend_subnet_handle, rm_ble_mesh_network_subnet_handle_t const p_master_subnet_handle)

fsp_err_t(*	deleteNetKey )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle)

fsp_err_t(*	getNetKey )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint8_t const p_net_key)

fsp_err_t(*	getNetKeyIndexList )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint16_t const p_netkey_count, uint16_t *const p_netkey_index_list)

fsp_err_t(*	lookUpNid )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint8_t nid, rm_ble_mesh_network_subnet_handle_t const p_subnet_handle, rm_ble_mesh_access_associated_keys_t *const p_key_set)

fsp_err_t(*	lookUpNetworkId )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint8_t const const p_network_id, rm_ble_mesh_network_subnet_handle_t const p_subnet_handle, rm_ble_mesh_access_associated_keys_t const p_key_set)

fsp_err_t(*	lookUpAid )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint8_t aid, rm_ble_mesh_network_appkey_handle_t const p_appkey_handle, uint8_t *const p_app_key)

fsp_err_t(*	setProvisioningData )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_provision_data_t const const p_prov_data)

fsp_err_t(*	getSubnetNid )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t handle, uint8_t const p_nid)

fsp_err_t(*	getSubnetPrivacyKey )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t handle, uint8_t const p_privacy_key)

fsp_err_t(*	getSubnetNetworkId )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t handle, uint8_t const p_network_id)

fsp_err_t(*	getSubnetBeaconKey )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t handle, uint8_t const p_beacon_key)

fsp_err_t(*	getSubnetIdentityKey )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t handle, uint8_t const p_identity_key)

fsp_err_t(*	getSubnetEncryptionKey )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t handle, uint8_t const p_encrypt_key)

fsp_err_t(*	getNodeIdentity )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint8_t const p_id_state)

fsp_err_t(*	setNodeIdentity )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint8_t const p_id_state)

fsp_err_t(*	getKeyRefreshPhase )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint8_t const p_key_refresh_state)

fsp_err_t(*	setKeyRefreshPhase )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint8_t const const p_key_refresh_state)

fsp_err_t(*	setTransmitState )(rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t tx_state_type, uint8_t tx_state)

fsp_err_t(*	getTransmitState )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint8_t tx_state_type, uint8_t const p_tx_state)

fsp_err_t(*	addAppKey )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t appkey_index, uint8_t const const p_app_key)

fsp_err_t(*	updateAppKey )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t appkey_index, uint8_t const const p_app_key)

fsp_err_t(*	deleteAppKey )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t appkey_index, uint8_t const const p_app_key)

fsp_err_t(*	getAppKeyHandle )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t appkey_index, uint8_t const const p_app_key, rm_ble_mesh_network_appkey_handle_t *const p_appkey_handle)

fsp_err_t(*	getAppKeyIndexList )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t const p_appkey_count, uint16_t *const p_appkey_index_list)

fsp_err_t(*	bindModelWithAppKey )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, uint16_t appkey_index)

fsp_err_t(*	unbindModelWithAppKey )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, uint16_t appkey_index)

fsp_err_t(*	getModelAppKeyList )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, uint16_t const p_appkey_count, uint16_t *const p_appkey_index_list)

fsp_err_t(*	setModelPublication )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, rm_ble_mesh_access_publish_info_t const p_publish_info)

fsp_err_t(*	setModelPublicationPeriodDivisor )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, uint8_t period_divisor)

fsp_err_t(*	getModelPublication )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, rm_ble_mesh_access_publish_info_t const p_publish_info)

fsp_err_t(*	addModelSubscription )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, rm_ble_mesh_access_address_t const const p_sub_addr)

fsp_err_t(*	deleteModelSubscription )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, rm_ble_mesh_access_address_t const const p_sub_addr)

fsp_err_t(*	deleteAllModelSubscription )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle)

fsp_err_t(*	getModelSubscriptionList )(rm_ble_mesh_access_ctrl_t const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, uint16_t const p_sub_addr_count, uint16_t *const p_sub_addr_list)

fsp_err_t(*	getAllModelSubscriptionList )(rm_ble_mesh_access_ctrl_t const p_ctrl, uint16_t const p_sub_addr_count, uint16_t *const p_sub_addr_list)

fsp_err_t(*	isValidElementAddress )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t addr)

fsp_err_t(*	isFixedGroupAddressToBeProcessed )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t addr)

fsp_err_t(*	isValidSubscriptionAddress )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t addr)

fsp_err_t(*	enableIvUpdateTestMode )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_iv_update_test_mode_t mode)

Field Documentation

◆ open

fsp_err_t(* rm_ble_mesh_access_api_t::open) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_cfg_t const *const p_cfg)

Open access middleware.

Parameters

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

◆ close

fsp_err_t(* rm_ble_mesh_access_api_t::close) (rm_ble_mesh_access_ctrl_t *const p_ctrl)

Close access middleware.

Parameters

[in] p_ctrl Pointer to control structure.

◆ registerModel

fsp_err_t(* rm_ble_mesh_access_api_t::registerModel) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_t const *const p_model, rm_ble_mesh_access_model_handle_t *const p_model_handle)

Register a model with the access layer.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_model	Pointer to model structure.
[out]	p_model_handle	Pointer to model handle.

◆ getElementHandle

fsp_err_t(* rm_ble_mesh_access_api_t::getElementHandle) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t elem_addr, rm_ble_mesh_access_element_handle_t *const p_handle)

Get element handle.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	elem_addr	Address of the corresponding element.
[out]	p_handle	Pointer to model handle.

◆ getElementHandleForModelHandle

fsp_err_t(* rm_ble_mesh_access_api_t::getElementHandleForModelHandle) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, rm_ble_mesh_access_element_handle_t *const p_elem_handle)

Get element handle for a given model handle

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	model_handle	Model handle.
[out]	p_elem_handle	Pointer to element handle.

◆ getModelHandle

fsp_err_t(* rm_ble_mesh_access_api_t::getModelHandle) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_element_handle_t elem_handle, rm_ble_mesh_access_model_id_t model_id, rm_ble_mesh_access_model_handle_t *const p_handle)

Get model handle.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	elem_handle	Element identifier associated with the Model.
[in]	model_id	Model identifier for which the model handle to be searched.
[out]	p_handle	Pointer to model handle.

◆ publish

fsp_err_t(* rm_ble_mesh_access_api_t::publish) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t const *const p_handle, rm_ble_mesh_access_req_msg_raw_t const *const p_publish_message, uint8_t reliable)

API to publish access layer message.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_handl	Pointer to model handle.
[in]	p_publish_message	Pointer to received message structure.
[in]	reliable	MS_TRUE for reliable message. MS_FALSE otherwise.

◆ reliablePublish

fsp_err_t(* rm_ble_mesh_access_api_t::reliablePublish) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t const *const p_handle, rm_ble_mesh_access_req_msg_raw_t const *const p_publish_message, uint32_t rsp_opcode)

API to reliably publish access layer message.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_handl	Pointer to model handle.
[in]	p_publish_message	Pointer to raw received message structure.
[in]	rsp_opcode	Response opcode.

◆ reply

fsp_err_t(* rm_ble_mesh_access_api_t::reply) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_req_msg_context_t const *const p_req_msg_context, uint8_t ttl, rm_ble_mesh_access_req_msg_raw_t const *const p_req_msg_raw)

API to reply to access layer message.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_req_msg_context	Pointer to context of received message structure.
[in]	ttl	Time to live.
[in]	p_req_msg_raw	Pointer to received message structure.

◆ replyAndPublish

fsp_err_t(* rm_ble_mesh_access_api_t::replyAndPublish) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_req_msg_context_t const *const p_req_msg_context, rm_ble_mesh_access_req_msg_raw_t const *const p_req_msg_raw, rm_ble_mesh_access_publish_setting_t const *const p_publish_setting)

API to reply to access layer message and optionally also to publish.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_req_msg_context	Pointer to context of received message structure.
[in]	p_req_msg_raw	Pointer to received message structure.
[in]	p_publish_setting	Pointer to publish setting structure.

◆ sendPdu

fsp_err_t(* rm_ble_mesh_access_api_t::sendPdu) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_pdu_t const *const p_pdu, uint8_t reliable)

API to send access PDUs.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_pdu	Pointer to PDU structure.
[in]	reliable	If requires lower transport ACK, set reliable as TRUE.

◆ getCompositionData

fsp_err_t(* rm_ble_mesh_access_api_t::getCompositionData) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_buffer_t *const p_buffer)

Get composition data.

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_buffer	Pointer to buffer structure.

◆ reset

fsp_err_t(* rm_ble_mesh_access_api_t::reset) (rm_ble_mesh_access_ctrl_t *const p_ctrl)

To reset a node.

Parameters

[in] p_ctrl Pointer to control structure.

◆ getElementCount

fsp_err_t(* rm_ble_mesh_access_api_t::getElementCount) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t *const p_count)

To get the number of elements in local node.

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_count	Pointer to number of elements.

◆ setPrimaryUnicastAddress

fsp_err_t(* rm_ble_mesh_access_api_t::setPrimaryUnicastAddress) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t addr)

To set primary unicast address.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	addr	Primary Unicast address to be set.

◆ getPrimaryUnicastAddress

fsp_err_t(* rm_ble_mesh_access_api_t::getPrimaryUnicastAddress) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t *const p_addr)

To get primary unicast address.

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_addr	Pointer to address.

◆ setDefaultTtl

fsp_err_t(* rm_ble_mesh_access_api_t::setDefaultTtl) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t ttl)

To set default TTL.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	ttl	Default TTL to be set.

◆ getDefaultTtl

fsp_err_t(* rm_ble_mesh_access_api_t::getDefaultTtl) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t const *const p_ttl)

To get default TTL.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_ttl	Pointer to TTL.

◆ setIvIndex

fsp_err_t(* rm_ble_mesh_access_api_t::setIvIndex) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint32_t iv_index, uint8_t iv_update_flag)

To set IV Index.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	iv_index	IV index to be set.
[in]	iv_update_flag	IV update flag.

◆ getIvIndex

fsp_err_t(* rm_ble_mesh_access_api_t::getIvIndex) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint32_t *const p_iv_index, uint8_t *const p_iv_update_flag)

To get IV Index.

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_iv_index	Pointer to index.
[out]	p_iv_update_flag	Pointer to update flag.

◆ getIvIndexByIvi

fsp_err_t(* rm_ble_mesh_access_api_t::getIvIndexByIvi) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t ivi, uint32_t *const p_iv_index)

To get IV Index by IVI.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	ivi	Least significant bit of the IV index used in the once to authenticate and encrypt the network PDU.
[out]	p_iv_index	Pointer to index.

◆ setFeaturesField

fsp_err_t(* rm_ble_mesh_access_api_t::setFeaturesField) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t enable, uint8_t feature)

To enable/disable a feature.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	enable	Enable or Disable.
[in]	feature	Relay, proxy, friend or low power.

◆ getFeaturesField

fsp_err_t(* rm_ble_mesh_access_api_t::getFeaturesField) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t *const p_enable, uint8_t feature)

To get state of a feature.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_enable	Pointer to enable.
[in]	feature	Relay, proxy, friend or low power.

◆ getFeatures

fsp_err_t(* rm_ble_mesh_access_api_t::getFeatures) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t *const p_features)

To get state of all features.

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_features	Pointer to features.

◆ getFriendshipRole

fsp_err_t(* rm_ble_mesh_access_api_t::getFriendshipRole) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t *const p_friend_role)

To get friendship role of the node.

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	p_friend_role	Pointer to friend role.

◆ setFriendshipRole

fsp_err_t(* rm_ble_mesh_access_api_t::setFriendshipRole) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t friend_role)

To set friendship role of the node.

Parameters

[in]	p_ctrl	Pointer to control structure.
[out]	friend_role	Friend role.

◆ addDeviceKey

fsp_err_t(* rm_ble_mesh_access_api_t::addDeviceKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t const *const p_dev_key, rm_ble_mesh_network_address_t uaddr, uint8_t num_elements)

To add Device Key.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_dev_key	Pointer to device Key.
[in]	uaddr	Unicast address of the first element.
[in]	num_elements	Number of elements.

◆ getDeviceKey

fsp_err_t(* rm_ble_mesh_access_api_t::getDeviceKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t dev_key_index, uint8_t **const p_dev_key)

To get Device Key.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	dev_key_index	Device key index.
[out]	p_dev_key	Pointer to device key to be returned.

◆ removeAllDeviceKeys

fsp_err_t(* rm_ble_mesh_access_api_t::removeAllDeviceKeys) (rm_ble_mesh_access_ctrl_t *const p_ctrl)

To remove all Device Keys.

Parameters

[in] p_ctrl Pointer to control structure.

◆ getProvisionedDeviceList

fsp_err_t(* rm_ble_mesh_access_api_t::getProvisionedDeviceList) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_provisioned_device_entry_t const *const p_prov_dev_list, uint16_t *const p_num_entries)

To get list of Provisioned Device List.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_prov_dev_list	Pointer to provisioned device list structure.
[in]	p_num_entries	Pointer to number of entries.

◆ getDeviceKeyHandle

fsp_err_t(* rm_ble_mesh_access_api_t::getDeviceKeyHandle) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t prim_elem_uaddr, rm_ble_mesh_access_device_key_handle_t *const p_handle)

To get Device Key Handle.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	prim_elem_uaddr	Primary element address to be searched.
[in]	p_handle	Pointer to handle.

◆ getAppKey

fsp_err_t(* rm_ble_mesh_access_api_t::getAppKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_appkey_handle_t appkey_handle, uint8_t **const p_app_key, uint8_t *const p_aid)

To get AppKey.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	appkey_handle	AppKey Handle.
[out]	p_app_key	Pointer to AppKey to be returned.
[out]	p_aid	Pointer to AID to be returned.

◆ addUpdateNetkey

fsp_err_t(* rm_ble_mesh_access_api_t::addUpdateNetkey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint16_t netkey_index, uint32_t opcode, uint8_t const *const p_net_key)

To add/update NetKey.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	netkey_index	Identifies global index of NetKey. A 12bits value.
[in]	opcode	To identify Add or Update NetKey.
[out]	p_net_key	Pointer to NetKey.

◆ addFriendSecurityCredential

fsp_err_t(* rm_ble_mesh_access_api_t::addFriendSecurityCredential) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t friend_index, rm_ble_mesh_access_friend_security_credential_info_t info)

To add Security Credential of a LPN or the Friend.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Identifies associated subnet.
[in]	friend_index	Friend Index.
[in]	info	Security credential of a LPN or the friend.

◆ deleteFriendSecurityCredential

fsp_err_t(* rm_ble_mesh_access_api_t::deleteFriendSecurityCredential) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t friend_index)

To delete the Security Credential of a LPN or the Friend.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Identifies associated subnet.
[in]	friend_index	Friend index.

◆ findSubnet

fsp_err_t(* rm_ble_mesh_access_api_t::findSubnet) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint16_t netkey_index, rm_ble_mesh_network_subnet_handle_t *const p_subnet_handle)

To find a Subnet associated with the NetKey.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	netkey_index	Identifies global Index of NetKey, corresponding Subnet to be returned.
[out]	p_subnet_handle	Pointer to subnet handle.

◆ findMasterSubnet

fsp_err_t(* rm_ble_mesh_access_api_t::findMasterSubnet) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t friend_subnet_handle, rm_ble_mesh_network_subnet_handle_t *const p_master_subnet_handle)

To find the Master Subnet associated with the friend security credential, identified by Friend Subnet Handle.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	friend_subnet_handle	Identifies the friend subnet handle, corresponding to friend subnet handle.
[out]	p_master_subnet_handle	Pointer to master subnet handle.

◆ deleteNetKey

fsp_err_t(* rm_ble_mesh_access_api_t::deleteNetKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle)

To delete NetKey.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Handle of the subnet for which NetKey to be deleted.

◆ getNetKey

fsp_err_t(* rm_ble_mesh_access_api_t::getNetKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint8_t *const p_net_key)

To get NetKey.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Target subnet handle to get net key.
[in]	p_net_key	Pointer to NetKey.

◆ getNetKeyIndexList

fsp_err_t(* rm_ble_mesh_access_api_t::getNetKeyIndexList) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint16_t *const p_netkey_count, uint16_t *const p_netkey_index_list)

To get list of all known NetKeys.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_netkey_count	Pointer to NetKey count.
[in]	p_netkey_index_list	Pointer to NetKey index list.

◆ lookUpNid

fsp_err_t(* rm_ble_mesh_access_api_t::lookUpNid) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t nid, rm_ble_mesh_network_subnet_handle_t *const p_subnet_handle, rm_ble_mesh_access_associated_keys_t *const p_key_set)

To search for NID.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	nid	NID to be searched in all known subnets for match.
[out]	p_subnet_handle	Pointer to subnet handle.
[out]	p_key_set	Pointer to key set.

◆ lookUpNetworkId

fsp_err_t(* rm_ble_mesh_access_api_t::lookUpNetworkId) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t const *const p_network_id, rm_ble_mesh_network_subnet_handle_t *const p_subnet_handle, rm_ble_mesh_access_associated_keys_t *const p_key_set)

To search for Network ID.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_network_id	Pointer to network ID to be searched in all known subnets for match.
[out]	p_subnet_handle	Pointer to subnet handle.
[out]	p_key_set	Pointer to key settings.

◆ lookUpAid

fsp_err_t(* rm_ble_mesh_access_api_t::lookUpAid) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t aid, rm_ble_mesh_network_appkey_handle_t *const p_appkey_handle, uint8_t *const p_app_key)

To search for AID.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	aid	AID to be searched in all known AppKeys for match.
[out]	p_appkey_handle	Pointer to AppKey handle.
[out]	p_app_key	Pointer to AppKey.

◆ setProvisioningData

fsp_err_t(* rm_ble_mesh_access_api_t::setProvisioningData) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_provision_data_t const *const p_prov_data)

Set Provisioning Data.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_prov_data	Pointer to provisioning data structure.

◆ getSubnetNid

fsp_err_t(* rm_ble_mesh_access_api_t::getSubnetNid) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t handle, uint8_t *const p_nid)

To get NID associated with a subnet.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	handle	Handle identifying the subnet.
[out]	p_nid	Pointer to NID.

◆ getSubnetPrivacyKey

fsp_err_t(* rm_ble_mesh_access_api_t::getSubnetPrivacyKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t handle, uint8_t *const p_privacy_key)

To get privacy Key associated with a subnet.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	handle	Handle identifying the subnet.
[out]	p_privacy_key	Pointer to Privacy Key.

◆ getSubnetNetworkId

fsp_err_t(* rm_ble_mesh_access_api_t::getSubnetNetworkId) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t handle, uint8_t *const p_network_id)

To get Network ID associated with a subnet.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	handle	Handle identifying the subnet.
[out]	p_network_id	Pointer to Network ID.

◆ getSubnetBeaconKey

fsp_err_t(* rm_ble_mesh_access_api_t::getSubnetBeaconKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t handle, uint8_t *const p_beacon_key)

To get Beacon Key associated with a subnet.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	handle	Handle identifying the subnet.
[out]	p_beacon_key	Pointer to Beacon Key.

◆ getSubnetIdentityKey

fsp_err_t(* rm_ble_mesh_access_api_t::getSubnetIdentityKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t handle, uint8_t *const p_identity_key)

To get Identity Key associated with a subnet.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	handle	Handle identifying the subnet.
[out]	p_identity_key	Pointer to Identity Key.

◆ getSubnetEncryptionKey

fsp_err_t(* rm_ble_mesh_access_api_t::getSubnetEncryptionKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t handle, uint8_t *const p_encrypt_key)

To get Encryption Key associated with a subnet.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	handle	Handle identifying the subnet.
[out]	p_encrypt_key	Pointer to Encryption Key.

◆ getNodeIdentity

fsp_err_t(* rm_ble_mesh_access_api_t::getNodeIdentity) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint8_t *const p_id_state)

To get Node Identity.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Handle identifying the subnet.
[out]	p_id_state	Pointer to node identity state.

◆ setNodeIdentity

fsp_err_t(* rm_ble_mesh_access_api_t::setNodeIdentity) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint8_t *const p_id_state)

To set Node Identity.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Handle identifying the subnet.
[out]	p_id_state	Pointer to node identity state.

◆ getKeyRefreshPhase

fsp_err_t(* rm_ble_mesh_access_api_t::getKeyRefreshPhase) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint8_t *const p_key_refresh_state)

To get Key refresh phase.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Handle identifying the subnet.
[out]	p_key_refresh_state	Pointer to key refresh phase state.

◆ setKeyRefreshPhase

fsp_err_t(* rm_ble_mesh_access_api_t::setKeyRefreshPhase) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint8_t const *const p_key_refresh_state)

To set Key refresh phase.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Handle identifying the subnet.
[in]	p_key_refresh_state	Pointer to key refresh phase state.

◆ setTransmitState

fsp_err_t(* rm_ble_mesh_access_api_t::setTransmitState) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t tx_state_type, uint8_t tx_state)

To set Network/Relay Transmit state.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	tx_state_type	Transmit state type (Network or Relay).
[in]	tx_state	Composite state (3bits of TX count and 5bits of TX interval steps).

◆ getTransmitState

fsp_err_t(* rm_ble_mesh_access_api_t::getTransmitState) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint8_t tx_state_type, uint8_t *const p_tx_state)

To get Network/Relay Transmit state.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	tx_state_type	Transmit State Type (Network or Relay).
[out]	p_tx_state	Pointer to TX state.

◆ addAppKey

fsp_err_t(* rm_ble_mesh_access_api_t::addAppKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t appkey_index, uint8_t const *const p_app_key)

To add AppKey.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Handle of the subnet for which AppKey to be added.
[in]	appkey_index	Identifies global Index of AppKey. A 12bits value.
[in]	p_app_key	Pointer to AppKey.

◆ updateAppKey

fsp_err_t(* rm_ble_mesh_access_api_t::updateAppKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t appkey_index, uint8_t const *const p_app_key)

To update/delete AppKey.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Handle of the Subnet for which AppKey to be updated/deleted.
[in]	appkey_index	Identifies global Index of AppKey. A 12bits value.
[in]	p_app_key	Pointer to AppKey.

◆ deleteAppKey

fsp_err_t(* rm_ble_mesh_access_api_t::deleteAppKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t appkey_index, uint8_t const *const p_app_key)

To update/delete AppKey.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Handle of the Subnet for which AppKey to be updated/deleted.
[in]	appkey_index	Identifies global index of AppKey. A 12bits value.
[in]	p_app_key	Pointer to AppKey.

◆ getAppKeyHandle

fsp_err_t(* rm_ble_mesh_access_api_t::getAppKeyHandle) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t appkey_index, uint8_t const *const p_app_key, rm_ble_mesh_network_appkey_handle_t *const p_appkey_handle)

To get AppKey Handle for a given AppKey Index.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Handle of the Subnet for which AppKey to be gotten.
[in]	appkey_index	Identifies global Index of AppKey. A 12bits value.
[in]	p_app_key	Pointer to AppKey.
[out]	p_app_key_handle	Pointer to AppKey handle.

◆ getAppKeyIndexList

fsp_err_t(* rm_ble_mesh_access_api_t::getAppKeyIndexList) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_subnet_handle_t subnet_handle, uint16_t *const p_appkey_count, uint16_t *const p_appkey_index_list)

To get list of all known AppKeys.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	subnet_handle	Handle of the Subnet for which AppKey to be returned.
[out]	p_appkey_count	Pointer to AppKey count.
[out]	p_appkey_index_list	Pointer to AppKey index list.

◆ bindModelWithAppKey

fsp_err_t(* rm_ble_mesh_access_api_t::bindModelWithAppKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, uint16_t appkey_index)

To bind a model with an AppKey.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	model_handle	Model handle identifying the model.
[in]	appkey_index	Identifies global index of AppKey. A 12bits value.

◆ unbindModelWithAppKey

fsp_err_t(* rm_ble_mesh_access_api_t::unbindModelWithAppKey) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, uint16_t appkey_index)

To unbind a model with an AppKey.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	model_handle	Model handle identifying the model.
[in]	appkey_index	Identifies global index of AppKey. A 12bits value.

◆ getModelAppKeyList

fsp_err_t(* rm_ble_mesh_access_api_t::getModelAppKeyList) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, uint16_t *const p_appkey_count, uint16_t *const p_appkey_index_list)

To get list of all AppKeys associated with a model.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	model_handle	Handle of the Model for which AppKey to be returned.
[out]	p_appkey_count	pointer to AppKey count.
[out]	p_appkey_index_list	Pointer to AppKey index list.

◆ setModelPublication

fsp_err_t(* rm_ble_mesh_access_api_t::setModelPublication) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, rm_ble_mesh_access_publish_info_t *const p_publish_info)

To set Publication information associated with a model.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	model_handle	Handle of the Model for which Publication info to be set.
[in]	p_publish_info	Pointer to publication information structure.

◆ setModelPublicationPeriodDivisor

fsp_err_t(* rm_ble_mesh_access_api_t::setModelPublicationPeriodDivisor) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, uint8_t period_divisor)

To set Publication Fast Period Divisor information associated with a model.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	model_handle	Handle of the Model for which Publication info to be set.
[in]	period_divisor	The value range for the Health Fast Period Divisor state is 0 through 15, all other values are prohibited.

◆ getModelPublication

fsp_err_t(* rm_ble_mesh_access_api_t::getModelPublication) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, rm_ble_mesh_access_publish_info_t *const p_publish_info)

To get Publication information associated with a model.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	model_handle	Handle of the Model for which Publication info to be returned.
[out]	p_publish_info	Pointer to publication information structure.

◆ addModelSubscription

fsp_err_t(* rm_ble_mesh_access_api_t::addModelSubscription) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, rm_ble_mesh_access_address_t const *const p_sub_addr)

To add an address to a model subscription list.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	model_handle	Handle of the Model for which address to be added in the subscription list.
[in]	p_sub_addr	Pointer to address structure.

◆ deleteModelSubscription

fsp_err_t(* rm_ble_mesh_access_api_t::deleteModelSubscription) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, rm_ble_mesh_access_address_t const *const p_sub_addr)

To delete an address to a model subscription list.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	model_handle	Handle of the Model for which address to be deleted in the subscription list.
[in]	p_sub_addr	Pointer to address structure.

◆ deleteAllModelSubscription

fsp_err_t(* rm_ble_mesh_access_api_t::deleteAllModelSubscription) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle)

To discard a model subscription list.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	model_handle	Handle of the Model for which the subscription list to be discarded.

◆ getModelSubscriptionList

fsp_err_t(* rm_ble_mesh_access_api_t::getModelSubscriptionList) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_model_handle_t model_handle, uint16_t *const p_sub_addr_count, uint16_t *const p_sub_addr_list)

To get list of subscription addresses of a model.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	model_handle	Handle of the Model for which the subscription addresses to be returned.
[in]	p_sub_addr_count	Pointer to maximum number of subscription address.
[out]	p_sub_addr_list	Pointer to subscription addresses.

◆ getAllModelSubscriptionList

fsp_err_t(* rm_ble_mesh_access_api_t::getAllModelSubscriptionList) (rm_ble_mesh_access_ctrl_t *const p_ctrl, uint16_t *const p_sub_addr_count, uint16_t *const p_sub_addr_list)

To get list of subscription addresses of all the models.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_sub_addr_count	Pointer to maximum number of subscription address.
[out]	p_sub_addr_list	Pointer to subscription addresses.

◆ isValidElementAddress

fsp_err_t(* rm_ble_mesh_access_api_t::isValidElementAddress) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t addr)

To check if valid element address to receive a packet.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	addr	A valid element address, to be checked.

◆ isFixedGroupAddressToBeProcessed

fsp_err_t(* rm_ble_mesh_access_api_t::isFixedGroupAddressToBeProcessed) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t addr)

To check if Fixed Group Address in receive packet to be processed.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	addr	A valid fixed group address, to be checked.

◆ isValidSubscriptionAddress

fsp_err_t(* rm_ble_mesh_access_api_t::isValidSubscriptionAddress) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_network_address_t addr)

To check if valid subscription address to receive a packet.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	addr	A valid subscription address, to be checked.

◆ enableIvUpdateTestMode

fsp_err_t(* rm_ble_mesh_access_api_t::enableIvUpdateTestMode) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_iv_update_test_mode_t mode)

To set the IV Update Test Mode feature.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	mode	This flag is used to either enable or disable the IV update test mode feature.

◆ rm_ble_mesh_access_instance_t

struct rm_ble_mesh_access_instance_t

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

Data Fields
rm_ble_mesh_access_ctrl_t *	p_ctrl	Pointer to the control structure for this instance.
rm_ble_mesh_access_cfg_t const *	p_cfg	Pointer to the configuration structure for this instance.
rm_ble_mesh_access_api_t const *	p_api	Pointer to the API structure for this instance.

Macro Definition Documentation

◆ RM_BLE_MESH_ACCESS_VADDR_LABEL_UUID_SIZE

#define RM_BLE_MESH_ACCESS_VADDR_LABEL_UUID_SIZE

Array sizes for use in the Access layer Size of Virtual Address (Label UUID)

◆ RM_BLE_MESH_ACCESS_NETKEY_SIZE

#define RM_BLE_MESH_ACCESS_NETKEY_SIZE

Size of NetKey

◆ RM_BLE_MESH_ACCESS_APPKEY_SIZE

#define RM_BLE_MESH_ACCESS_APPKEY_SIZE

Size of AppKey

◆ RM_BLE_MESH_ACCESS_KEY_SIZE

#define RM_BLE_MESH_ACCESS_KEY_SIZE

Size of Key

Typedef Documentation

◆ rm_ble_mesh_access_node_id_t

typedef uint8_t rm_ble_mesh_access_node_id_t

Access Node ID

◆ rm_ble_mesh_access_element_handle_t

typedef uint8_t rm_ble_mesh_access_element_handle_t

Access Element Handle

◆ rm_ble_mesh_access_model_handle_t

typedef uint16_t rm_ble_mesh_access_model_handle_t

Access Model Handle

◆ rm_ble_mesh_access_model_id_sig_t

typedef uint16_t rm_ble_mesh_access_model_id_sig_t

SIG Model ID

◆ rm_ble_mesh_access_model_id_vendor_t

typedef uint32_t rm_ble_mesh_access_model_id_vendor_t

Vendor Model ID

◆ rm_ble_mesh_access_address_handle_t

typedef uint32_t rm_ble_mesh_access_address_handle_t

Access Address Handle

◆ rm_ble_mesh_access_device_key_handle_t

typedef uint32_t rm_ble_mesh_access_device_key_handle_t

Device Key Handle

◆ rm_ble_mesh_access_ctrl_t

typedef void rm_ble_mesh_access_ctrl_t

BLE MESH ACCESS control block. Allocate an instance specific control block to pass into the BLE MESH ACCESS API calls.

Enumeration Type Documentation

◆ rm_ble_mesh_access_model_req_msg_type_t

enum rm_ble_mesh_access_model_req_msg_type_t

Model Specific Request Message Type: Get, Set or Others

Enumerator
RM_BLE_MESH_ACCESS_MODEL_REQ_MSG_TYPE_GET	Model Specific Request Message Type: Get
RM_BLE_MESH_ACCESS_MODEL_REQ_MSG_TYPE_SET	Model Specific Request Message Type: Set
RM_BLE_MESH_ACCESS_MODEL_REQ_MSG_TYPE_OTHERS	Model Specific Request Message Type: Others

◆ rm_ble_mesh_access_iv_update_test_mode_t

enum rm_ble_mesh_access_iv_update_test_mode_t

Test modes

Enumerator
RM_BLE_MESH_ACCESS_IV_UPDATE_TEST_MODE_DISABLE	Test mode disable.
RM_BLE_MESH_ACCESS_IV_UPDATE_TEST_MODE_ENABLE	Test mode enable.

◆ rm_ble_mesh_access_message_opcode_t

enum rm_ble_mesh_access_message_opcode_t

Opcodes of Model specific messages

Enumerator
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_APPKEY_DELETE	Config AppKey Delete Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_APPKEY_GET	Config AppKey Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_APPKEY_LIST	Config AppKey List Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_APPKEY_STATUS	Config AppKey Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_ATTENTION_GET	Health Attention Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_ATTENTION_SET	Health Attention Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_ATTENTION_SET_UNACKNOWLEDGED	Health Attention Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_ATTENTION_STATUS	Health Attention Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_COMPOSITION_DATA_GET	Config Composition Data Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_BEACON_GET	Config Beacon Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_BEACON_SET	Config Beacon Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_BEACON_STATUS	Config Beacon Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_DEFAULT_TTL_GET	Config Deafault TTL Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_DEFAULT_TTL_SET	Config Deafault TTL Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_DEFAULT_TTL_STATUS	Config Deafault TTL Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_FRIEND_GET	Config Friend Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_FRIEND_SET	Config Friend Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_FRIEND_STATUS	Config Friend Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_GATT_PROXY_GET	Config GATT Proxy Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_GATT_PROXY_SET	Config GATT Proxy Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_GATT_PROXY_STATUS	Config GATT Proxy Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_KEY_REFRESH_PHASE_GET	Config Key Refresh Phase Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_KEY_REFRESH_PHASE_SET	Config Key Refresh Phase Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_KEY_REFRESH_PHASE_STATUS	Config Key Refresh Phase Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_PUBLICATION_GET	Config Model Publication Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_PUBLICATION_STATUS	Config Model Publication Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_PUBLICATION_VIRTUAL_ADDRESS_SET	Config Model Publication Virtual Address Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_SUBSCRIPTION_ADD	Config Model Subscription Add Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_SUBSCRIPTION_DELETE	Config Model Subscription Delete Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_SUBSCRIPTION_DELETE_ALL	Config Model Subscription Delete All Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_SUBSCRIPTION_OVERWRITE	Config Model Subscription Overwrite Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_SUBSCRIPTION_STATUS	Config Model Subscription Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_SUBSCRIPTION_VIRTUAL_ADDRESS_ADD	Config Model Subscription Virtual Address Add Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_SUBSCRIPTION_VIRTUAL_ADDRESS_DELETE	Config Model Subscription Virtual Address Delete Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_SUBSCRIPTION_VIRTUAL_ADDRESS_OVERWRITE	Config Model Subscription Virtual Address Overwrite Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NETWORK_TRANSMIT_GET	Config Network Transmit Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NETWORK_TRANSMIT_SET	Config Network Transmit Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NETWORK_TRANSMIT_STATUS	Config Network Transmit Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_RELAY_GET	Config Relay Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_RELAY_SET	Config Relay Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_RELAY_STATUS	Config Relay Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_SIG_MODEL_SUBSCRIPTION_GET	Config SIG Model Subscription Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_SIG_MODEL_SUBSCRIPTION_LIST	Config SIG Model Subscription List Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_VENDOR_MODEL_SUBSCRIPTION_GET	Config Vendor Model Subscription Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_VENDOR_MODEL_SUBSCRIPTION_LIST	Config Vendor Model Subscription List Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_LOW_POWER_NODE_POLLTIMEOUT_GET	Config Low Power Node PollTimeout Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_LOW_POWER_NODE_POLLTIMEOUT_STATUS	Config Low Power Node PollTimeout Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_FAULT_CLEAR	Health Fault Clear Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_FAULT_CLEAR_UNACKNOWLEDGED	Health Fault Clear Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_FAULT_GET	Health Fault Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_FAULT_TEST	Health Fault Test Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_FAULT_TEST_UNACKNOWLEDGED	Health Fault Test Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_PERIOD_GET	Health Period Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_PERIOD_SET	Health Period Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_PERIOD_SET_UNACKNOWLEDGED	Health Period Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_HEALTH_PERIOD_STATUS	Health Period Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_HEARTBEAT_PUBLICATION_GET	Config Heartbeat Publication Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_HEARTBEAT_PUBLICATION_SET	Config Heartbeat Publication Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_HEARTBEAT_SUBSCRIPTION_GET	Config Heartbeat Subscription Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_HEARTBEAT_SUBSCRIPTION_SET	Config Heartbeat Subscription Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_HEARTBEAT_SUBSCRIPTION_STATUS	Config Heartbeat Subscription Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_APP_BIND	Config Model App Bind Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_APP_STATUS	Config Model App Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_MODEL_APP_UNBIND	Config Model App Unbind Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NETKEY_ADD	Config NetKey Add Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NETKEY_DELETE	Config NetKey Delete Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NETKEY_GET	Config NetKey Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NETKEY_LIST	Config NetKey List Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NETKEY_STATUS	Config NetKey Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NETKEY_UPDATE	Config NetKey Update Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NODE_IDENTITY_GET	Config Node Identity Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NODE_IDENTITY_SET	Config Node Identity Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NODE_IDENTITY_STATUS	Config Node Identity Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NODE_RESET	Config Node Reset Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_NODE_RESET_STATUS	Config Node Reset Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_SIG_MODEL_APP_GET	Config SIG Model App Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_SIG_MODEL_APP_LIST	Config SIG Model App List Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_VENDOR_MODEL_APP_GET	Config Vendor Model App Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_CONFIG_VENDOR_MODEL_APP_LIST	Config Vendor Model App List Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ONOFF_GET	Generic OnOff Generic OnOff Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ONOFF_SET	Generic OnOff Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ONOFF_SET_UNACKNOWLEDGED	Generic OnOff Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ONOFF_STATUS	Generic OnOff Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_LEVEL_GET	Generic Level Generic Level Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_LEVEL_SET	Generic Level Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_LEVEL_SET_UNACKNOWLEDGED	Generic Level Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_LEVEL_STATUS	Generic Level Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_DELTA_SET	Generic Delta Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_DELTA_SET_UNACKNOWLEDGED	Generic Delta Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_MOVE_SET	Generic Move Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_MOVE_SET_UNACKNOWLEDGED	Generic Move Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_DEFAULT_TRANSITION_TIME_GET	Generic Default Transition Time Generic Default Transition Time Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_DEFAULT_TRANSITION_TIME_SET	Generic Default Transition Time Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_DEFAULT_TRANSITION_TIME_SET_UNACKNOWLEDGED	Generic Default Transition Time Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_DEFAULT_TRANSITION_TIME_STATUS	Generic Default Transition Time Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ONPOWERUP_GET	Generic Power OnOff Generic Power OnOff Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ONPOWERUP_STATUS	Generic Power OnOff Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ONPOWERUP_SET	Generic Power OnOff Setup Generic Power OnOff Setup Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ONPOWERUP_SET_UNACKNOWLEDGED	Generic Power OnOff Setup Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_LEVEL_GET	Generic Power Level Generic Power Level Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_LEVEL_SET	Generic Power Level Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_LEVEL_SET_UNACKNOWLEDGED	Generic Power Level Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_LEVEL_STATUS	Generic Power Level Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_LAST_GET	Generic Power Last Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_LAST_STATUS	Generic Power Last Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_DEFAULT_GET	Generic Power Default Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_DEFAULT_STATUS	Generic Power Default Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_RANGE_GET	Generic Power Range Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_RANGE_STATUS	Generic Power Range Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_DEFAULT_SET	Generic Power Level Setup Generic Power Default Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_DEFAULT_SET_UNACKNOWLEDGED	Generic Power Default Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_RANGE_SET	Generic Power Range Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_POWER_RANGE_SET_UNACKNOWLEDGED	Generic Power Range Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_BATTERY_GET	Generic Battery Generic Battery Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_BATTERY_STATUS	Generic Battery Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_LOCATION_GLOBAL_GET	Generic Location Generic Location Global Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_LOCATION_GLOBAL_STATUS	Generic Location Global Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_LOCATION_LOCAL_GET	Generic Location Local Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_LOCATION_LOCAL_STATUS	Generic Location Local Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_LOCATION_GLOBAL_SET	Generic Location Setup Generic Location Global Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_LOCATION_GLOBAL_SET_UNACKNOWLEDGED	Generic Location Global Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_LOCATION_LOCAL_SET	Generic Location Local Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_LOCATION_LOCAL_SET_UNACKNOWLEDGED	Generic Location Local Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_MANUFACTURER_PROPERTIES_GET	Generic Manufacturer Property Generic Manufacturer Properties Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_MANUFACTURER_PROPERTIES_STATUS	Generic Manufacturer Properties Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_MANUFACTURER_PROPERTY_GET	Generic Manufacturer Property Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_MANUFACTURER_PROPERTY_SET	Generic Manufacturer Property Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_MANUFACTURER_PROPERTY_SET_UNACKNOWLEDGED	Generic Manufacturer Property Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_MANUFACTURER_PROPERTY_STATUS	Generic Manufacturer Property Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ADMIN_PROPERTIES_GET	Generic Admin Property Generic Admin Properties Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ADMIN_PROPERTIES_STATUS	Generic Admin Properties Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ADMIN_PROPERTY_GET	Generic Admin Property Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ADMIN_PROPERTY_SET	Generic Admin Property Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ADMIN_PROPERTY_SET_UNACKNOWLEDGED	Generic Admin Property Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_ADMIN_PROPERTY_STATUS	Generic Admin Property Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_USER_PROPERTIES_GET	Generic User Property Generic User Properties Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_USER_PROPERTIES_STATUS	Generic User Properties Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_USER_PROPERTY_GET	Generic User Property Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_USER_PROPERTY_SET	Generic User Property Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_USER_PROPERTY_SET_UNACKNOWLEDGED	Generic User Property Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_USER_PROPERTY_STATUS	Generic User Property Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_CLIENT_PROPERTIES_GET	Generic Client Property Generic Client Properties Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_GENERIC_CLIENT_PROPERTIES_STATUS	Generic Client Properties Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_DESCRIPTOR_GET	Sensor Sensor Descriptor Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_DESCRIPTOR_STATUS	Sensor Descriptor Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_GET	Sensor Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_STATUS	Sensor Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_COLUMN_GET	Sensor Column Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_COLUMN_STATUS	Sensor Column Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_SERIES_GET	Sensor Series Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_SERIES_STATUS	Sensor Series Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_CADENCE_GET	Sensor Setup Sensor Cadence Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_CADENCE_SET	Sensor Cadence Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_CADENCE_SET_UNACKNOWLEDGED	Sensor Cadence Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_CADENCE_STATUS	Sensor Cadence Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_SETTINGS_GET	Sensor Settings Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_SETTINGS_STATUS	Sensor Settings Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_SETTING_GET	Sensor Setting Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_SETTING_SET	Sensor Setting Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_SETTING_SET_UNACKNOWLEDGED	Sensor Setting Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SENSOR_SETTING_STATUS	Sensor Setting Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_TIME_GET	Time Time Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_TIME_SET	Time Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_TIME_STATUS	Time Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_TIME_ROLE_GET	Time Role Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_TIME_ROLE_SET	Time Role Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_TIME_ROLE_STATUS	Time Role Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_TIME_ZONE_GET	Time Zone Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_TIME_ZONE_SET	Time Zone Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_TIME_ZONE_STATUS	Time Zone Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_TAI_UTC_DELTA_GET	Time - TAI UTC Delta Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_TAI_UTC_DELTA_SET	Time - TAI UTC Delta Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_TAI_UTC_DELTA_STATUS	Time - TAI UTC Delta Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCENE_GET	Scene Scene Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCENE_RECALL	Scene Recall Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCENE_RECALL_UNACKNOWLEDGED	Scene Recall Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCENE_STATUS	Scene Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCENE_REGISTER_GET	Scene Register Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCENE_REGISTER_STATUS	Scene Register Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCENE_STORE	Scene Setup Scene Store Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCENE_STORE_UNACKNOWLEDGED	Scene Store Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCENE_DELETE	Scene Delete Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCENE_DELETE_UNACKNOWLEDGED	Scene Delete Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCHEDULER_ACTION_GET	Scheduler Scheduler Action Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCHEDULER_ACTION_STATUS	Scheduler Action Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCHEDULER_GET	Scheduler Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCHEDULER_STATUS	Scheduler Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCHEDULER_ACTION_SET	Scheduler Setup Scheduler Action Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_SCHEDULER_ACTION_SET_UNACKNOWLEDGED	Scheduler Action Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_GET	Light Lightness Light Lightness Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_SET	Light Lightness Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_SET_UNACKNOWLEDGED	Light Lightness Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_STATUS	Light Lightness Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_LINEAR_GET	Light Lightness Linear Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_LINEAR_SET	Light Lightness Linear Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_LINEAR_SET_UNACKNOWLEDGED	Light Lightness Linear Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_LINEAR_STATUS	Light Lightness Linear Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_LAST_GET	Light Lightness Last Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_LAST_STATUS	Light Lightness Last Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_DEFAULT_GET	Light Lightness Default Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_DEFAULT_STATUS	Light Lightness Default Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_RANGE_GET	Light Lightness Range Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_RANGE_STATUS	Light Lightness Range Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_DEFAULT_SET	Light Lightness Setup Light Lightness Range Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_DEFAULT_SET_UNACKNOWLEDGED	Light Lightness Range Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_RANGE_SET	Light Lightness Range Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LIGHTNESS_RANGE_SET_UNACKNOWLEDGED	Light Lightness Range Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_GET	Light CTL Light CTL Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_SET	Light CTL Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_SET_UNACKNOWLEDGED	Light CTL Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_STATUS	Light CTL Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_TEMPERATURE_GET	Light CTL Temperature Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_TEMPERATURE_RANGE_GET	Light CTL Temperature Range Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_TEMPERATURE_RANGE_STATUS	Light CTL Temperature Range Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_TEMPERATURE_SET	Light CTL Temperature Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_TEMPERATURE_SET_UNACKNOWLEDGED	Light CTL Temperature Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_TEMPERATURE_STATUS	Light CTL Temperature Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_DEFAULT_GET	Light CTL Default Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_DEFAULT_STATUS	Light CTL Default Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_DEFAULT_SET	Light CTL Setup Light CTL Default Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_DEFAULT_SET_UNACKNOWLEDGED	Light CTL Default Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_TEMPERATURE_RANGE_SET	Light CTL Default Range Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_CTL_TEMPERATURE_RANGE_SET_UNACKNOWLEDGED	Light CTL Default Range Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_GET	Light HSL Light HSL Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_HUE_GET	Light HSL HUE Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_HUE_SET	Light HSL HUE Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_HUE_SET_UNACKNOWLEDGED	Light HSL HUE Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_HUE_STATUS	Light HSL HUE Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_SATURATION_GET	Light HSL Saturation Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_SATURATION_SET	Light HSL Saturation Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_SATURATION_SET_UNACKNOWLEDGED	Light HSL Saturation Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_SATURATION_STATUS	Light HSL Saturation Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_SET	Light HSL Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_SET_UNACKNOWLEDGED	Light HSL Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_STATUS	Light HSL Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_TARGET_GET	Light HSL Target Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_TARGET_STATUS	Light HSL Target Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_DEFAULT_GET	Light HSL Default Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_DEFAULT_STATUS	Light HSL Default Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_RANGE_GET	Light HSL Range Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_RANGE_STATUS	Light HSL Range Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_DEFAULT_SET	Light HSL Setup Light HSL Default Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_DEFAULT_SET_UNACKNOWLEDGED	Light HSL Default Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_RANGE_SET	Light HSL Range Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_HSL_RANGE_SET_UNACKNOWLEDGED	Light HSL Range Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_GET	Light xyL Light xyL Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_SET	Light xyL Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_SET_UNACKNOWLEDGED	Light xyL Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_STATUS	Light xyL Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_TARGET_GET	Light xyL Target Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_TARGET_STATUS	Light xyL Target Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_DEFAULT_GET	Light xyL Default Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_DEFAULT_STATUS	Light xyL Default Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_RANGE_GET	Light xyL Range Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_RANGE_STATUS	Light xyL Range Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_DEFAULT_SET	Light xyL Setup Light xyL Default Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_DEFAULT_SET_UNACKNOWLEDGED	Light xyL Default Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_RANGE_SET	Light xyL Range Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_XYL_RANGE_SET_UNACKNOWLEDGED	Light xyL Range Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_MODE_GET	Light Control Light LC Mode Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_MODE_SET	Light LC Mode Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_MODE_SET_UNACKNOWLEDGED	Light LC Mode Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_MODE_STATUS	Light LC Mode Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_OM_GET	Light LC Occupancy Mode Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_OM_SET	Light LC Occupancy Mode Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_OM_SET_UNACKNOWLEDGED	Light LC Occupancy Mode Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_OM_STATUS	Light LC Occupancy Mode Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_LIGHT_ONOFF_GET	Light LC Light OnOff Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_LIGHT_ONOFF_SET	Light LC Light OnOff Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_LIGHT_ONOFF_SET_UNACKNOWLEDGED	Light LC Light OnOff Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_LIGHT_ONOFF_STATUS	Light LC Light OnOff Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_PROPERTY_GET	Light LC Property Get Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_PROPERTY_SET	Light LC Property Set Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_PROPERTY_SET_UNACKNOWLEDGED	Light LC Property Set Unacknowledged Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_LIGHT_LC_PROPERTY_STATUS	Light LC Property Status Opcode
RM_BLE_MESH_ACCESS_MESSAGE_OPCODE_INVALID	Invalid Opcode

◆ rm_ble_mesh_access_model_type_info_t

enum rm_ble_mesh_access_model_type_info_t

Model type information

Enumerator
RM_BLE_MESH_ACCESS_MODEL_TYPE_INFO_SIG	Model type - SIG
RM_BLE_MESH_ACCESS_MODEL_TYPE_INFO_VENDOR	Model type - VENDOR

◆ rm_ble_mesh_access_model_id_info_t

enum rm_ble_mesh_access_model_id_info_t

Model ID information

Enumerator
RM_BLE_MESH_ACCESS_MODEL_INFO_CONFIG_SERVER	Model ID - Config Server
RM_BLE_MESH_ACCESS_MODEL_INFO_CONFIG_CLIENT	Model ID - Config Client
RM_BLE_MESH_ACCESS_MODEL_INFO_HEALTH_SERVER	Model ID - Health Server
RM_BLE_MESH_ACCESS_MODEL_INFO_HEALTH_CLIENT	Model ID - Health Client
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_ONOFF_SERVER	Generic Model ID - Generic OnOff Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_ONOFF_CLIENT	Model ID - Generic OnOff Client
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_LEVEL_SERVER	Model ID - Generic Level Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_LEVEL_CLIENT	Model ID - Generic Level Client
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_DEFAULT_TRANSITION_TIME_SERVER	Model ID - Generic Default Transition Time Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_DEFAULT_TRANSITION_TIME_CLIENT	Model ID - Generic Default Transition Time Client
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_POWER_ONOFF_SERVER	Model ID - Generic Power OnOff Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_POWER_ONOFF_SETUP_SERVER	Model ID - Generic Power OnOff Setup Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_POWER_ONOFF_CLIENT	Model ID - Generic Power OnOff Client
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_POWER_LEVEL_SERVER	Model ID - Generic Power Level Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_POWER_LEVEL_SETUP_SERVER	Model ID - Generic Power Level Setup Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_POWER_LEVEL_CLIENT	Model ID - Generic Power Level Client
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_BATTERY_SERVER	Model ID - Generic Battery Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_BATTERY_CLIENT	Model ID - Generic Battery Client
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_LOCATION_SERVER	Model ID - Generic Location Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_LOCATION_SETUP_SERVER	Model ID - Generic Location Setup Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_LOCATION_CLIENT	Model ID - Generic Location Client
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_ADMIN_PROPERTY_SERVER	Model ID - Generic Admin Property Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_MANUFACTURER_PROPERTY_SERVER	Model ID - Generic Manufacturer Property Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_USER_PROPERTY_SERVER	Model ID - Generic User Property Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_CLIENT_PROPERTY_SERVER	Model ID - Generic Client Property Server
RM_BLE_MESH_ACCESS_MODEL_INFO_GENERIC_PROPERTY_CLIENT	Model ID - Generic Property Client
RM_BLE_MESH_ACCESS_MODEL_INFO_SENSOR_SERVER	Sensors Model ID - Sensor Server
RM_BLE_MESH_ACCESS_MODEL_INFO_SENSOR_SETUP_SERVER	Model ID - Sensor Setup Server
RM_BLE_MESH_ACCESS_MODEL_INFO_SENSOR_CLIENT	Model ID - Sensor Client
RM_BLE_MESH_ACCESS_MODEL_INFO_TIME_SERVER	Time and Scenes Model ID - Time Server
RM_BLE_MESH_ACCESS_MODEL_INFO_TIME_SETUP_SERVER	Model ID - Time Setup Server
RM_BLE_MESH_ACCESS_MODEL_INFO_TIME_CLIENT	Model ID - Time Client
RM_BLE_MESH_ACCESS_MODEL_INFO_SCENE_SERVER	Model ID - Scene Server
RM_BLE_MESH_ACCESS_MODEL_INFO_SCENE_SETUP_SERVER	Model ID - Scene Setup Server
RM_BLE_MESH_ACCESS_MODEL_INFO_SCENE_CLIENT	Model ID - Scene Client
RM_BLE_MESH_ACCESS_MODEL_INFO_SCHEDULER_SERVER	Model ID - Scheduler Server
RM_BLE_MESH_ACCESS_MODEL_INFO_SCHEDULER_SETUP_SERVER	Model ID - Scheduler Setup Server
RM_BLE_MESH_ACCESS_MODEL_INFO_SCHEDULER_CLIENT	Model ID - Scheduler Client
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_LIGHTNESS_SERVER	Lighting Model ID - Light Lightness Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_LIGHTNESS_SETUP_SERVER	Model ID - Light Lightness Setup Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_LIGHTNESS_CLIENT	Model ID - Light Lightness Client
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_CTL_SERVER	Model ID - Light CTL Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_CTL_SETUP_SERVER	Model ID - Light CTL Setup Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_CTL_CLIENT	Model ID - Light CTL Client
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_CTL_TEMPERATURE_SERVER	Model ID - Light CTL Temperature Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_HSL_SERVER	Model ID - Light HSL Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_HSL_SETUP_SERVER	Model ID - Light HSL Setup Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_HSL_CLIENT	Model ID - Light HSL Client
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_HSL_HUE_SERVER	Model ID - Light HSL HUE Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_HSL_SATURATION_SERVER	Model ID - Light HSL Saturation Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_XYL_SERVER	Model ID - Light xyL Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_XYL_SETUP_SERVER	Model ID - Light xyL Setup Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_XYL_CLIENT	Model ID - Light xyL Client
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_LC_SERVER	Model ID - Light LC Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_LC_SETUP_SERVER	Model ID - Light LC Setup Server
RM_BLE_MESH_ACCESS_MODEL_INFO_LIGHT_LC_CLIENT	Model ID - Light LC Client

Detailed Description

Summary

Modules

Data Structures

Macros

Typedefs

Enumerations

Data Structure Documentation

◆ rm_ble_mesh_access_model_id_t

◆ rm_ble_mesh_access_model_id_t.__unnamed__

◆ rm_ble_mesh_access_element_descriptor_t

◆ rm_ble_mesh_access_address_t

◆ rm_ble_mesh_access_publish_info_t

◆ rm_ble_mesh_access_model_req_msg_context_t

◆ rm_ble_mesh_access_req_msg_raw_t

◆ rm_ble_mesh_access_model_req_msg_t

◆ rm_ble_mesh_access_publish_setting_t

◆ rm_ble_mesh_access_pdu_t

◆ rm_ble_mesh_access_model_state_parameter_t

◆ rm_ble_mesh_access_extended_parameter_t

◆ rm_ble_mesh_access_device_entry_t

◆ rm_ble_mesh_access_model_t

◆ rm_ble_mesh_access_server_state_t

◆ rm_ble_mesh_access_provisioned_device_entry_t

◆ rm_ble_mesh_access_associated_keys_t

◆ rm_ble_mesh_access_friend_security_credential_info_t

◆ rm_ble_mesh_access_cfg_t

◆ rm_ble_mesh_access_api_t

Data Fields

Field Documentation

◆ open

◆ close

◆ registerModel

◆ getElementHandle

◆ getElementHandleForModelHandle

◆ getModelHandle

◆ publish

◆ reliablePublish

◆ reply

◆ replyAndPublish

◆ sendPdu

◆ getCompositionData

◆ reset

◆ getElementCount

◆ setPrimaryUnicastAddress

◆ getPrimaryUnicastAddress

◆ setDefaultTtl

◆ getDefaultTtl

◆ setIvIndex

◆ getIvIndex

◆ getIvIndexByIvi

◆ setFeaturesField

◆ getFeaturesField

◆ getFeatures

◆ getFriendshipRole

◆ setFriendshipRole

◆ addDeviceKey

◆ getDeviceKey

◆ removeAllDeviceKeys

◆ getProvisionedDeviceList

◆ getDeviceKeyHandle

◆ getAppKey

◆ addUpdateNetkey

◆ addFriendSecurityCredential

◆ deleteFriendSecurityCredential

◆ findSubnet

◆ findMasterSubnet

◆ deleteNetKey

◆ getNetKey

◆ getNetKeyIndexList

◆ lookUpNid

◆ lookUpNetworkId

◆ lookUpAid

◆ setProvisioningData

◆ getSubnetNid

◆ getSubnetPrivacyKey

◆ getSubnetNetworkId

◆ getSubnetBeaconKey

◆ getSubnetIdentityKey

◆ getSubnetEncryptionKey

◆ rm_ble_mesh_access_model_id_t.unnamed