jogwheel.h File Reference

#include <inttypes.h>

Go to the source code of this file.

Classes
struct	_jogwheel_config_t

Macros
#define	JOGWHEEL_FLG_INV_DIR   0x01
#define	JOGWHEEL_FLG_INV_ENC   0x02
#define	JOGWHEEL_FLG_INV_E12   0x04
#define	JOGWHEEL_FLG_2PULSES   0x08
#define	JOGWHEEL_DEF_FLG   (JOGWHEEL_FLG_INV_ENC | JOGWHEEL_FLG_2PULSES)

Typedefs
typedef struct _jogwheel_config_t	jogwheel_config_t

Functions
void	jogwheel_init (void)
void	jogwheel_update_1ms (void)
void	jogwheel_encoder_set (int32_t val, int32_t min, int32_t max)

Variables
uint8_t	jogwheel_signals
int32_t	jogwheel_encoder
uint16_t	jogwheel_button_down
uint8_t	jogwheel_changed
jogwheel_config_t	jogwheel_config

Macro Definition Documentation

JOGWHEEL_FLG_INV_DIR

#define JOGWHEEL_FLG_INV_DIR   0x01

JOGWHEEL_FLG_INV_ENC

#define JOGWHEEL_FLG_INV_ENC   0x02

JOGWHEEL_FLG_INV_E12

#define JOGWHEEL_FLG_INV_E12   0x04

JOGWHEEL_FLG_2PULSES

#define JOGWHEEL_FLG_2PULSES   0x08

JOGWHEEL_DEF_FLG

#define JOGWHEEL_DEF_FLG   (JOGWHEEL_FLG_INV_ENC | JOGWHEEL_FLG_2PULSES)

Typedef Documentation

jogwheel_config_t

typedef struct _jogwheel_config_t jogwheel_config_t

Function Documentation

jogwheel_init()

void jogwheel_init

(

void

)

                         {
    gpio_init(jogwheel_config.pinEN1, GPIO_MODE_INPUT, GPIO_PULLUP, GPIO_SPEED_FREQ_LOW);
    gpio_init(jogwheel_config.pinEN2, GPIO_MODE_INPUT, GPIO_PULLUP, GPIO_SPEED_FREQ_LOW);
    gpio_init(jogwheel_config.pinENC, GPIO_MODE_INPUT, GPIO_PULLUP, GPIO_SPEED_FREQ_LOW);
}

Here is the call graph for this function:

Here is the caller graph for this function:

jogwheel_update_1ms()

void jogwheel_update_1ms

(

void

)

                               {
    uint8_t signals = 0;
    if (gpio_get(jogwheel_config.pinENC))
        signals |= 4; //bit 2 - button press
    if (jogwheel_config.flg & JOGWHEEL_FLG_INV_ENC)
        signals ^= 4;
    if (gpio_get(jogwheel_config.pinEN1))
        signals |= 1; //bit 0 - phase0
    if (gpio_get(jogwheel_config.pinEN2))
        signals |= 2; //bit 1 - phase1
    if (jogwheel_config.flg & JOGWHEEL_FLG_INV_E12)
        signals ^= 3;
    if (jogwheel_signals_new != signals) {
        jogwheel_signals_new = signals;
        return;
    }
    uint8_t change = signals ^ jogwheel_signals;
    if (change & 3) //encoder phase signals changed
    {
        uint8_t change2 = jogwheel_signals ^ jogwheel_signals_old;
        int32_t encoder = jogwheel_encoder;
        int32_t dir = (jogwheel_config.flg & JOGWHEEL_FLG_INV_DIR) ? -1 : 1;
        if ((jogwheel_config.flg & JOGWHEEL_FLG_2PULSES)) {
            if (((signals & 3) == 0) || ((signals & 3) == 3)) {
                if (((change & 3) == 1) && ((change2 & 3) == 2))
                    encoder += dir;
                if (((change & 3) == 2) && ((change2 & 3) == 1))
                    encoder -= dir;
            }
        } else {
            if ((change & 1) && (signals & 1) && !(signals & 2))
                encoder += dir;
            if ((change & 2) && (signals & 2) && !(signals & 1))
                encoder -= dir;
        }
        if (encoder < jogwheel_encoder_min)
            encoder = jogwheel_encoder_min;
        if (encoder > jogwheel_encoder_max)
            encoder = jogwheel_encoder_max;
        if (jogwheel_encoder != encoder) {
            jogwheel_encoder = encoder;
            change |= 8; //bit3 means encoder changed
        }
    }
    if (signals & 4)
        jogwheel_button_down++;
    else
        jogwheel_button_down = 0;
    if (change & 7) //encoder phase signals or button changed
    {
        jogwheel_signals_old = jogwheel_signals; //save old signal state
        jogwheel_signals = signals; //update signal state
    }
    if (change & 12) //encoder changed or button changed
    {
        jogwheel_signals_old = jogwheel_signals; //save old signal state
        jogwheel_signals = signals; //update signal state
        jogwheel_changed |= (change >> 2); //synchronization is not necessary because we are inside interrupt
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

jogwheel_encoder_set()

void jogwheel_encoder_set	(	int32_t	val,
		int32_t	min,
		int32_t	max
	)

                                                                 {
    if (min > max)
        return;
    if (val < min)
        val = min;
    if (val > max)
        val = max;
    jogwheel_encoder = val;
    jogwheel_encoder_min = min;
    jogwheel_encoder_max = max;
}

Here is the caller graph for this function:

Variable Documentation

jogwheel_signals

uint8_t jogwheel_signals

jogwheel_encoder

int32_t jogwheel_encoder

jogwheel_button_down

uint16_t jogwheel_button_down

jogwheel_changed

uint8_t jogwheel_changed

jogwheel_config

jogwheel_config_t jogwheel_config