@ -0,0 +1,41 @@ | |||
# Encoders | |||
Basic encoders are supported by adding this to your `rules.mk`: | |||
ENCODER_ENABLE = yes | |||
and this to your `config.h`: | |||
#define NUMBER_OF_ENCODERS 1 | |||
#define ENCODERS_PAD_A { B12 } | |||
#define ENCODERS_PAD_B { B13 } | |||
Each PAD_A/B variable defines an array so multiple encoders can be defined, e.g.: | |||
#define ENCODERS_PAD_A { encoder1a, encoder2a } | |||
#define ENCODERS_PAD_B { encoder1a, encoder2b } | |||
If your encoder's clockwise directions are incorrect, you can swap the A & B pad definitions. | |||
Additionally, the resolution can be specified in the same file (the default & suggested is 4): | |||
#define ENCODER_RESOLUTION 4 | |||
## Callbacks | |||
The callback functions can be inserted into your `<keyboard>.c`: | |||
void encoder_update_kb(uint8_t index, bool clockwise) { | |||
encoder_update_user(index, clockwise); | |||
} | |||
or `keymap.c`: | |||
void encoder_update_user(uint8_t index, bool clockwise) { | |||
} | |||
## Hardware | |||
The A an B lines of the encoders should be wired directly to the MCU, and the C/common lines should be wired to ground. |
@ -0,0 +1,70 @@ | |||
/* | |||
* Copyright 2018 Jack Humbert <jack.humb@gmail.com> | |||
* | |||
* This program 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 2 of the License, or | |||
* (at your option) any later version. | |||
* | |||
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>. | |||
*/ | |||
#include "encoder.h" | |||
#ifndef ENCODER_RESOLUTION | |||
#define ENCODER_RESOLUTION 4 | |||
#endif | |||
#ifndef NUMBER_OF_ENCODERS | |||
#error "Number of encoders not defined by NUMBER_OF_ENCODERS" | |||
#endif | |||
#if !defined(ENCODERS_PAD_A) || !defined(ENCODERS_PAD_B) | |||
#error "No encoder pads defined by ENCODERS_PAD_A and ENCODERS_PAD_B" | |||
#endif | |||
static pin_t encoders_pad_a[NUMBER_OF_ENCODERS] = ENCODERS_PAD_A; | |||
static pin_t encoders_pad_b[NUMBER_OF_ENCODERS] = ENCODERS_PAD_B; | |||
static int8_t encoder_LUT[] = { 0, -1, 1, 0, 1, 0, 0, -1, -1, 0, 0, 1, 0, 1, -1, 0 }; | |||
static uint8_t encoder_state[NUMBER_OF_ENCODERS] = {0}; | |||
static int8_t encoder_value[NUMBER_OF_ENCODERS] = {0}; | |||
__attribute__ ((weak)) | |||
void encoder_update_user(int8_t index, bool clockwise) { } | |||
__attribute__ ((weak)) | |||
void encoder_update_kb(int8_t index, bool clockwise) { | |||
encoder_update_user(index, clockwise); | |||
} | |||
void encoder_init(void) { | |||
for (int i = 0; i < NUMBER_OF_ENCODERS; i++) { | |||
setPinInputHigh(encoders_pad_a[i]); | |||
setPinInputHigh(encoders_pad_b[i]); | |||
encoder_state[i] = (readPin(encoders_pad_a[i]) << 0) | (readPin(encoders_pad_b[i]) << 1); | |||
} | |||
} | |||
void encoder_read(void) { | |||
for (int i = 0; i < NUMBER_OF_ENCODERS; i++) { | |||
encoder_state[i] <<= 2; | |||
encoder_state[i] |= (readPin(encoders_pad_a[i]) << 0) | (readPin(encoders_pad_b[i]) << 1); | |||
encoder_value[i] += encoder_LUT[encoder_state[i] & 0xF]; | |||
if (encoder_value[i] >= ENCODER_RESOLUTION) { | |||
encoder_update_kb(i, COUNTRECLOCKWISE); | |||
} | |||
if (encoder_value[i] <= -ENCODER_RESOLUTION) { // direction is arbitrary here, but this clockwise | |||
encoder_update_kb(i, CLOCKWISE); | |||
} | |||
encoder_value[i] %= ENCODER_RESOLUTION; | |||
} | |||
} |
@ -0,0 +1,29 @@ | |||
/* | |||
* Copyright 2018 Jack Humbert <jack.humb@gmail.com> | |||
* | |||
* This program 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 2 of the License, or | |||
* (at your option) any later version. | |||
* | |||
* This program 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 this program. If not, see <http://www.gnu.org/licenses/>. | |||
*/ | |||
#pragma once | |||
#include "quantum.h" | |||
#define COUNTRECLOCKWISE 0 | |||
#define CLOCKWISE 1 | |||
void encoder_init(void); | |||
void encoder_read(void); | |||
void encoder_update_kb(int8_t index, bool clockwise); | |||
void encoder_update_user(int8_t index, bool clockwise); |