xref: /btstack/src/mesh/mesh_generic_default_transition_time_client.h (revision f13fc290073baa163f06f3cc4c97b90a73935e8a)
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 MATTHIAS
24  * RINGWALD 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_DEFAULT_TRANSITION_TIME_CLIENT_H
39 #define __MESH_GENERIC_DEFAULT_TRANSITION_TIME_CLIENT_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 const mesh_operation_t * mesh_generic_default_transition_time_client_get_operations(void);
51 
52 /**
53  * @brief Set Default Transition Time value acknowledged
54  * @param mesh_model
55  * @param dest
56  * @param netkey_index
57  * @param appkey_index
58  * @param transition_time_gdtt
59  * @return status    0 if successful
60  */
61  uint8_t mesh_generic_default_transition_time_client_set(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index,
62     uint8_t transition_time_gdtt);
63 
64 /**
65  * @brief Set Default Transition Time value unacknowledged
66  * @param mesh_model
67  * @param dest
68  * @param netkey_index
69  * @param appkey_index
70  * @param on_off_value
71  * @param transition_time_gdtt
72  * @param delay_time_gdtt
73  * @return status    0 if successful
74  */
75 uint8_t mesh_generic_default_transition_time_client_set_unacknowledged(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index,
76     uint8_t transition_time_gdtt);
77 
78 /**
79  * @brief  Get present Default Transition Time value
80  * @param mesh_model
81  * @param dest
82  * @param netkey_index
83  * @param appkey_index
84  * @return status    0 if successful
85  */
86 uint8_t mesh_generic_default_transition_time_client_get(mesh_model_t *mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index);
87 
88 
89 #ifdef __cplusplus
90 } /* end of extern "C" */
91 #endif
92 
93 #endif
94