andreil/katapult
1
0
Fork 0
mirror of https://github.com/andreili/katapult.git synced 2025-08-23 19:34:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

readme: document the "-r" option of flash_can.py

Browse Source 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Eric Callahan 2023-01-29 16:56:56 -05:00
parent 1da9898366
commit c5515942a3
No known key found for this signature in database
GPG Key ID: 5A1EB336DFB4C71B
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -132,12 +132,23 @@ optional arguments:
Can device uuid Can device uuid
-q, --query Query Bootloader Device IDs -q, --query Query Bootloader Device IDs
-v, --verbose Enable verbose responses -v, --verbose Enable verbose responses
-r, --request-bootloader
Requests the bootloader and exits (CAN only)
``` ```
The `interface` option defaults to `can0` if omitted. The `firmware` option The `interface` option defaults to `can0` if omitted. The `firmware` option
defaults to `~/klipper/out/klipper.bin`. The `uuid` must be specified unless defaults to `~/klipper/out/klipper.bin`. The `uuid` must be specified unless
the user is running a query with `-q`. the user is running a query with `-q`.
When the `-r` option is supplied in addition to `-u` (and optionally `-i`)
the script will request that the node enter the bootloader. The script will
then immediately exit, no attempt will be made to upload a new binary over the
canbus. This is particularly useful for Klipper devices running "USB to CAN
bridge mode". These devices upload firmware using DFU and/or CanBoot-USB. This
option allows the user to enter the bootloader without physical access to the
board, then use the appropriate tool (`dfu-util` or `flash_can.py -d`) to
upload the new binary.
## CanBoot Deployer ## CanBoot Deployer
The CanBoot deployer allows a user to overwrite their existing bootloader The CanBoot deployer allows a user to overwrite their existing bootloader