xref: /btstack/src/mesh/mesh_configuration_server.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
1 /*
2  * Copyright (C) 2018 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  * 4. Any redistribution, use, or modification is done solely for
17  *    personal benefit and not for any commercial purpose or for
18  *    monetary gain.
19  *
20  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
24  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Please inquire about commercial licensing options at
34  * [email protected]
35  *
36  */
37 
38 #ifndef __MESH_CONFIGURATION_SERVER_H
39 #define __MESH_CONFIGURATION_SERVER_H
40 
41 #include <stdint.h>
42 
43 #include "mesh/mesh_access.h"
44 
45 #ifdef __cplusplus
46 extern "C"
47 {
48 #endif
49 
50 // typedefs
51 
52 typedef struct  {
53     btstack_timer_source_t timer;
54     uint8_t timer_active;
55     uint16_t active_features;
56     uint32_t period_ms;
57     uint16_t count;
58     //
59     uint16_t destination;
60     // uint16_t count_log;
61     uint8_t  period_log;
62     uint8_t  ttl;
63     uint16_t features;
64     uint16_t netkey_index;
65 } mesh_heartbeat_publication_t;
66 
67 typedef struct  {
68     // config
69     uint16_t source;
70     uint16_t destination;
71     uint8_t  period_log;
72     // data
73     uint32_t period_start_ms;
74     uint8_t  min_hops;
75     uint8_t  max_hops;
76     uint16_t count;
77 } mesh_heartbeat_subscription_t;
78 
79 typedef struct {
80     mesh_heartbeat_publication_t   heartbeat_publication;
81     mesh_heartbeat_subscription_t  heartbeat_subscription;
82 
83 } mesh_configuration_server_model_context_t;
84 
85 // API
86 
87 const mesh_operation_t * mesh_configuration_server_get_operations(void);
88 
89 void mesh_configuration_server_feature_changed(void);
90 
91 void mesh_configuration_server_process_heartbeat(mesh_model_t * configuration_server_model, uint16_t src, uint16_t dest, uint8_t hops, uint16_t features);
92 
93 // PTS Testing
94 void config_nekey_list_set_max(uint16_t max);
95 
96 #ifdef __cplusplus
97 } /* end of extern "C" */
98 #endif
99 
100 #endif
101