Skip to content

Commit 98c2318

Browse files
committed
rename POSTSCALER -> PRESCALER
1 parent eff9f87 commit 98c2318

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

src/modm/driver/encoder/bitbang_encoder_input.hpp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,18 @@ namespace modm
2626
*
2727
* @tparam SignalA First modm::platform::Gpio pin to input the encoder signal.
2828
* @tparam SignalB Second modm::platform::Gpio pin to input the encoder signal.
29-
* @tparam POSTSCALER n_cycles to count as one in-/decrement.
30-
* @tparam DeltaType Must be signed integer and fit at least POSTSCALER. The Bigger
29+
* @tparam PRESCALER n_cycles to count as one in-/decrement.
30+
* @tparam DeltaType Must be signed integer and fit at least PRESCALER. The Bigger
3131
* DeltaType, the more inc-/decrements can be stored temporarily.
3232
*/
33-
template<typename SignalA, typename SignalB, uint8_t POSTSCALER = 4,
33+
template<typename SignalA, typename SignalB, uint8_t PRESCALER = 4,
3434
std::signed_integral DeltaType = int8_t>
3535
class BitBangEncoderInput
3636
{
37-
static_assert(std::popcount(POSTSCALER) == 1,
38-
"POSTSCALER must be an integer to basis 2 and not 0: 1, 2, 4, 8, 16, ...");
39-
static_assert(POSTSCALER <= std::numeric_limits<DeltaType>::max(),
40-
"DeltaType is to small for POSTSCALER.");
37+
static_assert(std::popcount(PRESCALER) == 1,
38+
"PRESCALER must be an integer to basis 2 and not 0: 1, 2, 4, 8, 16, ...");
39+
static_assert(PRESCALER <= std::numeric_limits<DeltaType>::max(),
40+
"DeltaType is to small for PRESCALER.");
4141

4242
using Signals = modm::platform::SoftwareGpioPort<SignalA, SignalB>;
4343

src/modm/driver/encoder/bitbang_encoder_input_impl.hpp

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515

1616
#include <cmath>
1717

18-
template<typename SignalA, typename SignalB, uint8_t POSTSCALER,
18+
template<typename SignalA, typename SignalB, uint8_t PRESCALER,
1919
std::signed_integral DeltaType>
2020
inline uint8_t
21-
modm::BitBangEncoderInput<SignalA, SignalB, POSTSCALER, DeltaType>::getRaw()
21+
modm::BitBangEncoderInput<SignalA, SignalB, PRESCALER, DeltaType>::getRaw()
2222
{
2323
const uint8_t read = Signals::read();
2424
// convert graycode to binary
@@ -28,10 +28,10 @@ modm::BitBangEncoderInput<SignalA, SignalB, POSTSCALER, DeltaType>::getRaw()
2828
return raw;
2929
}
3030

31-
template<typename SignalA, typename SignalB, uint8_t POSTSCALER,
31+
template<typename SignalA, typename SignalB, uint8_t PRESCALER,
3232
std::signed_integral DeltaType>
3333
inline void
34-
modm::BitBangEncoderInput<SignalA, SignalB, POSTSCALER, DeltaType>::connect()
34+
modm::BitBangEncoderInput<SignalA, SignalB, PRESCALER, DeltaType>::connect()
3535
{
3636
Signals::setInput(::Gpio::InputType::PullUp);
3737

@@ -40,10 +40,10 @@ modm::BitBangEncoderInput<SignalA, SignalB, POSTSCALER, DeltaType>::connect()
4040
raw_last = getRaw();
4141
}
4242

43-
template<typename SignalA, typename SignalB, uint8_t POSTSCALER,
43+
template<typename SignalA, typename SignalB, uint8_t PRESCALER,
4444
std::signed_integral DeltaType>
4545
inline void
46-
modm::BitBangEncoderInput<SignalA, SignalB, POSTSCALER, DeltaType>::update()
46+
modm::BitBangEncoderInput<SignalA, SignalB, PRESCALER, DeltaType>::update()
4747
{
4848
uint8_t raw = getRaw();
4949
const uint8_t diff = raw_last - raw;
@@ -54,16 +54,16 @@ modm::BitBangEncoderInput<SignalA, SignalB, POSTSCALER, DeltaType>::update()
5454
}
5555
}
5656

57-
template<typename SignalA, typename SignalB, uint8_t POSTSCALER,
57+
template<typename SignalA, typename SignalB, uint8_t PRESCALER,
5858
std::signed_integral DeltaType>
5959
DeltaType
60-
modm::BitBangEncoderInput<SignalA, SignalB, POSTSCALER, DeltaType>::getIncrement()
60+
modm::BitBangEncoderInput<SignalA, SignalB, PRESCALER, DeltaType>::getIncrement()
6161
{
6262
::modm::atomic::Lock _;
6363
DeltaType val = delta;
6464

65-
delta &= (POSTSCALER - 1); // mask out higher bits
65+
delta &= (PRESCALER - 1); // mask out higher bits
6666

67-
constexpr uint8_t shift = std::log2(POSTSCALER); // Number of fraction bits
67+
constexpr uint8_t shift = std::log2(PRESCALER); // Number of fraction bits
6868
return val >> shift; // return whats left without fractions
6969
}

src/modm/driver/encoder/encoder_input.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ namespace modm
2121
* @tparam SignalA First modm::platform::Gpio pin that connects to Timer::Ch1
2222
* @tparam SignalB Second modm::platform::Gpio pin that connects to Timer::Ch2
2323
*/
24-
template<class Timer, typename SignalA, typename SignalB, uint16_t POSTSCALER = 4, std::signed_integral ValueType = int8_t>
24+
template<class Timer, typename SignalA, typename SignalB, uint16_t PRESCALER = 4, std::signed_integral ValueType = int8_t>
2525
class EncoderInput
2626
{
2727
public:
@@ -36,7 +36,7 @@ class EncoderInput
3636
Timer::enable();
3737

3838
Timer::setMode(invert ? Timer::Mode::UpCounter : Timer::Mode::DownCounter, Timer::SlaveMode::Encoder3);
39-
Timer::setPrescaler(POSTSCALER);
39+
Timer::setPrescaler(PRESCALER);
4040

4141
if(filter) {
4242
Timer::configureInputChannel(1, filter);

0 commit comments

Comments
 (0)