btstack/test/mesh/mesh_generic_server.c

/*
 * Copyright (C) 2019 BlueKitchen GmbH
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 * 4. Any redistribution, use, or modification is done solely for
 *    personal benefit and not for any commercial purpose or for
 *    monetary gain.
 *
 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * Please inquire about commercial licensing options at 
 * contact@bluekitchen-gmbh.com
 *
 */

#define __BTSTACK_FILE__ "mesh_generic_server.c"

#include <string.h>
#include <stdio.h>
#include "mesh_generic_server.h"
#include "btstack_util.h"
#include "ble/mesh/mesh_network.h"
#include "mesh_keys.h"
#include "mesh_transport.h"
#include "mesh_access.h"
#include "mesh_foundation.h"
#include "bluetooth_company_id.h"
#include "btstack_memory.h"
#include "btstack_debug.h"

static void generic_server_send_message(uint16_t src, uint16_t dest, uint16_t netkey_index, uint16_t appkey_index, mesh_pdu_t *pdu){
    uint8_t  ttl  = mesh_foundation_default_ttl_get();
    mesh_upper_transport_setup_access_pdu_header(pdu, netkey_index, appkey_index, ttl, src, dest, 0);
    mesh_upper_transport_send_access_pdu(pdu);
}

// Generic On Off State

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){
    if (transition_events_packet_handler == NULL){
        log_error("mesh_generic_on_off_server_register_packet_handler called with NULL callback");
        return;
    }
    if (generic_on_off_server_model == NULL){
        log_error("mesh_generic_on_off_server_register_packet_handler called with NULL generic_on_off_server_model");
        return;
    }
    generic_on_off_server_model->transition_events_packet_handler = &transition_events_packet_handler;
}

const mesh_access_message_t mesh_generic_on_off_status_transition = {
        MESH_GENERIC_ON_OFF_STATUS, "111"
};

const mesh_access_message_t mesh_generic_on_off_status_instantaneous = {
        MESH_GENERIC_ON_OFF_STATUS, "1"
};

static void mesh_generic_on_off_status_message(mesh_model_t *generic_on_off_server_model, uint16_t netkey_index, uint16_t dest, uint16_t appkey_index){
    if (generic_on_off_server_model->element == NULL){
        log_error("generic_on_off_server_model->element == NULL"); 
    }

    mesh_generic_on_off_state_t * state = (mesh_generic_on_off_state_t *) generic_on_off_server_model->model_data;
    if (state == NULL){
        log_error("generic_on_off_status ==  NULL");
    }
    // setup message
    mesh_transport_pdu_t * transport_pdu = NULL; 


    if (state->transition_data.base_transition.remaining_transition_time_ms != 0) {
        transport_pdu = mesh_access_setup_segmented_message(&mesh_generic_on_off_status_transition, state->transition_data.current_value, 
            state->transition_data.target_value, state->transition_data.base_transition.remaining_transition_time_ms);
    } else {
        transport_pdu = mesh_access_setup_segmented_message(&mesh_generic_on_off_status_instantaneous, state->transition_data.current_value);
    }
    if (!transport_pdu) return;

    // send as segmented access pdu
    generic_server_send_message(mesh_access_get_element_address(generic_on_off_server_model), dest, netkey_index, appkey_index, (mesh_pdu_t *) transport_pdu);
}

static void generic_on_off_get_handler(mesh_model_t *generic_on_off_server_model, mesh_pdu_t * pdu){
    mesh_generic_on_off_status_message(generic_on_off_server_model, mesh_pdu_netkey_index(pdu), mesh_pdu_src(pdu), mesh_pdu_appkey_index(pdu));
    mesh_access_message_processed(pdu);
}

static uint8_t mesh_get_num_steps_from_gdtt(uint8_t transition_time_gdtt){
    return transition_time_gdtt >> 2;
}

static uint32_t mesh_get_time_ms_from_gdtt(uint8_t transition_time_gdtt){
    uint32_t step_resolution_ms = 0;
    uint8_t num_steps  = mesh_get_num_steps_from_gdtt(transition_time_gdtt);
    
    mesh_default_transition_step_resolution_t step_resolution = (mesh_default_transition_step_resolution_t) (transition_time_gdtt & 0x03u);
    switch (step_resolution){
        case MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_100ms:
            step_resolution_ms = 100;
            break;
        case MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_1s:
            step_resolution_ms = 1000;
            break;
        case MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_10s:
            step_resolution_ms = 10000;
            break;
        case MESH_DEFAULT_TRANSITION_STEP_RESOLUTION_10min:
            step_resolution_ms = 600000;
            break;
        default:
            break;

    }
    return num_steps * step_resolution_ms;
}

