qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (2519B)

      1 # rp2040_orbweaver
      2 QMK firmware for RP2040 based MCU replacement PCB for the Razer Orbweaver gaming keypad
      3 
      4 ![RP2040 Orbweaver](https://i.imgur.com/GCPRUbs.png)
      5 
      6 
      7 This firmware is for the Razer Orbweaver Chroma keypad with a custom, plug and play, RP2040 MCU PCB. For installation instructions and board availability see [geekhack](https://geekhack.org/index.php?topic=124092.0).
      8 
      9 The firmware controls a 6x5 key matrix (4x5 keypad + 6 additional keys on the thumb pad and up to 4 additional keys added by user). It also controls a IS31FL3731 RGB Matrix controller (on the Chroma model) via I2C interface. This requires a single I2C Driver with 20 common anode RGB LEDs.
     10 
     11 Key 20 (bottom right) is used to switch layers.  
     12 
     13 The default key map provides 3 preset layers.  
     14 
     15 (layer 0) is a generic layer based on the original Razer defaults.  
     16 (layer 1) replaces modifier keys with letter keys.   
     17 (layer 2) replaces the 2 top rows with RGB control keys.  
     18 
     19 The three LEDs on the thumb pad indicate the active layer. 
     20 
     21 Blue = layer 0  
     22 Green = layer 1  
     23 Yellow = layer 3  
     24 
     25 All LEDs will be off when any other (user added) layout is activated
     26 
     27 A set of RGB animations are included in confg.h.  These are controlled by activating the Yellow layer and using keys 01 - 11 (11 toggles the lighting on and off - see /keymaps/default/keymap.c for more information)
     28 
     29 Many thanks to a_marmot. Without his original handwired project, this board would not have been possible. His original work can be found here. [geekhack](https://geekhack.org/index.php?topic=119396.0).
     30 
     31 * Keyboard Maintainer: [Lostdotfish](https://github.com/Lostdotfish)
     32 * Hardware Supported: RP2040 + IS31FL3731
     33 * Hardware Availability: [https://geekhack.org/index.php?topic=124092.0](https://geekhack.org/index.php?topic=124092.0)
     34 
     35 Make example for this keyboard (after setting up your build environment):
     36 
     37     make lostdotfish/rp2040_orbweaver:default
     38 
     39 Flashing example for this keyboard:
     40 
     41     make lostdotfish/rp2040_orbweaver:default:flash
     42     
     43 
     44 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
     45 
     46 ## Bootloader
     47 
     48 Enter the bootloader in 2 ways:
     49 
     50 * Press and hold the upper left hand key on the main keyboard while you plug in the USB.
     51 * Press and release the boot button on the top of the RP2040_Orbweaver v2.0 inside the modded unit.