Serial Wombat Arduino Library
serialWombatAnalogInput.h
Go to the documentation of this file.
1 #pragma once
2 #include <stdint.h>
3 #include "SerialWombat.h"
4 
8 class SerialWombat;
9 
48 {
49 public:
54 
61  void begin(uint8_t pin);
62 
70  void begin(uint8_t pin, uint16_t averageSamples, uint16_t filterConstant);
71 
78  uint16_t readVoltage_mV();
79 
93  uint16_t readCounts();
94 
101  uint16_t readFiltered_mV();
102 
110  uint16_t readFilteredCounts();
111 
118  uint16_t readAveraged_mV();
119 
131  uint16_t readAveragedCounts();
132 
134  uint16_t updateSupplyVoltage_mV();
135 
137 
145  uint16_t readMaximum_mV(bool resetAfterRead);
146 
154  uint16_t readMaximumCounts(bool resetAfterRead);
155 
163  uint16_t readMinimum_mV(bool resetAfterRead);
164 
172  uint16_t readMinimumCounts(bool resetAfterRead);
173 
174 private:
175  SerialWombat &_sw ;
176 
177  uint8_t _pin = 255;
178 
179 
180 };
181 
SerialWombatAnalogInput::readVoltage_mV
uint16_t readVoltage_mV()
Retreive a raw A/D measurement and convert it to mV.
Definition: serialWombatAnalogInput.cpp:28
SerialWombatAnalogInput::readFilteredCounts
uint16_t readFilteredCounts()
Retreive a filtered A/D measurement.
Definition: serialWombatAnalogInput.cpp:54
SerialWombatAnalogInput::readMinimum_mV
uint16_t readMinimum_mV(bool resetAfterRead)
Retreive the minimum single sample A/D value in mV.
Definition: serialWombatAnalogInput.cpp:135
SerialWombatAnalogInput::readMaximum_mV
uint16_t readMaximum_mV(bool resetAfterRead)
Retreive the maximum single sample A/D value in mV.
Definition: serialWombatAnalogInput.cpp:126
SerialWombatAnalogInput::readMaximumCounts
uint16_t readMaximumCounts(bool resetAfterRead)
Retreive the maximum single sample A/D value in counts.
Definition: serialWombatAnalogInput.cpp:97
SerialWombatAnalogInput::updateSupplyVoltage_mV
uint16_t updateSupplyVoltage_mV()
Provides a wrapper around the readSupplyVoltage_mV() method for the SerialWombat hosting this pin mod...
Definition: serialWombatAnalogInput.cpp:86
SerialWombatAnalogInput
A class to make analog measurements with the Serial Wombat.
Definition: serialWombatAnalogInput.h:47
SerialWombatAnalogInput::readAveraged_mV
uint16_t readAveraged_mV()
Retreive an averaged A/D measurement and convert it to mV.
Definition: serialWombatAnalogInput.cpp:64
SerialWombatAnalogInput::readAveragedCounts
uint16_t readAveragedCounts()
Retreive an averaged A/D measurement.
Definition: serialWombatAnalogInput.cpp:72
SerialWombat.h
SerialWombatAnalogInput::readMinimumCounts
uint16_t readMinimumCounts(bool resetAfterRead)
Retreive the maximum single sample A/D value in counts.
Definition: serialWombatAnalogInput.cpp:111
SerialWombatAnalogInput::SerialWombatAnalogInput
SerialWombatAnalogInput(SerialWombat &SerialWombat)
Constructor for the SerialWombatAnalogInput class.
Definition: serialWombatAnalogInput.cpp:4
SerialWombat
Definition: SerialWombat.h:72
SerialWombatAnalogInput::readFiltered_mV
uint16_t readFiltered_mV()
Retreive a filtered A/D measurement and convert it to mV.
Definition: serialWombatAnalogInput.cpp:45
SerialWombatAnalogInput::begin
void begin(uint8_t pin)
Initialize an analog input on a given pin.
Definition: serialWombatAnalogInput.cpp:9
SerialWombatAnalogInput::readCounts
uint16_t readCounts()
Retreive a raw A/D measurement.
Definition: serialWombatAnalogInput.cpp:40
SerialWombatAnalogInput::~SerialWombatAnalogInput
~SerialWombatAnalogInput()
Definition: serialWombatAnalogInput.cpp:91