diff --git a/README.md b/README.md index a9aec2bb..8ffa2439 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # AM32-MultiRotor-ESC-firmware + Firmware for ARM based speed controllers

GitHub license @@ -17,16 +18,16 @@ AM32 has the following features: - KISS standard ESC telemetry - Variable PWM frequency - Sinusoidal startup mode, which is designed to get larger motors up to speed + ## Build instructions -Download and install Keil community edition. Open the Keil project for the mcu you want in the "Keil projects" folder. Install any mcu packs if prompted. -Select the build target from the drop down box and build project + +Download and install [Keil](https://www.keil.com) community edition. Open the Keil project for the mcu you want in the "Keil projects" folder. Install any mcu packs if prompted. Select the build target from the drop down box and build project. ## Firmware Release & Configuration Tool The latest release of the firmware can be found [here](https://am32.ca/downloads). -The primary configurator is the [AM32 Configurator](https://am32.ca) -which supports web browser based configuration and firmware update. +The primary configurator is the [AM32 Configurator](https://am32.ca) which supports web browser based configuration and firmware update. You can also use a desktop configurator which you can download from here: @@ -35,27 +36,21 @@ You can also use a desktop configurator which you can download from here: Alternately you can use the [Online-ESC Configurator](https://esc-configurator.com/) to flash or change settings with any web browser that supports web serial. - - ## Hardware -AM32 currently has support for STSPIN32F0, STM32F051, STM32G071, GD32E230, AT32F415 and AT32F421. -The CKS32F051 is not recommended due to too many random issues. -Target compatibility List can be found [here](https://github.com/am32-firmware/AM32/blob/main/Inc/targets.h) +AM32 currently has support for STSPIN32F0, STM32F051, STM32G071, GD32E230, AT32F415 and AT32F421. The CKS32F051 is not recommended due to too many random issues. Target compatibility list can be found [here](https://github.com/am32-firmware/AM32/blob/main/Inc/targets.h). ## Installation & Bootloader -To use AM32 firmware on a blank ESC, a bootloader must first be installed using an ST-LINK, GD-LINK , CMIS-DAP or AT-LINK. THe bootloader will be dependant on the MCU used ont he esc . Choose the bootloader that matches the MCU type and signal input pin of the ESC. -The compatibility chart has the bootloader pinouts listed. -Current bootloaders can be found [here](https://github.com/am32-firmware/AM32-bootloader). +To use AM32 firmware on a blank ESC, a bootloader must first be installed using an ST-LINK, GD-LINK , CMIS-DAP or AT-LINK. The bootloader will be dependant on the MCU used ont he ESC. Choose the bootloader that matches the MCU type and signal input pin of the ESC. The compatibility chart has the bootloader pinouts listed. Current bootloaders can be found [here](https://github.com/am32-firmware/AM32-bootloader). -After the bootloader has been installed the main firmware from can be installed either with the configuration tools and a Betaflight flight controller or a direct connection with a usb serial adapter modified for one wire. +After the bootloader has been installed, the main firmware can be installed either with the configuration tools and a Betaflight flight controller or a direct connection with a USB serial adapter modified for one wire. To update an existing AM32 bootloader an update tool can be found [here](https://github.com/am32-firmware/AM32-unlocker). ## Support and Developers Channel -There are two ways you can get support or participate in improving am32. -We have a discord server here: + +There are two ways you can get support or participate in improving AM32. We have a discord server here: https://discord.gg/h7ddYMmEVV @@ -65,28 +60,29 @@ If you wish to support the project please join the Patreon. https://www.patreon.com/user?u=44228479 - ## Sponsors + The AM32 project would not have made this far without help from the following sponsors: -Holmes Hobbies - https://holmeshobbies.com/ - The project would not be where it is today without the support of HH. Check out the Crawlmaster V2 for the best am32 experience! +Holmes Hobbies - https://holmeshobbies.com/ - The project would not be where it is today without the support of HH. Check out the Crawlmaster V2 for the best AM32 experience! -Repeat Robotics - https://repeat-robotics.com/ - Bringing Am32 esc's to the fighting robot community! +Repeat Robotics - https://repeat-robotics.com/ - Bringing AM32 ESC's to the fighting robot community! Quaternium - https://www.quaternium.com/ - Firmware development support and hardware donations Airbot - Many hardware donations -NeutronRC - For hardware, am32 promotion and schematics +NeutronRC - For hardware, AM32 promotion and schematics Aikon - Hardware donations and schematics\ -Skystars - For hardware and taking a chance on the first commercial am32 esc's\ +Skystars - For hardware and taking a chance on the first commercial AM32 ESC's\ Diatone - Hardware donations\ T-motor - Motor and Hardware donations\ HLGRC - Hardaware donations ## Contributors + A big thanks to all those who contributed time, advice and code to the AM32 project.\ Un!t\ Hugo Chiang (Dusking)\ @@ -100,4 +96,3 @@ Markus Gritsch\ Voodoobrew (and many more) -