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_update(mesh_transition_bool_t * transition, uint32_t current_timestamp_ms){ 73 if (transition->base_transition.remaining_delay_time_ms != 0){ 74 transition->base_transition.state = MESH_TRANSITION_STATE_DELAYED; 75 transition->base_transition.remaining_delay_time_ms = 0; 76 transition->base_transition.phase_start_ms = current_timestamp_ms; 77 return; 78 } 79 80 mesh_model_t * generic_on_off_server_model = transition->base_transition.mesh_model; 81 if (transition->base_transition.remaining_transition_time_ms != 0){ 82 transition->base_transition.state = MESH_TRANSITION_STATE_ACTIVE; 83 transition->base_transition.phase_start_ms = current_timestamp_ms; 84 if (transition->target_value == 1){ 85 transition->current_value = 1; 86 mesh_access_emit_state_update_bool(generic_on_off_server_model->model_packet_handler, 87 mesh_access_get_element_index(generic_on_off_server_model), 88 generic_on_off_server_model->model_identifier, 89 MODEL_STATE_ID_GENERIC_ON_OFF, 90 MODEL_STATE_UPDATE_REASON_TRANSITION_START, 91 transition->current_value); 92 93 } 94 return; 95 } 96 transition->current_value = transition->target_value; 97 transition->base_transition.remaining_transition_time_ms = 0; 98 99 // emit event 100 mesh_access_emit_state_update_bool(generic_on_off_server_model->model_packet_handler, 101 mesh_access_get_element_index(generic_on_off_server_model), 102 generic_on_off_server_model->model_identifier, 103 MODEL_STATE_ID_GENERIC_ON_OFF, 104 MODEL_STATE_UPDATE_REASON_TRANSITION_END, 105 transition->current_value); 106 107 // done, stop transition 108 mesh_access_transitions_remove((mesh_transition_t *)transition); 109 } 110 111 static void mesh_server_transition_step_bool(mesh_transition_t * base_transition, transition_event_t event, uint32_t current_timestamp){ 112 uint32_t time_step_ms; 113 114 mesh_transition_bool_t * transition = (mesh_transition_bool_t*) base_transition; 115 116 switch (transition->base_transition.state){ 117 case MESH_TRANSITION_STATE_IDLE: 118 if (event != TRANSITION_START) break; 119 mesh_server_transition_state_update(transition, current_timestamp); 120 break; 121 case MESH_TRANSITION_STATE_DELAYED: 122 if (event != TRANSITION_UPDATE) break; 123 time_step_ms = current_timestamp - transition->base_transition.phase_start_ms; 124 if (transition->base_transition.remaining_delay_time_ms >= time_step_ms){ 125 transition->base_transition.remaining_delay_time_ms -= time_step_ms; 126 } else { 127 transition->base_transition.remaining_delay_time_ms = 0; 128 mesh_server_transition_state_update(transition, current_timestamp); 129 } 130 break; 131 case MESH_TRANSITION_STATE_ACTIVE: 132 if (event != TRANSITION_UPDATE) break; 133 time_step_ms = current_timestamp - transition->base_transition.phase_start_ms; 134 if (transition->base_transition.remaining_transition_time_ms >= time_step_ms){ 135 transition->base_transition.remaining_transition_time_ms -= time_step_ms; 136 } else { 137 transition->base_transition.remaining_transition_time_ms = 0; 138 mesh_server_transition_state_update(transition, current_timestamp); 139 } 140 break; 141 default: 142 break; 143 } 144 } 145 146 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, model_state_update_reason_t reason){ 147 mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)mesh_model->model_data; 148 mesh_transition_t transition = generic_on_off_server_state->transition_data.base_transition; 149 150 if (transition_time_gdtt != 0 || delay_time_gdtt != 0) { 151 mesh_access_transitions_setup(&transition, (mesh_model_t *) mesh_model, 152 transition_time_gdtt, delay_time_gdtt, &mesh_server_transition_step_bool); 153 mesh_access_transitions_add(&transition); 154 } else { 155 generic_on_off_server_state->transition_data.current_value = generic_on_off_server_state->transition_data.target_value; 156 transition.phase_start_ms = 0; 157 transition.remaining_delay_time_ms = 0; 158 transition.remaining_transition_time_ms = 0; 159 transition.state = MESH_TRANSITION_STATE_IDLE; 160 161 mesh_access_emit_state_update_bool(mesh_model->model_packet_handler, 162 mesh_access_get_element_index(mesh_model), 163 mesh_model->model_identifier, 164 MODEL_STATE_ID_GENERIC_ON_OFF, 165 reason, 166 generic_on_off_server_state->transition_data.current_value); 167 } 168 } 169 170 171 // Generic On Off State 172 173 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){ 174 if (transition_events_packet_handler == NULL){ 175 log_error("mesh_generic_on_off_server_register_packet_handler called with NULL callback"); 176 return; 177 } 178 if (generic_on_off_server_model == NULL){ 179 log_error("mesh_generic_on_off_server_register_packet_handler called with NULL generic_on_off_server_model"); 180 return; 181 } 182 generic_on_off_server_model->model_packet_handler = transition_events_packet_handler; 183 } 184 185 const mesh_access_message_t mesh_generic_on_off_status_transition = { 186 MESH_GENERIC_ON_OFF_STATUS, "111" 187 }; 188 189 const mesh_access_message_t mesh_generic_on_off_status_instantaneous = { 190 MESH_GENERIC_ON_OFF_STATUS, "1" 191 }; 192 193 static mesh_pdu_t * mesh_generic_on_off_status_message(mesh_model_t *generic_on_off_server_model){ 194 if (generic_on_off_server_model->element == NULL){ 195 log_error("generic_on_off_server_model->element == NULL"); 196 } 197 198 mesh_generic_on_off_state_t * state = (mesh_generic_on_off_state_t *) generic_on_off_server_model->model_data; 199 if (state == NULL){ 200 log_error("generic_on_off_status == NULL"); 201 } 202 // setup message 203 mesh_transport_pdu_t * transport_pdu = NULL; 204 if (state->transition_data.base_transition.remaining_transition_time_ms != 0) { 205 transport_pdu = mesh_access_setup_segmented_message(&mesh_generic_on_off_status_transition, state->transition_data.current_value, 206 state->transition_data.target_value, state->transition_data.base_transition.remaining_transition_time_ms); 207 } else { 208 transport_pdu = mesh_access_setup_segmented_message(&mesh_generic_on_off_status_instantaneous, state->transition_data.current_value); 209 } 210 return (mesh_pdu_t *) transport_pdu; 211 } 212 213 static void generic_on_off_get_handler(mesh_model_t *generic_on_off_server_model, mesh_pdu_t * pdu){ 214 mesh_transport_pdu_t * transport_pdu = (mesh_transport_pdu_t *) mesh_generic_on_off_status_message(generic_on_off_server_model); 215 if (!transport_pdu) return; 216 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); 217 mesh_access_message_processed(pdu); 218 } 219 220 static void generic_on_off_handle_set_message(mesh_model_t *mesh_model, mesh_pdu_t * pdu){ 221 if (mesh_model == NULL){ 222 log_error("mesh_model == NULL"); 223 } 224 mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)mesh_model->model_data; 225 226 if (generic_on_off_server_state == NULL){ 227 log_error("generic_on_off_server_state == NULL"); 228 } 229 230 mesh_access_parser_state_t parser; 231 mesh_access_parser_init(&parser, (mesh_pdu_t*) pdu); 232 uint8_t on_off_value = mesh_access_parser_get_u8(&parser); 233 234 // The TID field is a transaction identifier indicating whether the message is 235 // a new message or a retransmission of a previously sent message 236 uint8_t tid = mesh_access_parser_get_u8(&parser); 237 uint8_t transition_time_gdtt = 0; 238 uint8_t delay_time_gdtt = 0; 239 240 mesh_transition_t * base_transition = generic_on_off_server_get_base_transition(mesh_model); 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 on retransmission 244 break; 245 default: 246 mesh_access_transitions_setup_transaction(base_transition, tid, mesh_pdu_src(pdu), mesh_pdu_dst(pdu)); 247 generic_on_off_server_state->transition_data.target_value = on_off_value; 248 249 if (mesh_access_parser_available(&parser) == 2){ 250 // Generic Default Transition Time format - num_steps (higher 6 bits), step_resolution (lower 2 bits) 251 transition_time_gdtt = mesh_access_parser_get_u8(&parser); 252 delay_time_gdtt = mesh_access_parser_get_u8(&parser); 253 } 254 mesh_server_transition_setup_transition_or_instantaneous_update(mesh_model, transition_time_gdtt, delay_time_gdtt, MODEL_STATE_UPDATE_REASON_SET); 255 mesh_access_state_changed(mesh_model); 256 break; 257 } 258 } 259 260 static void generic_on_off_set_handler(mesh_model_t *generic_on_off_server_model, mesh_pdu_t * pdu){ 261 generic_on_off_handle_set_message(generic_on_off_server_model, pdu); 262 263 mesh_transport_pdu_t * transport_pdu = (mesh_transport_pdu_t *) mesh_generic_on_off_status_message(generic_on_off_server_model); 264 if (!transport_pdu) return; 265 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); 266 mesh_access_message_processed(pdu); 267 } 268 269 static void generic_on_off_set_unacknowledged_handler(mesh_model_t *generic_on_off_server_model, mesh_pdu_t * pdu){ 270 generic_on_off_handle_set_message(generic_on_off_server_model, pdu); 271 } 272 273 // Generic On Off Message 274 const static mesh_operation_t mesh_generic_on_off_model_operations[] = { 275 { MESH_GENERIC_ON_OFF_GET, 0, generic_on_off_get_handler }, 276 { MESH_GENERIC_ON_OFF_SET, 2, generic_on_off_set_handler }, 277 { MESH_GENERIC_ON_OFF_SET_UNACKNOWLEDGED, 2, generic_on_off_set_unacknowledged_handler }, 278 { 0, 0, NULL } 279 }; 280 281 const mesh_operation_t * mesh_generic_on_off_server_get_operations(void){ 282 return mesh_generic_on_off_model_operations; 283 } 284 285 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){ 286 mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)mesh_model->model_data; 287 generic_on_off_server_state->transition_data.target_value = on_off_value; 288 289 mesh_server_transition_setup_transition_or_instantaneous_update(mesh_model, transition_time_gdtt, delay_time_gdtt, MODEL_STATE_UPDATE_REASON_APPLICATION_CHANGE); 290 mesh_access_state_changed(mesh_model); 291 // TODO implement publication 292 } 293 294 uint8_t mesh_generic_on_off_server_get(mesh_model_t *generic_on_off_server_model){ 295 mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)generic_on_off_server_model->model_data; 296 return generic_on_off_server_state->transition_data.current_value; 297 } 298 299 void mesh_generic_on_off_server_set_publication_model(mesh_model_t *generic_on_off_server_model, mesh_publication_model_t * publication_model){ 300 if (generic_on_off_server_model == NULL) return; 301 if (publication_model == NULL) return; 302 publication_model->publish_state_fn = &mesh_generic_on_off_status_message; 303 generic_on_off_server_model->publication_model = publication_model; 304 } 305 306