salfter/fluxengine
1
0
Fork 0
mirror of https://github.com/davidgiven/fluxengine.git synced 2025-10-24 11:11:02 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for the USB autodetection.

Browse Source
This commit is contained in:
David Given
2021-12-13 23:19:16 +01:00
parent 3dfafaa278
commit 5eeb52660c
2 changed files with 8 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/greaseweazle.md
View File

@@ -7,15 +7,9 @@ completely open source solution. This requires more work to set up (or you can
buy a prebuilt GreaseWeazle board), but provides completely open source
hardware which doesn't require the use of the Cypress Windows-based tools that
the FluxEngine does. Luckily, the FluxEngine software supports it almost
out-of-the-box --- just plug it in and nearly everything should work. You will
need to tell FluxEngine which serial port the GreaseWeazle is plugged
in with:
```
fluxengine read ibm -o ibm.img --usb.greaseweazle=/dev/ttyACM3
```
On Windows, use `COM1`/`COM2`/`COM3` etc for the port.
out-of-the-box --- just plug it in and nearly everything should work. The
FluxEngine software will autodetect it. If you have more than one device
plugged in, use `--usb.serial=` to specify which one you want to use.
I am aware that having _software_ called FluxEngine and _hardware_ called
FluxEngine makes things complicated when you're not using the FluxEngine client

9
doc/using.md
View File

@@ -43,13 +43,14 @@ file while changing the decoder options, to save disk wear. It's also much faste
### Connecting it up
To use, simply plug your FluxEngine into your computer and run the client. If a
single device is plugged in, it will be automatically detected and used.
To use, simply plug your FluxEngine (or [GreaseWeazle](greaseweazle.doc) into
your computer and run the client. If a single device is plugged in, it will be
automatically detected and used.
If _more_ than one device is plugged in, you need to specify which one to use
with the `--usb.fluxengine` parameter, which takes the device serial number as a
with the `--usb.serial` parameter, which takes the device serial number as a
parameter. You can find out the serial numbers by running the command without
the `--usb.fluxengine` parameter, and if more than one device is attached they will
the `--usb.serial` parameter, and if more than one device is attached they will
be listed. The serial number is also shown whenever a connection is made.
You _can_ work with more than one FluxEngine at the same time, using different