nRF5 SDK for Mesh v5.0.0
Data Structures | Macros | Typedefs | Functions
Generic Power OnOff Setup server model interface

This model extends Generic PowerOnOff server, Generic OnOff server, and Generic Default Transition Time server. More...

Data Structures

struct  generic_ponoff_setup_server_state_cbs_t
 Transaction callbacks for the Power OnOff state. More...
 
struct  generic_ponoff_server_settings_t
 User provided settings and callbacks for the model instance. More...
 
struct  generic_ponoff_server_t
 
struct  generic_ponoff_setup_server_callbacks_t
 Default Transition Time server callback list. More...
 
struct  generic_ponoff_setup_server_settings_t
 User provided settings and callbacks for the model instance. More...
 
struct  generic_ponoff_setup_server_t
 

Macros

#define GENERIC_PONOFF_SERVER_MODEL_ID   0x1006
 Server model ID.
 
#define GENERIC_PONOFF_SETUP_SERVER_MODEL_ID   0x1007
 Setup server model ID.
 

Typedefs

typedef void(* generic_ponoff_state_set_cb_t) (const generic_ponoff_setup_server_t *p_self, const access_message_rx_meta_t *p_meta, const generic_ponoff_set_params_t *p_in, generic_ponoff_status_params_t *p_out)
 Callback type for Generic Power OnOff Set/Set Unacknowledged message. More...
 
typedef void(* generic_ponoff_state_get_cb_t) (const generic_ponoff_setup_server_t *p_self, const access_message_rx_meta_t *p_meta, generic_ponoff_status_params_t *p_out)
 Callback type for Generic Power OnOff Get message. More...
 

Functions

uint32_t generic_ponoff_server_status_publish (generic_ponoff_server_t *p_server, const generic_ponoff_status_params_t *p_params)
 Publishes unsolicited Status message. More...
 
uint32_t generic_ponoff_setup_server_init (generic_ponoff_setup_server_t *p_server, uint8_t element_index)
 Initializes Generic Power OnOff Setup server. More...
 

Detailed Description

This model extends Generic PowerOnOff server, Generic OnOff server, and Generic Default Transition Time server.

Therefore, this model generates events for messages received by its parent model.

Typedef Documentation

◆ generic_ponoff_state_set_cb_t

typedef void(* generic_ponoff_state_set_cb_t) (const generic_ponoff_setup_server_t *p_self, const access_message_rx_meta_t *p_meta, const generic_ponoff_set_params_t *p_in, generic_ponoff_status_params_t *p_out)

Callback type for Generic Power 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.
[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 82 of file generic_ponoff_setup_server.h.

◆ generic_ponoff_state_get_cb_t

typedef void(* generic_ponoff_state_get_cb_t) (const generic_ponoff_setup_server_t *p_self, const access_message_rx_meta_t *p_meta, generic_ponoff_status_params_t *p_out)

Callback type for Generic Power 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 94 of file generic_ponoff_setup_server.h.

Function Documentation

◆ generic_ponoff_server_status_publish()

uint32_t generic_ponoff_server_status_publish ( generic_ponoff_server_t *  p_server,
const generic_ponoff_status_params_t p_params 
)

Publishes unsolicited Status message.

This API 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.
NRF_ERROR_NULLNULL pointer supplied to function.
NRF_ERROR_INVALID_PARAMIncorrect message parameters, the model not bound to application key, or publish address not set or wrong opcode format.
NRF_ERROR_NO_MEMNo memory available to send the message at this point.
NRF_ERROR_NOT_FOUNDThe model is not initialized.
NRF_ERROR_FORBIDDENFailed to allocate a sequence number from network.
NRF_ERROR_INVALID_STATEThere's already a segmented packet that is being to sent to this destination. Wait for the transmission to finish before sending new segmented packets.

◆ generic_ponoff_setup_server_init()

uint32_t generic_ponoff_setup_server_init ( generic_ponoff_setup_server_t *  p_server,
uint8_t  element_index 
)

Initializes Generic Power OnOff Setup server.

Note
The server handles the model allocation and adding.
Parameters
[in]p_serverGeneric Power OnOff server context pointer.
[in]element_indexElement index to add the model to.
Return values
NRF_SUCCESSThe model is initialized successfully.
NRF_ERROR_NULLNULL pointer given to function.
NRF_ERROR_NO_MEMACCESS_MODEL_COUNT number of models already allocated or no more subscription lists available in memory pool (see ACCESS_SUBSCRIPTION_LIST_COUNT).
NRF_ERROR_FORBIDDENMultiple model instances per element are not allowed or changes to device composition are not allowed. Adding a new model after device is provisioned is not allowed.
NRF_ERROR_NOT_FOUNDInvalid access element index.

Documentation feedback | Developer Zone | Subscribe | Updated