Serial Wombat Arduino Library
SerialWombatAbstractScaledOutput.h
Go to the documentation of this file.
1 #pragma once
2 /*
3 Copyright 2021 Broadwell Consulting Inc.
4 
5 "Serial Wombat" is a registered trademark of Broadwell Consulting Inc. in
6 the United States. See SerialWombat.com for usage guidance.
7 
8 Permission is hereby granted, free of charge, to any person obtaining a
9  * copy of this software and associated documentation files (the "Software"),
10  * to deal in the Software without restriction, including without limitation
11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12  * and/or sell copies of the Software, and to permit persons to whom the
13  * Software is furnished to do so, subject to the following conditions:
14 
15 The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17 
18 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24  * OTHER DEALINGS IN THE SOFTWARE.
25 */
26 
27 #include "SerialWombat.h"
28 #include "limits.h"
29 
37 {
38 public:
43 
44  int16_t writeTimeout(uint16_t timeout_mS, uint16_t timeoutOutputValue);
45  int16_t writeScalingEnabled(bool enabled, uint8_t sourcePin);
46  int16_t writeInputScaling(uint16_t inputMin, uint16_t inputMax);
47  int16_t writeOutputScaling(uint16_t outputMin, uint16_t outputMax);
48  int16_t writeScalingInvertedInput(bool inverted);
49  int16_t writeScalingTargetValue(uint16_t target);
50  int16_t configureRateControl(uint8_t sampleRate, uint16_t filterConstant);
51  int16_t configure1stOrderFiltering(uint8_t sampleRate, uint16_t filterConstant);
52  int16_t configureHysteresis(uint16_t lowLimit, uint16_t lowOutputValue, uint16_t highLimit, uint16_t highOutputValue, uint16_t initialOutputValue);
53  int16_t configurePID(uint16_t kp, uint16_t ki, uint16_t kd,uint16_t target,uint8_t sampleRate);
54  virtual uint8_t pin() = 0;
55  virtual uint8_t swPinModeNumber() = 0;
56 
57 private:
58  SerialWombatChip& _asosw;
59 
60 };
61 
62 
SerialWombatAbstractScaledOutput::writeTimeout
int16_t writeTimeout(uint16_t timeout_mS, uint16_t timeoutOutputValue)
Definition: SerialWombatAbstractScaledOutput.cpp:10
SerialWombatChip
Class for a Serial Wombat chip. Each Serial Wombat chip on a project should have its own instance.
Definition: SerialWombat.h:265
SerialWombatAbstractScaledOutput::writeInputScaling
int16_t writeInputScaling(uint16_t inputMin, uint16_t inputMax)
Definition: SerialWombatAbstractScaledOutput.cpp:40
SerialWombatAbstractScaledOutput::writeScalingEnabled
int16_t writeScalingEnabled(bool enabled, uint8_t sourcePin)
Definition: SerialWombatAbstractScaledOutput.cpp:27
SerialWombatAbstractScaledOutput::SerialWombatAbstractScaledOutput
SerialWombatAbstractScaledOutput(SerialWombatChip &sw)
Constructor for the SerialWombatAbstractScaledOutput Class.
Definition: SerialWombatAbstractScaledOutput.cpp:6
SerialWombatAbstractScaledOutput::writeOutputScaling
int16_t writeOutputScaling(uint16_t outputMin, uint16_t outputMax)
Definition: SerialWombatAbstractScaledOutput.cpp:52
SerialWombatAbstractScaledOutput
SerialWombatServo and SerialWombatPWM inherit from this class.
Definition: SerialWombatAbstractScaledOutput.h:36
SerialWombatAbstractScaledOutput::configurePID
int16_t configurePID(uint16_t kp, uint16_t ki, uint16_t kd, uint16_t target, uint8_t sampleRate)
Definition: SerialWombatAbstractScaledOutput.cpp:179
SerialWombat.h
SerialWombatAbstractScaledOutput::writeScalingInvertedInput
int16_t writeScalingInvertedInput(bool inverted)
Definition: SerialWombatAbstractScaledOutput.cpp:64
SerialWombatAbstractScaledOutput::pin
virtual uint8_t pin()=0
SerialWombatAbstractScaledOutput::configureHysteresis
int16_t configureHysteresis(uint16_t lowLimit, uint16_t lowOutputValue, uint16_t highLimit, uint16_t highOutputValue, uint16_t initialOutputValue)
Definition: SerialWombatAbstractScaledOutput.cpp:143
SerialWombatAbstractScaledOutput::writeScalingTargetValue
int16_t writeScalingTargetValue(uint16_t target)
Definition: SerialWombatAbstractScaledOutput.cpp:76
SerialWombatAbstractScaledOutput::configure1stOrderFiltering
int16_t configure1stOrderFiltering(uint8_t sampleRate, uint16_t filterConstant)
Definition: SerialWombatAbstractScaledOutput.cpp:115
SerialWombatAbstractScaledOutput::configureRateControl
int16_t configureRateControl(uint8_t sampleRate, uint16_t filterConstant)
Definition: SerialWombatAbstractScaledOutput.cpp:87
SerialWombatAbstractScaledOutput::swPinModeNumber
virtual uint8_t swPinModeNumber()=0