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_LEVEL_CLIENT_H 39 #define __MESH_GENERIC_LEVEL_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_level_client_get_operations(void); 51 /** 52 * @brief Register packet handler 53 * @param generic_level_client_model 54 * @param events_packet_handler 55 */ 56 void mesh_generic_level_client_register_packet_handler(mesh_model_t *mesh_model, btstack_packet_handler_t events_packet_handler); 57 58 /** 59 * @brief Set Level value 60 * @param mesh_model 61 * @param dest 62 * @param netkey_index 63 * @param appkey_index 64 * @param level_value 65 * @param transition_time_gdtt 66 * @param delay_time_gdtt 67 * @param transaction_id 68 * @return status 0 if successful 69 */ 70 uint8_t mesh_generic_level_client_level_set(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, 71 int16_t level_value, uint8_t transition_time_gdtt, uint8_t delay_time_gdtt, uint8_t transaction_id); 72 73 /** 74 * @brief Get present Level value 75 * @param mesh_model 76 * @param dest 77 * @param netkey_index 78 * @param appkey_index 79 * @param level_value 80 * @param transition_time_gdtt 81 * @param delay_time_gdtt 82 * @param transaction_id 83 * @return transaction_id if transaction_id == 0, it is invalid 84 */ 85 uint8_t mesh_generic_level_client_level_set_unacknowledged(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, 86 int16_t level_value, uint8_t transition_time_gdtt, uint8_t delay_time_gdtt, uint8_t transaction_id); 87 88 /** 89 * @brief Get present Level value 90 * @param mesh_model 91 * @param dest 92 * @param netkey_index 93 * @param appkey_index 94 * @return status 0 if successful 95 */ 96 uint8_t mesh_generic_level_client_level_get(mesh_model_t *mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index); 97 98 /** 99 * @brief Publish level value by sending an unacknowledged set message to the publish destination 100 * @param mesh_model 101 * @param level_value 102 * @param transaction_id 103 * @return status 0 if successful 104 */ 105 uint8_t mesh_generic_level_client_publish_level(mesh_model_t * mesh_model, int16_t level_value, uint8_t transaction_id); 106 107 /** 108 * @brief Set Level value 109 * @param mesh_model 110 * @param dest 111 * @param netkey_index 112 * @param appkey_index 113 * @param delta_value 114 * @param transition_time_gdtt 115 * @param delay_time_gdtt 116 * @param transaction_id 117 * @return status 0 if successful 118 */ 119 uint8_t mesh_generic_level_client_delta_set(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, 120 int16_t delta_value, uint8_t transition_time_gdtt, uint8_t delay_time_gdtt, uint8_t transaction_id); 121 122 /** 123 * @brief Get present Level value 124 * @param mesh_model 125 * @param dest 126 * @param netkey_index 127 * @param appkey_index 128 * @param delta_value 129 * @param transition_time_gdtt 130 * @param delay_time_gdtt 131 * @param transaction_id 132 * @return transaction_id if transaction_id == 0, it is invalid 133 */ 134 uint8_t mesh_generic_level_client_delta_set_unacknowledged(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, 135 int16_t delta_value, uint8_t transition_time_gdtt, uint8_t delay_time_gdtt, uint8_t transaction_id); 136 137 /** 138 * @brief Set Level value 139 * @param mesh_model 140 * @param dest 141 * @param netkey_index 142 * @param appkey_index 143 * @param delta_value used to calculate the speed of the transition of the Generic Level state 144 * @param transition_time_gdtt 145 * @param delay_time_gdtt 146 * @param transaction_id 147 * @return status 0 if successful 148 */ 149 uint8_t mesh_generic_level_client_move_set(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, 150 int16_t delta_value, uint8_t transition_time_gdtt, uint8_t delay_time_gdtt, uint8_t transaction_id); 151 152 /** 153 * @brief Get present Level value 154 * @param mesh_model 155 * @param dest 156 * @param netkey_index 157 * @param appkey_index 158 * @param delta_value used to calculate the speed of the transition of the Generic Level state 159 * @param transition_time_gdtt 160 * @param delay_time_gdtt 161 * @param transaction_id 162 * @return transaction_id if transaction_id == 0, it is invalid 163 */ 164 uint8_t mesh_generic_level_client_move_set_unacknowledged(mesh_model_t * mesh_model, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, 165 int16_t delta_value, uint8_t transition_time_gdtt, uint8_t delay_time_gdtt, uint8_t transaction_id); 166 167 #ifdef __cplusplus 168 } /* end of extern "C" */ 169 #endif 170 171 #endif 172