/*
 * 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_sensor_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_SENSOR_ATTRIBUTE_H_
#define TASK_INC_TASK_SENSOR_ATTRIBUTE_H_

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

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

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

/********************** typedef **********************************************/
/* Sensor Statechart - State Transition Table */
/* +-------------------+----------------+-------------+-------------------+-----------------------+
 * | Current           | Event          |             | Next              |                       |
 * | State             | (Parameters)   | [Guard]     | State             | Actions               |
 * |===================+================+=============+===================+=======================|
 * | INICIAL           |                |             | ST_BTN_XX_UP      |                       |
 * |-------------------+----------------+-------------+-------------------+-----------------------|
 * | ST_BTN_XX_UP      | EV_BTN_XX_UP   |             | ST_BTN_XX_UP      |                       |
 * |                   +----------------+-------------+-------------------+-----------------------|
 * |                   | EV_BTN_XX_DOWN |             | ST_BTN_XX_FALLING | tick = TICK_MAX       |
 * |-------------------+----------------+-------------+-------------------+-----------------------|
 * | ST_BTN_XX_FALLING | EV_BTN_XX_UP   | [tick == 0] | ST_BTN_XX_UP      |                       |
 * |                   |                +-------------+-------------------+-----------------------|
 * |                   |                | [tick >  0] | ST_BTN_XX_FALLING | tick--                |
 * |                   +----------------+-------------+-------------------+-----------------------|
 * |                   | EV_BTN_XX_DOWN | [tick == 0] | ST_BTN_XX_DOWN    | put_event_task_system |
 * |                   |                |             |                   |  (event)              |
 * |                   |                +-------------+-------------------+-----------------------|
 * |                   |                | [tick >  0] | ST_BTN_XX_FALLING | tick--                |
 * |-------------------+----------------+-------------+-------------------+-----------------------|
 * | ST_BTN_XX_DOWN    | EV_BTN_XX_UP   |             | ST_BTN_XX_RISING  | tick = TICK_MAX       |
 * |                   +----------------+-------------+-------------------+-----------------------|
 * |                   | EV_BTN_XX_DOWN |             | ST_BTN_XX_DOWN    |                       |
 * |-------------------+----------------+-------------+-------------------+-----------------------|
 * | ST_BTN_XX_RISING  | EV_BTN_XX_UP   | [tick == 0] | ST_BTN_XX_UP      | put_event_task_system |
 * |                   |                |             |                   |  (event)              |
 * |                   |                +-------------+-------------------+-----------------------|
 * |                   |                | [tick >  0] | ST_BTN_XX_RISING  | tick--                |
 * |                   +----------------+-------------+-------------------+-----------------------|
 * |                   | EV_BTN_XX_DOWN | [tick == 0] | ST_BTN_XX_DOWN    |                       |
 * |                   |                +-------------+-------------------+-----------------------|
 * |                   |                | [tick >  0] | ST_BTN_XX_RISING  | tick--                |
 * +-------------------+----------------+-------------+-------------------+-----------------------+
 */

/* Events to excite Task Sensor */
typedef enum
{
    EV_BTN_XX_UP,
    EV_BTN_XX_DOWN
} task_sensor_ev_t;

/* States of Task Sensor */
typedef enum
{
    ST_BTN_XX_UP,
    ST_BTN_XX_FALLING,
    ST_BTN_XX_DOWN,
    ST_BTN_XX_RISING
} task_sensor_st_t;

/* Identifier of Task Sensor */
typedef enum
{
    ID_BTN_A
} task_sensor_id_t;

typedef struct
{
    task_sensor_id_t identifier;
    GPIO_TypeDef *   gpio_port;
    uint16_t         pin;
    GPIO_PinState    pressed;
    uint32_t         tick_max;
    task_sensor_ev_t signal_up;
    task_sensor_ev_t signal_down;
} task_sensor_cfg_t;

typedef struct
{
    uint32_t         tick;
    task_sensor_st_t state;
    task_sensor_ev_t event;
} task_sensor_dta_t;

/********************** external data declaration ****************************/
extern task_sensor_dta_t task_sensor_dta_list[];

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

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

#endif /* TASK_INC_TASK_SENSOR_ATTRIBUTE_H_ */

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