Library for manual Encoders as used in user interfaces. Very simple, reduced and rock solid encoder library. Counts full pulses only. Inherent debouncing through state machine. Running on a regular timer IRQ. No IRQ jamming through bouncing. Immune to false edges giving unwanted counts when moving partial steps. Not depending on PinDetect or anything else. May be enhanced by adding acceleration and push button debouncing in the future.

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers EncoderConfig.h Source File

EncoderConfig.h

00001 // Encoder lib for user interfaces
00002 // Use this file for configuring the pins, timings etc.
00003 /*
00004 The MIT License (MIT)
00005 
00006 Copyright (c) 2014 calima engineering
00007 
00008 Permission is hereby granted, free of charge, to any person obtaining a copy
00009 of this software and associated documentation files (the "Software"), to deal
00010 in the Software without restriction, including without limitation the rights
00011 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00012 copies of the Software, and to permit persons to whom the Software is
00013 furnished to do so, subject to the following conditions:
00014 
00015 The above copyright notice and this permission notice shall be included in
00016 all copies or substantial portions of the Software.
00017 
00018 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00019 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00020 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00021 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00022 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00023 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00024 THE SOFTWARE.
00025 */
00026 
00027 #ifndef ENCODER_CONFIG_H_
00028 #define ENCODER_CONFIG_H_
00029 
00030 #include "project.h"
00031 
00032 // Chose encoder pins
00033 // First tested with Nucleo STM32F302
00034 #define ENCODER_PIN_A D6
00035 #define ENCODER_PIN_B D7
00036 #define ENCODER_PIN_PB D5
00037 
00038 // Sample every ... microseconds, default
00039 // 250µs is a good value for cheap 24 ppr encoders (ALPS EC12E24...) with strong bouncing.
00040 // 1000µs is a good value for quality 24 ppr encoders (ALPS EC12E24...) with low bouncing.
00041 // 250µs is a good value for fast 24+ ppr encoders (Sparkfun, Some Bourns types, ...).
00042 #define ENCODER_SAMPLE_PERIOD_US (250)
00043 
00044 // Pushbutton debouncing in milliseconds
00045 #define ENCODER_PB_DEBOUNCE_MS (125uL)
00046 
00047 
00048 #endif // ENCODER_CONFIG_H_