summaryrefslogtreecommitdiffstats
path: root/keyboards/crkbd/keymaps/kidbrazil/README.md
diff options
context:
space:
mode:
authorLucas Moreira <hello@lucasmoreira.dev>2020-01-07 20:28:06 -0500
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2020-01-07 17:28:06 -0800
commitfdc144d215b59a5bc3f3283b159895ec42ccba0b (patch)
tree4cfae7c8c7baf75aebbbbf4db828ce8a641dffb6 /keyboards/crkbd/keymaps/kidbrazil/README.md
parentee70d496f44f43b5fd0e7b3a94db4dc467725e1e (diff)
[Keymap] Improvements to KidBrazil keymap to better handle OLED/LED Matrix timeout. (#7688)
* Added KidBrazil custom keymap for CRKBD -Custom Font -Custom OLED output * Added missing readme * Oled Timeout Update for KidBrazil Keymap (#1) * Setup Oled timeout based on simple timer * Cleaned up comments and added timeout for LEDs * Fixed some small errors * Updated oled timout with matrix scan * Updated oled timout with matrix scan * Update withou eeprom * Update timer code * Use process user instead of keymap * Added ifdef to protect oledtimer * Updated with half timeout state for logo * Removed middle tier timer * Final cleanup of unused files * Updated code as per suggestions & requests * Second round of revisions * Updated keymap to better handle LED timeout - Added boolean to hold LED state - Added init function to set rgb to known state - Modified RGB_TOG to work with noeeprom commands * Finished adding the timeout for OLED and testing on CRKBD * Updated documentation * fixed the timeout logic so it works as intended * Update keyboards/crkbd/keymaps/kidbrazil/README.md
Diffstat (limited to 'keyboards/crkbd/keymaps/kidbrazil/README.md')
-rw-r--r--keyboards/crkbd/keymaps/kidbrazil/README.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/keyboards/crkbd/keymaps/kidbrazil/README.md b/keyboards/crkbd/keymaps/kidbrazil/README.md
index 28414860c3..a7995a4f65 100644
--- a/keyboards/crkbd/keymaps/kidbrazil/README.md
+++ b/keyboards/crkbd/keymaps/kidbrazil/README.md
@@ -1,6 +1,6 @@
# KidBrazil's custom CRKBD Layout
-![Crkbd](https://user-images.githubusercontent.com/736191/40575636-6fba63a4-6123-11e8-9ca0-3f990f1f9f4c.jpg)
+![Loose Transistor Crkbd](https://user-images.githubusercontent.com/4823043/71268460-0862c000-231b-11ea-8f32-2fe8da4d348a.jpg)
This is a simple layout that I use for both programming and gaming. It is very
closely based on the original CRKBD layout with some modifications to the
@@ -45,8 +45,19 @@ customize this with showing layer and USB information. I also tried my best to
get a dormant / sleep state going but it is hit or miss and often only works on
the master hand.
+## OLED & RGB Matrix timeout
+This keymap will set a automated timeout system for the OLED screen and the RGB
+matrix. After 3 minutes or so the LED screen will display the logo on both
+halves and 5 minutes after that both the LED and the Matrix will be switched
+off.
+
+Once a user hits the keys again, the LED matrix will turn back on unless the
+user has disabled it via RGB_TOG.
+
+## Flashing
+To flash this on your CRKBD simply use the `make crkbd:kidbrazil:flash`
+command.
+
### TODO
-- Fix OLED and Backlight so they turn off when the computer sleeps, currently
- only the left hand does that and the LEDs still stay on.
- Wait for Spit_common to be implemented in CRKBD and revisit the special color
layers and animations