static void generic_on_off_set_handler(mesh_model_t *generic_on_off_server_model, mesh_pdu_t * pdu){
    if (generic_on_off_server_model == NULL){
        log_error("generic_on_off_server_model == NULL");
    }
    mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)generic_on_off_server_model->model_data;
    
    if (generic_on_off_server_state == NULL){
        log_error("generic_on_off_server_state == NULL");
    }
    
    mesh_access_parser_state_t parser;
    mesh_access_parser_init(&parser, (mesh_pdu_t*) pdu);
    uint8_t on_off_value = mesh_access_parser_get_u8(&parser);
    // The TID field is a transaction identifier indicating whether the message is 
    // a new message or a retransmission of a previously sent message
    uint8_t tid = mesh_access_parser_get_u8(&parser); 

    if (tid == generic_on_off_server_state->transaction_identifier){
        printf("retransmission\n");
        return;
    }

    if (mesh_access_parser_available(&parser) == 2){
        //  Generic Default Transition Time format - num_steps (higher 6 bits), step_resolution (lower 2 bits) 
        uint8_t  transition_time_gdtt = mesh_access_parser_get_u8(&parser);
        //  Only values of 0x00 through 0x3E shall be used to specify the value of the Transition Number of Steps field
        uint8_t num_steps  = mesh_get_num_steps_from_gdtt(transition_time_gdtt);
        if (num_steps > 0x3E){

        }

        uint32_t transition_time_ms = mesh_get_time_ms_from_gdtt(transition_time_gdtt);
        // Delay is given in 5 millisecond steps 
        uint16_t  delay_ms = mesh_access_parser_get_u8(&parser) * 5;
        printf("todo check/set transition timer transition_time %d ms, delay %d ms", transition_time_ms, delay_ms);
        //TODO: return;
    }

    // Instantanious update
    generic_on_off_server_state->transition_data.current_value = on_off_value;
    generic_on_off_server_state->transition_data.target_value = on_off_value;
    generic_on_off_server_state->transaction_identifier = tid;
    generic_on_off_server_state->transition_data.base_transition.remaining_transition_time_ms = 0;
    generic_on_off_server_state->transition_data.base_transition.remaining_delay_time_ms = 0;
    mesh_generic_on_off_status_message(generic_on_off_server_model, mesh_pdu_netkey_index(pdu), mesh_pdu_src(pdu), mesh_pdu_appkey_index(pdu));
    mesh_access_message_processed(pdu);
    
    mesh_access_emit_state_update_bool(generic_on_off_server_model->transition_events_packet_handler, 
        mesh_access_get_element_index(generic_on_off_server_model), 
        generic_on_off_server_model->model_identifier, 
        MODEL_STATE_ID_GENERIC_ON_OFF, 
        MODEL_STATE_UPDATE_REASON_SET, 
        generic_on_off_server_state->transition_data.current_value);
}

// static void generic_on_off_set_unacknowledged_handler(mesh_model_t *mesh_model, mesh_pdu_t * pdu){
// }

// Generic On Off Message
const static mesh_operation_t mesh_generic_on_off_model_operations[] = {
    { MESH_GENERIC_ON_OFF_GET,                                   0, generic_on_off_get_handler },
    { MESH_GENERIC_ON_OFF_SET,                                   2, generic_on_off_set_handler },
    // { MESH_GENERIC_ON_OFF_SET_UNACKNOWLEDGED,                    4, generic_on_off_set_unacknowledged_handler },
    { 0, 0, NULL }
};

const mesh_operation_t * mesh_generic_on_off_server_get_operations(void){
    return mesh_generic_on_off_model_operations;
}

