 |
Serial Wombat Arduino Library
|
@ DUTYCYCLE_ON_LTH_TRANSITION
Duty cycle of the pulse as a ratio from 0 to 65535, updated on low to high transition.
Definition: SerialWombatPulseTimer.h:171
Class for a Serial Wombat chip. Each Serial Wombat chip on a project should have its own instance.
Definition: SerialWombat.h:267
uint16_t readPulses()
Retreives the number of pulses.
Definition: SerialWombatPulseTimer.cpp:61
uint16_t HighCounts
Count in selected units of last retreived high pulse.
Definition: SerialWombatPulseTimer.h:136
@ HIGH_TIME
The pulse high time in uS. Updated on each high to low transition.
Definition: SerialWombatPulseTimer.h:164
bool MeasurementOverflowOccurred
Definition: SerialWombatPulseTimer.h:146
@ FREQUENCY_ON_HTL_TRANSITION
The frequency of the pulse in Hz, based on the previous high and low times, updated on high to low tr...
Definition: SerialWombatPulseTimer.h:170
uint8_t pin()
Facilitates multi-inheritance.
Definition: SerialWombatPulseTimer.h:189
uint16_t readLowCounts()
Retreives the most recent Counts in the configured units for the most recent low pulse.
Definition: SerialWombatPulseTimer.cpp:55
uint16_t readHighCounts()
Retreives the most recent Counts in the configured units for the most recent high pulse.
Definition: SerialWombatPulseTimer.cpp:49
SerialWombatPulseTimerUnits
Definition: SerialWombatPulseTimer.h:35
Describes a Serial Wombat Pin. Is base class for other pin modes.
Definition: SerialWombat.h:727
extends the SerialWombatPulseTimer class with SW18AB specific functionality
Definition: SerialWombatPulseTimer.h:160
uint8_t _pinMode
Definition: SerialWombat.h:799
A Class which uses a Serial Wombat pin to measure the length of a pulse high and low time.
Definition: SerialWombatPulseTimer.h:82
@ PERIOD_ON_LTH_TRANSITION
The period of the pulse in uS, based on the previous high and low times, updated on low to high trans...
Definition: SerialWombatPulseTimer.h:167
uint8_t swPinModeNumber()
Facilitates multi-inheritance.
Definition: SerialWombatPulseTimer.h:191
@ SW_PULSETIMER_uS
Definition: SerialWombatPulseTimer.h:37
uint16_t LowCounts
Count in selected units of last retreived low pulse.
Definition: SerialWombatPulseTimer.h:140
void refreshHighCountsPulses()
Retreive the High counts and number of pulses Serial Wombat chip in a single transaction.
Definition: SerialWombatPulseTimer.cpp:39
void refresh()
Retreive the latest values for HighCounts, LowCounts, Pulses, and MeasurementOverflowOccured.
Definition: SerialWombatPulseTimer.cpp:18
SerialWombatPulseTimer_18AB(SerialWombatChip &serialWombat)
constructor for SerialWombatPulseTimer_18AB
Definition: SerialWombatPulseTimer.cpp:74
@ SW_PULSETIMER_mS
Definition: SerialWombatPulseTimer.h:38
uint8_t pin()
Returns the current SW pin number. Used primarily for virtual calls by derived classes.
Definition: SerialWombat.h:789
This class name is depricated. Do not use for new development. Use SerialWombatChip instead.
Definition: SerialWombat.h:710
@ LOW_TIME
the pulse low time in uS. Update on each low to high transition.
Definition: SerialWombatPulseTimer.h:165
@ DUTYCYCLE_ON_HTL_TRANSITION
Duty cycle of the pulse as a ratio from 0 to 65535, updated on high to low transition.
Definition: SerialWombatPulseTimer.h:172
uint8_t _pin
Definition: SerialWombat.h:797
void refreshHighCountsLowCounts()
Retreive the High and Low counts from the Serial Wombat chip in a single transaction.
Definition: SerialWombatPulseTimer.cpp:30
@ FREQUENCY_ON_LTH_TRANSITION
The frequency of the pulse in Hz, based on the previous high and low times, updated on low to high tr...
Definition: SerialWombatPulseTimer.h:169
void begin(uint8_t pin, SerialWombatPulseTimerUnits units=SW_PULSETIMER_uS, bool pullUpEnabled=false)
Initialization routine for SerialWombatPulseTimer.
Definition: SerialWombatPulseTimer.cpp:9
@ PERIOD_ON_HTL_TRANSITION
The period of the pulse in uS, based on the previous high and low times, updated on high to low trans...
Definition: SerialWombatPulseTimer.h:168
SerialWombatPulseTimer(SerialWombatChip &serialWombat)
Class constructor for SerialWombatPulseTimer.
Definition: SerialWombatPulseTimer.cpp:3
int16_t configurePublicDataOutput(SerialWombatPulseTimer_18AB::publicDataOutput publicDataOutput)
configures which measurement is the Public Data Output of this pin mode
Definition: SerialWombatPulseTimer.cpp:68
publicDataOutput
Definition: SerialWombatPulseTimer.h:163
uint16_t Pulses
Count of last retreived pulses.
Definition: SerialWombatPulseTimer.h:145
@ PULSE_COUNT
The number of pulses that have occured since initialization. Updated on each high to low transition.
Definition: SerialWombatPulseTimer.h:166