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...
uint32_t	generic_ponoff_setup_server_status_publish (generic_ponoff_setup_server_t *p_server, const generic_ponoff_status_params_t *p_params)
	Publishes unsolicited Status message. 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_self	Pointer to the model structure.
[in]	p_meta	Access metadata for the received message.
[in]	p_in	Pointer to the input parameters for the user application.
[out]	p_out	Pointer 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_self	Pointer to the model structure.
[in]	p_meta	Access metadata for the received message.
[out]	p_out	Pointer 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_server	Status server context pointer.
[in]	p_params	Message parameters.

Return values

NRF_SUCCESS

If message is published successfully.

Returns

Other appropriate error codes on failure.

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_server	Generic Power OnOff server context pointer.
[in]	element_index	Element index to add the model to.

Return values

NRF_SUCCESS

If model is initialized successfully.

Returns

Other appropriate error codes on failure.

generic_ponoff_setup_server_status_publish()

uint32_t generic_ponoff_setup_server_status_publish	(	generic_ponoff_setup_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_server	Status server context pointer.
[in]	p_params	Message parameters.

Return values

NRF_SUCCESS

If message is published successfully.

Returns

Other appropriate error codes on failure.