xref: /btstack/src/mesh/mesh_generic_model.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
1 /*
2  * Copyright (C) 2019 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_GENERIC_MODEL_H
39 #define __MESH_GENERIC_MODEL_H
40 
41 #include "mesh/mesh_access.h"
42 
43 #ifdef __cplusplus
44 extern "C"
45 {
46 #endif
47 
48 
49 #define MESH_GENERIC_ON_OFF_GET                                     0x8201u
50 #define MESH_GENERIC_ON_OFF_SET                                     0x8202u
51 #define MESH_GENERIC_ON_OFF_SET_UNACKNOWLEDGED                      0x8203u
52 #define MESH_GENERIC_ON_OFF_STATUS                                  0x8204u
53 
54 #define MESH_GENERIC_DEFAULT_TRANSITION_TIME_GET                    0x820Du
55 #define MESH_GENERIC_DEFAULT_TRANSITION_TIME_SET                    0x820Eu
56 #define MESH_GENERIC_DEFAULT_TRANSITION_TIME_SET_UNACKNOWLEDGED     0x820Fu
57 #define MESH_GENERIC_DEFAULT_TRANSITION_TIME_STATUS                 0x8210u
58 
59 #define MESH_GENERIC_LEVEL_GET                                      0x8205u
60 #define MESH_GENERIC_LEVEL_SET                                      0x8206u
61 #define MESH_GENERIC_LEVEL_SET_UNACKNOWLEDGED                       0x8207u
62 #define MESH_GENERIC_LEVEL_STATUS                                   0x8208u
63 #define MESH_GENERIC_DELTA_SET                                      0x8209u
64 #define MESH_GENERIC_DELTA_SET_UNACKNOWLEDGED                       0x820Au
65 #define MESH_GENERIC_MOVE_SET                                       0x820Bu
66 #define MESH_GENERIC_MOVE_SET_UNACKNOWLEDGED                        0x820Cu
67 
68 typedef struct {
69     mesh_transition_t base_transition;
70 
71     uint8_t  current_value;
72     uint8_t  target_value;
73 } mesh_transition_bool_t;
74 
75 typedef struct {
76     mesh_transition_t base_transition;
77 
78     int16_t current_value;
79     int16_t initial_value;
80     int16_t target_value;
81     int16_t stepwise_value_increment;
82 } mesh_transition_int16_t;
83 
84 typedef struct {
85     mesh_transition_bool_t transition_data;
86 } mesh_generic_on_off_state_t;
87 
88 typedef struct {
89     uint8_t  value;
90 } mesh_generic_default_transition_time_state_t;
91 
92 typedef struct {
93     mesh_transition_int16_t transition_data;
94 } mesh_generic_level_state_t;
95 
96 #ifdef __cplusplus
97 } /* end of extern "C" */
98 #endif
99 
100 #endif
101