2013-09-29 08:33:29 -04:00
|
|
|
//
|
|
|
|
// FILE: AnalogPin.cpp
|
|
|
|
// AUTHOR: Rob Tillaart
|
2021-12-12 09:57:24 -05:00
|
|
|
// VERSION: 0.2.6
|
2020-11-27 05:10:47 -05:00
|
|
|
// DATE: 2013-09-09
|
|
|
|
// PURPOSE: wrapper for analogRead with smoothing and noise filtering
|
2014-12-07 15:11:55 -05:00
|
|
|
//
|
2021-10-17 13:20:48 -04:00
|
|
|
// HISTORY:
|
|
|
|
// 0.1.00 2013-09-09 initial version
|
|
|
|
// 0.1.01 2013-11-09 added some comments
|
|
|
|
// 0.1.02 2014-10-05 changed signatures data types
|
|
|
|
// 0.1.03 2014-12-07 some refactor
|
|
|
|
// 0.1.04 2015-03-06 refactor smaller footprint
|
|
|
|
// 0.2.00 2015-05-14 added pre-scale support
|
|
|
|
// 0.2.01 2015-12-19 breaking interface; big refactor;
|
|
|
|
// 0.2.2 2020-03-25 refactor AVR specific code; bugfix
|
|
|
|
// 0.2.3 2020-05-27 update library.json
|
|
|
|
// 0.2.4 2020-12-10 add Arduino-ci
|
|
|
|
// 0.2.5 2021-10-17 update Arduino-CI
|
2021-12-12 09:57:24 -05:00
|
|
|
// 0.2.6 2021-12-12 update library.json, license, minor edits.
|
2021-10-17 13:20:48 -04:00
|
|
|
|
2013-09-29 08:33:29 -04:00
|
|
|
|
|
|
|
#include "AnalogPin.h"
|
|
|
|
|
2021-10-17 13:20:48 -04:00
|
|
|
|
2015-03-06 08:26:17 -05:00
|
|
|
AnalogPin::AnalogPin(const uint8_t pin)
|
2013-09-29 08:33:29 -04:00
|
|
|
{
|
2021-01-29 06:31:58 -05:00
|
|
|
_pin = pin;
|
|
|
|
_prescale = 7;
|
|
|
|
_alpha = 0;
|
|
|
|
_noise = 0;
|
2021-10-17 13:20:48 -04:00
|
|
|
_rawRead();
|
2021-01-29 06:31:58 -05:00
|
|
|
_prevValue = _value;
|
2013-09-29 08:33:29 -04:00
|
|
|
}
|
|
|
|
|
2021-10-17 13:20:48 -04:00
|
|
|
|
|
|
|
void AnalogPin::setPrescaler(const uint8_t prescale)
|
|
|
|
{
|
|
|
|
_prescale = prescale;
|
|
|
|
if (_prescale < 2) _prescale = 2;
|
|
|
|
else if (_prescale > 7) _prescale = 7;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
void AnalogPin::setSmoothWeight(const uint8_t alpha)
|
|
|
|
{
|
|
|
|
_alpha = alpha;
|
|
|
|
if (_alpha > 31) _alpha = 31;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2020-11-27 05:10:47 -05:00
|
|
|
int AnalogPin::read(const bool twice)
|
2013-09-29 08:33:29 -04:00
|
|
|
{
|
2021-10-17 13:20:48 -04:00
|
|
|
if (twice) _rawRead();
|
|
|
|
_rawRead();
|
2021-01-29 06:31:58 -05:00
|
|
|
if ( (_noise == 0) || (((_value - _prevValue) & 0x7FFF) > _noise) )
|
|
|
|
{
|
|
|
|
_prevValue = _value;
|
|
|
|
}
|
|
|
|
return _prevValue;
|
2013-09-29 08:33:29 -04:00
|
|
|
}
|
|
|
|
|
2021-10-17 13:20:48 -04:00
|
|
|
|
2020-11-27 05:10:47 -05:00
|
|
|
int AnalogPin::readSmoothed()
|
2013-09-29 08:33:29 -04:00
|
|
|
{
|
2021-10-17 13:20:48 -04:00
|
|
|
_rawRead();
|
2021-01-29 06:31:58 -05:00
|
|
|
if (_alpha > 0)
|
|
|
|
{
|
|
|
|
_value = _value + (_alpha * (_prevValue - _value)) / 32;
|
|
|
|
}
|
|
|
|
_prevValue = _value;
|
|
|
|
return _value;
|
2013-09-29 08:33:29 -04:00
|
|
|
}
|
2014-12-07 15:11:55 -05:00
|
|
|
|
2021-10-17 13:20:48 -04:00
|
|
|
|
|
|
|
void AnalogPin::_rawRead()
|
2014-12-07 15:11:55 -05:00
|
|
|
{
|
2020-11-27 05:10:47 -05:00
|
|
|
#if defined(ARDUINO_ARCH_AVR)
|
2021-01-29 06:31:58 -05:00
|
|
|
// remember old register value
|
|
|
|
uint8_t ADCSRA_TMP = ADCSRA;
|
|
|
|
ADCSRA = (ADCSRA | 0x07) & (0xF8 | _prescale);
|
2020-11-27 05:10:47 -05:00
|
|
|
#elif defined(ARDUINO_ARCH_SAM)
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2020-11-27 05:10:47 -05:00
|
|
|
#else
|
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
#endif
|
|
|
|
|
|
|
|
_value = analogRead(_pin);
|
|
|
|
|
2020-11-27 05:10:47 -05:00
|
|
|
#if defined(ARDUINO_ARCH_AVR)
|
2021-01-29 06:31:58 -05:00
|
|
|
// restore register
|
|
|
|
ADCSRA = ADCSRA_TMP;
|
2020-11-27 05:10:47 -05:00
|
|
|
#elif defined(ARDUINO_ARCH_SAM)
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2020-11-27 05:10:47 -05:00
|
|
|
#else
|
2021-01-29 06:31:58 -05:00
|
|
|
|
|
|
|
#endif
|
2014-12-07 15:11:55 -05:00
|
|
|
}
|
2020-11-27 05:10:47 -05:00
|
|
|
|
2021-12-12 09:57:24 -05:00
|
|
|
|
2020-11-27 05:10:47 -05:00
|
|
|
// -- END OF FILE --
|
2021-12-12 09:57:24 -05:00
|
|
|
|