nRF5 SDK for Mesh v5.0.0
generic_ponoff_setup_server.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_SETUP_SERVER_H__
39 #define GENERIC_PONOFF_SETUP_SERVER_H__
40 
41 #include <stdint.h>
42 #include "access.h"
43 #include "generic_ponoff_common.h"
44 #include "model_common.h"
45 
46 #include "generic_onoff_server.h"
47 #include "generic_dtt_server.h"
48 
61 #define GENERIC_PONOFF_SERVER_MODEL_ID 0x1006
62 
64 #define GENERIC_PONOFF_SETUP_SERVER_MODEL_ID 0x1007
65 
66 /* Forward declaration */
67 typedef struct __generic_ponoff_server_t generic_ponoff_server_t;
68 
69 /* Forward declaration */
70 typedef struct __generic_ponoff_setup_server_t generic_ponoff_setup_server_t;
71 
82 typedef void (*generic_ponoff_state_set_cb_t)(const generic_ponoff_setup_server_t * p_self,
83  const access_message_rx_meta_t * p_meta,
84  const generic_ponoff_set_params_t * p_in,
86 
94 typedef void (*generic_ponoff_state_get_cb_t)(const generic_ponoff_setup_server_t * p_self,
95  const access_message_rx_meta_t * p_meta,
97 
101 typedef struct
102 {
106 
110 typedef struct
111 {
118 
119  /* There are no callbacks for the state for this model, these callbacks are defined for the setup server. */
121 
124 {
127 
129  generic_onoff_server_t generic_onoff_srv;
130 
133 };
134 
155 uint32_t generic_ponoff_server_status_publish(generic_ponoff_server_t * p_server, const generic_ponoff_status_params_t * p_params);
156 
157 
161 typedef struct
162 {
166 
170 typedef struct
171 {
173  uint8_t element_index;
180 
184 
187 {
190 
192  generic_ponoff_server_t generic_ponoff_srv;
194  generic_dtt_server_t generic_dtt_srv;
195 
198 };
199 
218 uint32_t generic_ponoff_setup_server_init(generic_ponoff_setup_server_t * p_server, uint8_t element_index);
219 
221 #endif /* GENERIC_PONOFF_SETUP_SERVER_H__ */
uint16_t access_model_handle_t
Access layer handle type.
Definition: access.h:162
User provided settings and callbacks for the model instance.
uint32_t generic_ponoff_setup_server_init(generic_ponoff_setup_server_t *p_server, uint8_t element_index)
Initializes Generic Power OnOff Setup server.
Parameters for the Power OnOff Status message.
generic_dtt_server_t generic_dtt_srv
Parent model context for - Generic Default Transition Time server.
nrf_mesh_transmic_size_t transmic_size
TransMIC size used by the outgoing server messages.
Unpacked message structure typedefs are used for API interfaces and for implementing model code...
generic_ponoff_setup_server_state_cbs_t ponoff_cbs
Callback for transactions related to Power OnOff states.
Default Transition Time server callback list.
access_model_handle_t model_handle
Model handle assigned to this instance.
generic_ponoff_server_t generic_ponoff_srv
Parent model context for - Generic Power OnOff server.
generic_ponoff_server_settings_t settings
Model settings and callbacks for this instance.
const generic_ponoff_setup_server_callbacks_t * p_callbacks
Callback list.
void(* generic_ponoff_state_get_cb_t)(const generic_ponoff_setup_server_t *p_self, const access_message_rx_meta_t *p_meta, generic_ponoff_status_params_t *p_out)
Callback type for Generic Power OnOff Get message.
Metadata for received messages.
Definition: access.h:196
bool force_segmented
If server should force outgoing messages as segmented messages.
access_model_handle_t model_handle
Model handle assigned to this instance.
User provided settings and callbacks for the model instance.
uint32_t generic_ponoff_server_status_publish(generic_ponoff_server_t *p_server, const generic_ponoff_status_params_t *p_params)
Publishes unsolicited Status message.
Transaction callbacks for the Power OnOff state.
bool force_segmented
If server should force outgoing messages as segmented messages.
generic_onoff_server_t generic_onoff_srv
Parent model context - Generic OnOff server, user must provide a state callback.
nrf_mesh_transmic_size_t
Message MIC size selection.
Definition: nrf_mesh.h:385
void(* generic_ponoff_state_set_cb_t)(const generic_ponoff_setup_server_t *p_self, const access_message_rx_meta_t *p_meta, const generic_ponoff_set_params_t *p_in, generic_ponoff_status_params_t *p_out)
Callback type for Generic Power OnOff Set/Set Unacknowledged message.
nrf_mesh_transmic_size_t transmic_size
TransMIC size used by the outgoing server messages.
generic_ponoff_setup_server_settings_t settings
Model settings and callbacks for this instance.

Documentation feedback | Developer Zone | Subscribe | Updated