nRF5 SDK for Mesh v5.0.0
simple_on_off_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 SIMPLE_ON_OFF_CLIENT_H__
39 #define SIMPLE_ON_OFF_CLIENT_H__
40 
41 #include <stdint.h>
42 #include "access.h"
43 #include "simple_on_off_common.h"
44 
54 #ifndef SIMPLE_ON_OFF_CLIENT_ACKED_TRANSACTION_TIMEOUT
55 #define SIMPLE_ON_OFF_CLIENT_ACKED_TRANSACTION_TIMEOUT (SEC_TO_US(60))
56 #endif
57 
59 #define SIMPLE_ON_OFF_CLIENT_MODEL_ID (0x0001)
60 
62 typedef enum
63 {
73 
75 typedef struct __simple_on_off_client simple_on_off_client_t;
76 
84 typedef void (*simple_on_off_status_cb_t)(const simple_on_off_client_t * p_self, simple_on_off_status_t status, uint16_t src);
85 
92 typedef void (*simple_on_off_timeout_cb_t)(access_model_handle_t handle, void * p_self);
93 
96 {
104  struct
105  {
108  } state;
109 };
110 
126 uint32_t simple_on_off_client_init(simple_on_off_client_t * p_client, uint16_t element_index);
127 
144 uint32_t simple_on_off_client_set(simple_on_off_client_t * p_client, bool on_off);
145 
163 uint32_t simple_on_off_client_set_unreliable(simple_on_off_client_t * p_client, bool on_off, uint8_t repeats);
164 
182 uint32_t simple_on_off_client_get(simple_on_off_client_t * p_client);
183 
189 void simple_on_off_client_pending_msg_cancel(simple_on_off_client_t * p_client);
190 
191 
192 
195 #endif /* SIMPLE_ON_OFF_CLIENT_H__ */
simple_on_off_status_cb_t status_cb
Status callback called after status received from server.
uint16_t access_model_handle_t
Access layer handle type.
Definition: access.h:162
Simple OnOff Client state structure.
Message format for the Simple OnOff Set message.
uint32_t simple_on_off_client_set_unreliable(simple_on_off_client_t *p_client, bool on_off, uint8_t repeats)
Sets the state of the Simple OnOff Server unreliably (without acknowledgment).
void simple_on_off_client_pending_msg_cancel(simple_on_off_client_t *p_client)
Cancel any ongoing reliable message transfer.
The server did not reply to a Simple OnOff Set/Get.
uint32_t simple_on_off_client_init(simple_on_off_client_t *p_client, uint16_t element_index)
Initializes the Simple OnOff client.
void(* simple_on_off_timeout_cb_t)(access_model_handle_t handle, void *p_self)
Simple OnOff timeout callback type.
Received status ON from the server.
simple_on_off_msg_set_t data
Variable reflecting the data stored in the server.
bool reliable_transfer_active
Variable used to determine if a transfer is currently active.
Simple OnOff Set/Get was cancelled.
uint32_t simple_on_off_client_get(simple_on_off_client_t *p_client)
Gets the state of the Simple OnOff server.
simple_on_off_timeout_cb_t timeout_cb
Periodic timer timeout callback used for periodic publication.
void(* simple_on_off_status_cb_t)(const simple_on_off_client_t *p_self, simple_on_off_status_t status, uint16_t src)
Simple OnOff status callback type.
struct __simple_on_off_client::@25 state
Internal client state.
Received status OFF from the server.
uint32_t simple_on_off_client_set(simple_on_off_client_t *p_client, bool on_off)
Sets the state of the Simple OnOff server.
simple_on_off_status_t
Simple OnOff status codes.
access_model_handle_t model_handle
Model handle assigned to the client.

Documentation feedback | Developer Zone | Subscribe | Updated