Update docs (#136)

* update docs surrounding firmware update

* add note about MSD

* fix header format

* don't neep separators
This commit is contained in:
David Holdeman 2021-05-17 00:37:00 -05:00 committed by GitHub
parent a7aeed1d52
commit 2f8b760971
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 66 additions and 20 deletions

View File

@ -6,17 +6,33 @@ rusEFI offers complete software download bundles for multiple supported microcon
[microRusEFI 0.4 and newer (STM32F4)](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_mre_f4.zip)
[Frankenso stm32f407 bundle](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle.zip)
[Proteus 0.6 (STM32F7)](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_proteus_f7.zip)
[Proteus 0.3 and newer (STM32F4)](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_proteus_f4.zip)
[Proteus 0.3-0.5 (STM32F4)](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_proteus_f4.zip)
[STM32 Discovery](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_default.zip)
### Hellen Family Boards
[121 Nissan](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_hellen121nissan.zip)
[121 VAG](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_hellen121vag.zip)
[128](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_hellen128.zip)
[72](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_hellen72.zip)
[NA6](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_hellenNA6.zip)
### Uncommon Boards
[Frankenso stm32f407 bundle](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle.zip)
[Frankenso PnP Miata NA6 bundle](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_frankenso_na6.zip)
[microRusEFI 0.3 and older (STM32F7)](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_mre_f7.zip)
[Proteus v0.2 and older (STM32F7)](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_proteus_f7.zip)
[Proteus 0.2 and older (STM32F7)](https://github.com/rusefi/rusefi/releases/latest/download/rusefi_bundle_proteus_legacy.zip)
# Advanced

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 33 KiB

View File

@ -10,6 +10,3 @@ used to program brand new stm32 chips which do not have a running version of rus
[HOWTO DFU video](https://www.youtube.com/watch?v=VdvXYgv_acg)
On a STM32F4 Discovery, entering DFU mode requires putting a jumper between the pins VDD and BOOT0, then powering or resetting the board.
If you're running Linux, the tool `dfu-util` works great for uploading DFUs.
example: `dfu-util -a 0 -D rusefi.dfu`

View File

@ -1,6 +1,34 @@
<!-- this URL us hard-coded in rusEFI console splash screen MAKE SURE NOT TO RENAME -->
<!-- this URL is hard-coded in rusEFI console splash screen MAKE SURE NOT TO RENAME -->
For DFU see [HOWTO-DFU](HOWTO-DFU)
[Download the rusEFI bundle](Download) for your hardware.
## Windows:
Launch [rusEFI Console](Console). You can find it in the bundle you downloaded, in the "console" folder.
ST-LINK is an advanced mode of firmware update which requires ST-LINK device, either external or build-in like on Discovery/Nucleo board.
Click the "Update Firmware" button.
## Linux:
The canonical way to update the firmware on Linux is with DFU.
You will need dfu-util:
```
# Debian/Ubuntu
sudo apt install dfu-util
# Arch/Manjaro
sudo pacman -Syu dfu-util
```
Once you have dfu-util, you can run this from the extracted bundle directory:
```
java -jar console/rusefi_console.jar reboot_dfu
dfu-util -a 0 -D rusefi.dfu
```
## More Information
For more about DFU see [HOWTO-DFU](HOWTO-DFU)
ST-LINK is an advanced mode of firmware update which requires ST-LINK device, either external, or built-in like on Discovery/Nucleo board.

View File

@ -3,7 +3,9 @@ Tunerstudio is a tuning application needed while working with rusEFI. Here is ho
![First project](FAQ/images/simulator/TCP_first_project.png)
In order to create a rusEFI project you need a rusefiSOMETHING.ini file from you [rusEFI bundle](https://github.com/rusefi/rusefi/wiki/Download).
In order to create a rusEFI project you need a rusefiSOMETHING.ini file from your [rusEFI bundle](https://github.com/rusefi/rusefi/wiki/Download).
Your rusEFI board should also present itself as a USB storage device to your computer, containing the .ini file you need. This is the most foolproof method of making sure you have the correct .ini file.
![Menu](FAQ/images/simulator/TunerStudio_other_browse.png)
@ -11,4 +13,4 @@ After clicking on the link you'll see this:
![Menu](FAQ/images/simulator/TCP_menu.png)
You have successfully created your first Tunerstudio project.
You have successfully created your first Tunerstudio project.

View File

@ -2,7 +2,7 @@
1. [Download the rusEFI bundle](Download) for your hardware.
2. Uncompress the bundle and launch the rusEFI console. Hit the "Install Drivers" button to install the Virtual Com Port and ST-Link drivers. If necessary the bundle will also help you install java run-time.
2. Extract the bundle and launch the rusEFI console. Hit the "Install Drivers" button to install the Virtual Com Port and ST-Link drivers. If necessary the bundle will also help you install java run-time.
![console](FAQ/images/rusEFI_console_start_screen.png)
@ -18,6 +18,9 @@
## Once you get your hardware:
### Install firmware on Frankenstein, Frankenso, and Discovery
/If you have any other rusEFI board, such as microRusEFI, Proteus, or Hellen, your board comes with firmware installed, and you can skip to "Update Firmware" ./
1. Connect the stm32f4discovery ('brain board') to the IO board, place jumpers like XYZ, then connect to a PC with a mini-USB cable. Mini-USB cable is used to power and to program the brain board. See below procedure found [here](http://rusefi.com/forum/viewtopic.php?f=5&t=210&start=23)
@ -31,7 +34,11 @@
![STLink Start](Images/st_link_start.png)
* After you have programmed the chip, you should click '''Target --> Disconnect''' and hit the '''black button''' on the discovery board '''to reset''' the firmware. After you hit the reset button, you should expect all four LEDs to blink once and then you should see just the '''blue LED blinking'''. If all is good, proceed to the Dev Console below.
* Another way to upload firmware is using a [DFU file](HOWTO-DFU)
### Update Firmware
Now that your board has rusEFI firmware installed on it, the firmware can be updated without using STLink software. You should ensure your firmware is up to date before proceeding.
[How to update your firmware](HOWTO-Update-Firmware)
## rusEFI Console

View File

@ -1,11 +1,7 @@
###List USB devices. This is useful for diagnosing driver issues.
```
sudo apt-get install dfu-util
lsusb
lsusb | grep 'STMicroelectronics Virtual COM Port'
lsusb | grep DFU
java -jar rusefi_console.jar reboot_dfu
dfu-util -a 0 -D rusefi.dfu
```
```