summaryrefslogtreecommitdiff
path: root/keyboards/massdrop/ctrl/keymaps/foxx1337/README.md
diff options
context:
space:
mode:
authorfoxx1337 <foxx1337@yahoo.com>2021-11-05 03:36:27 +0100
committerGitHub <noreply@github.com>2021-11-05 13:36:27 +1100
commit2ac2695cb5fac5402e9a9834c55dce9d34ed0da5 (patch)
tree18192954ade73f87b49fc553f336bf4e93d5b306 /keyboards/massdrop/ctrl/keymaps/foxx1337/README.md
parent45b35e6ea13d8c184d9cbd23e4bd3868e66d2933 (diff)
[Keymap] foxx1337 for Massdrop CTRL with raw HID (#8692)
* [Keymap] foxx1337's personal keymap * Add keymap based on ctrl default * Add 5 minute rgb matrix timeout * Add foxx1337 layout defaults * Add raw HID communication protocol * Add rgbmatrix to the raw HID protocol * Add readme * Modernize ctrl, shift, alt mods detection * Add GPL like copyright headers
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