[Keyboard] HB85 Refactor/Layout Addition (#5451)
* introduce stt layout with K(row)(col) * set bootmagic to lite * Rename the original LAYOUT to LAYOUT_all Introduce the STT layout In additional the whole matrix was changed to support the K(row)(col) notation. * rename LAYOUT to LAYOUT_all * add QMK Configurator support * stt keymap based on mrpetrov's default configuration on the hb85 he lent me * update readme * introduce basic and aop layouts along with QMK Configurator support for them * add a new line * add EEP_RST to layer 1 as it is needed to get rgb underglow to work * add documentation on how to reset the eeprom on the board * put contributors names where appropriate
This commit is contained in:
		
							parent
							
								
									066465fa6f
								
							
						
					
					
						commit
						995b31a565
					
				
					 7 changed files with 175 additions and 72 deletions
				
			
		| 
						 | 
				
			
			@ -2,59 +2,47 @@
 | 
			
		|||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
A HitBit MSX Computer inspired Keyboard.
 | 
			
		||||
A Sony HitBit MSX Computer inspired Keyboard.
 | 
			
		||||
 | 
			
		||||
Keyboard Maintainer: [Felipe Coury](https://github.com/fcoury)  
 | 
			
		||||
Hardware Supported: Gray Studio HB85  
 | 
			
		||||
Hardware Availability: Group buy finished  
 | 
			
		||||
Hardware Availability: [Group buy](https://en.zfrontier.com/products/gray-hb85) finished  
 | 
			
		||||
 | 
			
		||||
Make example for this keyboard (after setting up your build environment):
 | 
			
		||||
 | 
			
		||||
    make hb85:default
 | 
			
		||||
    make gray_studio/hb85:default
 | 
			
		||||
 | 
			
		||||
See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
 | 
			
		||||
Flashing
 | 
			
		||||
 | 
			
		||||
ps2avr(GB) boards use an atmega32a microcontroller and a different bootloader. It is not flashable using the regular QMK methods. 
 | 
			
		||||
 | 
			
		||||
ps2avrGB keyboard firmware
 | 
			
		||||
==========================
 | 
			
		||||
**Reset Key:** To put the HB85 into reset, hold F3 (`K00`) while plugging in. 
 | 
			
		||||
 | 
			
		||||
This keyboard uses the port of the QMK firmware for boards that are based on the
 | 
			
		||||
ps2avrGB firmware.
 | 
			
		||||
Windows: 
 | 
			
		||||
1. Download [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
 | 
			
		||||
2. Place your keyboard into reset. 
 | 
			
		||||
3. Press the `Find Device` button and ensure that your keyboard is found.
 | 
			
		||||
4. Press the `Open .hex File` button and locate the `.hex` file you created.
 | 
			
		||||
5. Press the `Flash Device` button and wait for the process to complete. 
 | 
			
		||||
 | 
			
		||||
Note that this is a complete replacement for the firmware, so you won't be
 | 
			
		||||
using Bootmapper Client to change any keyboard settings, since not all the
 | 
			
		||||
USB report options are supported.
 | 
			
		||||
macOS:
 | 
			
		||||
1. Install homebrew by typing the following:   
 | 
			
		||||
    ```
 | 
			
		||||
    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 | 
			
		||||
    ```
 | 
			
		||||
2. Install `crosspack-avr`.  
 | 
			
		||||
    ```
 | 
			
		||||
    brew cask install crosspack-avr
 | 
			
		||||
    ```
 | 
			
		||||
3. Install the following packages:
 | 
			
		||||
    ```
 | 
			
		||||
    brew install python
 | 
			
		||||
    pip3 install pyusb
 | 
			
		||||
    brew install --HEAD`https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
 | 
			
		||||
 | 
			
		||||
## Installing
 | 
			
		||||
4. Place your keyboard into reset. 
 | 
			
		||||
5. Flash the board by typing `bootloadHID -r` followed by the path to your `.hex` file. 
 | 
			
		||||
 | 
			
		||||
First, install the requirements. These commands are for OSX, but all you
 | 
			
		||||
need is the AVR toolchain and `bootloadHID` for flashing:
 | 
			
		||||
**Please Note:** You will need to use the `EEP_RST` keycode first, followed by unplugging/replugging the board to get RGB underglow effects to work.
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
$ brew cask install crosspack-avr
 | 
			
		||||
$ brew install --HEAD https://raw.githubusercontent.com/robertgzr/homebrew-tap/master/bootloadhid.rb
 | 
			
		||||
$ pip install pyusb
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Then, with the keyboard plugged in, simply run this command from the
 | 
			
		||||
`qmk_firmware` directory:
 | 
			
		||||
 | 
			
		||||
```
 | 
			
		||||
$ make hb85
 | 
			
		||||
$ bootloadHID -r hb85_default.hex
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
## Setting the board to bootloader mode
 | 
			
		||||
 | 
			
		||||
Hold the F3 key while plugging the USB cable.
 | 
			
		||||
 | 
			
		||||
## Troubleshooting
 | 
			
		||||
 | 
			
		||||
From my experience, it's really hard to brick these boards. But these
 | 
			
		||||
tricks have been useful when it got stuck in a weird scenario.
 | 
			
		||||
 | 
			
		||||
1. Try plugging the board in while holding the bootloader key. This will force
 | 
			
		||||
   it to boot only the bootloader without loading the firmware. Once this is
 | 
			
		||||
   done, just reflash the board with the original firmware.
 | 
			
		||||
2. Sometimes USB hubs can act weird, so try connecting the board directly
 | 
			
		||||
   to your computer or plugging/unplugging the USB hub.
 | 
			
		||||
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).
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue