encoder.h

Go to the documentation of this file.

/*
 * Copyright 2015 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/>.
 */

/*
 * Header for encoders
*/

#ifndef _ENCODER_H
#define _ENCODER_H


//---------------- includes ----------------//
#include <stdbool.h>
#include "gpio.h"


//---------------- data types ----------------//

enum encoder_action
{
    ENCODER_ACTION_NONE,                
    ENCODER_ACTION_PUSH,                
    ENCODER_ACTION_CW,                  
    ENCODER_ACTION_CCW,                 
};

enum encoder_type
{
    ENCODER_TYPE_3_PHASE = 3,           
    ENCODER_TYPE_4_PHASE = 4,           
};

struct encoder_config
{
    const struct gpio_pin* inputA;      
    const struct gpio_pin* inputB;      
    const struct gpio_pin* inputSwitch; 

    const enum encoder_type type;       

    void (*cw_callback  )(void);        
    void (*ccw_callback )(void);        
    void (*push_callback)(void);        
};

struct encoder_state
{
    bool                inputA;         
    bool                inputB;         
    int8_t              counter;        
};

struct encoder
{
    struct encoder_config   config;     
    struct encoder_state    state;      
};


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

void init_encoder(struct encoder* encoder);

enum encoder_action poll_encoder(struct encoder* encoder);


//---------------- EOF ----------------//
#endif // _ENCODER_H