diff --git a/README.md b/README.md index 408606a..b07496d 100644 --- a/README.md +++ b/README.md @@ -7,15 +7,40 @@ This repository implements Field Oriented Control (FOC) for stock hoverboards. C - reduced noise and vibrations - smooth torque output and improved motor efficiency. Thus, lower energy consumption - field weakening to increase maximum speed range - + + +Table of Contents +======================= + +* [Hardware](#hardware) +* [FOC Firmware](#foc-firmware) +* [Example Variants ](#example-variants) +* [Flashing](#flashing) +* [Troubleshooting](#troubleshooting) +* [Projects and Links](#projects-and-links) +* [Contributions](#contributions) + #### For the hoverboard sideboard firmware, see the following repositories: - [hoverboard-sideboard-hack-GD](https://github.com/EmanuelFeru/hoverboard-sideboard-hack-GD) - [hoverboard-sideboard-hack-STM](https://github.com/EmanuelFeru/hoverboard-sideboard-hack-STM) #### For the FOC controller design, see the following repository: - [bldc-motor-control-FOC](https://github.com/EmanuelFeru/bldc-motor-control-FOC) - - + + + + + + + + + + + + +
+ + --- ## Hardware @@ -83,17 +108,6 @@ Each motor is constantly monitored for errors. These errors are: The error codes above are reported for each motor in the variables **rtY_Left.z_errCode** and **rtY_Right.z_errCode** for Left motor (long wired motor) and Right motor (short wired motor), respectively. In case of error, the motor power is reduced to 0, while an audible (fast beep) can be heard to notify the user. -### Demo Videos - -[►Video: HOVERCAR](https://www.youtube.com/watch?v=IgHCcj0NgWQ&t=) - -[►Video: Commutation vs Advanced control (constant speed)](https://drive.google.com/open?id=1vC_kEkp2LE2lAaMCJcmK4z2m3jrPUoBD) - -[►Video: Commutation vs Advanced control (variable speed)](https://drive.google.com/open?id=1rrQ4k5VLhhAWXQzDSCar_SmEdsbM-hq2) - -[►Video: Reliable Serial Communication demo](https://drive.google.com/open?id=1mUM-p7SE6gmyTH7zhDHy5DUyczXvmy5d) - - --- ## Example Variants diff --git a/docs/pictures/videos_preview/com_foc_const.png b/docs/pictures/videos_preview/com_foc_const.png new file mode 100644 index 0000000..c6b4f01 Binary files /dev/null and b/docs/pictures/videos_preview/com_foc_const.png differ diff --git a/docs/pictures/videos_preview/com_foc_var.png b/docs/pictures/videos_preview/com_foc_var.png new file mode 100644 index 0000000..8a359a9 Binary files /dev/null and b/docs/pictures/videos_preview/com_foc_var.png differ diff --git a/docs/pictures/videos_preview/cruise_control.png b/docs/pictures/videos_preview/cruise_control.png new file mode 100644 index 0000000..1257316 Binary files /dev/null and b/docs/pictures/videos_preview/cruise_control.png differ diff --git a/docs/pictures/videos_preview/hovercar_intro.png b/docs/pictures/videos_preview/hovercar_intro.png new file mode 100644 index 0000000..82af51f Binary files /dev/null and b/docs/pictures/videos_preview/hovercar_intro.png differ diff --git a/docs/pictures/videos_preview/hovercar_pedals.png b/docs/pictures/videos_preview/hovercar_pedals.png new file mode 100644 index 0000000..666b24a Binary files /dev/null and b/docs/pictures/videos_preview/hovercar_pedals.png differ diff --git a/docs/pictures/videos_preview/serial_com.png b/docs/pictures/videos_preview/serial_com.png new file mode 100644 index 0000000..944cef2 Binary files /dev/null and b/docs/pictures/videos_preview/serial_com.png differ