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 the message is published successfully. |
NRF_ERROR_NULL | NULL pointer supplied to function. |
NRF_ERROR_INVALID_PARAM | Incorrect message parameters, the model not bound to application key, or publish address not set or wrong opcode format. |
NRF_ERROR_NO_MEM | No memory available to send the message at this point. |
NRF_ERROR_NOT_FOUND | The model is not initialized. |
NRF_ERROR_FORBIDDEN | Failed to allocate a sequence number from network. |
NRF_ERROR_INVALID_STATE | There'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_server | Generic Power OnOff server context pointer. |
[in] | element_index | Element index to add the model to. |
- Return values
-
NRF_SUCCESS | The model is initialized successfully. |
NRF_ERROR_NULL | NULL pointer given to function. |
NRF_ERROR_NO_MEM | ACCESS_MODEL_COUNT number of models already allocated or no more subscription lists available in memory pool (see ACCESS_SUBSCRIPTION_LIST_COUNT). |
NRF_ERROR_FORBIDDEN | Multiple 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_FOUND | Invalid access element index. |
◆ 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 the message is published successfully. |
NRF_ERROR_NULL | NULL pointer given to function. |
NRF_ERROR_NO_MEM | No memory available to send the message at this point. |
NRF_ERROR_NOT_FOUND | The model is not initialized. |
NRF_ERROR_INVALID_PARAM | Incorrect message parameters, the model not bound to application key, or publish address not set. |
NRF_ERROR_FORBIDDEN | Failed to allocate a sequence number from network. |
NRF_ERROR_INVALID_STATE | There's already a segmented packet that is being to sent to this destination. Wait for the transmission to finish before sending new segmented packets. |