Serial Wombat Arduino Library
Public Types | Public Member Functions | List of all members
SerialWombatAbstractProcessedInput Class Referenceabstract

SerialWombatAnalogInput, SerialWombatPulseTimer, SerialWombatResistanceInput and others inherit from this class. More...

#include <SerialWombatAbstractProcessedInput.h>

Inheritance diagram for SerialWombatAbstractProcessedInput:
SerialWombatAnalogInput_18AB SerialWombatProcessedInputPin SerialWombatUltrasonicDistanceSensor

Public Types

enum  Frequency {
  FREQ_1Hz = 0, FREQ_2Hz = 1, FREQ_4Hz = 2, FREQ_8Hz = 3,
  FREQ_16Hz = 4, FREQ_32Hz = 5, FREQ_64Hz = 6, FREQ_128Hz = 7,
  FREQ_256Hz = 8, FREQ_512Hz = 9, FREQ_1024Hz = 10
}
 
enum  OutputValue { RAW = 0, AVERAGE = 1, FIRST_ORDER_FILTERED = 2 }
 
enum  Transform { NONE = 0, SCALE_RANGE = 1, LINEAR_MXB = 2 }
 

Public Member Functions

 SerialWombatAbstractProcessedInput (SerialWombatChip &sw)
 Constructor for the SerialWombatAbstractScaledOutput Class. More...
 
int16_t writeInverted (bool inverted)
 
int16_t writeFirstOrderFilteringConstant (uint16_t constant)
 
int16_t writeAveragingNumberOfSamples (uint16_t numberOfSamples)
 
int16_t writeExcludeBelowAbove (uint16_t low, uint16_t high)
 
int16_t configureQueue (SerialWombatQueue *queue, Frequency frequency, bool queueHighByte=true, bool queueLowByte=true)
 
int16_t configureOutputValue (OutputValue outputValue)
 
int16_t configureTransformScaleRange (uint16_t min, uint16_t max)
 
int16_t configureTransformLinearMXB (int32_t m, int32_t b)
 
int16_t writeProcessedInputEnable (bool enabled)
 
uint16_t readMinimum (bool reset=false)
 
uint16_t readMaximum (bool reset=false)
 
uint16_t readAverage ()
 
uint16_t readFiltered ()
 
virtual uint8_t pin ()=0
 
virtual uint8_t swPinModeNumber ()=0
 

Detailed Description

SerialWombatAnalogInput, SerialWombatPulseTimer, SerialWombatResistanceInput and others inherit from this class.

Member Enumeration Documentation

◆ Frequency

Enumerator
FREQ_1Hz 
FREQ_2Hz 
FREQ_4Hz 
FREQ_8Hz 
FREQ_16Hz 
FREQ_32Hz 
FREQ_64Hz 
FREQ_128Hz 
FREQ_256Hz 
FREQ_512Hz 
FREQ_1024Hz 

◆ OutputValue

Enumerator
RAW 
AVERAGE 
FIRST_ORDER_FILTERED 

◆ Transform

Enumerator
NONE 
SCALE_RANGE 
LINEAR_MXB 

Constructor & Destructor Documentation

◆ SerialWombatAbstractProcessedInput()

SerialWombatAbstractProcessedInput::SerialWombatAbstractProcessedInput ( SerialWombatChip sw)

Constructor for the SerialWombatAbstractScaledOutput Class.

Parameters
swA reference to a previously declared SerialWombatPin to which the output is connected.

Member Function Documentation

◆ configureOutputValue()

int16_t SerialWombatAbstractProcessedInput::configureOutputValue ( OutputValue  outputValue)

◆ configureQueue()

int16_t SerialWombatAbstractProcessedInput::configureQueue ( SerialWombatQueue queue,
Frequency  frequency,
bool  queueHighByte = true,
bool  queueLowByte = true 
)

◆ configureTransformLinearMXB()

int16_t SerialWombatAbstractProcessedInput::configureTransformLinearMXB ( int32_t  m,
int32_t  b 
)

◆ configureTransformScaleRange()

int16_t SerialWombatAbstractProcessedInput::configureTransformScaleRange ( uint16_t  min,
uint16_t  max 
)

◆ pin()

virtual uint8_t SerialWombatAbstractProcessedInput::pin ( )
pure virtual

◆ readAverage()

uint16_t SerialWombatAbstractProcessedInput::readAverage ( )

◆ readFiltered()

uint16_t SerialWombatAbstractProcessedInput::readFiltered ( )

◆ readMaximum()

uint16_t SerialWombatAbstractProcessedInput::readMaximum ( bool  reset = false)

◆ readMinimum()

uint16_t SerialWombatAbstractProcessedInput::readMinimum ( bool  reset = false)

◆ swPinModeNumber()

virtual uint8_t SerialWombatAbstractProcessedInput::swPinModeNumber ( )
pure virtual

◆ writeAveragingNumberOfSamples()

int16_t SerialWombatAbstractProcessedInput::writeAveragingNumberOfSamples ( uint16_t  numberOfSamples)

◆ writeExcludeBelowAbove()

int16_t SerialWombatAbstractProcessedInput::writeExcludeBelowAbove ( uint16_t  low,
uint16_t  high 
)

◆ writeFirstOrderFilteringConstant()

int16_t SerialWombatAbstractProcessedInput::writeFirstOrderFilteringConstant ( uint16_t  constant)

◆ writeInverted()

int16_t SerialWombatAbstractProcessedInput::writeInverted ( bool  inverted)

◆ writeProcessedInputEnable()

int16_t SerialWombatAbstractProcessedInput::writeProcessedInputEnable ( bool  enabled)