Serial Wombat Arduino Library
Public Member Functions | List of all members
SerialWombatAbstractScaledOutput Class Referenceabstract

SerialWombatServo and SerialWombatPWM inherit from this class. More...

#include <SerialWombatAbstractScaledOutput.h>

Inheritance diagram for SerialWombatAbstractScaledOutput:
SerialWombatPWM_18AB SerialWombatServo_18AB SerialWombatHighFrequencyServo

Public Member Functions

 SerialWombatAbstractScaledOutput (SerialWombatChip &sw)
 Constructor for the SerialWombatAbstractScaledOutput Class. More...
 
int16_t writeTimeout (uint16_t timeout_mS, uint16_t timeoutOutputValue)
 
int16_t writeScalingEnabled (bool enabled, uint8_t sourcePin)
 
int16_t writeInputScaling (uint16_t inputMin, uint16_t inputMax)
 
int16_t writeOutputScaling (uint16_t outputMin, uint16_t outputMax)
 
int16_t writeScalingInvertedInput (bool inverted)
 
int16_t writeScalingTargetValue (uint16_t target)
 
int16_t configureRateControl (uint8_t sampleRate, uint16_t filterConstant)
 
int16_t configure1stOrderFiltering (uint8_t sampleRate, uint16_t filterConstant)
 
int16_t configureHysteresis (uint16_t lowLimit, uint16_t lowOutputValue, uint16_t highLimit, uint16_t highOutputValue, uint16_t initialOutputValue)
 
int16_t configurePID (uint16_t kp, uint16_t ki, uint16_t kd, uint16_t target, uint8_t sampleRate)
 
virtual uint8_t pin ()=0
 
virtual uint8_t swPinModeNumber ()=0
 

Detailed Description

SerialWombatServo and SerialWombatPWM inherit from this class.

Constructor & Destructor Documentation

◆ SerialWombatAbstractScaledOutput()

SerialWombatAbstractScaledOutput::SerialWombatAbstractScaledOutput ( SerialWombatChip sw)

Constructor for the SerialWombatAbstractScaledOutput Class.

Parameters
swA reference to a previously declared SerialWombatPin to which the output is connected.

Member Function Documentation

◆ configure1stOrderFiltering()

int16_t SerialWombatAbstractScaledOutput::configure1stOrderFiltering ( uint8_t  sampleRate,
uint16_t  filterConstant 
)

◆ configureHysteresis()

int16_t SerialWombatAbstractScaledOutput::configureHysteresis ( uint16_t  lowLimit,
uint16_t  lowOutputValue,
uint16_t  highLimit,
uint16_t  highOutputValue,
uint16_t  initialOutputValue 
)

◆ configurePID()

int16_t SerialWombatAbstractScaledOutput::configurePID ( uint16_t  kp,
uint16_t  ki,
uint16_t  kd,
uint16_t  target,
uint8_t  sampleRate 
)

◆ configureRateControl()

int16_t SerialWombatAbstractScaledOutput::configureRateControl ( uint8_t  sampleRate,
uint16_t  filterConstant 
)

◆ pin()

virtual uint8_t SerialWombatAbstractScaledOutput::pin ( )
pure virtual

◆ swPinModeNumber()

virtual uint8_t SerialWombatAbstractScaledOutput::swPinModeNumber ( )
pure virtual

◆ writeInputScaling()

int16_t SerialWombatAbstractScaledOutput::writeInputScaling ( uint16_t  inputMin,
uint16_t  inputMax 
)

◆ writeOutputScaling()

int16_t SerialWombatAbstractScaledOutput::writeOutputScaling ( uint16_t  outputMin,
uint16_t  outputMax 
)

◆ writeScalingEnabled()

int16_t SerialWombatAbstractScaledOutput::writeScalingEnabled ( bool  enabled,
uint8_t  sourcePin 
)

◆ writeScalingInvertedInput()

int16_t SerialWombatAbstractScaledOutput::writeScalingInvertedInput ( bool  inverted)

◆ writeScalingTargetValue()

int16_t SerialWombatAbstractScaledOutput::writeScalingTargetValue ( uint16_t  target)

◆ writeTimeout()

int16_t SerialWombatAbstractScaledOutput::writeTimeout ( uint16_t  timeout_mS,
uint16_t  timeoutOutputValue 
)