SimRacing::Pedals Class Reference

Base class for all pedals instances. More...

#include <SimRacing.h>

Inheritance diagram for SimRacing::Pedals:

Public Types
using	PedalID = SimRacing::Pedal

Public Member Functions
	Pedals (AnalogInput *dataPtr, uint8_t nPedals, uint8_t detectPin)
virtual void	begin ()
virtual bool	update ()
long	getPosition (PedalID pedal, long rMin=0, long rMax=100) const
int	getPositionRaw (PedalID pedal) const
bool	hasPedal (PedalID pedal) const
int	getNumPedals () const
bool	positionChanged () const
void	setCalibration (PedalID pedal, AnalogInput::Calibration cal)
void	serialCalibration (Stream &iface=Serial)
bool	isConnected () const

Static Public Member Functions
static String	getPedalName (PedalID pedal)

Detailed Description

Base class for all pedals instances.

Definition at line 276 of file SimRacing.h.

Member Typedef Documentation

PedalID

using SimRacing::Pedals::PedalID = SimRacing::Pedal

Scoped alias for SimRacing::Pedal

Definition at line 279 of file SimRacing.h.

Constructor & Destructor Documentation

Pedals()

SimRacing::Pedals::Pedals	(	AnalogInput *	dataPtr,
		uint8_t	nPedals,
		uint8_t	detectPin
	)

Class constructor

Parameters

dataPtr	pointer to the analog input data managed by the class, stored elsewhere
nPedals	the number of pedals stored in said data pointer
detectPin	the digital pin for device detection (high is detected)

Definition at line 336 of file SimRacing.cpp.

Member Function Documentation

begin()

void SimRacing::Pedals::begin ( )

virtual

Initialize the hardware (if necessary)

Reimplemented from SimRacing::Peripheral.

Examples

PedalsJoystick.ino, and PedalsPrint.ino.

Definition at line 344 of file SimRacing.cpp.

getNumPedals()

int SimRacing::Pedals::getNumPedals ( ) const

inline

Retrieves the number of pedals handled by the class.

Returns

the number of pedals handled by the class

Definition at line 332 of file SimRacing.h.

getPedalName()

String SimRacing::Pedals::getPedalName ( PedalID  pedal )

static

Utility function to get the string name for each pedal.

Parameters

pedal

the pedal to get the name of

Returns

the name of the pedal, as a String

Definition at line 390 of file SimRacing.cpp.

getPosition()

long SimRacing::Pedals::getPosition	(	PedalID	pedal,
		long	rMin = 0,
		long	rMax = 100
	)		const

Retrieves the buffered position for the pedal, rescaled to a nominal range using the calibration values.

By default this is rescaled to an integer percentage.

Parameters

pedal	the pedal to retrieve position for
rMin	the minimum output value for the rescaling function
rMax	the maximum output value for the rescaling function

Returns

the pedal position, buffered and rescaled

Examples

PedalsJoystick.ino, and PedalsPrint.ino.

Definition at line 370 of file SimRacing.cpp.

getPositionRaw()

int SimRacing::Pedals::getPositionRaw

(

PedalID

pedal

)

const

Retrieves the buffered position for the pedal, ignoring the calibration data.

Parameters

pedal

the pedal to retrieve position for

Returns

the axis position, buffered

Definition at line 375 of file SimRacing.cpp.

hasPedal()

bool SimRacing::Pedals::hasPedal

(

PedalID

pedal

)

const

Checks if a given pedal is present in the class.

Parameters

pedal

the pedal to check

Returns

'true' if there is data for the pedal, 'false' otherwise

Examples

PedalsJoystick.ino, and PedalsPrint.ino.

Definition at line 380 of file SimRacing.cpp.

isConnected()

bool SimRacing::Pedals::isConnected ( ) const

inlinevirtual

Check if the device is physically connected to the board. That means it is both present and detected long enough to be considered 'stable'.

Returns

'true' if the device is connected, 'false' otherwise

Reimplemented from SimRacing::Peripheral.

Definition at line 358 of file SimRacing.h.

positionChanged()

bool SimRacing::Pedals::positionChanged ( ) const

inline

Checks whether the current pedal positions have changed since the last update.

Returns

'true' if position has changed, 'false' otherwise

Examples

PedalsJoystick.ino.

Definition at line 339 of file SimRacing.h.

serialCalibration()

void SimRacing::Pedals::serialCalibration

(

Stream &

iface = Serial

)

Runs an interactive calibration tool using the serial interface.

Parameters

iface

the serial interface to send and receive prompts. Defaults to Serial (CDC USB on most boards).

Examples

PedalsPrint.ino.

Definition at line 410 of file SimRacing.cpp.

setCalibration()

void SimRacing::Pedals::setCalibration	(	PedalID	pedal,
		AnalogInput::Calibration	cal
	)

Calibrate a pedal's min/max values for rescaling.

Parameters

pedal	the pedal to set the calibration of
cal	the calibration data to set

Definition at line 384 of file SimRacing.cpp.

update()

bool SimRacing::Pedals::update ( )

virtual

Perform a poll of the hardware to refresh the class state

Returns

'true' if device state changed, 'false' otherwise

Implements SimRacing::Peripheral.

Examples

PedalsJoystick.ino, and PedalsPrint.ino.

Definition at line 348 of file SimRacing.cpp.

---

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

• SimRacing.h
• SimRacing.cpp