Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions tests/quadrature_encoder_tests.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
#include "doctest.h"
#include "util/quadrature_encoder.hh"

TEST_CASE("Quadrature Encoder") {

using Enc = QuadratureEncoder<>;

Enc encoder{};

// check clockwise
CHECK(encoder.get_motion(true, false) == Enc::None);
CHECK(encoder.get_motion(false, false) == Enc::None);
CHECK(encoder.get_motion(false, true) == Enc::None);
CHECK(encoder.get_motion(true, true) == Enc::CW);

// check clockwise no state change
CHECK(encoder.get_motion(true, false) == Enc::None);
CHECK(encoder.get_motion(true, false) == Enc::None);
CHECK(encoder.get_motion(true, false) == Enc::None);
CHECK(encoder.get_motion(true, false) == Enc::None);

CHECK(encoder.get_motion(false, false) == Enc::None);
CHECK(encoder.get_motion(false, false) == Enc::None);
CHECK(encoder.get_motion(false, false) == Enc::None);
CHECK(encoder.get_motion(false, false) == Enc::None);

CHECK(encoder.get_motion(false, true) == Enc::None);
CHECK(encoder.get_motion(false, true) == Enc::None);
CHECK(encoder.get_motion(false, true) == Enc::None);
CHECK(encoder.get_motion(false, true) == Enc::None);

CHECK(encoder.get_motion(true, true) == Enc::CW);
CHECK(encoder.get_motion(true, true) == Enc::None);
CHECK(encoder.get_motion(true, true) == Enc::None);
CHECK(encoder.get_motion(true, true) == Enc::None);

// check counter-clockwise
CHECK(encoder.get_motion(false, true) == Enc::None);
CHECK(encoder.get_motion(false, false) == Enc::None);
CHECK(encoder.get_motion(true, false) == Enc::None);
CHECK(encoder.get_motion(true, true) == Enc::CCW);

// check with no state change
CHECK(encoder.get_motion(false, true) == Enc::None);
CHECK(encoder.get_motion(false, true) == Enc::None);

CHECK(encoder.get_motion(false, false) == Enc::None);
CHECK(encoder.get_motion(false, false) == Enc::None);

CHECK(encoder.get_motion(true, false) == Enc::None);
CHECK(encoder.get_motion(true, false) == Enc::None);

CHECK(encoder.get_motion(true, true) == Enc::CCW);
CHECK(encoder.get_motion(true, true) == Enc::None);
}
33 changes: 33 additions & 0 deletions util/quadrature_encoder.hh
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
#pragma once

#include <cstdint>

template<bool invert = false>
class QuadratureEncoder {
static constexpr uint8_t valid_ccw = 0b10000111 ^ (invert ? 0xff : 0x00);
static constexpr uint8_t valid_cw = 0b01001011 ^ (invert ? 0xff : 0x00);

uint8_t prev_state{};

public:
enum Direction { None = 0, CW = 1, CCW = -1 };

Direction get_motion(bool state_a, bool state_b) {
const auto cur_state = state_a | (state_b << 1u);

if ((prev_state & 0b11) == cur_state)
return None;

prev_state <<= 2;
prev_state |= cur_state;

switch (prev_state) {
case valid_cw:
return CW;
case valid_ccw:
return CCW;
default:
return None;
}
}
};