https://plover.wiki/index.php?action=history&feed=atom&title=Plover_HIDPlover HID - Revision history2026-05-23T21:54:42ZRevision history for this page on the wikiMediaWiki 1.41.0https://plover.wiki/index.php?title=Plover_HID&diff=175&oldid=prevLynn: create article2024-02-12T20:17:54Z<p>create article</p>
<p><b>New page</b></p><div>The '''Plover HID''' protocol is an alternative protocol for steno keyboards to communicate with steno software, using the common HID (Human Interface Device) standard for mice, keyboards, game controllers, et cetera.<br />
<br />
It is implemented by the [https://github.com/dnaq/plover-machine-hid plover-machine-hid Plover plugin].<br />
<br />
Notably, it sends packets for each key-up or key-down event, unlike the [[Gemini PR]] or [[TX Bolt]] protocols which only send a packet after a chord is completely released. This allows the plugin to support features such as [[first-up chord send]] or [[auto-repeat]].<br />
<br />
== Using Plover HID ==<br />
If your steno board supports [[Javelin]], you can use the [https://lim.au/#/software/javelin-steno firmware builder] to get a version of the Javelin firmware that outputs Plover HID:<br />
# At the top of the page, enable '''Show expert options'''.<br />
# Under '''Keymap''', click the '''Edit''' button next to "Script: OK, xxx bytes"<br />
# Find the line that says <code>console("set_steno_mode <b>gemini</b>");</code><br />
# Replace it with <code>console("set_steno_mode <b>plover_hid</b>");</code><br />
<br />
Now the four corner keys on your board switch between embedded steno and Plover HID output.<br />
<br />
To install the [https://github.com/dnaq/plover-machine-hid plover-machine-hid plugin], see [[Installing plugins]]. Then select "Plover HID" under "Machine" in Plover.<br />
<br />
== Specification ==<br />
Devices using the Plover HID protocol can be recognized by <code>usagePage = 0xFF50</code> and <code>usage = 0x4C56</code>.<br />
<br />
They send input reports with report ID 80 (<code>0x50</code>) followed by an 8-byte body. The body is a 64-bit bitmask representing the state of the standard English steno keys <code>S- T- K- P- W- H- R- A- O- * -E -U -F -R -P -B -L -G -T -S -D -Z #</code>, followed by extra keys <code>X1</code> through <code>X26</code>.<br />
<br />
For example, when <code>S-</code> is pressed down, the device reports <code>80 00 00 00 00 00 00 00</code> (in hexadecimal). Then when <code>T-</code> is additionally pressed it reports <code>c0 00 00 00 00 00 00 00</code>.<br />
<br />
== See also ==<br />
* [https://github.com/dnaq/plover-machine-hid/blob/main/README.md The specification in the plover-machine-hid README]<br />
* [https://lim.au/#/software/plover-hid Plover HID Inspector], for debugging.<br />
* [https://foldr.moe/plover-hid-display Plover HID Display], a web-based live keyboard display tool.</div>Lynn