nRF5 SDK for Mesh v3.2.0  08c60f6
generic_onoff_client.h
1 /* Copyright (c) 2010 - 2019, Nordic Semiconductor ASA
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without modification,
5  * are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form, except as embedded into a Nordic
11  * Semiconductor ASA integrated circuit in a product or a software update for
12  * such product, must reproduce the above copyright notice, this list of
13  * conditions and the following disclaimer in the documentation and/or other
14  * materials provided with the distribution.
15  *
16  * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
17  * contributors may be used to endorse or promote products derived from this
18  * software without specific prior written permission.
19  *
20  * 4. This software, with or without modification, must only be used with a
21  * Nordic Semiconductor ASA integrated circuit.
22  *
23  * 5. Any software provided in binary form under this license must not be reverse
24  * engineered, decompiled, modified and/or disassembled.
25  *
26  * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
27  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28  * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
29  * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
30  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
32  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
35  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef GENERIC_ONOFF_CLIENT_H__
39 #define GENERIC_ONOFF_CLIENT_H__
40 
41 
42 #include <stdint.h>
43 #include "access.h"
44 #include "access_reliable.h"
45 #include "generic_onoff_common.h"
46 #include "generic_onoff_messages.h"
47 
55 #define GENERIC_ONOFF_CLIENT_MODEL_ID 0x1001
56 
57 /* Forward declaration */
58 typedef struct __generic_onoff_client_t generic_onoff_client_t;
59 
67 typedef void (*generic_onoff_state_status_cb_t)(const generic_onoff_client_t * p_self,
68  const access_message_rx_meta_t * p_meta,
69  const generic_onoff_status_params_t * p_in);
70 typedef struct
71 {
74 
80 
84 typedef struct
85 {
89  uint32_t timeout;
94 
98 
100 typedef union
101 {
104 
107 {
112  /* Acknowledged message context variable */
113  access_reliable_t access_message;
114 
117 };
118 
131 uint32_t generic_onoff_client_init(generic_onoff_client_t * p_client, uint8_t element_index);
132 
145 uint32_t generic_onoff_client_set(generic_onoff_client_t * p_client, const generic_onoff_set_params_t * p_params,
146  const model_transition_t * p_transition);
147 
161 uint32_t generic_onoff_client_set_unack(generic_onoff_client_t * p_client, const generic_onoff_set_params_t * p_params,
162  const model_transition_t * p_transition, uint8_t repeats);
163 
174 uint32_t generic_onoff_client_get(generic_onoff_client_t * p_client);
175 
177 #endif /* GENERIC_ONOFF_CLIENT_H__ */
access_message_rx_meta_t
Metadata for received messages.
Definition: access.h:196
generic_onoff_client_settings_t::timeout
uint32_t timeout
Reliable message timeout in microseconds.
Definition: generic_onoff_client.h:89
generic_onoff_client_callbacks_t
Definition: generic_onoff_client.h:70
generic_onoff_status_params_t
Parameters for the Generic OnOff Status message.
Definition: generic_onoff_common.h:81
__generic_onoff_client_t::settings
generic_onoff_client_settings_t settings
Model settings and callbacks for this instance.
Definition: generic_onoff_client.h:116
__generic_onoff_client_t
Definition: generic_onoff_client.h:106
generic_onoff_client_settings_t::force_segmented
bool force_segmented
If server should force outgoing messages as segmented messages.
Definition: generic_onoff_client.h:91
generic_onoff_client_init
uint32_t generic_onoff_client_init(generic_onoff_client_t *p_client, uint8_t element_index)
Initializes Generic On Off client.
generic_onoff_client_msg_data_t
Union for holding current message packet.
Definition: generic_onoff_client.h:100
__generic_onoff_client_t::model_handle
access_model_handle_t model_handle
Model handle assigned to this instance.
Definition: generic_onoff_client.h:109
generic_onoff_client_set
uint32_t generic_onoff_client_set(generic_onoff_client_t *p_client, const generic_onoff_set_params_t *p_params, const model_transition_t *p_transition)
Sends a Set message to the server.
generic_onoff_client_callbacks_t::periodic_publish_cb
access_publish_timeout_cb_t periodic_publish_cb
callback called at the end of the each period for the publishing
Definition: generic_onoff_client.h:78
generic_onoff_client_settings_t::transmic_size
nrf_mesh_transmic_size_t transmic_size
TransMIC size used by the outgoing server messages.
Definition: generic_onoff_client.h:93
generic_onoff_set_msg_pkt_t
Packed message structure typedefs are used for packing and unpacking byte stream.
Definition: generic_onoff_messages.h:73
generic_onoff_client_set_unack
uint32_t generic_onoff_client_set_unack(generic_onoff_client_t *p_client, const generic_onoff_set_params_t *p_params, const model_transition_t *p_transition, uint8_t repeats)
Sends a Set Unacknowledged message to the server.
generic_onoff_client_get
uint32_t generic_onoff_client_get(generic_onoff_client_t *p_client)
Sends a Get message to the server.
generic_onoff_client_settings_t
User provided settings and callbacks for the model instance.
Definition: generic_onoff_client.h:84
access_reliable_t
Access layer reliable publish parameter structure.
Definition: access_reliable.h:134
access_reliable_cb_t
void(* access_reliable_cb_t)(access_model_handle_t model_handle, void *p_args, access_reliable_status_t status)
Access layer reliable message callback type.
Definition: access_reliable.h:126
access_model_handle_t
uint16_t access_model_handle_t
Access layer handle type.
Definition: access.h:162
generic_onoff_client_settings_t::p_callbacks
const generic_onoff_client_callbacks_t * p_callbacks
Callback list.
Definition: generic_onoff_client.h:96
generic_onoff_client_callbacks_t::onoff_status_cb
generic_onoff_state_status_cb_t onoff_status_cb
Client model response message callback.
Definition: generic_onoff_client.h:73
access_publish_timeout_cb_t
void(* access_publish_timeout_cb_t)(access_model_handle_t handle, void *p_args)
Access layer publish timeout event callback.
Definition: access.h:170
nrf_mesh_transmic_size_t
nrf_mesh_transmic_size_t
Message MIC size selection.
Definition: nrf_mesh.h:385
__generic_onoff_client_t::msg_pkt
generic_onoff_client_msg_data_t msg_pkt
Holds the raw message packet data for transactions.
Definition: generic_onoff_client.h:111
generic_onoff_client_callbacks_t::ack_transaction_status_cb
access_reliable_cb_t ack_transaction_status_cb
Callback to call after the acknowledged transaction has ended.
Definition: generic_onoff_client.h:76
generic_onoff_set_params_t
Mandatory parameters for the Generic OnOff Set message.
Definition: generic_onoff_common.h:74
generic_onoff_state_status_cb_t
void(* generic_onoff_state_status_cb_t)(const generic_onoff_client_t *p_self, const access_message_rx_meta_t *p_meta, const generic_onoff_status_params_t *p_in)
Callback type for OnOff state related transactions.
Definition: generic_onoff_client.h:67
model_transition_t
Generic Transition parameters for the model messages.
Definition: model_common.h:107