nRF5 SDK for Mesh v3.2.0  08c60f6
Generic OnOff server model interface

Data Structures

struct  generic_onoff_server_state_cbs_t
 Transaction callbacks for the OnOff state. More...
 
struct  generic_onoff_server_callbacks_t
 OnOff server callback list. More...
 
struct  generic_onoff_server_settings_t
 User provided settings and callbacks for the model instance. More...
 
struct  generic_onoff_server_t
 

Macros

#define GENERIC_ONOFF_SERVER_MODEL_ID   0x1000
 Server model ID.
 

Typedefs

typedef void(* generic_onoff_state_set_cb_t) (const generic_onoff_server_t *p_self, const access_message_rx_meta_t *p_meta, const generic_onoff_set_params_t *p_in, const model_transition_t *p_in_transition, generic_onoff_status_params_t *p_out)
 Callback type for Generic OnOff Set/Set Unacknowledged message. More...
 
typedef void(* generic_onoff_state_get_cb_t) (const generic_onoff_server_t *p_self, const access_message_rx_meta_t *p_meta, generic_onoff_status_params_t *p_out)
 Callback type for Generic OnOff Get message. More...
 

Functions

uint32_t generic_onoff_server_init (generic_onoff_server_t *p_server, uint8_t element_index)
 Initializes Generic OnOff server. More...
 
uint32_t generic_onoff_server_status_publish (generic_onoff_server_t *p_server, const generic_onoff_status_params_t *p_params)
 Publishes unsolicited Status message. More...
 

Detailed Description

Typedef Documentation

◆ generic_onoff_state_set_cb_t

typedef void(* generic_onoff_state_set_cb_t) (const generic_onoff_server_t *p_self, const access_message_rx_meta_t *p_meta, const generic_onoff_set_params_t *p_in, const model_transition_t *p_in_transition, generic_onoff_status_params_t *p_out)

Callback type for Generic OnOff 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.
[in]p_in_transitionPointer to transition parameters, if present in the incoming message, otherwise set to null.
[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 70 of file generic_onoff_server.h.

◆ generic_onoff_state_get_cb_t

typedef void(* generic_onoff_state_get_cb_t) (const generic_onoff_server_t *p_self, const access_message_rx_meta_t *p_meta, generic_onoff_status_params_t *p_out)

Callback type for Generic OnOff 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 83 of file generic_onoff_server.h.

Function Documentation

◆ generic_onoff_server_init()

uint32_t generic_onoff_server_init ( generic_onoff_server_t *  p_server,
uint8_t  element_index 
)

Initializes Generic OnOff server.

Note
The server handles the model allocation and adding.
Parameters
[in]p_serverGeneric OnOff 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_onoff_server_status_publish()

uint32_t generic_onoff_server_status_publish ( generic_onoff_server_t *  p_server,
const generic_onoff_status_params_t p_params 
)

Publishes unsolicited Status message.

This function can be used to send unsolicited messages to report the 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.