/*
 * Copyright (c) 2023 Juan Manuel Cruz <jcruz@fi.uba.ar> <jcruz@frba.utn.edu.ar>.
 * 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 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 holder nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 THE
 * COPYRIGHT HOLDER 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.
 *
 * @file   : task_menu_attribute.h
 * @date   : Set 26, 2023
 * @author : Juan Manuel Cruz <jcruz@fi.uba.ar> <jcruz@frba.utn.edu.ar>
 * @version	v1.0.0
 */

#ifndef TASK_INC_TASK_MENU_ATTRIBUTE_H_
#define TASK_INC_TASK_MENU_ATTRIBUTE_H_

/********************** CPP guard ********************************************/
#ifdef __cplusplus
extern "C" {
#endif

/********************** inclusions *******************************************/

/********************** macros ***********************************************/

/********************** typedef **********************************************/
/*
* Menu Statechart - State Transition Table
* 
* +------------------------+-------------------------+---------+-------------------------+----------------------------------------------------------------------+
* | Current State          | Event                   | [Guard] | Next State              | Actions                                                              |
* +------------------------+-------------------------+---------+-------------------------+----------------------------------------------------------------------+
* | ST_MEN_MOTOR_INFO      | EV_MEN_ENT_ACTIVE       |         | ST_MEN_MOTOR_SELECT     | sel_motor = 1                                                        |
* | ST_MEN_MOTOR_INFO      | EV_MEN_NEX_ACTIVE       |         | ST_MEN_MOTOR_SELECT     | sel_motor = 1                                                        |
* | ST_MEN_MOTOR_INFO      | EV_MEN_ESC_ACTIVE       |         | ST_MEN_MOTOR_SELECT     | sel_motor = 1                                                        |
* | ST_MEN_MOTOR_INFO      | EV_MEN_INACTIVE_TIMEOUT |         | ST_MEN_MOTOR_INFO       |                                                                      |
* +------------------------+-------------------------+---------+-------------------------+----------------------------------------------------------------------+
* | ST_MEN_MOTOR_SELECT    | EV_MEN_ENT_ACTIVE       |         | ST_MEN_MOTOR_POWER      |                                                                      |
* | ST_MEN_MOTOR_SELECT    | EV_MEN_NEX_ACTIVE       |         | ST_MEN_MOTOR_SELECT     | sel_motor = (sel_motor % motor_qty) + 1                              |
* | ST_MEN_MOTOR_SELECT    | EV_MEN_ESC_ACTIVE       |         | ST_MEN_MOTOR_INFO       |                                                                      |
* | ST_MEN_MOTOR_SELECT    | EV_MEN_INACTIVE_TIMEOUT |         | ST_MEN_MOTOR_INFO       |                                                                      |
* +------------------------+-------------------------+---------+-------------------------+----------------------------------------------------------------------+
* | ST_MEN_MOTOR_POWER     | EV_MEN_ENT_ACTIVE       |         | ST_MEN_MOTOR_POWER_SEL  | new_sel_motor_pow = sel_motor_pow                                    |
* | ST_MEN_MOTOR_POWER     | EV_MEN_NEX_ACTIVE       |         | ST_MEN_MOTOR_SPEED      |                                                                      |
* | ST_MEN_MOTOR_POWER     | EV_MEN_ESC_ACTIVE       |         | ST_MEN_MOTOR_SELECT     |                                                                      |
* | ST_MEN_MOTOR_POWER     | EV_MEN_INACTIVE_TIMEOUT |         | ST_MEN_MOTOR_INFO       |                                                                      |
* +------------------------+-------------------------+---------+-------------------------+----------------------------------------------------------------------+
* | ST_MEN_MOTOR_POWER_SEL | EV_MEN_ENT_ACTIVE       |         | ST_MEN_MOTOR_POWER      | sel_motor_pow = new_sel_motor_pow                                    |
* | ST_MEN_MOTOR_POWER_SEL | EV_MEN_NEX_ACTIVE       |         | ST_MEN_MOTOR_POWER_SEL  | new_sel_motor_pow = !new_sel_motor_pow                               |
* | ST_MEN_MOTOR_POWER_SEL | EV_MEN_ESC_ACTIVE       |         | ST_MEN_MOTOR_POWER      |                                                                      |
* | ST_MEN_MOTOR_POWER_SEL | EV_MEN_INACTIVE_TIMEOUT |         | ST_MEN_MOTOR_INFO       |                                                                      |
* +------------------------+-------------------------+---------+-------------------------+----------------------------------------------------------------------+
* | ST_MEN_MOTOR_SPEED     | EV_MEN_ENT_ACTIVE       |         | ST_MEN_MOTOR_SPEED_SEL  | new_sel_motor_speed = sel_motor_speed                                |
* | ST_MEN_MOTOR_SPEED     | EV_MEN_NEX_ACTIVE       |         | ST_MEN_MOTOR_SPIN       |                                                                      |
* | ST_MEN_MOTOR_SPEED     | EV_MEN_ESC_ACTIVE       |         | ST_MEN_MOTOR_SELECT     |                                                                      |
* | ST_MEN_MOTOR_SPEED     | EV_MEN_INACTIVE_TIMEOUT |         | ST_MEN_MOTOR_INFO       |                                                                      |
* +------------------------+-------------------------+---------+-------------------------+----------------------------------------------------------------------+
* | ST_MEN_MOTOR_SPEED_SEL | EV_MEN_ENT_ACTIVE       |         | ST_MEN_MOTOR_SPEED      | sel_motor_speed = new_sel_motor_speed                                |
* | ST_MEN_MOTOR_SPEED_SEL | EV_MEN_NEX_ACTIVE       |         | ST_MEN_MOTOR_SPEED_SEL  | new_sel_motor_speed = (new_sel_motor_speed + step) % max_motor_speed |
* | ST_MEN_MOTOR_SPEED_SEL | EV_MEN_ESC_ACTIVE       |         | ST_MEN_MOTOR_SPEED      |                                                                      |
* | ST_MEN_MOTOR_SPEED_SEL | EV_MEN_INACTIVE_TIMEOUT |         | ST_MEN_MOTOR_INFO       |                                                                      |
* +------------------------+-------------------------+---------+-------------------------+----------------------------------------------------------------------+
* | ST_MEN_MOTOR_SPIN      | EV_MEN_ENT_ACTIVE       |         | ST_MEN_MOTOR_SPIN_SEL   | new_sel_motor_spin = sel_motor_spin                                  |
* | ST_MEN_MOTOR_SPIN      | EV_MEN_NEX_ACTIVE       |         | ST_MEN_MOTOR_POWER      |                                                                      |
* | ST_MEN_MOTOR_SPIN      | EV_MEN_ESC_ACTIVE       |         | ST_MEN_MOTOR_SELECT     |                                                                      |
* | ST_MEN_MOTOR_SPIN      | EV_MEN_INACTIVE_TIMEOUT |         | ST_MEN_MOTOR_INFO       |                                                                      |
* +------------------------+-------------------------+---------+-------------------------+----------------------------------------------------------------------+
* | ST_MEN_MOTOR_SPIN_SEL  | EV_MEN_ENT_ACTIVE       |         | ST_MEN_MOTOR_SPIN       | sel_motor_spin = new_sel_motor_spin                                  |
* | ST_MEN_MOTOR_SPIN_SEL  | EV_MEN_NEX_ACTIVE       |         | ST_MEN_MOTOR_SPIN_SEL   | new_sel_motor_spin = !new_sel_motor_spin                             |
* | ST_MEN_MOTOR_SPIN_SEL  | EV_MEN_ESC_ACTIVE       |         | ST_MEN_MOTOR_SPIN       |                                                                      |
* | ST_MEN_MOTOR_SPIN_SEL  | EV_MEN_INACTIVE_TIMEOUT |         | ST_MEN_MOTOR_INFO       |                                                                      |
* +------------------------+-------------------------+---------+-------------------------+----------------------------------------------------------------------+
*/

/* Events to excite Task Menu */
typedef enum {
    EV_MEN_ENT_IDLE,
    EV_MEN_ENT_ACTIVE,

    EV_MEN_NEX_IDLE,
    EV_MEN_NEX_ACTIVE,

    EV_MEN_ESC_IDLE,
    EV_MEN_ESC_ACTIVE,

    EV_MEN_INACTIVE_TIMEOUT
} task_menu_ev_t;

/* State of Task Menu */
typedef enum {
    ST_MEN_MOTOR_INFO,
    ST_MEN_MOTOR_SELECT,
    ST_MEN_MOTOR_POWER,
    ST_MEN_MOTOR_POWER_SEL,
    ST_MEN_MOTOR_SPEED,
    ST_MEN_MOTOR_SPEED_SEL,
    ST_MEN_MOTOR_SPIN,
    ST_MEN_MOTOR_SPIN_SEL
} task_menu_st_t;

typedef struct {
    uint32_t tick;
    task_menu_st_t state;
    task_menu_ev_t event;
    bool flag;
} task_menu_dta_t;

/********************** external data declaration ****************************/
extern task_menu_dta_t task_menu_dta;

/********************** external functions declaration ***********************/

/********************** End of CPP guard *************************************/
#ifdef __cplusplus
}
#endif

#endif /* TASK_INC_TASK_MENU_ATTRIBUTE_H_ */

/********************** end of file ******************************************/
