summaryrefslogtreecommitdiff
path: root/keyboards/massdrop/ctrl/keymaps/foxx1337/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/massdrop/ctrl/keymaps/foxx1337/README.md')
-rw-r--r--keyboards/massdrop/ctrl/keymaps/foxx1337/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/keyboards/massdrop/ctrl/keymaps/foxx1337/README.md b/keyboards/massdrop/ctrl/keymaps/foxx1337/README.md
new file mode 100644
index 0000000000..4827d2bdbf
--- /dev/null
+++ b/keyboards/massdrop/ctrl/keymaps/foxx1337/README.md
@@ -0,0 +1,18 @@
+# Massdrop CTRL default layout with raw HID protocol
+
+This represents my current layout, with filtered out effects, personal defaults,
+added inactivity timeout (for rgbmatrix) and a HID protocol example.
+
+To test that this is working, there's a user application I'm using to help with
+development on [my GitHub](https://github.com/foxx1337/rawhid_io).
+
+Currently all the HID operations defined in the protocol are callable from the
+user application:
+
+- hello: gets the string "CTRLHID 1.0.0"
+- lights: toggles the rgbmatrix on/off
+- led n #RRGGBB: colors the specified led. Valid n from 0 to 117 (87-117 are on
+ the edge)
+- leds start #RRGGBB #RRGGBB #RRGGBB ...: colors the range of leds from start
+- mode n: switches to the specific rgbmatrix mode. Use the last one, 11, to test
+ the led operations listed above