hmi.h

Go to the documentation of this file.

/*
 * Copyright 2016 Sebastian Neuser
 *
 * This file is part of the uMIDI firmware.
 *
 * the uMIDI firmware is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * The uMIDI firmware is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with the uMIDI firmware.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _HMI_H
#define _HMI_H


//---------------- includes ----------------//
#include <stdbool.h>
#include <stdint.h>

#include "gpio.h"


//---------------- constants ----------------//


//---------------- data types ----------------//
typedef uint8_t hmi_led_pattern_t;

enum hmi_led
{
    HMI_LED1 = 1,           
    HMI_LED2 = 3,           
    HMI_LED3 = 5,           
    HMI_LED4 = 7,           
    HMI_LED5 = 6,           
    HMI_LED6 = 4,           
    HMI_LED7 = 2,           
    HMI_LED8 = 0            
};

enum hmi_bar_graph_percentage
{
    HMI_BAR_000_PERCENT,    
    HMI_BAR_013_PERCENT,    
    HMI_BAR_025_PERCENT,    
    HMI_BAR_038_PERCENT,    
    HMI_BAR_050_PERCENT,    
    HMI_BAR_063_PERCENT,    
    HMI_BAR_075_PERCENT,    
    HMI_BAR_088_PERCENT,    
    HMI_BAR_100_PERCENT     
};

struct hmi_config
{
    const struct gpio_header* input_header;     
    const struct gpio_header* output_header;    
    void (* button1_handler)(void);             
    void (* button2_handler)(void);             
    void (* encoder1cw_handler)(void);          
    void (* encoder1ccw_handler)(void);         
    void (* encoder1push_handler)(void);        
    void (* encoder2cw_handler)(void);          
    void (* encoder2ccw_handler)(void);         
    void (* encoder2push_handler)(void);        
};


//---------------- functions and procedures ----------------//

void init_hmi_module(const struct hmi_config* config);

void show_bar_graph(enum hmi_bar_graph_percentage percentage);

void show_led_pattern(hmi_led_pattern_t pattern);

void set_hmi_led(enum hmi_led led, bool value);

void poll_hmi(void);


//---------------- EOF ----------------//
#endif // _HMI_H