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 #define BTSTACK_FILE__ "mesh_generic_level_server.c" 39 40 #include <string.h> 41 #include <stdio.h> 42 43 #include "mesh/mesh_generic_level_server.h" 44 45 #include "bluetooth_company_id.h" 46 #include "btstack_debug.h" 47 #include "btstack_memory.h" 48 #include "btstack_util.h" 49 50 #include "mesh/mesh_access.h" 51 #include "mesh/mesh_foundation.h" 52 #include "mesh/mesh_generic_model.h" 53 #include "mesh/mesh_keys.h" 54 #include "mesh/mesh_network.h" 55 #include "mesh/mesh_upper_transport.h" 56 57 58 static void generic_server_send_message(uint16_t src, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, mesh_pdu_t *pdu){ 59 uint8_t ttl = mesh_foundation_default_ttl_get(); 60 mesh_upper_transport_setup_access_pdu_header(pdu, netkey_index, appkey_index, ttl, src, dest, 0); 61 mesh_access_send_unacknowledged_pdu(pdu); 62 } 63 64 // Transition 65 static int16_t add_and_clip_int16(int16_t current_value, int16_t increment){ 66 int32_t value = current_value + increment; 67 if (value < -32768){ 68 value = -32768; 69 } else if (value > 32767){ 70 value = 32767; 71 } 72 return (int16_t) value; 73 } 74 75 static mesh_transition_t * generic_level_server_get_base_transition(mesh_model_t * mesh_model) { 76 mesh_generic_level_state_t * generic_level_server_state = (mesh_generic_level_state_t *)mesh_model->model_data; 77 return &generic_level_server_state->transition_data.base_transition; 78 } 79 80 static void mesh_server_transition_state_update_stepwise_value(mesh_transition_int16_t * transition){ 81 mesh_model_t * generic_level_server_model = transition->base_transition.mesh_model; 82 83 if (transition->stepwise_value_increment){ 84 transition->current_value = add_and_clip_int16(transition->current_value, transition->stepwise_value_increment); 85 } else if (transition->delta_from_initial_value){ 86 transition->current_value = add_and_clip_int16(transition->initial_value, transition->delta_from_initial_value); 87 } 88 // emit event 89 mesh_access_emit_state_update_int16(generic_level_server_model->model_packet_handler, 90 mesh_access_get_element_index(generic_level_server_model), 91 generic_level_server_model->model_identifier, 92 MODEL_STATE_ID_GENERIC_LEVEL, 93 MODEL_STATE_UPDATE_REASON_TRANSITION_END, 94 transition->current_value); 95 } 96 97 static void mesh_server_transition_state_update(mesh_transition_int16_t * transition, uint32_t current_timestamp_ms){ 98 if (transition->base_transition.remaining_delay_time_ms != 0){ 99 transition->base_transition.state = MESH_TRANSITION_STATE_DELAYED; 100 transition->base_transition.remaining_delay_time_ms = 0; 101 transition->base_transition.phase_start_ms = current_timestamp_ms; 102 return; 103 } 104 105 mesh_model_t * generic_level_server_model = transition->base_transition.mesh_model; 106 107 if (transition->base_transition.remaining_transition_time_ms != 0){ 108 transition->base_transition.state = MESH_TRANSITION_STATE_ACTIVE; 109 transition->base_transition.phase_start_ms = current_timestamp_ms; 110 return; 111 } 112 113 transition->current_value = transition->target_value; 114 transition->base_transition.remaining_transition_time_ms = 0; 115 116 // emit event 117 mesh_access_emit_state_update_int16(generic_level_server_model->model_packet_handler, 118 mesh_access_get_element_index(generic_level_server_model), 119 generic_level_server_model->model_identifier, 120 MODEL_STATE_ID_GENERIC_LEVEL, 121 MODEL_STATE_UPDATE_REASON_TRANSITION_END, 122 transition->current_value); 123 124 // done, stop transition 125 mesh_access_transitions_remove((mesh_transition_t *)transition); 126 } 127 128 static void mesh_server_transition_step(mesh_transition_t * base_transition, transition_event_t event, uint32_t current_timestamp){ 129 uint32_t time_step_ms; 130 131 mesh_transition_int16_t * transition = (mesh_transition_int16_t*) base_transition; 132 133 switch (transition->base_transition.state){ 134 case MESH_TRANSITION_STATE_IDLE: 135 if (event != TRANSITION_START) break; 136 mesh_server_transition_state_update(transition, current_timestamp); 137 break; 138 case MESH_TRANSITION_STATE_DELAYED: 139 if (event != TRANSITION_UPDATE) break; 140 time_step_ms = current_timestamp - transition->base_transition.phase_start_ms; 141 if (transition->base_transition.remaining_delay_time_ms >= time_step_ms){ 142 transition->base_transition.remaining_delay_time_ms -= time_step_ms; 143 transition->base_transition.phase_start_ms = current_timestamp; 144 } else { 145 transition->base_transition.remaining_delay_time_ms = 0; 146 mesh_server_transition_state_update(transition, current_timestamp); 147 } 148 break; 149 case MESH_TRANSITION_STATE_ACTIVE: 150 if (event != TRANSITION_UPDATE) break; 151 time_step_ms = current_timestamp - transition->base_transition.phase_start_ms; 152 if (transition->base_transition.remaining_transition_time_ms >= time_step_ms){ 153 transition->base_transition.remaining_transition_time_ms -= time_step_ms; 154 mesh_server_transition_state_update_stepwise_value(transition); 155 transition->base_transition.phase_start_ms = current_timestamp; 156 } else { 157 transition->base_transition.remaining_transition_time_ms = 0; 158 mesh_server_transition_state_update(transition, current_timestamp); 159 } 160 break; 161 default: 162 break; 163 } 164 } 165 166 167 static void mesh_server_transition_setup_transition_or_instantaneous_update_int16(mesh_model_t *mesh_model, uint8_t transition_time_gdtt, uint8_t delay_time_gdtt, model_state_update_reason_t reason){ 168 mesh_generic_level_state_t * generic_level_server_state = (mesh_generic_level_state_t *)mesh_model->model_data; 169 mesh_transition_t * transition = &generic_level_server_state->transition_data.base_transition; 170 171 if (transition_time_gdtt != 0 || delay_time_gdtt != 0) { 172 mesh_access_transitions_setup(transition, mesh_model, transition_time_gdtt, delay_time_gdtt, &mesh_server_transition_step); 173 mesh_access_transitions_add(transition); 174 } else { 175 // instantaneous update 176 generic_level_server_state->transition_data.current_value = generic_level_server_state->transition_data.target_value; 177 generic_level_server_state->transition_data.stepwise_value_increment = 0; 178 generic_level_server_state->transition_data.delta_from_initial_value = 0; 179 generic_level_server_state->transition_data.transition_speed = 0; 180 mesh_access_transitions_setup(transition, mesh_model, 0, 0, NULL); 181 182 mesh_access_emit_state_update_int16(mesh_model->model_packet_handler, 183 mesh_access_get_element_index(mesh_model), 184 mesh_model->model_identifier, 185 MODEL_STATE_ID_GENERIC_LEVEL, 186 reason, 187 generic_level_server_state->transition_data.current_value); 188 } 189 } 190 // Generic Level State 191 192 void mesh_generic_level_server_register_packet_handler(mesh_model_t *generic_level_server_model, btstack_packet_handler_t transition_events_packet_handler){ 193 btstack_assert(generic_level_server_model != NULL); 194 btstack_assert(transition_events_packet_handler != NULL); 195 generic_level_server_model->model_packet_handler = transition_events_packet_handler; 196 } 197 198 const mesh_access_message_t mesh_generic_level_status_transition = { 199 MESH_GENERIC_LEVEL_STATUS, "221" 200 }; 201 202 const mesh_access_message_t mesh_generic_level_status_instantaneous = { 203 MESH_GENERIC_LEVEL_STATUS, "2" 204 }; 205 206 static mesh_pdu_t * mesh_generic_level_status_message(mesh_model_t *generic_level_server_model){ 207 mesh_generic_level_state_t * state = (mesh_generic_level_state_t *) generic_level_server_model->model_data; 208 btstack_assert(state != NULL); 209 210 // setup message 211 mesh_transport_pdu_t * transport_pdu = NULL; 212 if (state->transition_data.base_transition.remaining_transition_time_ms != 0) { 213 transport_pdu = mesh_access_setup_segmented_message(&mesh_generic_level_status_transition, state->transition_data.current_value, 214 state->transition_data.target_value, state->transition_data.base_transition.remaining_transition_time_ms); 215 } else { 216 transport_pdu = mesh_access_setup_segmented_message(&mesh_generic_level_status_instantaneous, state->transition_data.current_value); 217 } 218 return (mesh_pdu_t *)transport_pdu; 219 } 220 221 static void generic_level_handle_set_target_level_message(mesh_model_t *mesh_model, mesh_pdu_t * pdu){ 222 mesh_generic_level_state_t * generic_level_server_state = (mesh_generic_level_state_t *)mesh_model->model_data; 223 btstack_assert(generic_level_server_state != NULL); 224 225 mesh_access_parser_state_t parser; 226 mesh_access_parser_init(&parser, (mesh_pdu_t*) pdu); 227 int16_t level_value = (int16_t)mesh_access_parser_get_u16(&parser); 228 // The TID field is a transaction identifier indicating whether the message is 229 // a new message or a retransmission of a previously sent message 230 uint8_t tid = mesh_access_parser_get_u8(&parser); 231 232 uint8_t transition_time_gdtt = 0; 233 uint8_t delay_time_gdtt = 0; 234 mesh_transition_t * base_transition = generic_level_server_get_base_transition(mesh_model); 235 236 switch (mesh_access_transitions_transaction_status(base_transition, tid, mesh_pdu_src(pdu), mesh_pdu_dst(pdu))){ 237 case MESH_TRANSACTION_STATUS_RETRANSMISSION: 238 // ignore 239 break; 240 default: 241 mesh_access_transitions_setup_transaction(base_transition, tid, mesh_pdu_src(pdu), mesh_pdu_dst(pdu)); 242 243 generic_level_server_state->transition_data.initial_value = generic_level_server_state->transition_data.current_value; 244 generic_level_server_state->transition_data.target_value = level_value; 245 generic_level_server_state->transition_data.stepwise_value_increment = 0; 246 generic_level_server_state->transition_data.delta_from_initial_value = 0; 247 248 if (mesh_access_parser_available(&parser) == 2){ 249 // Generic Default Transition Time format - num_steps (higher 6 bits), step_resolution (lower 2 bits) 250 transition_time_gdtt = mesh_access_parser_get_u8(&parser); 251 delay_time_gdtt = mesh_access_parser_get_u8(&parser); 252 int num_steps = mesh_access_transitions_num_steps_from_gdtt(transition_time_gdtt); 253 if (num_steps > 0){ 254 // TODO: remove division 255 generic_level_server_state->transition_data.stepwise_value_increment = (level_value - generic_level_server_state->transition_data.current_value)/num_steps; 256 } 257 } 258 mesh_server_transition_setup_transition_or_instantaneous_update_int16(mesh_model, transition_time_gdtt, delay_time_gdtt, MODEL_STATE_UPDATE_REASON_SET); 259 mesh_access_state_changed(mesh_model); 260 break; 261 } 262 263 } 264 265 static void generic_level_handle_set_move_message(mesh_model_t *mesh_model, mesh_pdu_t * pdu){ 266 mesh_generic_level_state_t * generic_level_server_state = (mesh_generic_level_state_t *)mesh_model->model_data; 267 btstack_assert(generic_level_server_state != NULL); 268 269 mesh_access_parser_state_t parser; 270 mesh_access_parser_init(&parser, (mesh_pdu_t*) pdu); 271 int16_t increment_value = (int16_t)mesh_access_parser_get_u16(&parser); 272 273 // The TID field is a transaction identifier indicating whether the message is 274 // a new message or a retransmission of a previously sent message 275 uint8_t tid = mesh_access_parser_get_u8(&parser); 276 277 uint8_t transition_time_gdtt = 0; 278 uint8_t delay_time_gdtt = 0; 279 mesh_transition_t * base_transition = generic_level_server_get_base_transition(mesh_model); 280 281 switch (mesh_access_transitions_transaction_status(base_transition, tid, mesh_pdu_src(pdu), mesh_pdu_dst(pdu))){ 282 case MESH_TRANSACTION_STATUS_RETRANSMISSION: 283 // ignore retransmission 284 break; 285 default: 286 mesh_access_transitions_setup_transaction(base_transition, tid, mesh_pdu_src(pdu), mesh_pdu_dst(pdu)); 287 288 generic_level_server_state->transition_data.initial_value = generic_level_server_state->transition_data.current_value; 289 generic_level_server_state->transition_data.target_value = add_and_clip_int16(generic_level_server_state->transition_data.current_value, increment_value); 290 generic_level_server_state->transition_data.stepwise_value_increment = increment_value; 291 generic_level_server_state->transition_data.delta_from_initial_value = 0; 292 293 if (mesh_access_parser_available(&parser) == 2){ 294 // Generic Default Transition Time format - num_steps (higher 6 bits), step_resolution (lower 2 bits) 295 transition_time_gdtt = mesh_access_parser_get_u8(&parser); 296 delay_time_gdtt = mesh_access_parser_get_u8(&parser); 297 int num_steps = mesh_access_transitions_num_steps_from_gdtt(transition_time_gdtt); 298 if (num_steps > 0){ 299 // TODO: remove division 300 generic_level_server_state->transition_data.target_value = add_and_clip_int16(generic_level_server_state->transition_data.current_value, increment_value * num_steps); 301 } 302 } 303 mesh_server_transition_setup_transition_or_instantaneous_update_int16(mesh_model, transition_time_gdtt, delay_time_gdtt, MODEL_STATE_UPDATE_REASON_SET); 304 break; 305 } 306 } 307 308 static void generic_level_handle_set_delta_message(mesh_model_t *mesh_model, mesh_pdu_t * pdu){ 309 mesh_generic_level_state_t * generic_level_server_state = (mesh_generic_level_state_t *)mesh_model->model_data; 310 btstack_assert(generic_level_server_state != NULL); 311 312 mesh_access_parser_state_t parser; 313 mesh_access_parser_init(&parser, (mesh_pdu_t*) pdu); 314 int16_t delta_value = (int16_t) mesh_access_parser_get_u16(&parser); 315 316 // The TID field is a transaction identifier indicating whether the message is 317 // a new message or a retransmission of a previously sent message 318 uint8_t tid = mesh_access_parser_get_u8(&parser); 319 uint8_t transition_time_gdtt = 0; 320 uint8_t delay_time_gdtt = 0; 321 322 mesh_transition_t * base_transition = generic_level_server_get_base_transition(mesh_model); 323 324 switch (mesh_access_transitions_transaction_status(base_transition, tid, mesh_pdu_src(pdu), mesh_pdu_dst(pdu))){ 325 case MESH_TRANSACTION_STATUS_DIFFERENT_DST_OR_SRC: 326 // abort transaction 327 mesh_access_transitions_abort_transaction(base_transition); 328 generic_level_server_state->transition_data.current_value = generic_level_server_state->transition_data.initial_value; 329 mesh_server_transition_setup_transition_or_instantaneous_update_int16(mesh_model, 0, 0, MODEL_STATE_UPDATE_REASON_TRANSITION_ABORT); 330 break; 331 case MESH_TRANSACTION_STATUS_RETRANSMISSION: 332 // ignore 333 break; 334 case MESH_TRANSACTION_STATUS_NEW: 335 mesh_access_transitions_setup_transaction(base_transition, tid, mesh_pdu_src(pdu), mesh_pdu_dst(pdu)); 336 337 generic_level_server_state->transition_data.initial_value = generic_level_server_state->transition_data.current_value; 338 generic_level_server_state->transition_data.target_value = add_and_clip_int16(generic_level_server_state->transition_data.current_value, delta_value); 339 generic_level_server_state->transition_data.delta_from_initial_value = delta_value; 340 generic_level_server_state->transition_data.stepwise_value_increment = 0; 341 342 if (mesh_access_parser_available(&parser) == 2){ 343 // Generic Default Transition Time format - num_steps (higher 6 bits), step_resolution (lower 2 bits) 344 transition_time_gdtt = mesh_access_parser_get_u8(&parser); 345 delay_time_gdtt = mesh_access_parser_get_u8(&parser); 346 } 347 mesh_server_transition_setup_transition_or_instantaneous_update_int16(mesh_model, transition_time_gdtt, delay_time_gdtt, MODEL_STATE_UPDATE_REASON_SET); 348 mesh_access_state_changed(mesh_model); 349 break; 350 default: 351 break; 352 } 353 } 354 355 static void generic_level_get_handler(mesh_model_t *generic_level_server_model, mesh_pdu_t * pdu){ 356 mesh_transport_pdu_t * transport_pdu = (mesh_transport_pdu_t *) mesh_generic_level_status_message(generic_level_server_model); 357 if (transport_pdu != NULL) { 358 generic_server_send_message(mesh_access_get_element_address(generic_level_server_model), mesh_pdu_src(pdu), mesh_pdu_netkey_index(pdu), mesh_pdu_appkey_index(pdu), (mesh_pdu_t *) transport_pdu); 359 } 360 mesh_access_message_processed(pdu); 361 } 362 363 static void generic_level_set_handler(mesh_model_t *generic_level_server_model, mesh_pdu_t * pdu){ 364 generic_level_handle_set_target_level_message(generic_level_server_model, pdu); 365 366 mesh_transport_pdu_t * transport_pdu = (mesh_transport_pdu_t *) mesh_generic_level_status_message(generic_level_server_model); 367 if (transport_pdu != NULL) { 368 generic_server_send_message(mesh_access_get_element_address(generic_level_server_model), mesh_pdu_src(pdu), mesh_pdu_netkey_index(pdu), mesh_pdu_appkey_index(pdu), (mesh_pdu_t *) transport_pdu); 369 } 370 mesh_access_message_processed(pdu); 371 } 372 373 static void generic_level_set_unacknowledged_handler(mesh_model_t *generic_level_server_model, mesh_pdu_t * pdu){ 374 generic_level_handle_set_target_level_message(generic_level_server_model, pdu); 375 mesh_access_message_processed(pdu); 376 } 377 378 static void generic_delta_set_handler(mesh_model_t *generic_level_server_model, mesh_pdu_t * pdu){ 379 generic_level_handle_set_delta_message(generic_level_server_model, pdu); 380 381 mesh_transport_pdu_t * transport_pdu = (mesh_transport_pdu_t *) mesh_generic_level_status_message(generic_level_server_model); 382 if (transport_pdu != NULL) { 383 generic_server_send_message(mesh_access_get_element_address(generic_level_server_model), mesh_pdu_src(pdu), mesh_pdu_netkey_index(pdu), mesh_pdu_appkey_index(pdu), (mesh_pdu_t *) transport_pdu); 384 } 385 mesh_access_message_processed(pdu); 386 } 387 388 static void generic_delta_set_unacknowledged_handler(mesh_model_t *generic_level_server_model, mesh_pdu_t * pdu){ 389 generic_level_handle_set_delta_message(generic_level_server_model, pdu); 390 mesh_access_message_processed(pdu); 391 } 392 393 static void generic_move_get_handler(mesh_model_t *generic_level_server_model, mesh_pdu_t * pdu){ 394 generic_level_handle_set_move_message(generic_level_server_model, pdu); 395 396 mesh_transport_pdu_t * transport_pdu = (mesh_transport_pdu_t *) mesh_generic_level_status_message(generic_level_server_model); 397 if (transport_pdu != NULL) { 398 generic_server_send_message(mesh_access_get_element_address(generic_level_server_model), mesh_pdu_src(pdu), mesh_pdu_netkey_index(pdu), mesh_pdu_appkey_index(pdu), (mesh_pdu_t *) transport_pdu); 399 } 400 mesh_access_message_processed(pdu); 401 } 402 403 static void generic_move_set_unacknowledged_handler(mesh_model_t *generic_level_server_model, mesh_pdu_t * pdu){ 404 generic_level_handle_set_move_message(generic_level_server_model, pdu); 405 mesh_access_message_processed(pdu); 406 } 407 408 // Generic On Off Message 409 const static mesh_operation_t mesh_generic_level_model_operations[] = { 410 { MESH_GENERIC_LEVEL_GET, 0, generic_level_get_handler }, 411 { MESH_GENERIC_LEVEL_SET, 3, generic_level_set_handler }, 412 { MESH_GENERIC_LEVEL_SET_UNACKNOWLEDGED, 3, generic_level_set_unacknowledged_handler }, 413 { MESH_GENERIC_DELTA_SET, 3, generic_delta_set_handler }, 414 { MESH_GENERIC_DELTA_SET_UNACKNOWLEDGED, 3, generic_delta_set_unacknowledged_handler }, 415 { MESH_GENERIC_MOVE_SET, 3, generic_move_get_handler }, 416 { MESH_GENERIC_MOVE_SET_UNACKNOWLEDGED, 3, generic_move_set_unacknowledged_handler }, 417 { 0, 0, NULL } 418 }; 419 420 const mesh_operation_t * mesh_generic_level_server_get_operations(void){ 421 return mesh_generic_level_model_operations; 422 } 423 424 void mesh_generic_level_server_set_publication_model(mesh_model_t *generic_level_server_model, mesh_publication_model_t * publication_model){ 425 if (generic_level_server_model == NULL) return; 426 if (publication_model == NULL) return; 427 publication_model->publish_state_fn = &mesh_generic_level_status_message; 428 generic_level_server_model->publication_model = publication_model; 429 } 430