quantum/encoder.c

   1 /*
   2  * Copyright 2018 Jack Humbert <jack.humb@gmail.com>
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include "encoder.h"
  19
  20 #ifndef ENCODER_RESOLUTION
  21   #define ENCODER_RESOLUTION 4
  22 #endif
  23
  24 #ifndef NUMBER_OF_ENCODERS
  25   #error "Number of encoders not defined by NUMBER_OF_ENCODERS"
  26 #endif
  27
  28 #if !defined(ENCODERS_PAD_A) || !defined(ENCODERS_PAD_B)
  29   #error "No encoder pads defined by ENCODERS_PAD_A and ENCODERS_PAD_B"
  30 #endif
  31
  32 static pin_t encoders_pad_a[NUMBER_OF_ENCODERS] = ENCODERS_PAD_A;
  33 static pin_t encoders_pad_b[NUMBER_OF_ENCODERS] = ENCODERS_PAD_B;
  34
  35 static int8_t encoder_LUT[] = { 0, -1, 1, 0, 1, 0, 0, -1, -1, 0, 0, 1, 0, 1, -1, 0 };
  36
  37 static uint8_t encoder_state[NUMBER_OF_ENCODERS] = {0};
  38 static int8_t encoder_value[NUMBER_OF_ENCODERS] = {0};
  39
  40 __attribute__ ((weak))
  41 void encoder_update_user(int8_t index, bool clockwise) { }
  42
  43 __attribute__ ((weak))
  44 void encoder_update_kb(int8_t index, bool clockwise) {
  45   encoder_update_user(index, clockwise);
  46 }
  47
  48 void encoder_init(void) {
  49   for (int i = 0; i < NUMBER_OF_ENCODERS; i++) {
  50     setPinInputHigh(encoders_pad_a[i]);
  51     setPinInputHigh(encoders_pad_b[i]);
  52
  53     encoder_state[i] = (readPin(encoders_pad_a[i]) << 0) | (readPin(encoders_pad_b[i]) << 1);
  54   }
  55 }
  56
  57 void encoder_read(void) {
  58   for (int i = 0; i < NUMBER_OF_ENCODERS; i++) {
  59     encoder_state[i] <<= 2;
  60     encoder_state[i] |= (readPin(encoders_pad_a[i]) << 0) | (readPin(encoders_pad_b[i]) << 1);
  61     encoder_value[i] += encoder_LUT[encoder_state[i] & 0xF];
  62     if (encoder_value[i] >= ENCODER_RESOLUTION) {
  63         encoder_update_kb(i, COUNTRECLOCKWISE);
  64     }
  65     if (encoder_value[i] <= -ENCODER_RESOLUTION) { // direction is arbitrary here, but this clockwise
  66         encoder_update_kb(i, CLOCKWISE);
  67     }
  68     encoder_value[i] %= ENCODER_RESOLUTION;
  69   }
  70 }