Updated Variants (markdown)

Candas1
2022-01-02 17:52:25 +01:00
parent 23e5a1c871
commit ce62fc975a

@@ -12,3 +12,23 @@ Variants are a set of parameters to configure FOC firmware for a specific use.
|<sub>MIXER<br>CMD1<br>CMD2</sub>|<sub><BR>STEER<BR>SPEED</sub>|<sub><BR>STEER<BR>SPEED</sub>|<sub><BR>STEER<BR>SPEED</sub>|<sub><BR>STEER<BR>SPEED</sub>|<sub><BR>STEER<BR>SPEED</sub>|<sub><BR>STEER<BR>SPEED</sub>|<sub><BR>BRAKE<BR>THROTTLE</sub>|<sub><BR>DISTANCE<BR>STEER</sub>|<sub><BR>N/A<BR>THROTTLE/BRAKE</sub>|<sub><BR>ANGLE LEFT<BR>ANGLE RIGHT</sub>|
|<sub>AUTO<BR>CALIBRATION</sub>|<sub>YES</sub>|<sub>YES</sub>|<sub>YES</sub>|<sub>YES</sub>|<sub>YES</sub>|<sub>YES</sub>|<sub>YES</sub>|<sub>NO</sub>|<sub>YES</sub>|<sub>NO</sub>|
|<sub>CURRENT<BR>MAX SPEED<BR>LIMIT</sub>|<sub>YES</sub>|<sub>YES</sub>|<sub>YES</sub>|<sub>YES</sub>|<sub>YES</sub>|<sub>YES</sub>|<sub>YES</sub>|<sub>NO</sub>|<sub>YES</sub>|<sub>NO</sub>|
# Dual Inputs
The firmware supports the input to be provided from two different sources connected to the Left and Right cable, respectively. To enable dual-inputs functionality uncomment `#define DUAL_INPUTS` in config.h for the respective variant. Various dual-inputs combinations can be realized as illustrated in the following table:
| Left | Right | Availability |
| --- | --- | --- |
| ADC<sup>(0)</sup> | UART<sup>(1)</sup> | VARIANT_ADC |
| ADC<sup>(0)</sup> | {PPM,PWM,iBUS}<sup>(1)</sup> | VARIANT_{PPM,PWM,IBUS} |
| ADC<sup>(0)</sup> | Sideboard<sup></sup><sup>(1*)</sup> | VARIANT_HOVERCAR |
| UART<sup>(0)</sup> | Sideboard<sup>(1*)</sup> | VARIANT_UART |
| UART<sup>(1)</sup> | Nunchuk<sup>(0)</sup> | VARIANT_NUNCHUK |
<sup>(0)</sup> Primary input: this input is used when the Auxilliary input is not available or not connected.<br/>
<sup>(1)</sup> Auxilliary input: this inputs is used when connected or enabled by a switch<sup>(*)</sup>. If the Auxilliary input is disconnected, the firmware will automatically switch to the Primary input. Timeout is reported **only** on the Primary input.
With slight modifications in config.h, other dual-inputs combinations can be realized as:
| Left | Right | Possibility |
| --- | --- | --- |
| Sideboard<sup>(1*)</sup> | UART<sup>(0)</sup> | VARIANT_UART |
| UART<sup>(0)</sup> | {PPM,PWM,iBUS}<sup>(1)</sup> | VARIANT_{PPM,PWM,IBUS} |
| {PPM,PWM,iBUS}<sup>(1)</sup> | Nunchuk<sup>(0)</sup> | VARIANT_{PPM,PWM,IBUS} |