32bits encoder counter using 16bits TIM and a 32bits software counter

Dependents:   v1 v2 v2bis GestionPixy ... more

Software 32 bits quadrature encoder interface for STM32 targets

This library is designed to help interface quadrature encoders with STM32 targets. The base idea is to use a timer as a counter with several inputs corresponding to the A and B channels of a quadrature encoder. This is easily done with the new STM32 chips from STMicro, and of course with the Nucleo Boards.

Almost every Nucleo Board has 4 or 5 of those interfaces, that can be routed to several pins (I still have to check with every board to this day). This library provides an easy way to use these quadrature decoders, with an added feature : using software 32 bits integers to stock the counter, allowing a more efficient way to use them. In deed, most of the timers of the Nucleo Boards are 16 bits counters, and thus can limit the possibilities in some projects.

The solution provided here uses the update interrupt of the timer, set when the counter over- or underflows, and updates an 32 bits integer accordingly, allowing to track the encoder activity on a range of -(2^31) to (2^31)-1, or -2147483648 to 2147483647.

Plus, this interface allows to use a simple object, easily instantiated.

Example code

#include "mbed.h"
#include "Nucleo_Encoder_16_bits.h"


Nucleo_Encoder_16_bits encoder1(TIM3);

void main (void)
{
    printf("Start of Nucleo Encoder test program");

    for(;;)
    {
        wait(1.0);
        printf("Encoder count : %l", encoder1.GetCounter());
    }
}

Please check the header file corresponding to your target to get the physical pins to which you have to connect the signals (EncoderMspInitxx.h)

Also, please do not mind the name of the files or objects/methods in this library. Some are named "16 bits", but everything runs using 32 bits soft counters, as said above.

Committer:
kkoichy
Date:
Thu May 26 16:21:43 2016 +0000
Revision:
1:e82009479b5c
Parent:
0:ebd170807e11
V1.1 :; - Added one constructor with only one parameter

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kkoichy 0:ebd170807e11 1 #include "mbed.h"
kkoichy 0:ebd170807e11 2 /*
kkoichy 0:ebd170807e11 3 * HAL_TIM_Encoder_MspInit()
kkoichy 0:ebd170807e11 4 * Overrides the __weak function stub in stm32f0xx_hal_tim.h
kkoichy 0:ebd170807e11 5 *
kkoichy 0:ebd170807e11 6 * Edit the below for your preferred pin wiring & pullup/down
kkoichy 0:ebd170807e11 7 * I have encoder common at 3V3, using GPIO_PULLDOWN on inputs.
kkoichy 0:ebd170807e11 8 * Encoder A&B outputs connected directly to GPIOs.
kkoichy 0:ebd170807e11 9 *
kkoichy 0:ebd170807e11 10 * http://www.st.com/st-web-ui/static/active/en/resource/technical/document/datasheet/DM00088500.pdf
kkoichy 0:ebd170807e11 11 * Table 11 has GPIO alternate function pinout mappings.
kkoichy 0:ebd170807e11 12 *
kkoichy 0:ebd170807e11 13 * TIM1_CH1: AF2 @ PA_8 - TIM1 used as system ticker under mbed, so unavailable
kkoichy 0:ebd170807e11 14 * TIM1_CH2: AF2 @ PA_9
kkoichy 0:ebd170807e11 15 *
kkoichy 0:ebd170807e11 16 * TIM3_CH1: AF1 @ PA_6, PB_4; AF0 @ PC_6* *only for F030xC devices
kkoichy 0:ebd170807e11 17 * TIM3_CH2: AF1 @ PA_7, PB_5; AF0 @ PC_7*
kkoichy 0:ebd170807e11 18 *
kkoichy 0:ebd170807e11 19 */
kkoichy 0:ebd170807e11 20
kkoichy 0:ebd170807e11 21 #ifdef TARGET_STM32F0
kkoichy 0:ebd170807e11 22 void HAL_TIM_Encoder_MspInit(TIM_HandleTypeDef *htim)
kkoichy 0:ebd170807e11 23 {
kkoichy 0:ebd170807e11 24 GPIO_InitTypeDef GPIO_InitStruct;
kkoichy 0:ebd170807e11 25
kkoichy 0:ebd170807e11 26 if (htim->Instance == TIM3) { //PB_4 PB_5 = Nucleo D5 D4
kkoichy 0:ebd170807e11 27 __TIM3_CLK_ENABLE();
kkoichy 0:ebd170807e11 28 __GPIOB_CLK_ENABLE();
kkoichy 0:ebd170807e11 29 GPIO_InitStruct.Pin = GPIO_PIN_4 | GPIO_PIN_5;
kkoichy 0:ebd170807e11 30 GPIO_InitStruct.Mode = GPIO_MODE_AF_PP;
kkoichy 0:ebd170807e11 31 GPIO_InitStruct.Pull = GPIO_PULLDOWN;
kkoichy 0:ebd170807e11 32 GPIO_InitStruct.Speed = GPIO_SPEED_HIGH;
kkoichy 0:ebd170807e11 33 GPIO_InitStruct.Alternate = GPIO_AF1_TIM3;
kkoichy 0:ebd170807e11 34 HAL_GPIO_Init(GPIOB, &GPIO_InitStruct);
kkoichy 0:ebd170807e11 35 }
kkoichy 0:ebd170807e11 36 }
kkoichy 0:ebd170807e11 37 #endif