app_transition.h

/* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * 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, except as embedded into a Nordic
 * Semiconductor ASA integrated circuit in a product or a software update for
 * such product, 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 Nordic Semiconductor ASA nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 * Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 * engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA 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.
 */

#ifndef APP_TRANSITION_H__
#define APP_TRANSITION_H__

#include <stdint.h>

#include "app_timer.h"
#include "model_common.h"
#include "fsm.h"
#include "timer_scheduler.h"

typedef enum
{
 APP_TRANSITION_TYPE_SET,
 APP_TRANSITION_TYPE_DELTA_SET,
 APP_TRANSITION_TYPE_MOVE_SET,
 APP_TRANSITION_TYPE_NONE
} app_transition_type_t;

/* Transition parameters */
typedef struct
{
 uint32_t transition_time_ms;
 int32_t required_delta;
 uint32_t minimum_step_ms;
 app_transition_type_t transition_type;
} app_transition_params_t;


typedef struct __app_transition_t app_transition_t;

typedef void (*app_transition_delay_start_cb_t)(const app_transition_t * p_transition);

typedef void (*app_transition_transition_start_cb_t)(const app_transition_t * p_transition);

typedef void (*app_transition_transition_tick_cb_t)(const app_transition_t * p_transition);

typedef void (*app_transition_transition_complete_cb_t)(const app_transition_t * p_transition);

struct __app_transition_t
{
 app_transition_delay_start_cb_t delay_start_cb;
 app_transition_transition_start_cb_t transition_start_cb;
 app_transition_transition_tick_cb_t transition_tick_cb;
 app_transition_transition_complete_cb_t transition_complete_cb;

 app_transition_params_t requested_params;
 app_transition_params_t ongoing_params;

 uint32_t delay_ms;

 model_timer_t timer;
 timer_event_t delay_timer;
 void * p_context;
 fsm_t fsm;
};

uint32_t app_transition_remaining_time_get(app_transition_t * p_transition);

uint32_t app_transition_elapsed_time_get(app_transition_t * p_transition);

bool app_transition_time_complete_check(app_transition_t * p_transition);

void app_transition_trigger(app_transition_t * p_transition);

void app_transition_abort(app_transition_t *p_transition);

uint32_t app_transition_init(app_transition_t * p_transition);

static inline app_transition_params_t * app_transition_requested_get(app_transition_t * p_transition)
{
 return &p_transition->requested_params;
}

static inline app_transition_params_t * app_transition_ongoing_get(app_transition_t * p_transition)
{
 return &p_transition->ongoing_params;
}

#endif /* APP_TRANSITION_H__ */