 |
Serial Wombat Arduino Library
|
|
Serial Wombat Arduino Library
|
This class extends SerialWombatAnalogInput with SW18AB specific capabilities. More...
#include <SerialWombatAnalogInput.h>
Public Member Functions | |
| SerialWombatAnalogInput_18AB (SerialWombatChip &serialWombat) | |
| uint8_t | pin () |
| Used for inheritance. More... | |
| uint8_t | swPinModeNumber () |
| Used for ineheritance. More... | |
 Public Member Functions inherited from SerialWombatAnalogInput | |
| SerialWombatAnalogInput (SerialWombatChip &SerialWombatChip) | |
| Constructor for the SerialWombatAnalogInput class. More... | |
| int16_t | begin (uint8_t pin, uint16_t averageSamples=64, uint16_t filterConstant=0xFF80, AnalogInputPublicDataOutput output=AnalogInputPublicDataOutput::AnalogInputPublicDataOutput_Raw) |
| Initialize an analog input on a given pin. More... | |
| uint16_t | readVoltage_mV () |
| Retreive a raw A/D measurement and convert it to mV. More... | |
| uint16_t | readCounts () |
| Retreive a raw A/D measurement. More... | |
| uint16_t | readFiltered_mV () |
| Retreive a filtered A/D measurement and convert it to mV. More... | |
| uint16_t | readFilteredCounts () |
| Retreive a filtered A/D measurement. More... | |
| uint16_t | readAveraged_mV () |
| Retreive an averaged A/D measurement and convert it to mV. More... | |
| uint16_t | readAveragedCounts () |
| Retreive an averaged A/D measurement. More... | |
| uint16_t | updateSupplyVoltage_mV () |
| Provides a wrapper around the readSupplyVoltage_mV() method for the SerialWombat chip hosting this pin mode. More... | |
| uint16_t | readMaximum_mV (bool resetAfterRead=false) |
| Retreive the maximum single sample A/D value in mV. More... | |
| uint16_t | readMaximumCounts (bool resetAfterRead=false) |
| uint16_t | readMinimum_mV (bool resetAfterRead=false) |
| uint16_t | readMinimumCounts (bool resetAfterRead=false) |
| Retreive the maximum single sample A/D value in counts. More... | |
| 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, bool pullDown=false, bool openDrain=false) |
| 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) |
| if enabled subtract the input value from 65535 before doing any other processing. More... | |
| int16_t | writeFirstOrderFilteringConstant (uint16_t constant) |
| Set a first order filtering constant to be applied to the signal Higher is heavier filtering. More... | |
| int16_t | writeAveragingNumberOfSamples (uint16_t numberOfSamples) |
| Set a number of samples to average for each update of the downstream signal. More... | |
| int16_t | writeExcludeBelowAbove (uint16_t low, uint16_t high) |
| Sets input value ranges which are discarded rather than processed. More... | |
| int16_t | configureQueue (SerialWombatQueue *queue, Period period, bool queueHighByte=true, bool queueLowByte=true) |
| Sets up the queueing feature for this pin mode. Queue must have been initialized prior to this queue. More... | |
| int16_t | configureOutputValue (OutputValue outputValue) |
| Configures whether the pin's public data value is averaged, filtered, or neither. More... | |
| int16_t | writeTransformScaleRange (uint16_t min, uint16_t max) |
| Scale incoming values to a range of 0 to 65535. More... | |
| int16_t | writeTransformLinearMXB (int32_t m, int32_t b) |
| Scale incoming values based on an mx+b linear equation. More... | |
| int16_t | configureIntegrator (uint16_t negativeMaxIndex, uint16_t negativeMidIndex, uint16_t negativeDeadZone, uint16_t positiveDeadZone, uint16_t positiveMidIndex, uint16_t positiveMaxIndex, uint16_t midIncrement, uint16_t maxIncrement, uint16_t initialValue, uint8_t updateFrequencyMask=0) |
| Sort incoming data into one of 5 ranges, and integrate based on linear interpolation in those ranges. More... | |
| int16_t | writeProcessedInputEnable (bool enabled) |
| Enables or disables all input processing functions If disabled, the raw input value is placed directly in the pin's 16 bit public data buffer. More... | |
| uint16_t | readMinimum (bool resetAfterRead=false) |
| Retreive the maximum public data output value since the last call with reset= true. More... | |
| uint16_t | readMaximum (bool resetAfterRead=false) |
| Retreive the minimum public data output value since the last call with reset= true. More... | |
| uint16_t | readAverage () |
| Retreive the last completed averaged value. More... | |
| uint16_t | readFiltered () |
| Retreive the filtered value. More... | |
Additional Inherited Members | |
| Public Types inherited from SerialWombatAbstractProcessedInput | |
| enum | Period { PERIOD_1mS = 0, PERIOD_2mS = 1, PERIOD_4mS = 2, PERIOD_8mS = 3, PERIOD_16mS = 4, PERIOD_32mS = 5, PERIOD_64mS = 6, PERIOD_128mS = 7, PERIOD_256mS = 8, PERIOD_512mS = 9, PERIOD_1024mS = 10 } |
| enum | OutputValue { RAW = 0, FIRST_ORDER_FILTERED = 1, AVERAGE = 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 |
This class extends SerialWombatAnalogInput with SW18AB specific capabilities.
|
inline |
|
inlinevirtual |
Used for inheritance.
Implements SerialWombatAbstractProcessedInput.
|
inlinevirtual |
Used for ineheritance.
Implements SerialWombatAbstractProcessedInput.
1.8.17