AnalogClutchInput Class Reference

Class for analog clutch paddles. More...

#include <InputHardware.hpp>

Public Member Functions
	AnalogClutchInput (ADC_GPIO pinNumber)
	Construct a new Analog Clutch Input object.
void	resetCalibrationData () override
	Force auto-calibration.
void	getCalibrationData (int &minReading, int &maxReading) override
	Get auto-calibration data. Required for persistent storage.
void	setCalibrationData (int minReading, int maxReading) override
	Set auto-calibration data (loaded from persistent storage).
void	read (uint8_t &value, bool &autoCalibrated) override
	Read current axis position. The axis must go from one end to the other for auto- calibration.
Public Member Functions inherited from AnalogInput

Protected Attributes
ADC_GPIO	pinNumber
	Configured ADC pin.
int	minADCReading
	Minimum ADC reading for auto-calibration.
int	maxADCReading
	Maximum ADC reading for auto-calibration.
int	lastADCReading
	Last ADC reading.
uint8_t	lastValue
	Last axis position.

Detailed Description

Class for analog clutch paddles.

Definition at line 492 of file InputHardware.hpp.

Constructor & Destructor Documentation

AnalogClutchInput()

AnalogClutchInput::AnalogClutchInput

(

ADC_GPIO

pinNumber

)

Construct a new Analog Clutch Input object.

Parameters

pinNumber

ADC-capable pin number

Member Function Documentation

getCalibrationData()

void AnalogClutchInput::getCalibrationData ( int & minReading, int & maxReading )

overridevirtual

Get auto-calibration data. Required for persistent storage.

Parameters

[out]	minReading	Minimum adc reading
[out]	maxReading	Maximum adc reading

Implements AnalogInput.

read()

void AnalogClutchInput::read ( uint8_t & value, bool & autoCalibrated )

overridevirtual

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

Parameters

[out]	value	Current axis position.
[out]	autoCalibrated	True if this axis has been auto-calibrated.

Implements AnalogInput.

resetCalibrationData()

void AnalogClutchInput::resetCalibrationData ( )

overridevirtual

Force auto-calibration.

Implements AnalogInput.

setCalibrationData()

void AnalogClutchInput::setCalibrationData ( int minReading, int maxReading )

overridevirtual

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

Parameters

[out]	minReading	Minimum adc reading
[out]	maxReading	Maximum adc reading

Implements AnalogInput.

Member Data Documentation

lastADCReading

int AnalogClutchInput::lastADCReading

protected

Last ADC reading.

Definition at line 502 of file InputHardware.hpp.

lastValue

uint8_t AnalogClutchInput::lastValue

protected

Last axis position.

Definition at line 504 of file InputHardware.hpp.

maxADCReading

int AnalogClutchInput::maxADCReading

protected

Maximum ADC reading for auto-calibration.

Definition at line 500 of file InputHardware.hpp.

minADCReading

int AnalogClutchInput::minADCReading

protected

Minimum ADC reading for auto-calibration.

Definition at line 498 of file InputHardware.hpp.

pinNumber

ADC_GPIO AnalogClutchInput::pinNumber

protected

Configured ADC pin.

Definition at line 496 of file InputHardware.hpp.

---

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

• /github/workspace/src/include/InputHardware.hpp