GUI tool for generating keymappings and firmware for the 356 Mini keyboard
This GUI tool was developed by Sunjun Kim and is rehosted here for use by the wider community
356 Mini keyboard designed and produced by Eungsam of OTD.kr
NOTE The following steps were tested on Windows 7 with an Atmel-ICE Basic for an Atmega32 version of the 356 Mini. They will almost certainly work on other operating systems with other AVR ISPs and for the Atmega16 version of the 356 Mini in a similar fashion.
This is a fairly old package and currently not all functionality of the GUI works. Currently broken:
- GUI generation of keymap.h ("Export" functionality in the GUI)
- GUI generation of firmware from exported keymapping ("Make Firm" functionality in the GUI)
- Compilation does not work on newest versions of arv-gcc, arv-libc like those installed via homebrew on OSX
As a reminder this software is provided as-is and the authors are not responsible for damage done through its use.
Much of this will likely seem familiar if your are comfortable with ps2avr -- newer versions of ps2avr than the one included may or may not be compatible.
- Setup AVR-GCC toolchain
- This is probably easiest via WinAVR
- NOTE: It looks like new versions of arv-libc might not be compatible with the current code, but WinAVR-20100110 has been used successfully
- Setup make
- This was tested with GnuWin32, but would likely also work with cygwin
keymap.h is the header file which defines the keymapping you'd like to bake into the firmware. It is pulled in by the compile scripts by name.
An example is included, as well as keymap_template.h which is the template the GUI uses to generate a keymap and the template we will use to create our new version of keymap.h
- Open index.html and allow Flash to run
- Using the legend at the footer of the page to indicate keys, create a mapping for the base and function layer by clicking and typing in each key.
- Click "Save" above the base layer diagram and save the .3mn file
- Copy keymap_template.h to keymap.h and replace the placeholder string %%%KEYMAP%%% with the entire contents of the .3mn file generated in the previous step.
keymain.hex is the baked firmware that you will flash to the keyboard to implement your keymapping.
There is an example .hex file provided in the hex directory. Please note this example .hex file is for the Atmega32 version of the 356 Mini, NOT the Atmega16 version.
To generate keymain.hex first ensure that the keymapping you'd like to bake in is present in a keymain.h file in the base directory (where the provided example is). Then run the appropriate compiling script:
- For the Atmega32 version of the 356 Mini, run
./compile.sh NAMEwhere 'NAME' is a unique name you'd like to give to the keymain.hex file - For the Atmega16 version of the 356 Mini, run
./compile_16.sh NAMEwhere 'NAME' is a unique name you'd like to give to the keymain.hex file
On success, a new keymain_NAME.hex file will be placed in the hex directory.
Alternatively, both the firm and firm_16 directories makefiles can be run manually via make clean followed by make. They will generate keymain.hex within the firm or firm_16 directory.
It is highly recommended that you backup any firmware existing on your 356 Mini before attempting to flash a new version. Doing so varies by toolchain, but for avrdude:
avrdude -p atmega32 -P com3 -c arduino -b 19200 -U flash:r:backup.hex:i
replacing com3 with the appropriate interface and arduino with the appropriate ISP and atmega32 with atmega16 depending on the version of the 356 Mini. See the avrdude documentation for specifics on each flag.
Atmel Studio also provides utilities for backing up firmware which may be useful if the Windows avrdude toolchain isn't working for you, but be aware it can further complicate using avrdude.
Finally, flash your Atmega with the generated keymain.hex file. Steps to do so vary a bit between ISPs and the toolchain you've chosen. Roughly:
- Connect your ISP to the 6 headers to the right of the spacebar switch on the PCB
- Plug in your ISP to the host computer
- Upload your generated keymain_NAME.hex file:
- For avrdude, the following command should work (with the -p, -P, and -c flags changed as per the preceding backup instructions)
- Atmel Studio also provides utilities for flashing firmware which may be useful if the Windows avrdude toolchain isn't working for you, but be aware it can further complicate using avrdude
- Congratulations, your 356 Mini has been remapped!
We welcome any contributions to fix broken functionality, document code, or implement new functionality.
Feel free to fork and submit a pull request, or create an Issue if you'd like to discuss your intentions.
Thank you!