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_delayed(mesh_transition_bool_t * transition, uint32_t current_timestamp_ms){ 83 transition->base_transition.state = MESH_TRANSITION_STATE_DELAYED; 84 transition->base_transition.phase_start_ms = current_timestamp_ms; 85 } 86 87 static void mesh_server_transition_state_started(mesh_transition_bool_t * transition, uint32_t current_timestamp_ms){ 88 transition->base_transition.state = MESH_TRANSITION_STATE_ACTIVE; 89 transition->base_transition.remaining_delay_time_ms = 0; 90 transition->base_transition.phase_start_ms = current_timestamp_ms; 91 if (transition->target_value == 1){ 92 transition->current_value = 1; 93 94 // publish new value 95 mesh_access_state_changed(transition->base_transition.mesh_model); 96 97 // notify app 98 mesh_server_transition_state_emit_change(transition, current_timestamp_ms, MODEL_STATE_UPDATE_REASON_TRANSITION_START); 99 } 100 } 101 102 static void mesh_server_transition_state_done(mesh_transition_bool_t * transition, uint32_t current_timestamp_ms){ 103 transition->base_transition.state = MESH_TRANSITION_STATE_IDLE; 104 transition->base_transition.remaining_transition_time_ms = 0; 105 transition->current_value = transition->target_value; 106 107 // publish new value 108 mesh_access_state_changed(transition->base_transition.mesh_model); 109 110 // notify transition completed 111 mesh_server_transition_state_emit_change(transition, current_timestamp_ms, MODEL_STATE_UPDATE_REASON_TRANSITION_END); 112 113 // done, stop transition 114 mesh_access_transitions_remove((mesh_transition_t *)transition); 115 } 116 117 static void mesh_server_transition_step_bool(mesh_transition_t * base_transition, transition_event_t event, uint32_t current_timestamp_ms){ 118 uint32_t time_step_ms; 119 mesh_transition_bool_t * transition = (mesh_transition_bool_t*) base_transition; 120 log_info("Transition: state %x, current timestamp %u, remaining delay %u ms, remaining transition %u ms", 121 transition->base_transition.state, current_timestamp_ms, transition->base_transition.remaining_delay_time_ms, transition->base_transition.remaining_transition_time_ms); 122 switch (transition->base_transition.state){ 123 case MESH_TRANSITION_STATE_IDLE: 124 if (event != TRANSITION_START) break; 125 mesh_server_transition_state_delayed(transition, current_timestamp_ms); 126 if (transition->base_transition.remaining_delay_time_ms != 0) break; 127 mesh_server_transition_state_started(transition, current_timestamp_ms); 128 if (transition->base_transition.remaining_transition_time_ms != 0) break; 129 mesh_server_transition_state_done(transition, current_timestamp_ms); 130 break; 131 case MESH_TRANSITION_STATE_DELAYED: 132 if (event != TRANSITION_UPDATE) break; 133 time_step_ms = current_timestamp_ms - transition->base_transition.phase_start_ms; 134 if (transition->base_transition.remaining_delay_time_ms > time_step_ms){ 135 transition->base_transition.remaining_delay_time_ms -= time_step_ms; 136 transition->base_transition.phase_start_ms += time_step_ms; 137 break; 138 } 139 mesh_server_transition_state_started(transition, current_timestamp_ms); 140 if (transition->base_transition.remaining_transition_time_ms != 0) break; 141 mesh_server_transition_state_done(transition, current_timestamp_ms); 142 break; 143 case MESH_TRANSITION_STATE_ACTIVE: 144 if (event != TRANSITION_UPDATE) break; 145 time_step_ms = current_timestamp_ms - transition->base_transition.phase_start_ms; 146 if (transition->base_transition.remaining_transition_time_ms > time_step_ms){ 147 transition->base_transition.remaining_transition_time_ms -= time_step_ms; 148 transition->base_transition.phase_start_ms += time_step_ms; 149 break; 150 } 151 mesh_server_transition_state_done(transition, current_timestamp_ms); 152 break; 153 default: 154 break; 155 } 156 } 157 158 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){ 159 mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)mesh_model->model_data; 160 mesh_transition_t * transition = &generic_on_off_server_state->transition_data.base_transition; 161 162 if (transition_time_gdtt != 0 || delay_time_gdtt != 0) { 163 mesh_access_transitions_setup(transition, (mesh_model_t *) mesh_model, 164 transition_time_gdtt, delay_time_gdtt, &mesh_server_transition_step_bool); 165 mesh_access_transitions_add(transition); 166 } else { 167 generic_on_off_server_state->transition_data.current_value = generic_on_off_server_state->transition_data.target_value; 168 transition->phase_start_ms = 0; 169 transition->remaining_delay_time_ms = 0; 170 transition->remaining_transition_time_ms = 0; 171 transition->state = MESH_TRANSITION_STATE_IDLE; 172 173 mesh_access_emit_state_update_bool(mesh_model->model_packet_handler, 174 mesh_access_get_element_index(mesh_model), 175 mesh_model->model_identifier, 176 MODEL_STATE_ID_GENERIC_ON_OFF, 177 reason, 178 generic_on_off_server_state->transition_data.current_value); 179 } 180 } 181 182 183 // Generic On Off State 184 185 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){ 186 btstack_assert(generic_on_off_server_model != NULL); 187 btstack_assert(transition_events_packet_handler != NULL); 188 generic_on_off_server_model->model_packet_handler = transition_events_packet_handler; 189 } 190 191 const mesh_access_message_t mesh_generic_on_off_status_transition = { 192 MESH_GENERIC_ON_OFF_STATUS, "111" 193 }; 194 195 const mesh_access_message_t mesh_generic_on_off_status_instantaneous = { 196 MESH_GENERIC_ON_OFF_STATUS, "1" 197 }; 198 199 static mesh_pdu_t * mesh_generic_on_off_status_message(mesh_model_t *generic_on_off_server_model){ 200 btstack_assert(generic_on_off_server_model->model_data != NULL); 201 202 mesh_generic_on_off_state_t * state = (mesh_generic_on_off_state_t *) generic_on_off_server_model->model_data; 203 // setup message 204 mesh_transport_pdu_t * transport_pdu = NULL; 205 if (state->transition_data.base_transition.remaining_transition_time_ms != 0) { 206 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); 207 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); 208 transport_pdu = mesh_access_setup_segmented_message(&mesh_generic_on_off_status_transition, state->transition_data.current_value, 209 state->transition_data.target_value, remaining_time); 210 } else { 211 log_info("On/Off Status: value %u, no transition active", state->transition_data.current_value); 212 transport_pdu = mesh_access_setup_segmented_message(&mesh_generic_on_off_status_instantaneous, state->transition_data.current_value); 213 } 214 return (mesh_pdu_t *) transport_pdu; 215 } 216 217 static void generic_on_off_get_handler(mesh_model_t *generic_on_off_server_model, mesh_pdu_t * pdu){ 218 mesh_transport_pdu_t * transport_pdu = (mesh_transport_pdu_t *) mesh_generic_on_off_status_message(generic_on_off_server_model); 219 if (!transport_pdu) return; 220 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); 221 mesh_access_message_processed(pdu); 222 } 223 224 static void generic_on_off_handle_set_message(mesh_model_t *mesh_model, mesh_pdu_t * pdu){ 225 btstack_assert(mesh_model != NULL); 226 btstack_assert(mesh_model->model_data != NULL); 227 228 mesh_access_parser_state_t parser; 229 mesh_access_parser_init(&parser, (mesh_pdu_t*) pdu); 230 uint8_t on_off_value = mesh_access_parser_get_u8(&parser); 231 232 // The TID field is a transaction identifier indicating whether the message is 233 // a new message or a retransmission of a previously sent message 234 mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)mesh_model->model_data; 235 uint8_t tid = mesh_access_parser_get_u8(&parser); 236 uint8_t transition_time_gdtt = 0; 237 uint8_t delay_time_gdtt = 0; 238 239 mesh_transition_t * base_transition = generic_on_off_server_get_base_transition(mesh_model); 240 switch (mesh_access_transitions_transaction_status(base_transition, tid, mesh_pdu_src(pdu), mesh_pdu_dst(pdu))){ 241 case MESH_TRANSACTION_STATUS_RETRANSMISSION: 242 // ignore on retransmission 243 break; 244 default: 245 mesh_access_transitions_setup_transaction(base_transition, tid, mesh_pdu_src(pdu), mesh_pdu_dst(pdu)); 246 generic_on_off_server_state->transition_data.target_value = on_off_value; 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 } 253 mesh_server_transition_setup_transition_or_instantaneous_update(mesh_model, transition_time_gdtt, delay_time_gdtt, MODEL_STATE_UPDATE_REASON_SET); 254 mesh_access_state_changed(mesh_model); 255 break; 256 } 257 } 258 259 static void generic_on_off_set_handler(mesh_model_t *generic_on_off_server_model, mesh_pdu_t * pdu){ 260 generic_on_off_handle_set_message(generic_on_off_server_model, pdu); 261 262 mesh_transport_pdu_t * transport_pdu = (mesh_transport_pdu_t *) mesh_generic_on_off_status_message(generic_on_off_server_model); 263 if (!transport_pdu) return; 264 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); 265 mesh_access_message_processed(pdu); 266 } 267 268 static void generic_on_off_set_unacknowledged_handler(mesh_model_t *generic_on_off_server_model, mesh_pdu_t * pdu){ 269 generic_on_off_handle_set_message(generic_on_off_server_model, pdu); 270 mesh_access_message_processed(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 } 292 293 uint8_t mesh_generic_on_off_server_get(mesh_model_t *generic_on_off_server_model){ 294 mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)generic_on_off_server_model->model_data; 295 return generic_on_off_server_state->transition_data.current_value; 296 } 297 298 void mesh_generic_on_off_server_set_publication_model(mesh_model_t *generic_on_off_server_model, mesh_publication_model_t * publication_model){ 299 if (generic_on_off_server_model == NULL) return; 300 if (publication_model == NULL) return; 301 publication_model->publish_state_fn = &mesh_generic_on_off_status_message; 302 generic_on_off_server_model->publication_model = publication_model; 303 } 304 305