This model extends Generic PowerOnOff server, Generic OnOff server, and Generic Default Transition Time server.
More...
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.
◆ generic_ponoff_state_set_cb_t
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
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.
◆ generic_ponoff_server_status_publish()
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()
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.