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 
138 private:
139  SerialWombat &_sw ;
140 
141  uint8_t _pin = 255;
142 
143 
144 };
145 
SerialWombatAnalogInput::readVoltage_mV
uint16_t readVoltage_mV()
Retreive a raw A/D measurement and convert it to mV.
Definition: serialWombatAnalogInput.cpp:26
SerialWombatAnalogInput::readFilteredCounts
uint16_t readFilteredCounts()
Retreive a filtered A/D measurement.
Definition: serialWombatAnalogInput.cpp:52
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:84
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:62
SerialWombatAnalogInput::readAveragedCounts
uint16_t readAveragedCounts()
Retreive an averaged A/D measurement.
Definition: serialWombatAnalogInput.cpp:70
SerialWombat.h
SerialWombatAnalogInput::SerialWombatAnalogInput
SerialWombatAnalogInput(SerialWombat &SerialWombat)
Constructor for the SerialWombatAnalogInput class.
Definition: serialWombatAnalogInput.cpp:4
SerialWombat
Definition: SerialWombat.h:86
SerialWombatAnalogInput::readFiltered_mV
uint16_t readFiltered_mV()
Retreive a filtered A/D measurement and convert it to mV.
Definition: serialWombatAnalogInput.cpp:43
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:38
SerialWombatAnalogInput::~SerialWombatAnalogInput
~SerialWombatAnalogInput()
Definition: serialWombatAnalogInput.cpp:89