Updated Variants (markdown)

Candas1
2022-01-02 18:21:53 +01:00
parent 0d3f7e9d82
commit 6cbcc34c6d

@@ -1,4 +1,3 @@
# Variant selection
Variants are a set of parameters to configure FOC firmware for a specific use. Variants are a set of parameters to configure FOC firmware for a specific use.
* Platformio - Remove the semicolon in front of the desired Variant in [platformio.ini](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/blob/master/platformio.ini) file * Platformio - Remove the semicolon in front of the desired Variant in [platformio.ini](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/blob/master/platformio.ini) file
* Others - Uncomment the desired Variant by removing the leading // in Variant selection section of [config.h](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/blob/eb20cc0acad0da91ead7d207fa6a83f1778f03e1/Inc/config.h#L12) file * Others - Uncomment the desired Variant by removing the leading // in Variant selection section of [config.h](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/blob/eb20cc0acad0da91ead7d207fa6a83f1778f03e1/Inc/config.h#L12) file
@@ -13,6 +12,8 @@ Variants are a set of parameters to configure FOC firmware for a specific use.
|<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>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>| |<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>|
For the configuration/customizing of the variants, please check each variant's wiki page.
# Dual Inputs # 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: 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 | | Left | Right | Availability |