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_on_off_server.c" 39 40 #include "mesh/mesh_generic_on_off_server.h" 41 42 #include <string.h> 43 #include <stdio.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 static void mesh_server_transition_step_bool(mesh_transition_t * transition, transition_event_t event, uint32_t current_timestamp); 58 59 static void generic_server_send_message(uint16_t src, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, mesh_pdu_t *pdu){ 60 uint8_t ttl = mesh_foundation_default_ttl_get(); 61 mesh_upper_transport_setup_access_pdu_header(pdu, netkey_index, appkey_index, ttl, src, dest, 0); 62 mesh_access_send_unacknowledged_pdu(pdu); 63 } 64 65 // Transaction management 66 67 static mesh_transition_t * generic_on_off_server_get_base_transition(mesh_model_t * mesh_model) { 68 mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)mesh_model->model_data; 69 return &generic_on_off_server_state->transition_data.base_transition; 70 } 71 72 static void mesh_server_transition_state_emit_change(mesh_transition_bool_t * transition, uint32_t current_timestamp_ms, model_state_update_reason_t reason){ 73 mesh_model_t * generic_on_off_server_model = transition->base_transition.mesh_model; 74 mesh_access_emit_state_update_bool(generic_on_off_server_model->model_packet_handler, 75 mesh_access_get_element_index(generic_on_off_server_model), 76 generic_on_off_server_model->model_identifier, 77 MODEL_STATE_ID_GENERIC_ON_OFF, 78 reason, 79 transition->current_value); 80 } 81 82 static void mesh_server_transition_state_started(mesh_transition_bool_t * transition, uint32_t current_timestamp_ms){ 83 transition->base_transition.state = MESH_TRANSITION_STATE_ACTIVE; 84 transition->base_transition.remaining_delay_time_ms = 0; 85 transition->base_transition.phase_start_ms = current_timestamp_ms; 86 if (transition->target_value == 1){ 87 transition->current_value = 1; 88 89 // publish new value 90 mesh_access_state_changed(transition->base_transition.mesh_model); 91 92 // notify app 93 mesh_server_transition_state_emit_change(transition, current_timestamp_ms, MODEL_STATE_UPDATE_REASON_TRANSITION_START); 94 } 95 } 96 97 static void mesh_server_transition_state_done(mesh_transition_bool_t * transition, uint32_t current_timestamp_ms){ 98 transition->base_transition.state = MESH_TRANSITION_STATE_IDLE; 99 transition->base_transition.remaining_transition_time_ms = 0; 100 transition->current_value = transition->target_value; 101 102 // publish new value 103 mesh_access_state_changed(transition->base_transition.mesh_model); 104 105 // notify transition completed 106 mesh_server_transition_state_emit_change(transition, current_timestamp_ms, MODEL_STATE_UPDATE_REASON_TRANSITION_END); 107 108 // done, stop transition 109 mesh_access_transitions_remove((mesh_transition_t *)transition); 110 } 111 112 static void mesh_server_transition_state_set(mesh_transition_bool_t * transition, uint32_t current_timestamp_ms){ 113 UNUSED(current_timestamp_ms); 114 115 transition->base_transition.state = MESH_TRANSITION_STATE_IDLE; 116 transition->base_transition.remaining_delay_time_ms = 0; 117 transition->base_transition.remaining_transition_time_ms = 0; 118 transition->base_transition.phase_start_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, current_timestamp_ms, MODEL_STATE_UPDATE_REASON_SET); 126 } 127 128 static void mesh_server_transition_handler(mesh_transition_t * base_transition, model_state_update_reason_t event){ 129 mesh_transition_bool_t * transition = (mesh_transition_bool_t*) base_transition; 130 uint32_t current_timestamp_ms = btstack_run_loop_get_time_ms(); 131 switch (event){ 132 case MODEL_STATE_UPDATE_REASON_SET: 133 mesh_server_transition_state_set(transition, current_timestamp_ms); 134 break; 135 case MODEL_STATE_UPDATE_REASON_TRANSITION_START: 136 mesh_server_transition_state_started(transition, current_timestamp_ms); 137 break; 138 case MODEL_STATE_UPDATE_REASON_TRANSITION_END: 139 mesh_server_transition_state_done(transition, current_timestamp_ms); 140 break; 141 case MODEL_STATE_UPDATE_REASON_TRANSITION_ABORT: 142 break; 143 default: 144 break; 145 } 146 } 147 static void mesh_server_transition_step_bool(mesh_transition_t * base_transition, transition_event_t event, uint32_t current_timestamp_ms){ 148 uint32_t time_step_ms; 149 mesh_transition_bool_t * transition = (mesh_transition_bool_t*) base_transition; 150 log_info("Transition: state %x, current timestamp %u, remaining delay %u ms, remaining transition %u ms", 151 transition->base_transition.state, current_timestamp_ms, transition->base_transition.remaining_delay_time_ms, transition->base_transition.remaining_transition_time_ms); 152 switch (transition->base_transition.state){ 153 case MESH_TRANSITION_STATE_IDLE: 154 if (event != TRANSITION_START) break; 155 transition->base_transition.state = MESH_TRANSITION_STATE_DELAYED; 156 transition->base_transition.phase_start_ms = current_timestamp_ms; 157 if (transition->base_transition.remaining_delay_time_ms != 0) break; 158 mesh_server_transition_handler(base_transition, MODEL_STATE_UPDATE_REASON_TRANSITION_START); 159 if (transition->base_transition.remaining_transition_time_ms != 0) break; 160 mesh_server_transition_handler(base_transition, MODEL_STATE_UPDATE_REASON_TRANSITION_END); 161 break; 162 case MESH_TRANSITION_STATE_DELAYED: 163 if (event != TRANSITION_UPDATE) break; 164 time_step_ms = current_timestamp_ms - transition->base_transition.phase_start_ms; 165 if (transition->base_transition.remaining_delay_time_ms > time_step_ms){ 166 transition->base_transition.remaining_delay_time_ms -= time_step_ms; 167 transition->base_transition.phase_start_ms += time_step_ms; 168 break; 169 } 170 mesh_server_transition_handler(base_transition, MODEL_STATE_UPDATE_REASON_TRANSITION_START); 171 if (transition->base_transition.remaining_transition_time_ms != 0) break; 172 mesh_server_transition_handler(base_transition, MODEL_STATE_UPDATE_REASON_TRANSITION_END); 173 break; 174 case MESH_TRANSITION_STATE_ACTIVE: 175 if (event != TRANSITION_UPDATE) break; 176 time_step_ms = current_timestamp_ms - transition->base_transition.phase_start_ms; 177 if (transition->base_transition.remaining_transition_time_ms > time_step_ms){ 178 transition->base_transition.remaining_transition_time_ms -= time_step_ms; 179 transition->base_transition.phase_start_ms += time_step_ms; 180 break; 181 } 182 mesh_server_transition_handler(base_transition, MODEL_STATE_UPDATE_REASON_TRANSITION_END); 183 break; 184 default: 185 break; 186 } 187 } 188 189 static void mesh_server_transition_setup_transition_or_instantaneous_update(mesh_model_t *mesh_model, uint8_t transition_time_gdtt, uint8_t delay_time_gdtt){ 190 mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)mesh_model->model_data; 191 mesh_transition_t * transition = &generic_on_off_server_state->transition_data.base_transition; 192 193 if ((transition_time_gdtt == 0) && (delay_time_gdtt == 0)){ 194 // instanteneous update 195 mesh_server_transition_handler(transition, MODEL_STATE_UPDATE_REASON_SET); 196 } else { 197 // transaction 198 mesh_access_transitions_setup(transition, (mesh_model_t *) mesh_model, transition_time_gdtt, delay_time_gdtt, &mesh_server_transition_step_bool); 199 mesh_access_transitions_add(transition); 200 } 201 } 202 203 204 // Generic On Off State 205 206 void mesh_generic_on_off_server_register_packet_handler(mesh_model_t *generic_on_off_server_model, btstack_packet_handler_t transition_events_packet_handler){ 207 btstack_assert(generic_on_off_server_model != NULL); 208 btstack_assert(transition_events_packet_handler != NULL); 209 generic_on_off_server_model->model_packet_handler = transition_events_packet_handler; 210 } 211 212 const mesh_access_message_t mesh_generic_on_off_status_transition = { 213 MESH_GENERIC_ON_OFF_STATUS, "111" 214 }; 215 216 const mesh_access_message_t mesh_generic_on_off_status_instantaneous = { 217 MESH_GENERIC_ON_OFF_STATUS, "1" 218 }; 219 220 static mesh_pdu_t * mesh_generic_on_off_status_message(mesh_model_t *generic_on_off_server_model){ 221 btstack_assert(generic_on_off_server_model->model_data != NULL); 222 223 mesh_generic_on_off_state_t * state = (mesh_generic_on_off_state_t *) generic_on_off_server_model->model_data; 224 // setup message 225 mesh_transport_pdu_t * transport_pdu = NULL; 226 if (state->transition_data.base_transition.remaining_transition_time_ms != 0) { 227 log_info("On/Off Status: value %u, remaining time %u ms", state->transition_data.current_value, state->transition_data.base_transition.remaining_transition_time_ms); 228 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); 229 transport_pdu = mesh_access_setup_segmented_message(&mesh_generic_on_off_status_transition, state->transition_data.current_value, 230 state->transition_data.target_value, remaining_time); 231 } else { 232 log_info("On/Off Status: value %u, no transition active", state->transition_data.current_value); 233 transport_pdu = mesh_access_setup_segmented_message(&mesh_generic_on_off_status_instantaneous, state->transition_data.current_value); 234 } 235 return (mesh_pdu_t *) transport_pdu; 236 } 237 238 static void generic_on_off_get_handler(mesh_model_t *generic_on_off_server_model, mesh_pdu_t * pdu){ 239 mesh_transport_pdu_t * transport_pdu = (mesh_transport_pdu_t *) mesh_generic_on_off_status_message(generic_on_off_server_model); 240 if (!transport_pdu) return; 241 generic_server_send_message(mesh_access_get_element_address(generic_on_off_server_model), mesh_pdu_src(pdu), mesh_pdu_netkey_index(pdu), mesh_pdu_appkey_index(pdu),(mesh_pdu_t *) transport_pdu); 242 mesh_access_message_processed(pdu); 243 } 244 245 // returns if set message was valid 246 static bool generic_on_off_handle_set_message(mesh_model_t *mesh_model, mesh_pdu_t * pdu){ 247 btstack_assert(mesh_model != NULL); 248 btstack_assert(mesh_model->model_data != NULL); 249 250 mesh_access_parser_state_t parser; 251 mesh_access_parser_init(&parser, (mesh_pdu_t*) pdu); 252 uint8_t on_off_value = mesh_access_parser_get_u8(&parser); 253 254 // check for valid value 255 if (on_off_value > 1) return false; 256 257 // The TID field is a transaction identifier indicating whether the message is 258 // a new message or a retransmission of a previously sent message 259 mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)mesh_model->model_data; 260 uint8_t tid = mesh_access_parser_get_u8(&parser); 261 uint8_t transition_time_gdtt = 0; 262 uint8_t delay_time_gdtt = 0; 263 264 mesh_transition_t * base_transition = generic_on_off_server_get_base_transition(mesh_model); 265 switch (mesh_access_transitions_transaction_status(base_transition, tid, mesh_pdu_src(pdu), mesh_pdu_dst(pdu))){ 266 case MESH_TRANSACTION_STATUS_RETRANSMISSION: 267 // ignore on retransmission 268 break; 269 default: 270 mesh_access_transitions_setup_transaction(base_transition, tid, mesh_pdu_src(pdu), mesh_pdu_dst(pdu)); 271 generic_on_off_server_state->transition_data.target_value = on_off_value; 272 273 if (mesh_access_parser_available(&parser) == 2){ 274 // Generic Default Transition Time format - num_steps (higher 6 bits), step_resolution (lower 2 bits) 275 transition_time_gdtt = mesh_access_parser_get_u8(&parser); 276 delay_time_gdtt = mesh_access_parser_get_u8(&parser); 277 } 278 mesh_server_transition_setup_transition_or_instantaneous_update(mesh_model, transition_time_gdtt, delay_time_gdtt); 279 mesh_access_state_changed(mesh_model); 280 break; 281 } 282 return true; 283 } 284 285 static void generic_on_off_set_handler(mesh_model_t *generic_on_off_server_model, mesh_pdu_t * pdu){ 286 bool send_status = generic_on_off_handle_set_message(generic_on_off_server_model, pdu); 287 if (send_status){ 288 mesh_transport_pdu_t * transport_pdu = (mesh_transport_pdu_t *) mesh_generic_on_off_status_message(generic_on_off_server_model); 289 if (transport_pdu) { 290 generic_server_send_message(mesh_access_get_element_address(generic_on_off_server_model), mesh_pdu_src(pdu), mesh_pdu_netkey_index(pdu), mesh_pdu_appkey_index(pdu),(mesh_pdu_t *) transport_pdu); 291 } 292 } 293 mesh_access_message_processed(pdu); 294 } 295 296 static void generic_on_off_set_unacknowledged_handler(mesh_model_t *generic_on_off_server_model, mesh_pdu_t * pdu){ 297 generic_on_off_handle_set_message(generic_on_off_server_model, pdu); 298 mesh_access_message_processed(pdu); 299 } 300 301 // Generic On Off Message 302 const static mesh_operation_t mesh_generic_on_off_model_operations[] = { 303 { MESH_GENERIC_ON_OFF_GET, 0, generic_on_off_get_handler }, 304 { MESH_GENERIC_ON_OFF_SET, 2, generic_on_off_set_handler }, 305 { MESH_GENERIC_ON_OFF_SET_UNACKNOWLEDGED, 2, generic_on_off_set_unacknowledged_handler }, 306 { 0, 0, NULL } 307 }; 308 309 const mesh_operation_t * mesh_generic_on_off_server_get_operations(void){ 310 return mesh_generic_on_off_model_operations; 311 } 312 313 void mesh_generic_on_off_server_set(mesh_model_t * mesh_model, uint8_t on_off_value, uint8_t transition_time_gdtt, uint8_t delay_time_gdtt){ 314 mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)mesh_model->model_data; 315 generic_on_off_server_state->transition_data.target_value = on_off_value; 316 317 mesh_server_transition_setup_transition_or_instantaneous_update(mesh_model, transition_time_gdtt, delay_time_gdtt); 318 mesh_access_state_changed(mesh_model); 319 } 320 321 uint8_t mesh_generic_on_off_server_get(mesh_model_t *generic_on_off_server_model){ 322 mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)generic_on_off_server_model->model_data; 323 return generic_on_off_server_state->transition_data.current_value; 324 } 325 326 void mesh_generic_on_off_server_set_publication_model(mesh_model_t *generic_on_off_server_model, mesh_publication_model_t * publication_model){ 327 if (generic_on_off_server_model == NULL) return; 328 if (publication_model == NULL) return; 329 publication_model->publish_state_fn = &mesh_generic_on_off_status_message; 330 generic_on_off_server_model->publication_model = publication_model; 331 } 332 333