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