Skip to content

Commit 110b7a3

Browse files
committed
Update supported devices documentation
Added the handbrake, simplified this list, and added generic devices to the main README.
1 parent d06c0d4 commit 110b7a3

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,15 @@ Run one of the library examples in the Arduino IDE by going to `File -> Examples
1414

1515
## Supported Devices
1616

17-
* [Logitech Three Pedal Peripheral (Gas, Brake, Clutch)](http://dmadison.github.io/Sim-Racing-Arduino/docs/logitech_pedals.html)
17+
### Generic Devices
18+
* [Two pedal peripherals (gas + brake)](https://dmadison.github.io/Sim-Racing-Arduino/docs/class_sim_racing_1_1_two_pedals.html)
19+
* [Three pedal peripherals (gas, brake, clutch)](https://dmadison.github.io/Sim-Racing-Arduino/docs/class_sim_racing_1_1_three_pedals.html)
20+
* [Analog shifters](https://dmadison.github.io/Sim-Racing-Arduino/docs/class_sim_racing_1_1_analog_shifter.html)
21+
* [Analog handbrakes](https://dmadison.github.io/Sim-Racing-Arduino/docs/class_sim_racing_1_1_handbrake.html)
22+
23+
### Commercial Devices
1824
* [Logitech Two Pedal Peripheral (Gas, Brake)](http://dmadison.github.io/Sim-Racing-Arduino/docs/logitech_pedals.html)
25+
* [Logitech Three Pedal Peripheral (Gas, Brake, Clutch)](http://dmadison.github.io/Sim-Racing-Arduino/docs/logitech_pedals.html)
1926
* [Logitech Driving Force Shifter](http://dmadison.github.io/Sim-Racing-Arduino/docs/logitech_shifter.html)
2027

2128
## License

docs/pages/supported_devices.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,13 @@
11
# Supported Devices
22

3-
### Commercial Devices:
4-
5-
- @subpage logitech_pedals
6-
- @subpage logitech_shifter
7-
83
### Generic Devices
94

10-
#### Pedals
5+
* Two pedal peripherals (gas + brake) using `SimRacing::TwoPedals`
6+
* Three pedal peripherals (gas, brake, clutch) using `SimRacing::ThreePedals`
7+
* Analog shifters using `SimRacing::AnalogShifter`
8+
* Analog handbrakes using `SimRacing::Handbrake`
119

12-
The library supports generic pedal devices that connect via the microcontroller's analog to digital converter (ADC).
10+
### Commercial Devices
1311

14-
* Two pedal setups (gas + brake) use the `SimRacing::TwoPedals` class.
15-
* Three pedal setups (gas, brake, clutch) use the `SimRacing::ThreePedals` class.
16-
17-
#### Shifters
18-
19-
The library supports generic shifting devices that record gear position using a pair of potentiometers. These are supported as part of the `SimRacing::AnalogShifter` class.
12+
- @subpage logitech_pedals
13+
- @subpage logitech_shifter

0 commit comments

Comments
 (0)