rotary_encoder.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 David Antliff
 * Copyright 2011 Ben Buxton
 *
 * This file is part of the esp32-rotary-encoder component.
 *
 * esp32-rotary-encoder 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.
 *
 * esp32-rotary-encoder 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 esp32-rotary-encoder.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef ROTARY_ENCODER_H
#define ROTARY_ENCODER_H

#include <stdbool.h>
#include <stdint.h>

#include "freertos/FreeRTOS.h"
#include "freertos/queue.h"
#include "esp_err.h"
#include "driver/gpio.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef int32_t rotary_encoder_position_t;

typedef enum
{
    ROTARY_ENCODER_DIRECTION_NOT_SET = 0,        
    ROTARY_ENCODER_DIRECTION_CLOCKWISE,
    ROTARY_ENCODER_DIRECTION_COUNTER_CLOCKWISE,
} rotary_encoder_direction_t;

// Used internally
#define TABLE_COLS 4
typedef uint8_t table_row_t[TABLE_COLS];

typedef struct
{
    rotary_encoder_position_t position;    
    rotary_encoder_direction_t direction;  
} rotary_encoder_state_t;

typedef struct
{
    gpio_num_t pin_a;                       
    gpio_num_t pin_b;                       
    QueueHandle_t queue;                    
    const table_row_t * table;              
    uint8_t table_state;                    
    volatile rotary_encoder_state_t state;  
} rotary_encoder_info_t;

typedef struct
{
    rotary_encoder_state_t state;  
} rotary_encoder_event_t;

esp_err_t rotary_encoder_init(rotary_encoder_info_t * info, gpio_num_t pin_a, gpio_num_t pin_b);

esp_err_t rotary_encoder_enable_half_steps(rotary_encoder_info_t * info, bool enable);

esp_err_t rotary_encoder_flip_direction(rotary_encoder_info_t * info);

esp_err_t rotary_encoder_uninit(rotary_encoder_info_t * info);

QueueHandle_t rotary_encoder_create_queue(void);

esp_err_t rotary_encoder_set_queue(rotary_encoder_info_t * info, QueueHandle_t queue);

esp_err_t rotary_encoder_get_state(const rotary_encoder_info_t * info, rotary_encoder_state_t * state);

esp_err_t rotary_encoder_reset(rotary_encoder_info_t * info);


#ifdef __cplusplus
}
#endif

#endif  // ROTARY_ENCODER_H