From 1c60388d2231a19324b22e66e5b2b3601c5df6f1 Mon Sep 17 00:00:00 2001 From: Candas1 Date: Sun, 2 Jan 2022 18:38:50 +0100 Subject: [PATCH] Updated Variants (markdown) --- Variants.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/Variants.md b/Variants.md index cf73c85..f4c3273 100644 --- a/Variants.md +++ b/Variants.md @@ -2,6 +2,22 @@ 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 * 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 +## Example Variants + +- **[VARIANT_ADC](https://github.com/EFeru/hoverboard-firmware-hack-FOC/wiki/Variant-ADC)**: The motors are controlled by two potentiometers connected to the Left sensor cable (long wired) +- **[VARIANT_USART](https://github.com/EFeru/hoverboard-firmware-hack-FOC/wiki/Variant-USART)**: The motors are controlled via serial protocol (e.g. on USART3 right sensor cable, the short wired cable). The commands can be sent from an Arduino. Check out the [hoverserial.ino](/Arduino/hoverserial) as an example sketch. +- **[VARIANT_NUNCHUK](https://github.com/EFeru/hoverboard-firmware-hack-FOC/wiki/Variant-Nunchuk)**: Wii Nunchuk offers one hand control for throttle, braking and steering. This was one of the first input device used for electric armchairs or bottle crates. +- **[VARIANT_PPM](https://github.com/EFeru/hoverboard-firmware-hack-FOC/wiki/Variant-PPM)**: RC remote control with PPM Sum signal. +- **[VARIANT_PWM](https://github.com/EFeru/hoverboard-firmware-hack-FOC/wiki/Variant-PWM)**: RC remote control with PWM signal. +- **[VARIANT_IBUS](https://github.com/EFeru/hoverboard-firmware-hack-FOC/wiki/Variant-IBUS)**: RC remote control with Flysky iBUS protocol connected to the Left sensor cable. +- **[VARIANT_HOVERCAR](https://github.com/EFeru/hoverboard-firmware-hack-FOC/wiki/Variant-HOVERCAR)**: The motors are controlled by two pedals brake and throttle. Reverse is engaged by double tapping on the brake pedal at standstill. +- **[VARIANT_TRANSPOTTER](https://github.com/EFeru/hoverboard-firmware-hack-FOC/wiki/Variant-TRANSPOTTER)**: This is for transpotter build, which is a hoverboard based transportation system. For more details on how to build it check [here](https://github.com/NiklasFauth/hoverboard-firmware-hack/wiki/Build-Instruction:-TranspOtter) and [here](https://hackaday.io/project/161891-transpotter-ng). +- **[VARIANT_SKATEBOARD](https://github.com/EFeru/hoverboard-firmware-hack-FOC/wiki/Variant-SKATEBOARD)**: This is for skateboard build, controlled using an RC remote with PWM signal connected to the right sensor cable. +- **[VARIANT_HOVERBOARD](https://github.com/EFeru/hoverboard-firmware-hack-FOC/wiki/Variant-HOVERBOARD)**: The mainboard reads the two sideboards data. The sideboards need to be flashed with the hacked version. The balancing controller is **not** yet implemented. + + +Of course the firmware can be further customized for other needs or projects. + |VARIANTS|[ADC](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/wiki/Variant-ADC)|[USART](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/wiki/Variant-USART)|[NUNCHUK](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/wiki/Variant-Nunchuk)|[PPM](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/wiki/Variant-PPM)|[PWM](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/wiki/Variant-PWM)|[IBUS](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/wiki/Variant-IBUS)|[HOVERCAR](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/wiki/Variant-HOVERCAR)|[TRANSPOTTER](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/wiki/Variant-TRANSPOTTER)|[SKATEBOARD](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/wiki/Variant-SKATEBOARD)|[HOVERBOARD](https://github.com/EmanuelFeru/hoverboard-firmware-hack-FOC/wiki/Variant-HOVERBOARD)| |---|---|---|---|---|---|---|---|---|---|---| |CONTROL|ADC|USART|I2C|PPM|PWM|USART|ADC|ADC|PWM|USART|