nRF5 SDK for Mesh v5.0.0
generic_dtt_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_DTT_SERVER_H__
39 #define GENERIC_DTT_SERVER_H__
40 
41 #include <stdint.h>
42 #include "access.h"
43 #include "generic_dtt_common.h"
44 #include "model_common.h"
45 
53 #define GENERIC_DTT_SERVER_MODEL_ID 0x1004
54 
55 /* Forward declaration */
56 typedef struct __generic_dtt_server_t generic_dtt_server_t;
57 
68 typedef void (*generic_dtt_state_set_cb_t)(const generic_dtt_server_t * p_self,
69  const access_message_rx_meta_t * p_meta,
70  const generic_dtt_set_params_t * p_in,
72 
80 typedef void (*generic_dtt_state_get_cb_t)(const generic_dtt_server_t * p_self,
81  const access_message_rx_meta_t * p_meta,
86 typedef struct
87 {
91 
95 typedef struct
96 {
100 
104 typedef struct
105 {
112 
116 
119 {
122 
125 
127  uint8_t state_handle;
128 };
129 
148 uint32_t generic_dtt_server_init(generic_dtt_server_t * p_server, uint8_t element_index);
149 
170 uint32_t generic_dtt_server_status_publish(generic_dtt_server_t * p_server, const generic_dtt_status_params_t * p_params);
171 
173 #endif /* GENERIC_DTT_SERVER_H__ */
uint16_t access_model_handle_t
Access layer handle type.
Definition: access.h:162
Unpacked message structure typedefs are used for API interfaces and for implementing model code...
generic_dtt_server_state_cbs_t dtt_cbs
Callbacks for the Default Transition Time state.
void(* generic_dtt_state_get_cb_t)(const generic_dtt_server_t *p_self, const access_message_rx_meta_t *p_meta, generic_dtt_status_params_t *p_out)
Callback type for Generic Default Transition Time Get message.
Parameters for the Default Transition Time Status message.
void(* generic_dtt_state_set_cb_t)(const generic_dtt_server_t *p_self, const access_message_rx_meta_t *p_meta, const generic_dtt_set_params_t *p_in, generic_dtt_status_params_t *p_out)
Callback type for Generic Default Transition Time Set/Set Unacknowledged message. ...
Default Transition Time server callback list.
const generic_dtt_server_callbacks_t * p_callbacks
Callback list.
bool force_segmented
If server should force outgoing messages as segmented messages.
Metadata for received messages.
Definition: access.h:196
nrf_mesh_transmic_size_t transmic_size
TransMIC size used by the outgoing server messages.
access_model_handle_t model_handle
Model handle assigned to this instance.
Transaction callbacks for the Default Transition Time state.
uint32_t generic_dtt_server_init(generic_dtt_server_t *p_server, uint8_t element_index)
Initializes Generic Default Transition Time server.
nrf_mesh_transmic_size_t
Message MIC size selection.
Definition: nrf_mesh.h:385
uint8_t state_handle
State handle for this instance.
generic_dtt_server_settings_t settings
Model settings and callbacks for this instance.
User provided settings and callbacks for the model instance.
uint32_t generic_dtt_server_status_publish(generic_dtt_server_t *p_server, const generic_dtt_status_params_t *p_params)
Publishes unsolicited Status message.

Documentation feedback | Developer Zone | Subscribe | Updated