AVR-Keyboard - Revision history

Alaricljs at 02:04, 9 November 2012

2012-11-09T02:04:21Z

Alaricljs at 02:04, 9 November 2012

2012-11-09T02:04:04Z

Alaricljs at 02:03, 9 November 2012

2012-11-09T02:03:41Z

Alaricljs at 02:03, 9 November 2012

2012-11-09T02:03:27Z

Alaricljs at 02:02, 9 November 2012

2012-11-09T02:02:35Z

Alaricljs at 02:00, 9 November 2012

2012-11-09T02:00:27Z

Alaricljs: /* Flashing the firmware */

2012-11-09T01:58:48Z

‎Flashing the firmware

Alaricljs at 01:25, 9 November 2012

2012-11-09T01:25:46Z

Alaricljs at 01:23, 9 November 2012

2012-11-09T01:23:14Z

Alaricljs: Created page with "The Bathroom Epiphanies AVR-Keyboard firmware. The files are available at [https://github.com/BathroomEpiphanies/AVR-Keyboard this] github page. =File list= {| class="wikitab..."

2012-11-09T01:21:53Z

Created page with "The Bathroom Epiphanies AVR-Keyboard firmware. The files are available at [https://github.com/BathroomEpiphanies/AVR-Keyboard this] github page. =File list= {| class="wikitab..."

New page