void mesh_generic_on_off_server_set_value(mesh_model_t *generic_on_off_server_model, uint8_t on_off_value, uint32_t transition_time_ms, uint16_t delay_ms){
    mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)generic_on_off_server_model->model_data;
    
    generic_on_off_server_state->transition_data.target_value = on_off_value;
    generic_on_off_server_state->transition_data.base_transition.remaining_transition_time_ms = transition_time_ms;
    generic_on_off_server_state->transition_data.base_transition.remaining_delay_time_ms = delay_ms;
    
    // TODO implement transition 
    // TODO implement publication
    generic_on_off_server_state->transition_data.current_value = on_off_value;
    
    mesh_access_emit_state_update_bool(generic_on_off_server_model->transition_events_packet_handler, 
        mesh_access_get_element_index(generic_on_off_server_model), 
        generic_on_off_server_model->model_identifier, 
        MODEL_STATE_ID_GENERIC_ON_OFF, 
        MODEL_STATE_UPDATE_REASON_APPLICATION_CHANGE, 
        generic_on_off_server_state->transition_data.current_value);
}

uint8_t mesh_generic_on_off_server_get_value(mesh_model_t *generic_on_off_server_model){
    mesh_generic_on_off_state_t * generic_on_off_server_state = (mesh_generic_on_off_state_t *)generic_on_off_server_model->model_data;
    return generic_on_off_server_state->transition_data.current_value;
}

static void mesh_server_transition_bool_init(mesh_transition_bool_t * transition){
    transition->base_transition.state = MESH_TRANSITION_STATE_IDLE;
    transition->base_transition.remaining_transition_time_ms = 0;
    transition->base_transition.remaining_delay_time_ms = 0;
    transition->base_transition.phase_start_ms = 0;
    transition->target_value = transition->current_value;
}

static void mesh_server_transition_state_update(mesh_transition_bool_t * transition, uint32_t current_timestamp_ms){
    if (transition->base_transition.remaining_delay_time_ms != 0){
        transition->base_transition.state = MESH_TRANSITION_STATE_DELAYED;
        transition->base_transition.remaining_delay_time_ms = 0;
        transition->base_transition.phase_start_ms = current_timestamp_ms;
        return;
    }

    if (transition->base_transition.remaining_transition_time_ms != 0){
        transition->base_transition.state = MESH_TRANSITION_STATE_ACTIVE;
        transition->base_transition.phase_start_ms = current_timestamp_ms;
        if (transition->target_value == 1){
            transition->current_value = 1;
            // TODO: emit event
            mesh_server_transition_bool_init(transition);
        }
        return;
    }
    transition->current_value = transition->target_value;
    transition->base_transition.remaining_transition_time_ms = 0;
    // TODO: emit event
    mesh_server_transition_bool_init(transition);
}

void mesh_server_transition_step_bool(mesh_transition_bool_t * transition, transition_event_t event, uint32_t current_timestamp){
    uint32_t time_step_ms;

    switch (transition->base_transition.state){
        case MESH_TRANSITION_STATE_IDLE:
            if (event != TRANSITION_START) break;
            mesh_server_transition_state_update(transition, current_timestamp);
            break;
        case MESH_TRANSITION_STATE_DELAYED:
            switch (event){
                case TRANSITION_START:
                    mesh_server_transition_state_update(transition, current_timestamp);
                    break;
                case TRANSITION_UPDATE:
                    time_step_ms = current_timestamp - transition->base_transition.phase_start_ms;
                    if (transition->base_transition.remaining_delay_time_ms >= time_step_ms){
                        transition->base_transition.remaining_delay_time_ms -= time_step_ms;
                    } else {
                        transition->base_transition.remaining_delay_time_ms = 0;
                        mesh_server_transition_state_update(transition, current_timestamp);
                    }
                    break;
                default:
                    break;
            }
            break;
        case MESH_TRANSITION_STATE_ACTIVE:
            switch (event){
                case TRANSITION_START:
                    mesh_server_transition_state_update(transition, current_timestamp);
                    break;
                case TRANSITION_UPDATE:
                    time_step_ms = current_timestamp - transition->base_transition.phase_start_ms;
                    if (transition->base_transition.remaining_transition_time_ms >= time_step_ms){
                        transition->base_transition.remaining_transition_time_ms -= time_step_ms;
                    } else {
                        transition->base_transition.remaining_transition_time_ms = 0;
                        mesh_server_transition_state_update(transition, current_timestamp);
                    }
                    break;
                default:
                    break;
            }
            break;
        default:
            break;
    }
}