From 9dc0f90d21aa74c1208b86934364bf4f0dfe312a Mon Sep 17 00:00:00 2001
From: Eric Callahan <arksine.code@gmail.com>
Date: Wed, 13 Apr 2022 19:36:43 -0400
Subject: [PATCH] readme:  add flash_can usage

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
---
 README.md | 35 +++++++++++++++++++++++++++++++++--
 1 file changed, 33 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 3bf19a1..04f1da9 100644
--- a/README.md
+++ b/README.md
@@ -48,9 +48,40 @@ Once configured and built flash with a programmer such as an ST-Link.
 3) Run the flash script:
    ```
    cd ~/CanBoot
-   python3 flash_can.py -i can0 -f ~/klipper/out/klipper.bin <uuid>
+   python3 flash_can.py -i can0 -f ~/klipper/out/klipper.bin -u <uuid>
    ```
-   Replace <uuid> with the appropriate uuid for your can device.
+   Replace <uuid> with the appropriate uuid for your can device.  If
+   the device has not been previouisly flashed with Klipper, it is possible
+   to query the bootloader for the UUID:
+
+   ```
+   flash_can.py -i can0 -q
+   ```
+
+## FlashCan usage
+
+Running `flash_can.py -h` to display help:
+
+```
+usage: flash_can.py [-h] [-i <can interface>] [-f <klipper.bin>] [-u <uuid>]
+                    [-q]
+
+Can Bootloader Flash Utility
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -i <can interface>, --interface <can interface>
+                        Can Interface
+  -f <klipper.bin>, --firmware <klipper.bin>
+                        Path to Klipper firmware file
+  -u <uuid>, --uuid <uuid>
+                        Can device uuid
+  -q, --query           Query Bootloader Device IDs
+```
+
+The `interface` option defaults to `can0` if omitted.  The `firmware` option
+defaults to `~/klipper/out/klipper.bin`.  The `uuid` must be specified unless
+the user is running a query with `-q`.
 
 ## Notes
 - If using a MCP2515 Can Device it is likely that packets will be dropped when