Serial Wombat Arduino Library
Public Member Functions | List of all members
SerialWombatProcessedInputPin Class Reference

A Class which reads data from another pin's public data and runs it through SerialWombatAbstractInputProcessing . No physical output. Designed for testing. More...

#include <SerialWombatProcessedInputPin.h>

Inheritance diagram for SerialWombatProcessedInputPin:
SerialWombatPin SerialWombatAbstractProcessedInput

Public Member Functions

 SerialWombatProcessedInputPin (SerialWombatChip &serialWombat)
 Class constructor for SerialWombatPulseTimer. More...
 
int16_t begin (uint8_t pin, uint8_t dataSourcePin)
 Initialize by providing the pin or public data source to read data from. More...
 
int16_t begin (uint8_t pin, SerialWombatDataSource dataSource)
 
uint8_t pin ()
 
uint8_t swPinModeNumber ()
 
- Public Member Functions inherited from SerialWombatPin
 SerialWombatPin (SerialWombatChip &serialWombatChip)
 Instantiates a Serial Wombat Pin. More...
 
 SerialWombatPin (SerialWombatChip &serialWombatChip, uint8_t pin)
 Instantiates a Serial Wombat Pin. More...
 
uint16_t readPublicData ()
 Read the 16 Bit public data associated with this pin. More...
 
void pinMode (uint8_t mode)
 Set pin to INPUT or OUTPUT. More...
 
void pinMode (uint8_t mode, bool pullDown, bool openDrain)
 Set pin to INPUT or OUTPUT, with options for pull Ups and open Drain settings. More...
 
void digitalWrite (uint8_t val)
 Set output pin High or Low. More...
 
int digitalRead ()
 Reads the state of the Pin. More...
 
uint16_t writePublicData (uint16_t value)
 Write a 16 bit value to this pin. More...
 
uint8_t pin ()
 Returns the current SW pin number. Used primarily for virtual calls by derived classes. More...
 
uint8_t swPinModeNumber ()
 Returns the Mode number. Used primarily by derived classes to populate packet data. More...
 
- Public Member Functions inherited from SerialWombatAbstractProcessedInput
 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 ()
 

Additional Inherited Members

- Public Types inherited from SerialWombatAbstractProcessedInput
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 }
 
- Protected Attributes inherited from SerialWombatPin
uint8_t _pin = 255
 
SerialWombatChip_sw
 
uint8_t _pinMode = 0
 

Detailed Description

A Class which reads data from another pin's public data and runs it through SerialWombatAbstractInputProcessing . No physical output. Designed for testing.

Constructor & Destructor Documentation

◆ SerialWombatProcessedInputPin()

SerialWombatProcessedInputPin::SerialWombatProcessedInputPin ( SerialWombatChip serialWombat)

Class constructor for SerialWombatPulseTimer.

Parameters
serialWombatThe Serial Wombat chip on which the SerialWombatPulseTimer pinmode will be run

Member Function Documentation

◆ begin() [1/2]

int16_t SerialWombatProcessedInputPin::begin ( uint8_t  pin,
SerialWombatDataSource  dataSource 
)
inline

◆ begin() [2/2]

int16_t SerialWombatProcessedInputPin::begin ( uint8_t  pin,
uint8_t  dataSourcePin 
)

Initialize by providing the pin or public data source to read data from.

This initialization takes a Serial Wombat pin as a parameter, sets units to uS and disables pull-ups

Parameters
pinpin or public data source to read data from.

◆ pin()

uint8_t SerialWombatProcessedInputPin::pin ( )
inlinevirtual

◆ swPinModeNumber()

uint8_t SerialWombatProcessedInputPin::swPinModeNumber ( )
inlinevirtual