nRF5 SDK for Mesh v4.1.0
generic_ponoff_client.h
1 /* Copyright (c) 2010 - 2020, 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_PONOFF_CLIENT_H__
39 #define GENERIC_PONOFF_CLIENT_H__
40 
41 
42 
43 #include <stdint.h>
44 #include "access.h"
45 #include "access_reliable.h"
46 #include "generic_ponoff_common.h"
47 #include "generic_ponoff_messages.h"
48 
49 
57 #define GENERIC_PONOFF_CLIENT_MODEL_ID 0x1008
58 
59 /* Forward declaration */
60 typedef struct __generic_ponoff_client_t generic_ponoff_client_t;
61 
69 typedef void (*generic_ponoff_state_status_cb_t)(const generic_ponoff_client_t * p_self,
70  const access_message_rx_meta_t * p_meta,
71  const generic_ponoff_status_params_t * p_in);
72 
73 typedef struct
74 {
77 
83 
87 typedef struct
88 {
92  uint32_t timeout;
99 
103 
105 typedef union
106 {
109 
112 {
117  /* Acknowledged message context variable */
118  access_reliable_t access_message;
121 };
122 
142 uint32_t generic_ponoff_client_init(generic_ponoff_client_t * p_client, uint8_t element_index);
143 
162 uint32_t generic_ponoff_client_set(generic_ponoff_client_t * p_client, const generic_ponoff_set_params_t * p_params);
163 
186 uint32_t generic_ponoff_client_set_unack(generic_ponoff_client_t * p_client, const generic_ponoff_set_params_t * p_params,
187  uint8_t repeats);
188 
189 
206 uint32_t generic_ponoff_client_get(generic_ponoff_client_t * p_client);
207 
208 
210 #endif /* GENERIC_PONOFF_CLIENT_H__ */
generic_ponoff_client_msg_data_t
Union for holding current message packet.
Definition: generic_ponoff_client.h:105
__generic_ponoff_client_t::settings
generic_ponoff_client_settings_t settings
Model settings and callbacks for this instance.
Definition: generic_ponoff_client.h:120
access_message_rx_meta_t
Metadata for received messages.
Definition: access.h:196
generic_ponoff_status_params_t
Parameters for the Power OnOff Status message.
Definition: generic_ponoff_common.h:82
generic_ponoff_client_callbacks_t
Definition: generic_ponoff_client.h:73
generic_ponoff_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_ponoff_client.h:79
generic_ponoff_state_status_cb_t
void(* generic_ponoff_state_status_cb_t)(const generic_ponoff_client_t *p_self, const access_message_rx_meta_t *p_meta, const generic_ponoff_status_params_t *p_in)
Callback type for Power OnOff state related transactions.
Definition: generic_ponoff_client.h:69
generic_ponoff_client_settings_t::force_segmented
bool force_segmented
If server should force outgoing messages as segmented messages.
Definition: generic_ponoff_client.h:95
generic_ponoff_client_settings_t::timeout
uint32_t timeout
Reliable message timeout in microseconds.
Definition: generic_ponoff_client.h:92
__generic_ponoff_client_t::msg_pkt
generic_ponoff_client_msg_data_t msg_pkt
Holds the raw message packet data for transactions.
Definition: generic_ponoff_client.h:116
generic_ponoff_client_settings_t::p_callbacks
const generic_ponoff_client_callbacks_t * p_callbacks
Callback list.
Definition: generic_ponoff_client.h:101
generic_ponoff_client_settings_t
User provided settings and callbacks for the model instance.
Definition: generic_ponoff_client.h:87
__generic_ponoff_client_t
Definition: generic_ponoff_client.h:111
access_reliable_t
Access layer acknowledged publish parameter structure.
Definition: access_reliable.h:134
generic_ponoff_set_params_t
Unpacked message structure typedefs are used for API interfaces and for implementing model code.
Definition: generic_ponoff_common.h:76
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 acknowledged 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_ponoff_client_init
uint32_t generic_ponoff_client_init(generic_ponoff_client_t *p_client, uint8_t element_index)
Initializes Generic Power OnOff client.
generic_ponoff_client_callbacks_t::ponoff_status_cb
generic_ponoff_state_status_cb_t ponoff_status_cb
Client model response message callback.
Definition: generic_ponoff_client.h:76
generic_ponoff_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_ponoff_client.h:81
generic_ponoff_client_set_unack
uint32_t generic_ponoff_client_set_unack(generic_ponoff_client_t *p_client, const generic_ponoff_set_params_t *p_params, uint8_t repeats)
Sends a Set Unacknowledged message to the server.
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_ponoff_client_settings_t::transmic_size
nrf_mesh_transmic_size_t transmic_size
TransMIC size used by the outgoing server messages.
Definition: generic_ponoff_client.h:98
generic_ponoff_client_get
uint32_t generic_ponoff_client_get(generic_ponoff_client_t *p_client)
Sends a Get message to the server.
generic_ponoff_client_set
uint32_t generic_ponoff_client_set(generic_ponoff_client_t *p_client, const generic_ponoff_set_params_t *p_params)
Sends a Set message to the server.
generic_ponoff_set_msg_pkt_t
Packed message structure typedefs are used for packing and unpacking byte stream.
Definition: generic_ponoff_messages.h:63
__generic_ponoff_client_t::model_handle
access_model_handle_t model_handle
Model handle assigned to this instance.
Definition: generic_ponoff_client.h:114