OpenSourceSimWheelESP32
Open-source wireless steering wheel/button box for ESP32 boards
Loading...
Searching...
No Matches
Public Member Functions | List of all members
AnalogInput Class Referenceabstract

Class for all polled analog inputs (axis) More...

#include <InputHardware.hpp>

Public Member Functions

virtual void getCalibrationData (int &minReading, int &maxReading)=0
 Get auto-calibration data. Required for persistent storage.
 
virtual void setCalibrationData (int minReading, int maxReading)=0
 Set auto-calibration data (loaded from persistent storage).
 
virtual void resetCalibrationData ()=0
 Force auto-calibration.
 
virtual void read (uint8_t &value, bool &autoCalibrated)=0
 Read current axis position. The axis must go from one end to the other for auto- calibration.
 

Detailed Description

Class for all polled analog inputs (axis)

Definition at line 450 of file InputHardware.hpp.

Constructor & Destructor Documentation

◆ ~AnalogInput()

virtual AnalogInput::~AnalogInput ( )
inlinevirtualnoexcept

Definition at line 485 of file InputHardware.hpp.

Member Function Documentation

◆ getCalibrationData()

virtual void AnalogInput::getCalibrationData ( int & minReading,
int & maxReading )
pure virtual

Get auto-calibration data. Required for persistent storage.

Parameters
[out]minReadingMinimum adc reading
[out]maxReadingMaximum adc reading

Implemented in AnalogClutchInput, and FakeAxis.

◆ read()

virtual void AnalogInput::read ( uint8_t & value,
bool & autoCalibrated )
pure virtual

Read current axis position. The axis must go from one end to the other for auto- calibration.

Parameters
[out]valueCurrent axis position.
[out]autoCalibratedTrue if this axis has been auto-calibrated.

Implemented in AnalogClutchInput, and FakeAxis.

◆ resetCalibrationData()

virtual void AnalogInput::resetCalibrationData ( )
pure virtual

Force auto-calibration.

Implemented in AnalogClutchInput, and FakeAxis.

◆ setCalibrationData()

virtual void AnalogInput::setCalibrationData ( int minReading,
int maxReading )
pure virtual

Set auto-calibration data (loaded from persistent storage).

Parameters
[out]minReadingMinimum adc reading
[out]maxReadingMaximum adc reading

Implemented in AnalogClutchInput, and FakeAxis.

The documentation for this class was generated from the following file: