Serial Wombat Arduino Library
SerialWombatResistanceInput.h
Go to the documentation of this file.
1 #pragma once
2 
3 /*
4 Copyright 2020-2021 Broadwell Consulting Inc.
5 
6 "Serial Wombat" is a registered trademark of Broadwell Consulting Inc. in
7 the United States. See SerialWombat.com for usage guidance.
8 
9 Permission is hereby granted, free of charge, to any person obtaining a
10  * copy of this software and associated documentation files (the "Software"),
11  * to deal in the Software without restriction, including without limitation
12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  * and/or sell copies of the Software, and to permit persons to whom the
14  * Software is furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17  * all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
22  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25  * OTHER DEALINGS IN THE SOFTWARE.
26 */
27 
28 #include <stdint.h>
29 #include "SerialWombat.h"
30 
41 };
42 
75 {
76 public:
81 
89  int16_t begin(uint8_t pin);
90 
98  int16_t begin(uint8_t pin, uint16_t averageSamples, uint16_t filterConstant);
99 
108  int16_t begin(uint8_t pin, uint16_t averageSamples, uint16_t filterConstant, ResistanceInputPublicDataOutput output);
109 
110 
111 
112 
120  uint16_t readFilteredOhms();
121 
122 
129  uint16_t readAveragedOhms();
130 
131 
139  uint16_t readMaximumOhms(bool resetAfterRead);
140 
141 
149  uint16_t readMinimumOhms(bool resetAfterRead);
150 
151  uint8_t pin() { return _pin; }
152  uint8_t swPinModeNumber() { return _pinMode; }
153 
154 private:
155 
156 };
157 
SerialWombatResistanceInput::readAveragedOhms
uint16_t readAveragedOhms()
Retreive an averaged Resistance measurement.
Definition: SerialWombatResistanceInput.cpp:45
SerialWombatChip
Class for a Serial Wombat chip. Each Serial Wombat chip on a project should have its own instance.
Definition: SerialWombat.h:267
ResistanceInputPublicDataOutput_Raw
@ ResistanceInputPublicDataOutput_Raw
The raw Resistance reading is displayed as public data (default)
Definition: SerialWombatResistanceInput.h:36
ResistanceInputPublicDataOutput_Minimum
@ ResistanceInputPublicDataOutput_Minimum
The Minimum Resistance reading is displayed as public data (default)
Definition: SerialWombatResistanceInput.h:39
SerialWombatResistanceInput::readMaximumOhms
uint16_t readMaximumOhms(bool resetAfterRead)
Retreive the maximum single sample Resistance value in Ohms.
Definition: SerialWombatResistanceInput.cpp:57
SerialWombatResistanceInput::begin
int16_t begin(uint8_t pin)
Initialize a resistance input on a given pin.
Definition: SerialWombatResistanceInput.cpp:8
SerialWombatResistanceInput::pin
uint8_t pin()
Used for inheritance.
Definition: SerialWombatResistanceInput.h:151
ResistanceInputPublicDataOutput_Filtered
@ ResistanceInputPublicDataOutput_Filtered
The Filtered Resistance reading is displayed as public data (default)
Definition: SerialWombatResistanceInput.h:37
SerialWombat.h
SerialWombatResistanceInput
A class to make resistance measurements with the Serial Wombat 18AB chip.
Definition: SerialWombatResistanceInput.h:74
SerialWombatPin
Describes a Serial Wombat Pin. Is base class for other pin modes.
Definition: SerialWombat.h:727
SerialWombatResistanceInput::swPinModeNumber
uint8_t swPinModeNumber()
Used for ineheritance.
Definition: SerialWombatResistanceInput.h:152
ResistanceInputPublicDataOutput
ResistanceInputPublicDataOutput
Definition: SerialWombatResistanceInput.h:35
SerialWombatPin::_pinMode
uint8_t _pinMode
Definition: SerialWombat.h:799
ResistanceInputPublicDataOutput_Maximum
@ ResistanceInputPublicDataOutput_Maximum
The Maximum Resistance reading is displayed as public data (default)
Definition: SerialWombatResistanceInput.h:40
SerialWombat
This class name is depricated. Do not use for new development. Use SerialWombatChip instead.
Definition: SerialWombat.h:710
ResistanceInputPublicDataOutput_Averaged
@ ResistanceInputPublicDataOutput_Averaged
The Averaged Resistance reading is displayed as public data (default)
Definition: SerialWombatResistanceInput.h:38
SerialWombatAbstractProcessedInput
SerialWombatAnalogInput, SerialWombatPulseTimer, SerialWombatResistanceInput and others inherit from ...
Definition: SerialWombatAbstractProcessedInput.h:79
SerialWombatResistanceInput::readFilteredOhms
uint16_t readFilteredOhms()
Retreive a filtered Resistance measurement.
Definition: SerialWombatResistanceInput.cpp:34
SerialWombatPin::_pin
uint8_t _pin
Definition: SerialWombat.h:797
SerialWombatResistanceInput::SerialWombatResistanceInput
SerialWombatResistanceInput(SerialWombatChip &SerialWombat)
Constructor for the SerialWombatResistanceInput class.
Definition: SerialWombatResistanceInput.cpp:4
SerialWombatResistanceInput::readMinimumOhms
uint16_t readMinimumOhms(bool resetAfterRead)
Retreive the maximum single sample Resistance value in Ohms.
Definition: SerialWombatResistanceInput.cpp:71