add ebuspicloader readme

2020-12-10 21:50:25 +01:00
parent febc3a10d3
commit 96d5623ce9
1 changed files with 77 additions and 0 deletions
@@ -0,0 +1,77 @@
+eBUS Adapter 3 PIC Loader
+=========================
+
+This is a tool for loading new firmware to the
+[eBUS adapter 3 PIC](https://adapter.ebusd.eu/)
+and to configure IP settings for the Ethernet variant.
+
+All of this is done via the bootloader on the PIC. Consequently, when the
+bootloader is not running, this tool can't do anything.
+Check the [eBUS adapter 3 documentation](https://adapter.ebusd.eu/picfirmware)
+on how to start the bootloader.
+
+This tool was developed due to very unreadable output of the MPLAB bootloader
+host application.
+
+Usage
+-----
+`ebuspicloader --help` reveals the options:
+```
+Usage: ebuspicloader [OPTION...] PORT
+A tool for loading firmware to the eBUS adapter PIC.
+
+  -d, --dhcp                 set IP address to DHCP
+  -f, --flash=FILE           flash the FILE to the device
+  -i, --ip=IP                set IP address (e.g. 192.168.0.10)
+  -m, --mask=MASK            set IP mask (e.g. 24)
+  -M, --macip                set the MAC address suffix from the IP address
+  -r, --reset                reset the device at the end on success
+  -v, --verbose              enable verbose output
+  -?, --help                 give this help list
+      --usage                give a short usage message
+  -V, --version              print program version
+
+PORT is the serial port to use (e.g./dev/ttyUSB0)
+```
+
+Flash firmware
+--------------
+For flashing a new firmware, you would typically do something like this:  
+`ebuspicloader -f firmware.hex /dev/ttyUSB0`
+
+On success, the output looks like this:
+```
+Device ID: 30b0 (PIC16F15356)
+Device revision: 0.1
+Bootloader version: 1
+Firmware version not found
+MAC address: ae:b0:53:26:15:80
+IP address: DHCP
+erasing flash: done.
+flashing:
+
+0x0400 ................................................................
+...
+0x2d90 ........................................
+flashing finished.
+flashing succeeded.
+```
+
+Configure IP
+------------
+For changing the IP address of an Ethernet enabled adapter, you would do
+something like this:  
+`ebuspicloader -i 192.168.1.10 -m 24 /dev/ttyUSB0`
+
+On success, the output looks like this:
+```
+Device ID: 30b0 (PIC16F15356)
+Device revision: 0.1
+Bootloader version: 1
+Firmware version: 1
+MAC address: ae:b0:53:26:15:80
+IP address: DHCP
+Writing IP settings: done.
+MAC address: ae:80:53:26:15:80
+IP address: 192.168.1.10/24
+```