nRF5 SDK for Mesh v3.2.0  08c60f6
Generic Default Transition Time server model interface

Data Structures

struct  generic_dtt_server_state_cbs_t
 Transaction callbacks for the Default Transition Time state. More...
 
struct  generic_dtt_server_callbacks_t
 Default Transition Time server callback list. More...
 
struct  generic_dtt_server_settings_t
 User provided settings and callbacks for the model instance. More...
 
struct  generic_dtt_server_t
 

Macros

#define GENERIC_DTT_SERVER_MODEL_ID   0x1004
 Server model ID.
 

Typedefs

typedef void(* generic_dtt_state_set_cb_t) (const generic_dtt_server_t *p_self, const access_message_rx_meta_t *p_meta, const generic_dtt_set_params_t *p_in, generic_dtt_status_params_t *p_out)
 Callback type for Generic Default Transition Time Set/Set Unacknowledged message. More...
 
typedef void(* generic_dtt_state_get_cb_t) (const generic_dtt_server_t *p_self, const access_message_rx_meta_t *p_meta, generic_dtt_status_params_t *p_out)
 Callback type for Generic Default Transition Time Get message. More...
 

Functions

uint32_t generic_dtt_server_init (generic_dtt_server_t *p_server, uint8_t element_index)
 Initializes Generic Default Transition Time server. More...
 
uint32_t generic_dtt_server_status_publish (generic_dtt_server_t *p_server, const generic_dtt_status_params_t *p_params)
 Publishes unsolicited Status message. More...
 

Detailed Description

Typedef Documentation

◆ generic_dtt_state_set_cb_t

typedef void(* generic_dtt_state_set_cb_t) (const generic_dtt_server_t *p_self, const access_message_rx_meta_t *p_meta, const generic_dtt_set_params_t *p_in, generic_dtt_status_params_t *p_out)

Callback type for Generic Default Transition Time Set/Set Unacknowledged message.

Parameters
[in]p_selfPointer to the model structure
[in]p_metaAccess metadata for the received message
[in]p_inPointer to the input parameters for the user application
[out]p_outPointer to store the output parameters from the user application. If null, indicates that it is UNACKNOWLEDGED message and no output params are required.

Definition at line 68 of file generic_dtt_server.h.

◆ generic_dtt_state_get_cb_t

typedef void(* generic_dtt_state_get_cb_t) (const generic_dtt_server_t *p_self, const access_message_rx_meta_t *p_meta, generic_dtt_status_params_t *p_out)

Callback type for Generic Default Transition Time Get message.

Parameters
[in]p_selfPointer to the model structure
[in]p_metaAccess metadata for the received message
[out]p_outPointer to store the output parameters from the user application

Definition at line 80 of file generic_dtt_server.h.

Function Documentation

◆ generic_dtt_server_init()

uint32_t generic_dtt_server_init ( generic_dtt_server_t *  p_server,
uint8_t  element_index 
)

Initializes Generic Default Transition Time server.

Note
The server handles the model allocation and adding.
Parameters
[in]p_serverGeneric Default Transition Time server context pointer.
[in]element_indexElement index to add the model to.
Return values
NRF_SUCCESSIf the model is initialized successfully.
Returns
Other appropriate error codes on failure.

◆ generic_dtt_server_status_publish()

uint32_t generic_dtt_server_status_publish ( generic_dtt_server_t *  p_server,
const generic_dtt_status_params_t p_params 
)

Publishes unsolicited Status message.

This function can be used to send unsolicited messages to report updated state value as a result of local action.

Parameters
[in]p_serverStatus server context pointer.
[in]p_paramsMessage parameters.
Return values
NRF_SUCCESSIf the message is published successfully.
Returns
Other appropriate error codes on failure.