aboutsummaryrefslogtreecommitdiff
path: root/usb-control/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'usb-control/README.md')
-rw-r--r--usb-control/README.md39
1 files changed, 25 insertions, 14 deletions
diff --git a/usb-control/README.md b/usb-control/README.md
index 74201e2..48e0172 100644
--- a/usb-control/README.md
+++ b/usb-control/README.md
@@ -1,7 +1,7 @@
# Haikou USB Control
-This tool allows to control the **BIOS Disable** and **Power** Button via USB.
-
+This tool allows to control the **BIOS disable** signal and
+**power** state via USB.
## Dependencies
@@ -15,19 +15,30 @@ apt install python-usb
# Usage
-To manipulate **BIOS Disable** via USB the slider has to be in the **Normal
-Boot** position.
+To manipulate **BIOS disable** via USB the slider has to be in the **normal
+boot** position.
+
+To list connected Haikou boards:
+
+ haikou.py list
+
+To power cycle the board:
+
+ haikou.py cycle
+
+To select a specific board with given serial number (can be fetched via 'list'):
+
+ haikou.py --serial SERIALNUMBER
+
+To enable the BIOS disable signal:
+
+ haikou.py biosdisable
+
+To switch back to normal boot:
-The script takes following commands:
+ haikou.py normalboot
- list list serial numbers of connected baseboards
+For more features use the built-in help:
- power controls the power and BIOS Disable state
- --serial SERIALNUMBER, -s SERIALNUMBER
- defines the serialnumber to use
- --bios-disable, -b activate BIOS Disable
- --normal-boot, -n activate Normal Boot
+ haikou.py --help
-Each Haikou base board has a unique USB ID so they can be differentiated if more
-then one is connected to the host. Provide the serialnumber on the commandline
-to select a specific board, otherwise the first one found will be used.