Data Structures | |
struct | generic_level_client_callbacks_t |
struct | generic_level_client_settings_t |
User provided settings and callbacks for the model instance. More... | |
union | generic_level_client_msg_data_t |
Union for holding current message packet. More... | |
struct | generic_level_client_t |
Macros | |
#define | GENERIC_LEVEL_CLIENT_MODEL_ID 0x1003 |
Client model ID. | |
Typedefs | |
typedef void(* | generic_level_state_status_cb_t) (const generic_level_client_t *p_self, const access_message_rx_meta_t *p_meta, const generic_level_status_params_t *p_in) |
Callback type for Level state related transactions. More... | |
Functions | |
uint32_t | generic_level_client_init (generic_level_client_t *p_client, uint8_t element_index) |
Initializes Generic On Off client. More... | |
uint32_t | generic_level_client_set (generic_level_client_t *p_client, const generic_level_set_params_t *p_params, const model_transition_t *p_transition) |
Sends a Set message to the server. More... | |
uint32_t | generic_level_client_set_unack (generic_level_client_t *p_client, const generic_level_set_params_t *p_params, const model_transition_t *p_transition, uint8_t repeats) |
Sends a Set Unacknowledged message to the server. More... | |
uint32_t | generic_level_client_delta_set (generic_level_client_t *p_client, const generic_level_delta_set_params_t *p_params, const model_transition_t *p_transition) |
Sends a Delta Set message to the server. More... | |
uint32_t | generic_level_client_delta_set_unack (generic_level_client_t *p_client, const generic_level_delta_set_params_t *p_params, const model_transition_t *p_transition, uint8_t repeats) |
Sends a Delta Set Unacknowledged message to the server. More... | |
uint32_t | generic_level_client_move_set (generic_level_client_t *p_client, const generic_level_move_set_params_t *p_params, const model_transition_t *p_transition) |
Sends a Move Set message to the server. More... | |
uint32_t | generic_level_client_move_set_unack (generic_level_client_t *p_client, const generic_level_move_set_params_t *p_params, const model_transition_t *p_transition, uint8_t repeats) |
Sends a Move Set Unacknowledged message to the server. More... | |
uint32_t | generic_level_client_get (generic_level_client_t *p_client) |
Sends a Get message to the server. More... | |
typedef void(* generic_level_state_status_cb_t) (const generic_level_client_t *p_self, const access_message_rx_meta_t *p_meta, const generic_level_status_params_t *p_in) |
Callback type for Level state related transactions.
[in] | p_self | Pointer to the model structure |
[in] | p_meta | Access metadata for the received message |
[in] | p_in | Pointer to the input event parameters for the user application |
Definition at line 68 of file generic_level_client.h.
uint32_t generic_level_client_init | ( | generic_level_client_t * | p_client, |
uint8_t | element_index | ||
) |
Initializes Generic On Off client.
[in] | p_client | Client model context pointer. |
[in] | element_index | Element index to add the model |
NRF_SUCCESS | If model is initialized succesfully |
uint32_t generic_level_client_set | ( | generic_level_client_t * | p_client, |
const generic_level_set_params_t * | p_params, | ||
const model_transition_t * | p_transition | ||
) |
Sends a Set message to the server.
[in] | p_client | Client model context pointer. |
[in] | p_params | Message parameters. |
[in] | p_transition | Optional transition parameters |
NRF_SUCCESS | If the message is handed over to the mesh stack for transmission. |
uint32_t generic_level_client_set_unack | ( | generic_level_client_t * | p_client, |
const generic_level_set_params_t * | p_params, | ||
const model_transition_t * | p_transition, | ||
uint8_t | repeats | ||
) |
Sends a Set Unacknowledged message to the server.
[in] | p_client | Client model context pointer. |
[in] | p_params | Message parameters. |
[in] | p_transition | Optional transition parameters |
[in] | repeats | Number of repetitions to use while sending unacknowledged message. |
NRF_SUCCESS | If the message is handed over to the mesh stack for transmission. |
uint32_t generic_level_client_delta_set | ( | generic_level_client_t * | p_client, |
const generic_level_delta_set_params_t * | p_params, | ||
const model_transition_t * | p_transition | ||
) |
Sends a Delta Set message to the server.
[in] | p_client | Client model context pointer. |
[in] | p_params | Message parameters. |
[in] | p_transition | Optional transition parameters |
NRF_SUCCESS | If the message is handed over to the mesh stack for transmission. |
uint32_t generic_level_client_delta_set_unack | ( | generic_level_client_t * | p_client, |
const generic_level_delta_set_params_t * | p_params, | ||
const model_transition_t * | p_transition, | ||
uint8_t | repeats | ||
) |
Sends a Delta Set Unacknowledged message to the server.
[in] | p_client | Client model context pointer. |
[in] | p_params | Message parameters. |
[in] | p_transition | Optional transition parameters |
[in] | repeats | Number of repetitions to use while sending unacknowledged message. |
NRF_SUCCESS | If the message is handed over to the mesh stack for transmission. |
uint32_t generic_level_client_move_set | ( | generic_level_client_t * | p_client, |
const generic_level_move_set_params_t * | p_params, | ||
const model_transition_t * | p_transition | ||
) |
Sends a Move Set message to the server.
[in] | p_client | Client model context pointer. |
[in] | p_params | Message parameters. |
[in] | p_transition | Optional transition parameters |
NRF_SUCCESS | If the message is handed over to the mesh stack for transmission. |
uint32_t generic_level_client_move_set_unack | ( | generic_level_client_t * | p_client, |
const generic_level_move_set_params_t * | p_params, | ||
const model_transition_t * | p_transition, | ||
uint8_t | repeats | ||
) |
Sends a Move Set Unacknowledged message to the server.
[in] | p_client | Client model context pointer. |
[in] | p_params | Message parameters. |
[in] | p_transition | Optional transition parameters |
[in] | repeats | Number of repetitions to use while sending unacknowledged message. |
NRF_SUCCESS | If the message is handed over to the mesh stack for transmission. |
uint32_t generic_level_client_get | ( | generic_level_client_t * | p_client | ) |
Sends a Get message to the server.
[in] | p_client | Client model context pointer. |
NRF_SUCCESS | If the message is handed over to the mesh stack for transmission. |