From 25a70ca594c3585208ba37a18f6b5437f3cb080f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 21 Oct 2023 06:44:30 +0000 Subject: [PATCH] Update docs for v1.1.4 (053c24c7598da5724791853732ffd376f8eb79b1) --- docs/_handbrake_joystick_8ino-example.html | 9 +- docs/_handbrake_joystick_8ino_source.html | 8 +- docs/_handbrake_print_8ino-example.html | 9 +- docs/_handbrake_print_8ino_source.html | 8 +- docs/_pedals_joystick_8ino-example.html | 11 +- docs/_pedals_joystick_8ino_source.html | 10 +- docs/_pedals_print_8ino-example.html | 11 +- docs/_pedals_print_8ino_source.html | 10 +- docs/_shift_joystick_8ino-example.html | 13 +-- docs/_shift_joystick_8ino_source.html | 12 +- docs/_shift_print_8ino-example.html | 15 ++- docs/_shift_print_8ino_source.html | 14 +-- docs/_sim_racing_8cpp_source.html | 110 +++++++++--------- docs/_sim_racing_8h.html | 16 ++- docs/_sim_racing_8h_source.html | 108 ++++++++--------- docs/class_sim_racing_1_1_analog_input.html | 41 +++++-- docs/class_sim_racing_1_1_analog_shifter.html | 74 ++++++++---- ...lass_sim_racing_1_1_device_connection.html | 30 +++-- docs/class_sim_racing_1_1_handbrake.html | 35 ++++-- ...1_logitech_driving_force_g_t___pedals.html | 55 ++++++--- .../class_sim_racing_1_1_logitech_pedals.html | 55 ++++++--- ...class_sim_racing_1_1_logitech_shifter.html | 74 ++++++++---- docs/class_sim_racing_1_1_pedals.html | 51 +++++--- docs/class_sim_racing_1_1_peripheral.html | 11 +- docs/class_sim_racing_1_1_shifter.html | 51 +++++--- docs/class_sim_racing_1_1_three_pedals.html | 55 ++++++--- docs/class_sim_racing_1_1_two_pedals.html | 55 ++++++--- 27 files changed, 598 insertions(+), 353 deletions(-) diff --git a/docs/_handbrake_joystick_8ino-example.html b/docs/_handbrake_joystick_8ino-example.html index e757ee3..1098d88 100644 --- a/docs/_handbrake_joystick_8ino-example.html +++ b/docs/_handbrake_joystick_8ino-example.html @@ -102,7 +102,6 @@

Emulates the handbrake as a joystick over USB.

-

Emulates the handbrake as a joystick over USB.

