Serial Wombat Arduino Library
Public Member Functions | List of all members
SerialWombatPWM_18AB Class Reference

Extends the SerialWombatPWM class with SW18AB specific functionality, including SerialWombatAbstractScaledOutput. More...

#include <SerialWombatPWM.h>

Inheritance diagram for SerialWombatPWM_18AB:
SerialWombatPWM SerialWombatAbstractScaledOutput SerialWombatPin

Public Member Functions

 SerialWombatPWM_18AB (SerialWombatChip &serialWombat)
 
void writeFrequency_Hz (uint32_t frequency_Hz)
 Set the PWM frequency on a Serial Wombat 18AB chip's PWM. More...
 
void writePeriod_uS (uint32_t period_uS)
 Set the PWM period on a Serial Wombat 18AB chip's PWM. More...
 
uint8_t pin ()
 fulfills a virtual function requirement of SerialWombatAbstractScaledOutput More...
 
uint8_t swPinModeNumber ()
 fulfills a virtual function requirement of SerialWombatAbstractScaledOutput More...
 
- Public Member Functions inherited from SerialWombatPWM
 SerialWombatPWM (SerialWombatChip &serialWombat)
 Constructor for SerialWombatPWM class. More...
 
void begin (uint8_t pin, uint16_t dutyCycle=0, bool invert=false)
 Initialize a pin that has been declared as PWM.
More...
 
void writeDutyCycle (uint16_t dutyCycle)
 Set PWM duty cycle. More...
 
 ~SerialWombatPWM ()
 
- Public Member Functions inherited from SerialWombatPin
 SerialWombatPin (SerialWombatChip &serialWombatChip)
 Instantiates a Serial Wombat Pin. More...
 
 SerialWombatPin (SerialWombatChip &serialWombatChip, uint8_t pin)
 Instantiates a Serial Wombat Pin. More...
 
uint16_t readPublicData ()
 Read the 16 Bit public data associated with this pin. More...
 
void pinMode (uint8_t mode)
 Set pin to INPUT or OUTPUT. More...
 
void pinMode (uint8_t mode, bool pullDown, bool openDrain)
 Set pin to INPUT or OUTPUT, with options for pull Ups and open Drain settings. More...
 
void digitalWrite (uint8_t val)
 Set output pin High or Low. More...
 
int digitalRead ()
 Reads the state of the Pin. More...
 
uint16_t writePublicData (uint16_t value)
 Write a 16 bit value to this pin. More...
 
uint8_t pin ()
 Returns the current SW pin number. Used primarily for virtual calls by derived classes. More...
 
uint8_t swPinModeNumber ()
 Returns the Mode number. Used primarily by derived classes to populate packet data. More...
 
- Public Member Functions inherited from SerialWombatAbstractScaledOutput
 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)
 

Additional Inherited Members

- Protected Attributes inherited from SerialWombatPin
uint8_t _pin = 255
 
SerialWombatChip_sw
 
uint8_t _pinMode = 0
 

Detailed Description

Extends the SerialWombatPWM class with SW18AB specific functionality, including SerialWombatAbstractScaledOutput.

Constructor & Destructor Documentation

◆ SerialWombatPWM_18AB()

SerialWombatPWM_18AB::SerialWombatPWM_18AB ( SerialWombatChip serialWombat)

Member Function Documentation

◆ pin()

uint8_t SerialWombatPWM_18AB::pin ( )
virtual

fulfills a virtual function requirement of SerialWombatAbstractScaledOutput

Returns
current pin number

Implements SerialWombatAbstractScaledOutput.

◆ swPinModeNumber()

uint8_t SerialWombatPWM_18AB::swPinModeNumber ( )
virtual

fulfills a virtual function requirement of SerialWombatAbstractScaledOutput

Returns
current pin mode number

Implements SerialWombatAbstractScaledOutput.

◆ writeFrequency_Hz()

void SerialWombatPWM_18AB::writeFrequency_Hz ( uint32_t  frequency_Hz)

Set the PWM frequency on a Serial Wombat 18AB chip's PWM.

Parameters
frequency_HzFrequency in Hz. Note that actual frequency may vary based on hardware capabilities of the pin.

◆ writePeriod_uS()

void SerialWombatPWM_18AB::writePeriod_uS ( uint32_t  period_uS)

Set the PWM period on a Serial Wombat 18AB chip's PWM.

Parameters
period_uSPeriod in microseconds. Note that actual period may vary based on hardware capabilities of the pin.