You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+35Lines changed: 35 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,3 +19,38 @@ which can be found in our GitHub repository [here](https://github.com/minipadkb/
19
19
<divalign="center">
20
20
<i>Made with ❤️ by Project Minipad</i>
21
21
</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