nRF5 SDK for Mesh v3.2.0  08c60f6
generic_onoff_server.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_SERVER_H__
39 #define GENERIC_ONOFF_SERVER_H__
40 
41 #include <stdint.h>
42 #include "access.h"
43 #include "generic_onoff_common.h"
44 #include "model_common.h"
45 
53 #define GENERIC_ONOFF_SERVER_MODEL_ID 0x1000
54 
55 /* Forward declaration */
56 typedef struct __generic_onoff_server_t generic_onoff_server_t;
57 
70 typedef void (*generic_onoff_state_set_cb_t)(const generic_onoff_server_t * p_self,
71  const access_message_rx_meta_t * p_meta,
72  const generic_onoff_set_params_t * p_in,
73  const model_transition_t * p_in_transition,
75 
83 typedef void (*generic_onoff_state_get_cb_t)(const generic_onoff_server_t * p_self,
84  const access_message_rx_meta_t * p_meta,
86 
90 typedef struct
91 {
95 
99 typedef struct
100 {
104 
108 typedef struct
109 {
114 
118 
121 {
126 
129 };
130 
142 uint32_t generic_onoff_server_init(generic_onoff_server_t * p_server, uint8_t element_index);
143 
155 uint32_t generic_onoff_server_status_publish(generic_onoff_server_t * p_server, const generic_onoff_status_params_t * p_params);
156 
158 #endif /* GENERIC_ONOFF_SERVER_H__ */
access_message_rx_meta_t
Metadata for received messages.
Definition: access.h:196
generic_onoff_server_callbacks_t
OnOff server callback list.
Definition: generic_onoff_server.h:99
generic_onoff_server_settings_t::transmic_size
nrf_mesh_transmic_size_t transmic_size
TransMIC size used by the outgoing server messages.
Definition: generic_onoff_server.h:113
generic_onoff_server_settings_t::p_callbacks
const generic_onoff_server_callbacks_t * p_callbacks
Callback list.
Definition: generic_onoff_server.h:116
generic_onoff_status_params_t
Parameters for the Generic OnOff Status message.
Definition: generic_onoff_common.h:81
tid_tracker_t
Structure for tracking TID expiry for the models.
Definition: model_common.h:114
__generic_onoff_server_t
Definition: generic_onoff_server.h:120
__generic_onoff_server_t::model_handle
access_model_handle_t model_handle
Model handle assigned to this instance.
Definition: generic_onoff_server.h:123
generic_onoff_state_get_cb_t
void(* generic_onoff_state_get_cb_t)(const generic_onoff_server_t *p_self, const access_message_rx_meta_t *p_meta, generic_onoff_status_params_t *p_out)
Callback type for Generic OnOff Get message.
Definition: generic_onoff_server.h:83
generic_onoff_server_status_publish
uint32_t generic_onoff_server_status_publish(generic_onoff_server_t *p_server, const generic_onoff_status_params_t *p_params)
Publishes unsolicited Status message.
generic_onoff_server_state_cbs_t
Transaction callbacks for the OnOff state.
Definition: generic_onoff_server.h:90
generic_onoff_server_settings_t
User provided settings and callbacks for the model instance.
Definition: generic_onoff_server.h:108
generic_onoff_server_init
uint32_t generic_onoff_server_init(generic_onoff_server_t *p_server, uint8_t element_index)
Initializes Generic OnOff server.
access_model_handle_t
uint16_t access_model_handle_t
Access layer handle type.
Definition: access.h:162
__generic_onoff_server_t::settings
generic_onoff_server_settings_t settings
Model settings and callbacks for this instance.
Definition: generic_onoff_server.h:128
nrf_mesh_transmic_size_t
nrf_mesh_transmic_size_t
Message MIC size selection.
Definition: nrf_mesh.h:385
__generic_onoff_server_t::tid_tracker
tid_tracker_t tid_tracker
Tid tracker structure.
Definition: generic_onoff_server.h:125
generic_onoff_state_set_cb_t
void(* generic_onoff_state_set_cb_t)(const generic_onoff_server_t *p_self, const access_message_rx_meta_t *p_meta, const generic_onoff_set_params_t *p_in, const model_transition_t *p_in_transition, generic_onoff_status_params_t *p_out)
Callback type for Generic OnOff Set/Set Unacknowledged message.
Definition: generic_onoff_server.h:70
generic_onoff_server_settings_t::force_segmented
bool force_segmented
If server should force outgoing messages as segmented messages.
Definition: generic_onoff_server.h:111
generic_onoff_set_params_t
Mandatory parameters for the Generic OnOff Set message.
Definition: generic_onoff_common.h:74
generic_onoff_server_callbacks_t::onoff_cbs
generic_onoff_server_state_cbs_t onoff_cbs
Callbacks for the OnOff state.
Definition: generic_onoff_server.h:102
model_transition_t
Generic Transition parameters for the model messages.
Definition: model_common.h:107