BLE Mesh Network Generic Default Transition Time Server (rm_mesh_generic_dtt_srv)

Functions
fsp_err_t	RM_MESH_GENERIC_DTT_SRV_Open (rm_ble_mesh_model_server_ctrl_t *const p_ctrl, rm_ble_mesh_model_server_cfg_t const *const p_cfg)
fsp_err_t	RM_MESH_GENERIC_DTT_SRV_Close (rm_ble_mesh_model_server_ctrl_t *const p_ctrl)
fsp_err_t	RM_MESH_GENERIC_DTT_SRV_GetTime (rm_ble_mesh_model_server_ctrl_t *const p_ctrl, rm_mesh_generic_dtt_srv_transtion_time_info_t *const p_info)

Detailed Description

Overview

Target Devices

The BLE Mesh Network Generic Default Transition Time Server module supports the following devices.

• RA4W1

Configuration

Build Time Configurations for rm_mesh_generic_dtt_srv

The following build time configurations are defined in fsp_cfg/rm_mesh_generic_dtt_srv_cfg.h:

Configuration	Options	Default	Description

Configurations for Networking > BLE Mesh Network modules > BLE Mesh Model Generic Default Transition Time Server (rm_mesh_generic_dtt_srv)

This module can be added to the Stacks tab via New Stack > Networking > BLE Mesh Network modules > BLE Mesh Model Generic Default Transition Time Server (rm_mesh_generic_dtt_srv).

Configuration	Options	Default	Description
Interrupts
Callback Provided When Tmeout Occurs	Name must Be a Valid C Symbol	NULL	Callback provided when mesh generic default transition time server ISR occurs
Callback Provided When an Timeout ISR Occurs	Name Must Be a Valid C Symbol	NULL	Callback provided when mesh generic default transition time server timeout ISR occurs
Name	Name Must Be a Valid C Symbol	g_rm_mesh_generic_dtt_srv0	Module name.

Data Structures
struct	rm_mesh_generic_dtt_srv_instance_ctrl_t

---

Data Structure Documentation

rm_mesh_generic_dtt_srv_instance_ctrl_t

struct rm_mesh_generic_dtt_srv_instance_ctrl_t

BLE mesh generic dtt instance control block. DO NOT INITIALIZE. Initialization occurs when RM_MESH_GENERIC_DTT_SRV_Open() is called.

Function Documentation

RM_MESH_GENERIC_DTT_SRV_Open()

fsp_err_t RM_MESH_GENERIC_DTT_SRV_Open	(	rm_ble_mesh_model_server_ctrl_t *const	p_ctrl,
		rm_ble_mesh_model_server_cfg_t const *const	p_cfg
	)

API to initialize Generic_Default_Transition_Time Server model. This is to initialize Generic_Default_Transition_Time Server model and to register with Access layer.

Implements rm_ble_mesh_model_server_api_t::open.

Example:

    /* Open the module. */
    err = RM_MESH_GENERIC_DTT_SRV_Open(&g_mesh_generic_dtt_srv0_ctrl, &g_mesh_generic_dtt_srv0_cfg);

Return values

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.

RM_MESH_GENERIC_DTT_SRV_Close()

fsp_err_t RM_MESH_GENERIC_DTT_SRV_Close

(

rm_ble_mesh_model_server_ctrl_t *const

p_ctrl

)

API to terminate Generic_Default_Transition_Time Server model. This is to terminate Generic_Default_Transition_Time Server model and to register with Access layer.

Implements rm_ble_mesh_model_server_api_t::close.

Example:

    /* Close the module. */
    err = RM_MESH_GENERIC_DTT_SRV_Close(&g_mesh_generic_dtt_srv0_ctrl);

Return values

FSP_SUCCESS	Model successfully closed.
FSP_ERR_ASSERTION	The parameter p_ctrl is NULL.
FSP_ERR_NOT_OPEN	Model is not open.

RM_MESH_GENERIC_DTT_SRV_GetTime()

fsp_err_t RM_MESH_GENERIC_DTT_SRV_GetTime	(	rm_ble_mesh_model_server_ctrl_t *const	p_ctrl,
		rm_mesh_generic_dtt_srv_transtion_time_info_t *const	p_info
	)

API to get default transition time. This is to get default transition time.

Parameters

[in]	p_ctrl	rm_mesh_generic_dtt_srv control block.
[in]	p_info	rm_mesh_generic_dtt_srv status information.

Return values

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.