/*
* Project Sim Racing Library for Arduino
* @author David Madison
@@ -175,10 +174,10 @@
}
SimRacing.h
Header file for the Sim Racing Library.
SimRacing::Handbrake
Interface with analog handbrakes that use hall effect sensors.
Definition SimRacing.h:676
-
SimRacing::Handbrake::begin
virtual void begin()
Definition SimRacing.cpp:997
-
SimRacing::Handbrake::getPosition
long getPosition(long rMin=0, long rMax=100) const
Definition SimRacing.cpp:1016
-
SimRacing::Handbrake::positionChanged
bool positionChanged() const
Definition SimRacing.h:724
-
SimRacing::Handbrake::update
virtual bool update()
Definition SimRacing.cpp:1001
+
SimRacing::Handbrake::begin
virtual void begin()
Initializes the pin for reading from the handbrake.
Definition SimRacing.cpp:997
+
SimRacing::Handbrake::getPosition
long getPosition(long rMin=0, long rMax=100) const
Retrieves the buffered position for the handbrake axis, rescaled to a nominal range using the calibra...
Definition SimRacing.cpp:1016
+
SimRacing::Handbrake::positionChanged
bool positionChanged() const
Checks whether the handbrake's position has changed since the last update.
Definition SimRacing.h:724
+
SimRacing::Handbrake::update
virtual bool update()
Polls the handbrake to update its position.
Definition SimRacing.cpp:1001
diff --git a/docs/_handbrake_joystick_8ino_source.html b/docs/_handbrake_joystick_8ino_source.html index 7e4f651..f9ebded 100644 --- a/docs/_handbrake_joystick_8ino_source.html +++ b/docs/_handbrake_joystick_8ino_source.html @@ -178,10 +178,10 @@
75}
SimRacing.h
Header file for the Sim Racing Library.
SimRacing::Handbrake
Interface with analog handbrakes that use hall effect sensors.
Definition SimRacing.h:676
-
SimRacing::Handbrake::begin
virtual void begin()
Definition SimRacing.cpp:997
-
SimRacing::Handbrake::getPosition
long getPosition(long rMin=0, long rMax=100) const
Definition SimRacing.cpp:1016
-
SimRacing::Handbrake::positionChanged
bool positionChanged() const
Definition SimRacing.h:724
-
SimRacing::Handbrake::update
virtual bool update()
Definition SimRacing.cpp:1001
+
SimRacing::Handbrake::begin
virtual void begin()
Initializes the pin for reading from the handbrake.
Definition SimRacing.cpp:997
+
SimRacing::Handbrake::getPosition
long getPosition(long rMin=0, long rMax=100) const
Retrieves the buffered position for the handbrake axis, rescaled to a nominal range using the calibra...
Definition SimRacing.cpp:1016
+
SimRacing::Handbrake::positionChanged
bool positionChanged() const
Checks whether the handbrake's position has changed since the last update.
Definition SimRacing.h:724
+
SimRacing::Handbrake::update
virtual bool update()
Polls the handbrake to update its position.
Definition SimRacing.cpp:1001
diff --git a/docs/_handbrake_print_8ino-example.html b/docs/_handbrake_print_8ino-example.html index 0556792..53ae038 100644 --- a/docs/_handbrake_print_8ino-example.html +++ b/docs/_handbrake_print_8ino-example.html @@ -102,7 +102,6 @@

Prints handbrake position percentage over Serial.

-

Prints handbrake position percentage over Serial.

/*
* Project Sim Racing Library for Arduino
* @author David Madison
@@ -163,10 +162,10 @@
}
SimRacing.h
Header file for the Sim Racing Library.
SimRacing::Handbrake
Interface with analog handbrakes that use hall effect sensors.
Definition SimRacing.h:676
-
SimRacing::Handbrake::begin
virtual void begin()
Definition SimRacing.cpp:997
-
SimRacing::Handbrake::getPosition
long getPosition(long rMin=0, long rMax=100) const
Definition SimRacing.cpp:1016
-
SimRacing::Handbrake::update
virtual bool update()
Definition SimRacing.cpp:1001
-
SimRacing::Handbrake::serialCalibration
void serialCalibration(Stream &iface=Serial)
Definition SimRacing.cpp:1029
+
SimRacing::Handbrake::begin
virtual void begin()
Initializes the pin for reading from the handbrake.
Definition SimRacing.cpp:997
+
SimRacing::Handbrake::getPosition
long getPosition(long rMin=0, long rMax=100) const
Retrieves the buffered position for the handbrake axis, rescaled to a nominal range using the calibra...
Definition SimRacing.cpp:1016
+
SimRacing::Handbrake::update
virtual bool update()
Polls the handbrake to update its position.
Definition SimRacing.cpp:1001
+
SimRacing::Handbrake::serialCalibration
void serialCalibration(Stream &iface=Serial)
Runs an interactive calibration tool using the serial interface.
Definition SimRacing.cpp:1029
diff --git a/docs/_handbrake_print_8ino_source.html b/docs/_handbrake_print_8ino_source.html index 22d8014..715f92d 100644 --- a/docs/_handbrake_print_8ino_source.html +++ b/docs/_handbrake_print_8ino_source.html @@ -166,10 +166,10 @@
63}
SimRacing.h
Header file for the Sim Racing Library.
SimRacing::Handbrake
Interface with analog handbrakes that use hall effect sensors.
Definition SimRacing.h:676
-
SimRacing::Handbrake::begin
virtual void begin()
Definition SimRacing.cpp:997
-
SimRacing::Handbrake::getPosition
long getPosition(long rMin=0, long rMax=100) const
Definition SimRacing.cpp:1016
-
SimRacing::Handbrake::update
virtual bool update()
Definition SimRacing.cpp:1001
-
SimRacing::Handbrake::serialCalibration
void serialCalibration(Stream &iface=Serial)
Definition SimRacing.cpp:1029
+
SimRacing::Handbrake::begin
virtual void begin()
Initializes the pin for reading from the handbrake.
Definition SimRacing.cpp:997
+
SimRacing::Handbrake::getPosition
long getPosition(long rMin=0, long rMax=100) const
Retrieves the buffered position for the handbrake axis, rescaled to a nominal range using the calibra...
Definition SimRacing.cpp:1016
+
SimRacing::Handbrake::update
virtual bool update()
Polls the handbrake to update its position.
Definition SimRacing.cpp:1001
+
SimRacing::Handbrake::serialCalibration
void serialCalibration(Stream &iface=Serial)
Runs an interactive calibration tool using the serial interface.
Definition SimRacing.cpp:1029
diff --git a/docs/_pedals_joystick_8ino-example.html b/docs/_pedals_joystick_8ino-example.html index 520c9df..4e1cce3 100644 --- a/docs/_pedals_joystick_8ino-example.html +++ b/docs/_pedals_joystick_8ino-example.html @@ -102,7 +102,6 @@

Emulates the pedals as a joystick over USB.

-

Emulates the pedals as a joystick over USB.

/*
* Project Sim Racing Library for Arduino
* @author David Madison
@@ -195,11 +194,11 @@
}
SimRacing.h
Header file for the Sim Racing Library.
SimRacing::LogitechPedals
Interface with the Logitech pedals (Gas, Brake, and Clutch)
Definition SimRacing.h:748
-
SimRacing::Pedals::hasPedal
bool hasPedal(PedalID pedal) const
Definition SimRacing.cpp:380
-
SimRacing::Pedals::positionChanged
bool positionChanged() const
Definition SimRacing.h:339
-
SimRacing::Pedals::update
virtual bool update()
Definition SimRacing.cpp:348
-
SimRacing::Pedals::begin
virtual void begin()
Definition SimRacing.cpp:344
-
SimRacing::Pedals::getPosition
long getPosition(PedalID pedal, long rMin=0, long rMax=100) const
Definition SimRacing.cpp:370
+
SimRacing::Pedals::hasPedal
bool hasPedal(PedalID pedal) const
Checks if a given pedal is present in the class.
Definition SimRacing.cpp:380
+
SimRacing::Pedals::positionChanged
bool positionChanged() const
Checks whether the current pedal positions have changed since the last update.
Definition SimRacing.h:339
+
SimRacing::Pedals::update
virtual bool update()
Perform a poll of the hardware to refresh the class state.
Definition SimRacing.cpp:348
+
SimRacing::Pedals::begin
virtual void begin()
Initialize the hardware (if necessary)
Definition SimRacing.cpp:344
+
SimRacing::Pedals::getPosition
long 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 valu...
Definition SimRacing.cpp:370
diff --git a/docs/_pedals_joystick_8ino_source.html b/docs/_pedals_joystick_8ino_source.html index c9bdd87..fa93080 100644 --- a/docs/_pedals_joystick_8ino_source.html +++ b/docs/_pedals_joystick_8ino_source.html @@ -198,11 +198,11 @@
95}
SimRacing.h
Header file for the Sim Racing Library.
SimRacing::LogitechPedals
Interface with the Logitech pedals (Gas, Brake, and Clutch)
Definition SimRacing.h:748
-
SimRacing::Pedals::hasPedal
bool hasPedal(PedalID pedal) const
Definition SimRacing.cpp:380
-
SimRacing::Pedals::positionChanged
bool positionChanged() const
Definition SimRacing.h:339
-
SimRacing::Pedals::update
virtual bool update()
Definition SimRacing.cpp:348
-
SimRacing::Pedals::begin
virtual void begin()
Definition SimRacing.cpp:344
-
SimRacing::Pedals::getPosition
long getPosition(PedalID pedal, long rMin=0, long rMax=100) const
Definition SimRacing.cpp:370
+
SimRacing::Pedals::hasPedal
bool hasPedal(PedalID pedal) const
Checks if a given pedal is present in the class.
Definition SimRacing.cpp:380
+
SimRacing::Pedals::positionChanged
bool positionChanged() const
Checks whether the current pedal positions have changed since the last update.
Definition SimRacing.h:339
+
SimRacing::Pedals::update
virtual bool update()
Perform a poll of the hardware to refresh the class state.
Definition SimRacing.cpp:348
+
SimRacing::Pedals::begin
virtual void begin()
Initialize the hardware (if necessary)
Definition SimRacing.cpp:344
+
SimRacing::Pedals::getPosition
long 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 valu...
Definition SimRacing.cpp:370
diff --git a/docs/_pedals_print_8ino-example.html b/docs/_pedals_print_8ino-example.html index 673d654..6785c28 100644 --- a/docs/_pedals_print_8ino-example.html +++ b/docs/_pedals_print_8ino-example.html @@ -102,7 +102,6 @@

Prints pedal position percentages over Serial.

-

Prints pedal position percentages over Serial.

/*
* Project Sim Racing Library for Arduino
* @author David Madison
@@ -183,11 +182,11 @@
}
SimRacing.h
Header file for the Sim Racing Library.
SimRacing::LogitechPedals
Interface with the Logitech pedals (Gas, Brake, and Clutch)
Definition SimRacing.h:748
-
SimRacing::Pedals::serialCalibration
void serialCalibration(Stream &iface=Serial)
Definition SimRacing.cpp:410
-
SimRacing::Pedals::hasPedal
bool hasPedal(PedalID pedal) const
Definition SimRacing.cpp:380
-
SimRacing::Pedals::update
virtual bool update()
Definition SimRacing.cpp:348
-
SimRacing::Pedals::begin
virtual void begin()
Definition SimRacing.cpp:344
-
SimRacing::Pedals::getPosition
long getPosition(PedalID pedal, long rMin=0, long rMax=100) const
Definition SimRacing.cpp:370
+
SimRacing::Pedals::serialCalibration
void serialCalibration(Stream &iface=Serial)
Runs an interactive calibration tool using the serial interface.
Definition SimRacing.cpp:410
+
SimRacing::Pedals::hasPedal
bool hasPedal(PedalID pedal) const
Checks if a given pedal is present in the class.
Definition SimRacing.cpp:380
+
SimRacing::Pedals::update
virtual bool update()
Perform a poll of the hardware to refresh the class state.
Definition SimRacing.cpp:348
+
SimRacing::Pedals::begin
virtual void begin()
Initialize the hardware (if necessary)
Definition SimRacing.cpp:344
+
SimRacing::Pedals::getPosition
long 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 valu...
Definition SimRacing.cpp:370
diff --git a/docs/_pedals_print_8ino_source.html b/docs/_pedals_print_8ino_source.html index 0177fad..2f4e670 100644 --- a/docs/_pedals_print_8ino_source.html +++ b/docs/_pedals_print_8ino_source.html @@ -186,11 +186,11 @@
83}
SimRacing.h
Header file for the Sim Racing Library.
SimRacing::LogitechPedals
Interface with the Logitech pedals (Gas, Brake, and Clutch)
Definition SimRacing.h:748
-
SimRacing::Pedals::serialCalibration
void serialCalibration(Stream &iface=Serial)
Definition SimRacing.cpp:410
-
SimRacing::Pedals::hasPedal
bool hasPedal(PedalID pedal) const
Definition SimRacing.cpp:380
-
SimRacing::Pedals::update
virtual bool update()
Definition SimRacing.cpp:348
-
SimRacing::Pedals::begin
virtual void begin()
Definition SimRacing.cpp:344
-
SimRacing::Pedals::getPosition
long getPosition(PedalID pedal, long rMin=0, long rMax=100) const
Definition SimRacing.cpp:370
+
SimRacing::Pedals::serialCalibration
void serialCalibration(Stream &iface=Serial)
Runs an interactive calibration tool using the serial interface.
Definition SimRacing.cpp:410
+
SimRacing::Pedals::hasPedal
bool hasPedal(PedalID pedal) const
Checks if a given pedal is present in the class.
Definition SimRacing.cpp:380
+
SimRacing::Pedals::update
virtual bool update()
Perform a poll of the hardware to refresh the class state.
Definition SimRacing.cpp:348
+
SimRacing::Pedals::begin
virtual void begin()
Initialize the hardware (if necessary)
Definition SimRacing.cpp:344
+
SimRacing::Pedals::getPosition
long 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 valu...
Definition SimRacing.cpp:370
diff --git a/docs/_shift_joystick_8ino-example.html b/docs/_shift_joystick_8ino-example.html index ccaca5b..bbf5463 100644 --- a/docs/_shift_joystick_8ino-example.html +++ b/docs/_shift_joystick_8ino-example.html @@ -102,7 +102,6 @@

Emulates the shifter as a joystick over USB.

-

Emulates the shifter as a joystick over USB.

/*
* Project Sim Racing Library for Arduino
* @author David Madison
@@ -211,13 +210,13 @@
Joystick.sendState();
}
SimRacing.h
Header file for the Sim Racing Library.
-
SimRacing::AnalogShifter::getReverseButton
bool getReverseButton() const
Definition SimRacing.cpp:777
- - -
SimRacing::AnalogShifter::getPosition
long getPosition(Axis ax, long rMin=AnalogInput::Min, long rMax=AnalogInput::Max) const
Definition SimRacing.cpp:767
+
SimRacing::AnalogShifter::getReverseButton
bool getReverseButton() const
Checks the current state of the "reverse" button at the bottom of the shift column.
Definition SimRacing.cpp:777
+
SimRacing::AnalogShifter::update
virtual bool update()
Polls the hardware to update the current gear state.
Definition SimRacing.cpp:679
+
SimRacing::AnalogShifter::begin
virtual void begin()
Initializes the hardware pins for reading the gear states.
Definition SimRacing.cpp:674
+
SimRacing::AnalogShifter::getPosition
long getPosition(Axis ax, long rMin=AnalogInput::Min, long rMax=AnalogInput::Max) const
Retrieves the buffered position for the analog axis, rescaled to a nominal range using the calibratio...
Definition SimRacing.cpp:767
SimRacing::LogitechShifter
Interface with the Logitech Driving Force shifter.
Definition SimRacing.h:775
-
SimRacing::Shifter::getGear
int8_t getGear() const
Definition SimRacing.h:463
-
SimRacing::Shifter::gearChanged
bool gearChanged() const
Definition SimRacing.h:507
+
SimRacing::Shifter::getGear
int8_t getGear() const
Returns the currently selected gear.
Definition SimRacing.h:463
+
SimRacing::Shifter::gearChanged
bool gearChanged() const
Checks whether the current gear has changed since the last update.
Definition SimRacing.h:507
diff --git a/docs/_shift_joystick_8ino_source.html b/docs/_shift_joystick_8ino_source.html index 25d4a7a..d9bd622 100644 --- a/docs/_shift_joystick_8ino_source.html +++ b/docs/_shift_joystick_8ino_source.html @@ -214,13 +214,13 @@
111 Joystick.sendState();
112}
SimRacing.h
Header file for the Sim Racing Library.
-
SimRacing::AnalogShifter::getReverseButton
bool getReverseButton() const
Definition SimRacing.cpp:777
-
SimRacing::AnalogShifter::update
virtual bool update()
Definition SimRacing.cpp:679
-
SimRacing::AnalogShifter::begin
virtual void begin()
Definition SimRacing.cpp:674
-
SimRacing::AnalogShifter::getPosition
long getPosition(Axis ax, long rMin=AnalogInput::Min, long rMax=AnalogInput::Max) const
Definition SimRacing.cpp:767
+
SimRacing::AnalogShifter::getReverseButton
bool getReverseButton() const
Checks the current state of the "reverse" button at the bottom of the shift column.
Definition SimRacing.cpp:777
+
SimRacing::AnalogShifter::update
virtual bool update()
Polls the hardware to update the current gear state.
Definition SimRacing.cpp:679
+
SimRacing::AnalogShifter::begin
virtual void begin()
Initializes the hardware pins for reading the gear states.
Definition SimRacing.cpp:674
+
SimRacing::AnalogShifter::getPosition
long getPosition(Axis ax, long rMin=AnalogInput::Min, long rMax=AnalogInput::Max) const
Retrieves the buffered position for the analog axis, rescaled to a nominal range using the calibratio...
Definition SimRacing.cpp:767
SimRacing::LogitechShifter
Interface with the Logitech Driving Force shifter.
Definition SimRacing.h:775
-
SimRacing::Shifter::getGear
int8_t getGear() const
Definition SimRacing.h:463
-
SimRacing::Shifter::gearChanged
bool gearChanged() const
Definition SimRacing.h:507
+
SimRacing::Shifter::getGear
int8_t getGear() const
Returns the currently selected gear.
Definition SimRacing.h:463
+
SimRacing::Shifter::gearChanged
bool gearChanged() const
Checks whether the current gear has changed since the last update.
Definition SimRacing.h:507
diff --git a/docs/_shift_print_8ino-example.html b/docs/_shift_print_8ino-example.html index 692f197..fd2b4ad 100644 --- a/docs/_shift_print_8ino-example.html +++ b/docs/_shift_print_8ino-example.html @@ -102,7 +102,6 @@

Reads and prints the current gear over serial.

-

Reads and prints the current gear over serial.

/*
* Project Sim Racing Library for Arduino
* @author David Madison
@@ -185,14 +184,14 @@
}
}
SimRacing.h
Header file for the Sim Racing Library.
-
SimRacing::AnalogShifter::serialCalibration
void serialCalibration(Stream &iface=Serial)
Definition SimRacing.cpp:867
-
SimRacing::AnalogShifter::getPositionRaw
int getPositionRaw(Axis ax) const
Definition SimRacing.cpp:772
- - +
SimRacing::AnalogShifter::serialCalibration
void serialCalibration(Stream &iface=Serial)
Runs an interactive calibration tool using the serial interface.
Definition SimRacing.cpp:867
+
SimRacing::AnalogShifter::getPositionRaw
int getPositionRaw(Axis ax) const
Retrieves the buffered position for the analog axis.
Definition SimRacing.cpp:772
+
SimRacing::AnalogShifter::update
virtual bool update()
Polls the hardware to update the current gear state.
Definition SimRacing.cpp:679
+
SimRacing::AnalogShifter::begin
virtual void begin()
Initializes the hardware pins for reading the gear states.
Definition SimRacing.cpp:674
SimRacing::LogitechShifter
Interface with the Logitech Driving Force shifter.
Definition SimRacing.h:775
-
SimRacing::Shifter::getGear
int8_t getGear() const
Definition SimRacing.h:463
-
SimRacing::Shifter::getGearString
static String getGearString(int gear)
Definition SimRacing.cpp:611
-
SimRacing::Shifter::gearChanged
bool gearChanged() const
Definition SimRacing.h:507
+
SimRacing::Shifter::getGear
int8_t getGear() const
Returns the currently selected gear.
Definition SimRacing.h:463
+
SimRacing::Shifter::getGearString
static String getGearString(int gear)
Returns a String that represents the given gear.
Definition SimRacing.cpp:611
+
SimRacing::Shifter::gearChanged
bool gearChanged() const
Checks whether the current gear has changed since the last update.
Definition SimRacing.h:507
diff --git a/docs/_shift_print_8ino_source.html b/docs/_shift_print_8ino_source.html index 8210dd1..f12ad76 100644 --- a/docs/_shift_print_8ino_source.html +++ b/docs/_shift_print_8ino_source.html @@ -188,14 +188,14 @@
85 }
86}
SimRacing.h
Header file for the Sim Racing Library.
-
SimRacing::AnalogShifter::serialCalibration
void serialCalibration(Stream &iface=Serial)
Definition SimRacing.cpp:867
-
SimRacing::AnalogShifter::getPositionRaw
int getPositionRaw(Axis ax) const
Definition SimRacing.cpp:772
-
SimRacing::AnalogShifter::update
virtual bool update()
Definition SimRacing.cpp:679
-
SimRacing::AnalogShifter::begin
virtual void begin()
Definition SimRacing.cpp:674
+
SimRacing::AnalogShifter::serialCalibration
void serialCalibration(Stream &iface=Serial)
Runs an interactive calibration tool using the serial interface.
Definition SimRacing.cpp:867
+
SimRacing::AnalogShifter::getPositionRaw
int getPositionRaw(Axis ax) const
Retrieves the buffered position for the analog axis.
Definition SimRacing.cpp:772
+
SimRacing::AnalogShifter::update
virtual bool update()
Polls the hardware to update the current gear state.
Definition SimRacing.cpp:679
+
SimRacing::AnalogShifter::begin
virtual void begin()
Initializes the hardware pins for reading the gear states.
Definition SimRacing.cpp:674
SimRacing::LogitechShifter
Interface with the Logitech Driving Force shifter.
Definition SimRacing.h:775
-
SimRacing::Shifter::getGear
int8_t getGear() const
Definition SimRacing.h:463
-
SimRacing::Shifter::getGearString
static String getGearString(int gear)
Definition SimRacing.cpp:611
-
SimRacing::Shifter::gearChanged
bool gearChanged() const
Definition SimRacing.h:507
+
SimRacing::Shifter::getGear
int8_t getGear() const
Returns the currently selected gear.
Definition SimRacing.h:463
+
SimRacing::Shifter::getGearString
static String getGearString(int gear)
Returns a String that represents the given gear.
Definition SimRacing.cpp:611
+
SimRacing::Shifter::gearChanged
bool gearChanged() const
Checks whether the current gear has changed since the last update.
Definition SimRacing.h:507
diff --git a/docs/_sim_racing_8cpp_source.html b/docs/_sim_racing_8cpp_source.html index fc0bb80..216706b 100644 --- a/docs/_sim_racing_8cpp_source.html +++ b/docs/_sim_racing_8cpp_source.html @@ -1234,75 +1234,75 @@
1091
1092}; // end SimRacing namespace
SimRacing.h
Header file for the Sim Racing Library.
-
SimRacing::Axis
Axis
Definition SimRacing.h:37
+
SimRacing::Axis
Axis
Enumeration for analog axis names, mapped to integers.
Definition SimRacing.h:37
SimRacing::AnalogInput
Handle I/O for analog (ADC) inputs.
Definition SimRacing.h:124
-
SimRacing::AnalogInput::setInverted
void setInverted(bool invert=true)
Definition SimRacing.cpp:319
-
SimRacing::AnalogInput::isInverted
bool isInverted() const
Definition SimRacing.cpp:311
-
SimRacing::AnalogInput::getPosition
long getPosition(long rMin=Min, long rMax=Max) const
Definition SimRacing.cpp:302
-
SimRacing::AnalogInput::getPositionRaw
int getPositionRaw() const
Definition SimRacing.cpp:307
+
SimRacing::AnalogInput::setInverted
void setInverted(bool invert=true)
Set the 'inverted' state of the axis.
Definition SimRacing.cpp:319
+
SimRacing::AnalogInput::isInverted
bool isInverted() const
Check whether the axis is inverted or not.
Definition SimRacing.cpp:311
+
SimRacing::AnalogInput::getPosition
long getPosition(long rMin=Min, long rMax=Max) const
Retrieves the buffered position for the analog axis, rescaled to a nominal range using the calibratio...
Definition SimRacing.cpp:302
+
SimRacing::AnalogInput::getPositionRaw
int getPositionRaw() const
Retrieves the buffered position for the analog axis.
Definition SimRacing.cpp:307
SimRacing::AnalogInput::Max
static const int Max
Maximum value of the analog to digital (ADC) converter. 10-bit by default.
Definition SimRacing.h:127
-
SimRacing::AnalogInput::getMax
int getMax() const
Definition SimRacing.h:176
-
SimRacing::AnalogInput::AnalogInput
AnalogInput(uint8_t p)
Definition SimRacing.cpp:261
-
SimRacing::AnalogInput::setCalibration
void setCalibration(Calibration newCal)
Definition SimRacing.cpp:327
-
SimRacing::AnalogInput::read
virtual bool read()
Definition SimRacing.cpp:269
-
SimRacing::AnalogInput::getMin
int getMin() const
Definition SimRacing.h:169
-
SimRacing::AnalogInput::setPosition
void setPosition(int newPos)
Definition SimRacing.cpp:315
+
SimRacing::AnalogInput::getMax
int getMax() const
Retrieves the calibrated maximum position.
Definition SimRacing.h:176
+
SimRacing::AnalogInput::AnalogInput
AnalogInput(uint8_t p)
Class constructor.
Definition SimRacing.cpp:261
+
SimRacing::AnalogInput::setCalibration
void setCalibration(Calibration newCal)
Calibrate the axis' min/max values for rescaling.
Definition SimRacing.cpp:327
+
SimRacing::AnalogInput::read
virtual bool read()
Updates the current value of the axis by polling the ADC.
Definition SimRacing.cpp:269
+
SimRacing::AnalogInput::getMin
int getMin() const
Retrieves the calibrated minimum position.
Definition SimRacing.h:169
+
SimRacing::AnalogInput::setPosition
void setPosition(int newPos)
Override the current position with a custom value.
Definition SimRacing.cpp:315
SimRacing::AnalogInput::Min
static const int Min
Minimum value of the analog to digital (ADC) converter.
Definition SimRacing.h:126
SimRacing::AnalogShifter
Interface with shifters using two potentiometers for gear position.
Definition SimRacing.h:535
-
SimRacing::AnalogShifter::setCalibration
void setCalibration(GearPosition neutral, GearPosition g1, GearPosition g2, GearPosition g3, GearPosition g4, GearPosition g5, GearPosition g6, float engagePoint=CalEngagementPoint, float releasePoint=CalReleasePoint, float edgeOffset=CalEdgeOffset)
Definition SimRacing.cpp:786
-
SimRacing::AnalogShifter::serialCalibration
void serialCalibration(Stream &iface=Serial)
Definition SimRacing.cpp:867
-
SimRacing::AnalogShifter::getReverseButton
bool getReverseButton() const
Definition SimRacing.cpp:777
-
SimRacing::AnalogShifter::AnalogShifter
AnalogShifter(uint8_t pinX, uint8_t pinY, uint8_t pinRev=NOT_A_PIN, uint8_t detectPin=NOT_A_PIN)
Definition SimRacing.cpp:660
-
SimRacing::AnalogShifter::getPositionRaw
int getPositionRaw(Axis ax) const
Definition SimRacing.cpp:772
-
SimRacing::AnalogShifter::update
virtual bool update()
Definition SimRacing.cpp:679
-
SimRacing::AnalogShifter::isConnected
bool isConnected() const
Definition SimRacing.h:629
-
SimRacing::AnalogShifter::begin
virtual void begin()
Definition SimRacing.cpp:674
-
SimRacing::AnalogShifter::getPosition
long getPosition(Axis ax, long rMin=AnalogInput::Min, long rMax=AnalogInput::Max) const
Definition SimRacing.cpp:767
-
SimRacing::DeviceConnection::poll
void poll()
Definition SimRacing.cpp:192
-
SimRacing::DeviceConnection::setStablePeriod
void setStablePeriod(unsigned long t)
Definition SimRacing.cpp:236
-
SimRacing::DeviceConnection::DeviceConnection
DeviceConnection(uint8_t pin, bool invert=false, unsigned long detectTime=250)
Definition SimRacing.cpp:164
-
SimRacing::DeviceConnection::getState
ConnectionState getState() const
Definition SimRacing.cpp:228
-
SimRacing::DeviceConnection::ConnectionState
ConnectionState
Definition SimRacing.h:56
+
SimRacing::AnalogShifter::setCalibration
void setCalibration(GearPosition neutral, GearPosition g1, GearPosition g2, GearPosition g3, GearPosition g4, GearPosition g5, GearPosition g6, float engagePoint=CalEngagementPoint, float releasePoint=CalReleasePoint, float edgeOffset=CalEdgeOffset)
Calibrate the gear shifter for more accurate shifting.
Definition SimRacing.cpp:786
+
SimRacing::AnalogShifter::serialCalibration
void serialCalibration(Stream &iface=Serial)
Runs an interactive calibration tool using the serial interface.
Definition SimRacing.cpp:867
+
SimRacing::AnalogShifter::getReverseButton
bool getReverseButton() const
Checks the current state of the "reverse" button at the bottom of the shift column.
Definition SimRacing.cpp:777
+
SimRacing::AnalogShifter::AnalogShifter
AnalogShifter(uint8_t pinX, uint8_t pinY, uint8_t pinRev=NOT_A_PIN, uint8_t detectPin=NOT_A_PIN)
Class constructor.
Definition SimRacing.cpp:660
+
SimRacing::AnalogShifter::getPositionRaw
int getPositionRaw(Axis ax) const
Retrieves the buffered position for the analog axis.
Definition SimRacing.cpp:772
+
SimRacing::AnalogShifter::update
virtual bool update()
Polls the hardware to update the current gear state.
Definition SimRacing.cpp:679
+
SimRacing::AnalogShifter::isConnected
bool isConnected() const
Check if the device is physically connected to the board.
Definition SimRacing.h:629
+
SimRacing::AnalogShifter::begin
virtual void begin()
Initializes the hardware pins for reading the gear states.
Definition SimRacing.cpp:674
+
SimRacing::AnalogShifter::getPosition
long getPosition(Axis ax, long rMin=AnalogInput::Min, long rMax=AnalogInput::Max) const
Retrieves the buffered position for the analog axis, rescaled to a nominal range using the calibratio...
Definition SimRacing.cpp:767
+
SimRacing::DeviceConnection::poll
void poll()
Checks if the pin detects a connection.
Definition SimRacing.cpp:192
+
SimRacing::DeviceConnection::setStablePeriod
void setStablePeriod(unsigned long t)
Allows the user to change the stable period of the detector.
Definition SimRacing.cpp:236
+
SimRacing::DeviceConnection::DeviceConnection
DeviceConnection(uint8_t pin, bool invert=false, unsigned long detectTime=250)
Class constructor.
Definition SimRacing.cpp:164
+
SimRacing::DeviceConnection::getState
ConnectionState getState() const
Retrieves the current ConnectionState from the instance.
Definition SimRacing.cpp:228
+
SimRacing::DeviceConnection::ConnectionState
ConnectionState
The state of the connection, whether it is connected, disconnected, and everywhere in-between.
Definition SimRacing.h:56
SimRacing::DeviceConnection::Unplug
@ Unplug
Device was just removed (connection ends)
Definition SimRacing.h:60
SimRacing::DeviceConnection::PlugIn
@ PlugIn
Device was just plugged in (connection starts), unstable.
Definition SimRacing.h:58
SimRacing::DeviceConnection::Disconnected
@ Disconnected
No connection present.
Definition SimRacing.h:57
SimRacing::DeviceConnection::Connected
@ Connected
Connection present and stable.
Definition SimRacing.h:59
-
SimRacing::DeviceConnection::isConnected
bool isConnected() const
Definition SimRacing.cpp:232
-
SimRacing::Handbrake::begin
virtual void begin()
Definition SimRacing.cpp:997
-
SimRacing::Handbrake::getPosition
long getPosition(long rMin=0, long rMax=100) const
Definition SimRacing.cpp:1016
-
SimRacing::Handbrake::setCalibration
void setCalibration(AnalogInput::Calibration newCal)
Definition SimRacing.cpp:1024
-
SimRacing::Handbrake::Handbrake
Handbrake(uint8_t pinAx, uint8_t detectPin=NOT_A_PIN)
Definition SimRacing.cpp:990
-
SimRacing::Handbrake::getPositionRaw
int getPositionRaw() const
Definition SimRacing.cpp:1020
-
SimRacing::Handbrake::update
virtual bool update()
Definition SimRacing.cpp:1001
-
SimRacing::Handbrake::isConnected
bool isConnected() const
Definition SimRacing.h:733
-
SimRacing::Handbrake::serialCalibration
void serialCalibration(Stream &iface=Serial)
Definition SimRacing.cpp:1029
-
SimRacing::LogitechDrivingForceGT_Pedals::LogitechDrivingForceGT_Pedals
LogitechDrivingForceGT_Pedals(uint8_t gasPin, uint8_t brakePin, uint8_t detectPin=NOT_A_PIN)
Definition SimRacing.cpp:574
-
SimRacing::LogitechPedals::LogitechPedals
LogitechPedals(uint8_t gasPin, uint8_t brakePin, uint8_t clutchPin, uint8_t detectPin=NOT_A_PIN)
Definition SimRacing.cpp:565
-
SimRacing::LogitechShifter::LogitechShifter
LogitechShifter(uint8_t pinX, uint8_t pinY, uint8_t pinRev=NOT_A_PIN, uint8_t detectPin=NOT_A_PIN)
Definition SimRacing.cpp:980
+
SimRacing::DeviceConnection::isConnected
bool isConnected() const
Check if the device is physically connected to the board.
Definition SimRacing.cpp:232
+
SimRacing::Handbrake::begin
virtual void begin()
Initializes the pin for reading from the handbrake.
Definition SimRacing.cpp:997
+
SimRacing::Handbrake::getPosition
long getPosition(long rMin=0, long rMax=100) const
Retrieves the buffered position for the handbrake axis, rescaled to a nominal range using the calibra...
Definition SimRacing.cpp:1016
+
SimRacing::Handbrake::setCalibration
void setCalibration(AnalogInput::Calibration newCal)
Calibrate the axis' min/max values for rescaling.
Definition SimRacing.cpp:1024
+
SimRacing::Handbrake::Handbrake
Handbrake(uint8_t pinAx, uint8_t detectPin=NOT_A_PIN)
Class constructor.
Definition SimRacing.cpp:990
+
SimRacing::Handbrake::getPositionRaw
int getPositionRaw() const
Retrieves the buffered position for the handbrake, ignoring the calibration data.
Definition SimRacing.cpp:1020
+
SimRacing::Handbrake::update
virtual bool update()
Polls the handbrake to update its position.
Definition SimRacing.cpp:1001
+
SimRacing::Handbrake::isConnected
bool isConnected() const
Check if the device is physically connected to the board.
Definition SimRacing.h:733
+
SimRacing::Handbrake::serialCalibration
void serialCalibration(Stream &iface=Serial)
Runs an interactive calibration tool using the serial interface.
Definition SimRacing.cpp:1029
+
SimRacing::LogitechDrivingForceGT_Pedals::LogitechDrivingForceGT_Pedals
LogitechDrivingForceGT_Pedals(uint8_t gasPin, uint8_t brakePin, uint8_t detectPin=NOT_A_PIN)
Class constructor.
Definition SimRacing.cpp:574
+
SimRacing::LogitechPedals::LogitechPedals
LogitechPedals(uint8_t gasPin, uint8_t brakePin, uint8_t clutchPin, uint8_t detectPin=NOT_A_PIN)
Class constructor.
Definition SimRacing.cpp:565
+
SimRacing::LogitechShifter::LogitechShifter
LogitechShifter(uint8_t pinX, uint8_t pinY, uint8_t pinRev=NOT_A_PIN, uint8_t detectPin=NOT_A_PIN)
Class constructor.
Definition SimRacing.cpp:980
SimRacing::Pedals
Base class for all pedals instances.
Definition SimRacing.h:276
-
SimRacing::Pedals::serialCalibration
void serialCalibration(Stream &iface=Serial)
Definition SimRacing.cpp:410
-
SimRacing::Pedals::setCalibration
void setCalibration(PedalID pedal, AnalogInput::Calibration cal)
Definition SimRacing.cpp:384
-
SimRacing::Pedals::Pedals
Pedals(AnalogInput *dataPtr, uint8_t nPedals, uint8_t detectPin)
Definition SimRacing.cpp:336
-
SimRacing::Pedals::getPedalName
static String getPedalName(PedalID pedal)
Definition SimRacing.cpp:390
-
SimRacing::Pedals::hasPedal
bool hasPedal(PedalID pedal) const
Definition SimRacing.cpp:380
-
SimRacing::Pedals::getPositionRaw
int getPositionRaw(PedalID pedal) const
Definition SimRacing.cpp:375
-
SimRacing::Pedals::update
virtual bool update()
Definition SimRacing.cpp:348
-
SimRacing::Pedals::begin
virtual void begin()
Definition SimRacing.cpp:344
-
SimRacing::Pedals::getPosition
long getPosition(PedalID pedal, long rMin=0, long rMax=100) const
Definition SimRacing.cpp:370
-
SimRacing::Pedals::getNumPedals
int getNumPedals() const
Definition SimRacing.h:332
+
SimRacing::Pedals::serialCalibration
void serialCalibration(Stream &iface=Serial)
Runs an interactive calibration tool using the serial interface.
Definition SimRacing.cpp:410
+
SimRacing::Pedals::setCalibration
void setCalibration(PedalID pedal, AnalogInput::Calibration cal)
Calibrate a pedal's min/max values for rescaling.
Definition SimRacing.cpp:384
+
SimRacing::Pedals::Pedals
Pedals(AnalogInput *dataPtr, uint8_t nPedals, uint8_t detectPin)
Class constructor.
Definition SimRacing.cpp:336
+
SimRacing::Pedals::getPedalName
static String getPedalName(PedalID pedal)
Utility function to get the string name for each pedal.
Definition SimRacing.cpp:390
+
SimRacing::Pedals::hasPedal
bool hasPedal(PedalID pedal) const
Checks if a given pedal is present in the class.
Definition SimRacing.cpp:380
+
SimRacing::Pedals::getPositionRaw
int getPositionRaw(PedalID pedal) const
Retrieves the buffered position for the pedal, ignoring the calibration data.
Definition SimRacing.cpp:375
+
SimRacing::Pedals::update
virtual bool update()
Perform a poll of the hardware to refresh the class state.
Definition SimRacing.cpp:348
+
SimRacing::Pedals::begin
virtual void begin()
Initialize the hardware (if necessary)
Definition SimRacing.cpp:344
+
SimRacing::Pedals::getPosition
long 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 valu...
Definition SimRacing.cpp:370
+
SimRacing::Pedals::getNumPedals
int getNumPedals() const
Retrieves the number of pedals handled by the class.
Definition SimRacing.h:332
SimRacing::Shifter
Base class for all shifter instances.
Definition SimRacing.h:445
-
SimRacing::Shifter::getGearString
String getGearString() const
Definition SimRacing.cpp:648
-
SimRacing::Shifter::getGear
int8_t getGear() const
Definition SimRacing.h:463
-
SimRacing::Shifter::Shifter
Shifter(int8_t min, int8_t max)
Definition SimRacing.cpp:585
-
SimRacing::Shifter::getGearChar
char getGearChar() const
Definition SimRacing.cpp:607
+
SimRacing::Shifter::getGearString
String getGearString() const
Returns a String that represents the current gear.
Definition SimRacing.cpp:648
+
SimRacing::Shifter::getGear
int8_t getGear() const
Returns the currently selected gear.
Definition SimRacing.h:463
+
SimRacing::Shifter::Shifter
Shifter(int8_t min, int8_t max)
Class constructor.
Definition SimRacing.cpp:585
+
SimRacing::Shifter::getGearChar
char getGearChar() const
Returns a character that represents the current gear.
Definition SimRacing.cpp:607
SimRacing::Shifter::changed
bool changed
whether the gear has changed since the previous update
Definition SimRacing.h:528
SimRacing::Shifter::currentGear
int8_t currentGear
index of the current gear
Definition SimRacing.h:527
SimRacing::ThreePedals
Pedal implementation for devices with gas, brake, and clutch.
Definition SimRacing.h:407
-
SimRacing::ThreePedals::ThreePedals
ThreePedals(uint8_t gasPin, uint8_t brakePin, uint8_t clutchPin, uint8_t detectPin=NOT_A_PIN)
Definition SimRacing.cpp:552
-
SimRacing::ThreePedals::setCalibration
void setCalibration(AnalogInput::Calibration gasCal, AnalogInput::Calibration brakeCal, AnalogInput::Calibration clutchCal)
Definition SimRacing.cpp:557
+
SimRacing::ThreePedals::ThreePedals
ThreePedals(uint8_t gasPin, uint8_t brakePin, uint8_t clutchPin, uint8_t detectPin=NOT_A_PIN)
Class constructor.
Definition SimRacing.cpp:552
+
SimRacing::ThreePedals::setCalibration
void setCalibration(AnalogInput::Calibration gasCal, AnalogInput::Calibration brakeCal, AnalogInput::Calibration clutchCal)
Sets the calibration data (min/max) for the pedals.
Definition SimRacing.cpp:557
SimRacing::TwoPedals
Pedal implementation for devices with only gas and brake.
Definition SimRacing.h:379
-
SimRacing::TwoPedals::setCalibration
void setCalibration(AnalogInput::Calibration gasCal, AnalogInput::Calibration brakeCal)
Definition SimRacing.cpp:546
-
SimRacing::TwoPedals::TwoPedals
TwoPedals(uint8_t gasPin, uint8_t brakePin, uint8_t detectPin=NOT_A_PIN)
Definition SimRacing.cpp:541
+
SimRacing::TwoPedals::setCalibration
void setCalibration(AnalogInput::Calibration gasCal, AnalogInput::Calibration brakeCal)
Sets the calibration data (min/max) for the pedals.
Definition SimRacing.cpp:546
+
SimRacing::TwoPedals::TwoPedals
TwoPedals(uint8_t gasPin, uint8_t brakePin, uint8_t detectPin=NOT_A_PIN)
Class constructor.
Definition SimRacing.cpp:541
SimRacing::Pedal
Pedal
Pedal ID names.
Definition SimRacing.h:265
SimRacing::AnalogInput::Calibration
Simple struct containing min/max values for axis calibration.
Definition SimRacing.h:215
SimRacing::AnalogInput::Calibration::max
int max
Maximum value of the analog axis.
Definition SimRacing.h:217
diff --git a/docs/_sim_racing_8h.html b/docs/_sim_racing_8h.html index 4bee27e..11f8ecc 100644 --- a/docs/_sim_racing_8h.html +++ b/docs/_sim_racing_8h.html @@ -160,8 +160,10 @@

Macros

#define SHIFTER_SHIELD_V1_PINS   A1, A0, 14, A2 + Pin definitions for the Parts Not Included Logitech Shifter Shield, designed for the SparkFun Pro Micro:
  #define PEDAL_SHIELD_V1_PINS   A2, A1, A0, 10 + Pin definitions for the Parts Not Included Logitech Pedals Shield, designed for the SparkFun Pro Micro:
  +

@@ -169,6 +171,7 @@

enum  SimRacing::Axis : uint8_t { SimRacing::X = 0 , SimRacing::Y = 1 }
 Enumeration for analog axis names, mapped to integers. More...
 
enum  SimRacing::Pedal {
  Gas = 0 @@ -198,7 +201,8 @@

-

Pin definitions for the Parts Not Included Logitech Pedals Shield, designed for the SparkFun Pro Micro:

+ +

Pin definitions for the Parts Not Included Logitech Pedals Shield, designed for the SparkFun Pro Micro: