diff --git a/README.md b/README.md index 6c574b4..89f0081 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This plugin can be used to flash pre-compiled firmware images to your printer from a file or URL. -
+ Works with boards with Atmel AVR family 8-bit MCUs (Atmega1280, Atmega1284p, and Atmega2560) MCUs, and Atmel SAM family 32-bit MCUs (Arduino DUE). @@ -56,7 +56,7 @@ sudo cp ~/BOSSA-1.7.0/bin/bossac /usr/local/bin/ In order to be able to flash firmware we need to select and configure a flash method. Once the flash method is selected additional options will be available. ### AVRDUDE Configuration - + The minimum settings are: * Path to avrdude @@ -71,23 +71,54 @@ Typical MCU/programmer combinations are: | Atmega2560 | wiring | RAMPS, RAMbo, etc. | | Atmega644p | arduino | Sanguinololu, Melzi | -#### Avrdude Advanced Settings -All advanced settings are optional. - - ### BOSSAC Configuration - + The only required setting is the path to the bossac binary. -#### BOSSAC Advanced Settings -All advanced settings are optional. - +### Customizing the Command Lines +The command lines for avrdude and bossac can be customized by editing the string in the advanced settings for the flash method. Text in braces (`{}`) will be substituted for preconfigured values if present. + +| String | Description| +| --- | --- | +| `{avrdude}` | Full path to the avrdude executable1 | +| `{bossac}` | Full path to the bossac executable2 | +| `{mcu}` | Avrdude MCU type1 | +| `{programmer}` | Avrdude programmer1 | +| `{port}` | COM port the printer is connected to | +| `{conffile}` | Full path to the avrdude configuration file1 | +| `{baudrate}` | Serial port speed1 | +| `{disableverify}` | Switch to disable write verification | +| `{firmware}` | Path to the uploaded firmware file | + +1. Avrdude flash method only +2. Bossac dude flash method only + +#### Command Line Defaults +Command lines can be returned to the default by clicking the **Reset** button. + +##### Avrdude +`{avrdude} -v -q -p {mcu} -c {programmer} -P {port} -D -C {conffile} -b {baudrate} {disableverify} -U flash:w:{firmware}:i` + +##### Bossac +`{bossac} -i -p {port} -U true -e -w {disableverify} -b {firmware} -R` ### Post-flash Settings + + +#### Post-flash Delay #### +This setting can be used to insert a delay of up to 180s after the firmware has been uploaded, before OctoPrint will try to reconnect to the printer. This can be useful if the board takes some time to restart. A delay of 20-30s is usually enough. + +#### Post-flash Gcode #### You can use the post-flash gcode settings to run gcode commands after a successful firmware flash. - The post-flash code will run more or less immediately if the printer was connected before the flash started (so reconnects automatically when the flash finishes), or whenever the printer is manually reconnected after the firmware is flashed. +## Flashing +Once the plugin is configured, flashing firmware is a simple operation: +1. Select the COM port to communicate with the board +1. Select a firmware file, either located on the filesystem or via a URL +1. Click the appropriate **Flash from** button +1. Wait for the firmware update to complete + ## Troubleshooting Log messages can be found in the OctoPrint log `octoprint.log` and the Firmware Updater's console log `plugin_firmwareupdater_console.log`. diff --git a/extras/img/avrdude-adv.png b/extras/img/avrdude-adv.png deleted file mode 100644 index 97e74d5..0000000 Binary files a/extras/img/avrdude-adv.png and /dev/null differ diff --git a/extras/img/avrdude-config.png b/extras/img/avrdude-config.png new file mode 100644 index 0000000..febaf76 Binary files /dev/null and b/extras/img/avrdude-config.png differ diff --git a/extras/img/avrdude-settings.png b/extras/img/avrdude-settings.png deleted file mode 100644 index 20c6d87..0000000 Binary files a/extras/img/avrdude-settings.png and /dev/null differ diff --git a/extras/img/bossac-adv.png b/extras/img/bossac-adv.png deleted file mode 100644 index ac2806f..0000000 Binary files a/extras/img/bossac-adv.png and /dev/null differ diff --git a/extras/img/bossac-config.png b/extras/img/bossac-config.png new file mode 100644 index 0000000..b54ea0a Binary files /dev/null and b/extras/img/bossac-config.png differ diff --git a/extras/img/bossac-settings.png b/extras/img/bossac-settings.png deleted file mode 100644 index 7ef85a8..0000000 Binary files a/extras/img/bossac-settings.png and /dev/null differ diff --git a/extras/img/firmware-updater.png b/extras/img/firmware-updater.png new file mode 100644 index 0000000..77e052f Binary files /dev/null and b/extras/img/firmware-updater.png differ diff --git a/extras/img/post-flash-config.png b/extras/img/post-flash-config.png new file mode 100644 index 0000000..92304cf Binary files /dev/null and b/extras/img/post-flash-config.png differ diff --git a/extras/img/post-flash.png b/extras/img/post-flash.png deleted file mode 100644 index 3d19387..0000000 Binary files a/extras/img/post-flash.png and /dev/null differ diff --git a/extras/img/updater-settings.png b/extras/img/updater-settings.png deleted file mode 100644 index e7d77e3..0000000 Binary files a/extras/img/updater-settings.png and /dev/null differ diff --git a/extras/img/updater.png b/extras/img/updater.png deleted file mode 100644 index cc8c216..0000000 Binary files a/extras/img/updater.png and /dev/null differ