Skip to content

Commit 6305c09

Browse files
committed
Add commands to readme
1 parent eedce01 commit 6305c09

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,38 @@ which can be found in our GitHub repository [here](https://github.com/minipadkb/
1919
<div align="center">
2020
<i>Made with ❤️ by Project Minipad</i>
2121
</div>
22+
23+
# Usage
24+
25+
This command-line utility can be used by opening the Windows Terminal or command prompt (*not powershell*) in the folder of the minitool.exe executable. Below you can find a list of commands.</br>
26+
**Note:** 'port' is always referring to the port number, excluding the `COM` prefix. (e.g. `4` instead of `COM4`)
27+
28+
General syntax: `minitool.exe <sub-command> <parameters...>`
29+
30+
Command: `devices`</br>
31+
Description: Lists all connected minipad devices.</br>
32+
Example: `minitool.exe devices`
33+
34+
Command: `info <port>`</br>
35+
Description: Outputs the configuration of the minipad device.</br>
36+
Example: `minitool.exe info 7`
37+
38+
Command: `boot <port>`</br>
39+
Description: Sets the minipad device into bootloader mode.</br>
40+
Example: `minitool.exe boot 4`</br>
41+
42+
Command: `send <port> "<command>"`</br>
43+
Description: Sends the specified command to the minipad device.</br>
44+
Example: `minitool.exe send 9 "hkey.rt 1"`</br>
45+
46+
Command: `calibrate <port>`</br>
47+
Description: Helps you calibrating the minipad by pressing the keys down.</br>
48+
Example: `minitool.exe calibrate 3`</br>
49+
50+
Command: `visualize <port>`</br>
51+
Description: Displays a commandline-based visualizer for the Hall Effect keys.</br>
52+
Example: `minitool.exe visualize 14`</br>
53+
54+
You can also find a list of these commands with `minitool.exe help`.
55+
56+
**A list of commands for the minipad firmware can be found [here](https://github.com/minipadKB/minipad-firmware/tree/master#minipad-serial-protocol-msp-).**

0 commit comments

Comments
 (0)