RA Flexible Software Package Documentation
Release v5.2.0
|
|
The BLE Mesh Network Config Client module supports the following devices.
Configuration | Options | Default | Description |
---|
Configuration | Options | Default | Description |
---|---|---|---|
Interrupts | |||
Callback Provided when Timeout Occurs | Name Must Be a Valid C Symbol | NULL | Callback provided when mesh config client ISR occurs |
Name | Name Must Be a Valid C Symbol | g_rm_mesh_config_clt0 | Module name. |
Data Structures | |
struct | rm_mesh_config_clt_instance_ctrl_t |
struct rm_mesh_config_clt_instance_ctrl_t |
BLE mesh config instance control block. DO NOT INITIALIZE. Initialization occurs when RM_MESH_CONFIG_CLT_Open() is called.
fsp_err_t RM_MESH_CONFIG_CLT_Open | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
rm_ble_mesh_config_client_cfg_t const *const | p_cfg | ||
) |
Open Configuration Client middleware. This is to initialize Configuration Client model and to register with Access layer.
Implements rm_ble_mesh_config_client_api_t::open.
Example:
FSP_SUCCESS | Model opened successfully. |
FSP_ERR_ASSERTION | Pointer to control block or configuration structure is NULL. |
FSP_ERR_ALREADY_OPEN | Model is already open. |
FSP_ERR_NOT_FOUND | The number of models has exceeded the limit. |
FSP_ERR_ABORTED | Model initialization is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_Close | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl | ) |
Close Configuration Client middleware.
Implements rm_ble_mesh_config_client_api_t::close.
Example:
FSP_SUCCESS | Model successfully closed. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
fsp_err_t RM_MESH_CONFIG_CLT_SetServer | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
rm_ble_mesh_network_address_t | server_addr, | ||
uint8_t * | p_dev_key | ||
) |
This is to sets the information about server which is to be configured.
Implements rm_ble_mesh_config_client_api_t::setServer.
Example:
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_SendReliablePdu | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
uint32_t | req_opcode, | ||
void const *const | p_parameter, | ||
uint32_t | rsp_opcode | ||
) |
This is to initialize sending acknowledged commands.
Implements rm_ble_mesh_config_client_api_t::sendReliablePdu.
Example:
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_BeaconGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl | ) |
The Config Beacon Get is an acknowledged message used to get the current Secure Network Beacon state of a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_BeaconSet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Beacon Set is an acknowledged message used to set the current Secure Network Beacon state of a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_beacon_set_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_CompositionDataGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Composition Data Get is an acknowledged message used to read one page of the Composition Data.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_composition_data_get_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_DefaultTtlGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl | ) |
Config Default TTL Get is an acknowledged message used to get the current Default TTL state of a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_DefaultTtlSet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Default TTL Set is an acknowledged message used to set the Default TTL state of a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_default_ttl_set_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_GattProxyGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl | ) |
The Config GATT Proxy Get is an acknowledged message used to get the GATT Proxy state of a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_GattProxySet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config GATT Proxy Set is an acknowledged message used to set the GATT Proxy state of a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_gatt_proxy_set_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_RelayGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl | ) |
The Config Relay Get is an acknowledged message used to get the current Relay and Relay Retransmit states of a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_RelaySet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Relay Set is an acknowledged message used to set the current Relay and Relay Retransmit states of a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_relay_set_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_ModelPublicationGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Model Publication Get is an acknowledged message used to get the publish address and parameters of an outgoing message that originates from a model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_model_publication_get_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_ModelPublicationSet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Model Publication Set is an acknowledged message used to set the Model Publication state of an outgoing message that originates from a model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_model_publication_set_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_ModelPublicationVaddrSet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Model Publication Set is an acknowledged message used to set the Model Publication state of an outgoing message that originates from a model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_model_publication_virtual_address_set_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_ModelSubscriptionAdd | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Model Subscription Add is an acknowledged message used to add an address to a Subscription List of a model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_model_subscription_add_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_ModelSubscriptionVaddrAdd | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Model Subscription Add is an acknowledged message used to add an address to a Subscription List of a model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_model_subscription_virtual_address_add_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_ModelSubscriptionDelete | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Model Subscription Delete is an acknowledged message used to delete a subscription address from the Subscription List of a model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_model_subscription_delete_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_ModelSubscriptionVaddrDelete | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Model Subscription Delete is an acknowledged message used to delete a subscription address from the Subscription List of a model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_model_subscription_virtual_address_delete_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_ModelSubscriptionOverwrite | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Model Subscription Overwrite is an acknowledged message used to discard the Subscription List and add an address to the cleared Subscription List of a model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_model_subscription_overwrite_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_ModelSubscriptionVaddrOverwrite | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Model Subscription Overwrite is an acknowledged message used to discard the Subscription List and add an address to the cleared Subscription List of a model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_model_subscription_virtual_address_overwrite_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_ModelSubscriptionDeleteAll | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Model Subscription Delete All is an acknowledged message used to discard the Subscription List of a model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_model_subscription_delete_all_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_SigModelSubscriptionGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config SIG Model Subscription Get is an acknowledged message used to get the list of subscription addresses of a model within the element. This message is only for SIG Models.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_sig_model_subscription_get_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_VendorModelSubscriptionGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config SIG Model Subscription Get is an acknowledged message used to get the list of subscription addresses of a model within the element. This message is only for Vendor Models.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_vendor_model_subscription_get_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_NetkeyAdd | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config NetKey Add is an acknowledged message used to add a NetKey to a NetKey List on a node. The added NetKey is then used by the node to authenticate and decrypt messages it receives, as well as authenticate and encrypt messages it sends.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_netkey_add_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_NetkeyUpdate | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config NetKey Update is an acknowledged message used to update a NetKey on a node. The updated NetKey is then used by the node to authenticate and decrypt messages it receives, as well as authenticate and encrypt messages it sends, as defined by the Key Refresh procedure.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_netkey_update_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_NetkeyDelete | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config NetKey Delete is an acknowledged message used to delete a NetKey on a NetKey List from a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_netkey_delete_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_NetkeyGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl | ) |
The Config NetKey Get is an acknowledged message used to report all NetKeys known to the node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_AppkeyAdd | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config AppKey Add is an acknowledged message used to add an AppKey to the AppKey List on a node and bind it to the NetKey identified by NetKeyIndex. The added AppKey can be used by the node only as a pair with the specified NetKey. The AppKey is used to authenticate and decrypt messages it receives, as well as authenticate and encrypt messages it sends.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_appkey_add_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_AppkeyUpdate | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config AppKey Update is an acknowledged message used to update an AppKey value on the AppKey List on a node. The updated AppKey is used by the node to authenticate and decrypt messages it receives, as well as authenticate and encrypt messages it sends, as defined by the Key Refresh procedure.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_appkey_update_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_AppkeyDelete | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config AppKey Delete is an acknowledged message used to delete an AppKey from the AppKey List on a node
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_appkey_delete_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_AppkeyGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The AppKey Get is an acknowledged message used to report all AppKeys bound to the NetKey.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_appkey_get_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_NodeIdentityGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Node Identity Get is an acknowledged message used to get the current Node Identity state for a subnet.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_node_id_get_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_NodeIdentitySet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Node Identity Set is an acknowledged message used to set the current Node Identity state for a subnet.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_node_id_set_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_ModelAppBind | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Model App Bind is an acknowledged message used to bind an AppKey to a model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_model_app_bind_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_ModelAppUnbind | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Model App Unbind is an acknowledged message used to remove the binding between an AppKey and a model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_model_app_unbind_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_SigModelAppGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config SIG Model App Get is an acknowledged message used to request report of all AppKeys bound to the SIG Model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_sig_model_app_get_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_VendorModelAppGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Vendor Model App Get is an acknowledged message used to request report of all AppKeys bound to the Vendor Model.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_vendor_model_app_get_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_NodeReset | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl | ) |
The Config Node Reset is an acknowledged message used to reset a node (other than a Provisioner) and remove it from the network.
[in] | p_ctrl | rm_mesh_config_clt control block. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_FriendGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl | ) |
The Config Friend Get is an acknowledged message used to get the current Friend state of a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_FriendSet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Friend Set is an acknowledged message used to set the Friend state of a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_friend_set_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_KeyrefreshPhaseGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Key Refresh Phase Get is an acknowledged message used to get the current Key Refresh Phase state of the identified network key.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_key_refresh_phase_get_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_KeyrefreshPhaseSet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Key Refresh Phase Set is an acknowledged message used to set the current Key Refresh Phase state of the identified network key.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_key_refresh_phase_set_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_HeartbeatPublicationGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl | ) |
The Config Heartbeat Publication Get is an acknowledged message used to get the current Heartbeat Publication state of an element.
[in] | p_ctrl | rm_mesh_config_clt control block. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_HeartbeatPublicationSet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Heartbeat Publication Set is an acknowledged message used to set the current Heartbeat Publication state of an element.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_heartbeat_publication_set_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_HeartbeatSubscriptionGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl | ) |
The Config Heartbeat Subscription Get is an acknowledged message used to get the current Heartbeat Subscription state of an element.
[in] | p_ctrl | rm_mesh_config_clt control block. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_HeartbeatSubscriptionSet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Heartbeat Publication Set is an acknowledged message used to set the current Heartbeat Subscription state of an element.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_heartbeat_subscription_set_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_LpnPolltimeoutGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Low Power Node PollTimeout Get is an acknowledged message used to get the current value of PollTimeout timer of the Low Power node within a Friend node. The message is sent to a Friend node that has claimed to be handling messages by sending ACKs On Behalf Of (OBO) the indicated Low Power node. This message should only be sent to a node that has the Friend feature supported and enabled.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_low_power_node_polling_timeout_get_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_NetworkTransmitGet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl | ) |
The Config Network Transmit Get is an acknowledged message used to get the current Network Transmit state of a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |
fsp_err_t RM_MESH_CONFIG_CLT_NetworkTransmitSet | ( | rm_ble_mesh_config_client_ctrl_t *const | p_ctrl, |
void const *const | p_parameter | ||
) |
The Config Network Transmit Set is an acknowledged message used to set the current Network Transmit state of a node.
[in] | p_ctrl | rm_mesh_config_clt control block. |
[in] | p_parameter | Pointer to the structure populated as in rm_mesh_config_clt_network_transmit_set_parameter_t. |
FSP_SUCCESS | Operation succeeded. |
FSP_ERR_ASSERTION | The parameter p_ctrl is NULL. |
FSP_ERR_NOT_OPEN | Model is not open. |
FSP_ERR_INVALID_ARGUMENT | Input parameter is invalid. |
FSP_ERR_INVALID_POINTER | The parameter p_parameter is NULL. |
FSP_ERR_APPROXIMATION | Lower layer is invalid state. |
FSP_ERR_NOT_FOUND | Input parameter is not found. |
FSP_ERR_INVALID_ADDRESS | Invalid source address. |
FSP_ERR_OUT_OF_MEMORY | Memory allocation is failed. |
FSP_ERR_OVERFLOW | TX queue is full. |
FSP_ERR_UNDERFLOW | TX queue is empty. |
FSP_ERR_ABORTED | Operation is failed. |