The Bathroom Epiphanies AVR-Keyboard firmware. The files are available at [https://github.com/BathroomEpiphanies/AVR-Keyboard this] github page.

=File list=
{| class="wikitable" border="1"
|-
! Filename
! Description
|-
| firmwares/
| Folder with pre-compiled firmwares.
|-
| hid_liber/
| Each physical board has its own folder with files defining the matrix layout and other parameters.
|-
| hid_liber/board.h
| Includes board parameters for number of rows/columns, microcontroller specifics, and declarations of the functions to interface the board.
|-
| hid_liber/board.c
| This is where the microcontroller pin-out is defined, and the function definitions for the interface can be found.
|-
| hid_liber/ansi_iso_jis.h
| Pretty much just a dummy file.
|-
| hid_liber/ansi_iso_jis.h
| Here is where the actual layout is defined.
|-
| [other board specific folders]
|
|-
| [...]
|
|-
| Makefile
| Magic make stuff to compile everything correctly. This is where the board and layout to be compiled is selected.
|-
| README.md
|
|-
| avr.h
| Extra definitions to make life easier..
|-
| avr_keyboard.c
| The main program code.
|-
| hid_listen
| A monitor that listens to debug data sent back from the keyboard. Compiled on Ubuntu 12.04 64-bit.
|-
| print.h
| Includes functions for debug printing.
|-
| print.c
| Includes functions for debug printing.
|-
| usb_keyboard_debug.h
| The HID keyboard framework supplied by [[pjrc.com]].
|-
| usb_keyboard_debug.c
| The HID keyboard framework supplied by [[pjrc.com]].
|}

=Detailed file info=
==Makefile==
The make system keeps track of what needs to be compiled and how that is supposed to be done. It does not work perfectly for this project. Changing the microcontroller used requires a 'make clean' to be done.

Each board has a section in the beginning of the file. The correct one needs to be un-commented before compiling.

Parameters that need to be defined.
BOARD = hid_liber // Folder for board specifics
LAYOUT = ansi_iso_jis // Required layout for that board. Located in the BOARD folder.
MCU = atmega32u4 // Microcontroller the board uses
F_CPU = 16000000 // CPU speed
B_LOADER = \"jmp\ 0x7000\" // Memory location of the bootloader section

To compile the firmware run the commands
make clean; make

=Flashing the firmware=
You need the Atmel [http://www.atmel.com/tools/FLIP.aspx Flip] software installed to your system. If you find that USB comms is not working, follow [[Flip-USB]] these steps.

# Plug in your keyboard
# Start Flip
# Click the Chip icon (first one)
# Select the ATmega32U4 from the list
# Click the USB icon
# Get your KB to jump to the bootloader (both shifts, or a magnet over the controller)
# Click Open (keep trying, takes a moment for the chip to be ready after jumping to the bootloader)
# Click the File menu and select your HEX file
# Click run on the bottom left
# Click Start Application on the bottom right
# Wait a moment and your KB should be live with your new firmware

=Hints to having a comfortable programming experience=
* Install Linux (Ubuntu recommended for beginners).
http://www.ubuntu.com/download/desktop/windows-installer
* Install a '''worthy''' text editor - [[emacs]] if you are a bit crazy, [[vim]] if you are flat out insane, but [[gedit]] will do really.
sudo apt-get install emacs
* Make sure you have the needed software installed
sudo apt-get install gcc-avr binutils-avr avr-libc

=External links=
* https://github.com/BathroomEpiphanies/AVR-Keyboard
* http://pjrc.com/teensy/usb_keyboard.html
* http://www.atmel.com/tools/FLIP.aspx

[[Category:Keyboard modding]]

@@ Line 1: / Line 1: @@
 The Bathroom Epiphanies AVR-Keyboard firmware. The files are available at [https://github.com/BathroomEpiphanies/AVR-Keyboard this] github page.
-This firmware is used on the [[Phantom]] and the HID-Liberation device, a replacement controller for the Filco's TKL boards.
+This firmware is used on the [[Phantom]] and the HID Liberation device, a replacement controller for the Filco's TKL boards.
 =File list=

@@ Line 1: / Line 1: @@
 The Bathroom Epiphanies AVR-Keyboard firmware. The files are available at [https://github.com/BathroomEpiphanies/AVR-Keyboard this] github page.
-This firmware is used on the Phantom and the HID-Liberation device, a replacement controller for the Filco's TKL boards.
+This firmware is used on the [[Phantom]] and the HID-Liberation device, a replacement controller for the Filco's TKL boards.
 =File list=

@@ Line 1: / Line 1: @@
 The Bathroom Epiphanies AVR-Keyboard firmware. The files are available at [https://github.com/BathroomEpiphanies/AVR-Keyboard this] github page.
-This firmware is used on the Phantom and the Hid-Liberation device, a replacement controller for the Filco's TKL boards.
+This firmware is used on the Phantom and the HID-Liberation device, a replacement controller for the Filco's TKL boards.
 =File list=

← Older revision		Revision as of 02:03, 9 November 2012
Line 1:		Line 1:
	The Bathroom Epiphanies AVR-Keyboard firmware. The files are available at [https://github.com/BathroomEpiphanies/AVR-Keyboard this] github page.		The Bathroom Epiphanies AVR-Keyboard firmware. The files are available at [https://github.com/BathroomEpiphanies/AVR-Keyboard this] github page.
		+
		+	This firmware is used on the Phantom and the Hid-Liberation device, a replacement controller for the Filco's TKL boards.

	=File list=		=File list=

← Older revision		Revision as of 02:02, 9 November 2012
Line 102:		Line 102:
	* http://pjrc.com/teensy/usb_keyboard.html		* http://pjrc.com/teensy/usb_keyboard.html
	* http://www.atmel.com/tools/FLIP.aspx		* http://www.atmel.com/tools/FLIP.aspx
−
−	[[Category:Keyboard modding]]

@@ Line 59: / Line 59: @@
 |}
 The make system keeps track of what needs to be compiled and how that is supposed to be done. It does not work perfectly for this project. Changing the microcontroller used requires a 'make clean' to be done.
@@ Line 75: / Line 75: @@
  make clean; make
-=Flashing the firmware=
+==Flashing the firmware==
 You need the Atmel [http://www.atmel.com/tools/FLIP.aspx Flip] software installed to your system.  If you find that USB comms is not working, use these directions: [[Flip-USB]]

@@ Line 86: / Line 86: @@
 # Click Open (keep trying, takes a moment for the chip to be ready after jumping to the bootloader)
 # Click the File menu and select your HEX file
-# Click run on the bottom left
+# Click Run on the bottom left
 # Click Start Application on the bottom right
 # Wait a moment and your KB should be live with your new firmware

@@ Line 93: / Line 93: @@
 * Install Linux (Ubuntu recommended for beginners).
  http://www.ubuntu.com/download/desktop/windows-installer
-* Install a '''worthy''' text editor - [[emacs]] if you are a bit crazy, [[vim]] if you are flat out insane, but [[gedit]] will do really.
+* Install a '''worthy''' text editor - [[emacs]] if you are a bit crazy, [[vim]] if you are flat out insane, but [[gedit]] will do nicely.
  sudo apt-get install emacs
 * Make sure you have the needed software installed

@@ Line 76: / Line 76: @@
 =Flashing the firmware=
-You need the Atmel [http://www.atmel.com/tools/FLIP.aspx Flip] software installed to your system.  If you find that USB comms is not working, follow [[Flip-USB]] these steps.
+You need the Atmel [http://www.atmel.com/tools/FLIP.aspx Flip] software installed to your system.  If you find that USB comms is not working, use these directions: [[Flip-USB]]
 # Plug in your keyboard