# Easy AVR USB Keyboard Firmware Keymapper
# Copyright (C) 2013-2016 David Howland
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program.  If not, see <http://www.gnu.org/licenses/>.

"""Keyboard definition for the GH-122.2016 custom keyboard"""

import easykeymap.templates.AT90USB1286_16MHz_JUMBO as firmware
from easykeymap.ioports import *
from easykeymap.helper import make_matrix_config

description = "GH-122v2"
unique_id = "GH122_003"
cfg_name = "gh122"

teensy = True
hw_boot_key = False

display_height = int(7.5*4)
display_width = int(24.75*4)

num_rows = 7
num_cols = 24

strobe_cols = False
strobe_low = True

matrix_hardware, matrix_strobe, matrix_sense = make_matrix_config(
    strobe_cols=strobe_cols,
    strobe_low=strobe_low,
    rows=[B6, B5, B1, D4, D3, D2, D1],
    cols=[F7, F6, F5, F4, F3, F2, C7, F0, F1, E1, C0, C1, C2, C3, C4, C5, C6, E7, D7, E6, E0, D0, B0, D5],
    device=firmware.device
)

num_leds = 3
num_ind = 3
num_bl_enab = 2

led_definition = [
    ('Scroll LED', 'Scroll Lock'),
    ('Caps LED', 'Caps Lock'),
    ('Num LED', 'Num Lock')
]

led_hardware = [
#       Port    Pin    Direction
    ( REF_PORTB, 2, LED_DRIVER_PULLUP ),
    ( REF_PORTB, 3, LED_DRIVER_PULLUP ),
    ( REF_PORTB, 4, LED_DRIVER_PULLUP )
]

backlighting = True

bl_modes = [
    ( 0, 0, 0 ),
    ( 1, 1, 1 )
]

KMAC_key = None

keyboard_definition = [
    [((4, 4), (0, 0), '0'),
     ((4, 4), (0, 1), '0'),
     (1, None, '0'),
     ((4, 4), (0, 2), '0'),
     ((4, 4), (0, 3), '0'),
     ((4, 4), (0, 4), '0'),
     ((4, 4), (0, 5), '0'),
     ((4, 4), (0, 6), '0'),
     ((4, 4), (0, 7), '0'),
     (0, None, '0'),
     ((4, 4), (0, 8), '0'),
     ((4, 4), (0, 9), '0'),
     ((4, 4), (0, 10), '0'),
     ((4, 4), (0, 11), '0'),
     ((4, 4), (0, 12), '0'),
     ((4, 4), (0, 13), '0'),
     ((4, 4), (0, 14), '0'),
     ((4, 4), (0, 15), '0'),
     ((4, 4), (0, 16), '0'),
     (1, None, '0'),
     ((4, 4), (0, 17), '0'),
     ((4, 4), (0, 18), '0'),
     ((4, 4), (0, 19), '0'),
     (17, None, '0'),
    ],
    
    [((4, 4), (1, 0), '0'),
     ((4, 4), (1, 1), '0'),
     (1, None, '0'),
     ((4, 4), (1, 2), 'HID_KEYBOARD_SC_ESCAPE'),
     ((4, 4), (1, 3), '0'),
     ((4, 4), (1, 4), 'HID_KEYBOARD_SC_F1'),
     ((4, 4), (1, 5), 'HID_KEYBOARD_SC_F2'),
     ((4, 4), (1, 6), 'HID_KEYBOARD_SC_F3'),
     ((4, 4), (1, 7), 'HID_KEYBOARD_SC_F4'),
     (0, None, '0'),
     ((4, 4), (1, 8), 'HID_KEYBOARD_SC_F5'),
     ((4, 4), (1, 9), 'HID_KEYBOARD_SC_F6'),
     ((4, 4), (1, 10), 'HID_KEYBOARD_SC_F7'),
     ((4, 4), (1, 11), 'HID_KEYBOARD_SC_F8'),
     ((4, 4), (1, 12), '0'),
     ((4, 4), (1, 13), 'HID_KEYBOARD_SC_F9'),
     ((4, 4), (1, 14), 'HID_KEYBOARD_SC_F10'),
     ((4, 4), (1, 15), 'HID_KEYBOARD_SC_F11'),
     ((4, 4), (1, 16), 'HID_KEYBOARD_SC_F12'),
     (1, None, '0'),
     ((4, 4), (1, 17), 'HID_KEYBOARD_SC_PRINT_SCREEN'),
     ((4, 4), (1, 18), 'HID_KEYBOARD_SC_SCROLL_LOCK'),
     ((4, 4), (1, 19), 'HID_KEYBOARD_SC_PAUSE'),
     (17, None, '0')],

    2,

    [((4, 4), (2, 0), '0'),
     ((4, 4), (2, 1), '0'),
     (1, None, '0'),
     ((4, 4), (2, 2), 'HID_KEYBOARD_SC_GRAVE_ACCENT_AND_TILDE'),
     ((4, 4), (2, 3), 'HID_KEYBOARD_SC_1_AND_EXCLAMATION'),
     ((4, 4), (2, 4), 'HID_KEYBOARD_SC_2_AND_AT'),
     ((4, 4), (2, 5), 'HID_KEYBOARD_SC_3_AND_HASHMARK'),
     ((4, 4), (2, 6), 'HID_KEYBOARD_SC_4_AND_DOLLAR'),
     ((4, 4), (2, 7), 'HID_KEYBOARD_SC_5_AND_PERCENTAGE'),
     ((4, 4), (2, 8), 'HID_KEYBOARD_SC_6_AND_CARET'),
     ((4, 4), (2, 9), 'HID_KEYBOARD_SC_7_AND_AND_AMPERSAND'),
     ((4, 4), (2, 10), 'HID_KEYBOARD_SC_8_AND_ASTERISK'),
     ((4, 4), (2, 11), 'HID_KEYBOARD_SC_9_AND_OPENING_PARENTHESIS'),
     ((4, 4), (2, 12), 'HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS'),
     ((4, 4), (2, 13), 'HID_KEYBOARD_SC_MINUS_AND_UNDERSCORE'),
     ((4, 4), (2, 14), 'HID_KEYBOARD_SC_EQUAL_AND_PLUS'),
     ((4, 4), (2, 15), 'HID_KEYBOARD_SC_BACKSPACE'),
     ((4, 4), (2, 16), 'HID_KEYBOARD_SC_BACKSPACE'),
     (1, None, '0'),
     ((4, 4), (2, 17), 'HID_KEYBOARD_SC_INSERT'),
     ((4, 4), (2, 18), 'HID_KEYBOARD_SC_HOME'),
     ((4, 4), (2, 19), 'HID_KEYBOARD_SC_PAGE_UP'),
     (1, None, '0'),
     ((4, 4), (2, 20), 'HID_KEYBOARD_SC_NUM_LOCK'),
     ((4, 4), (2, 21), 'HID_KEYBOARD_SC_KEYPAD_SLASH'),
     ((4, 4), (2, 22), 'HID_KEYBOARD_SC_KEYPAD_ASTERISK'),
     ((4, 4), (2, 23), 'HID_KEYBOARD_SC_KEYPAD_MINUS')],

    [((4, 4), (3, 0), '0'),
     ((4, 4), (3, 1), '0'),
     (1, None, '0'),
     ((6, 4), (3, 2), 'HID_KEYBOARD_SC_TAB'),
     ((4, 4), (3, 3), 'HID_KEYBOARD_SC_Q'),
     ((4, 4), (3, 4), 'HID_KEYBOARD_SC_W'),
     ((4, 4), (3, 5), 'HID_KEYBOARD_SC_E'),
     ((4, 4), (3, 6), 'HID_KEYBOARD_SC_R'),
     ((4, 4), (3, 7), 'HID_KEYBOARD_SC_T'),
     ((4, 4), (3, 8), 'HID_KEYBOARD_SC_Y'),
     ((4, 4), (3, 9), 'HID_KEYBOARD_SC_U'),
     ((4, 4), (3, 10), 'HID_KEYBOARD_SC_I'),
     ((4, 4), (3, 11), 'HID_KEYBOARD_SC_O'),
     ((4, 4), (3, 12), 'HID_KEYBOARD_SC_P'),
     ((4, 4), (3, 13), 'HID_KEYBOARD_SC_OPENING_BRACKET_AND_OPENING_BRACE'),
     ((4, 4), (3, 14), 'HID_KEYBOARD_SC_CLOSING_BRACKET_AND_CLOSING_BRACE'),
     (0, None, '0'),
     ((6, 4), (3, 16), 'HID_KEYBOARD_SC_BACKSLASH_AND_PIPE'),
     (1, None, '0'),
     ((4, 4), (3, 17), 'HID_KEYBOARD_SC_DELETE'),
     ((4, 4), (3, 18), 'HID_KEYBOARD_SC_END'),
     ((4, 4), (3, 19), 'HID_KEYBOARD_SC_PAGE_DOWN'),
     (1, None, '0'),
     ((4, 4), (3, 20), 'HID_KEYBOARD_SC_KEYPAD_7_AND_HOME'),
     ((4, 4), (3, 21), 'HID_KEYBOARD_SC_KEYPAD_8_AND_UP_ARROW'),
     ((4, 4), (3, 22), 'HID_KEYBOARD_SC_KEYPAD_9_AND_PAGE_UP'),
     ((4, 4), (3, 23), 'HID_KEYBOARD_SC_KEYPAD_PLUS')],

    [((4, 4), (4, 0), '0'),
     ((4, 4), (4, 1), '0'),
     (1, None, '0'),
     ((7, 4), (4, 2), 'HID_KEYBOARD_SC_CAPS_LOCK'),
     ((4, 4), (4, 3), 'HID_KEYBOARD_SC_A'),
     ((4, 4), (4, 4), 'HID_KEYBOARD_SC_S'),
     ((4, 4), (4, 5), 'HID_KEYBOARD_SC_D'),
     ((4, 4), (4, 6), 'HID_KEYBOARD_SC_F'),
     ((4, 4), (4, 7), 'HID_KEYBOARD_SC_G'),
     ((4, 4), (4, 8), 'HID_KEYBOARD_SC_H'),
     ((4, 4), (4, 9), 'HID_KEYBOARD_SC_J'),
     ((4, 4), (4, 10), 'HID_KEYBOARD_SC_K'),
     ((4, 4), (4, 11), 'HID_KEYBOARD_SC_L'),
     ((4, 4), (4, 12), 'HID_KEYBOARD_SC_SEMICOLON_AND_COLON'),
     ((4, 4), (4, 13), 'HID_KEYBOARD_SC_APOSTROPHE_AND_QUOTE'),
     ((9, 4), (4, 14), 'HID_KEYBOARD_SC_ENTER'),
     (0, None, '0'),
     (1, None, '0'),
     ((4, 4), (4, 17), '0'),
     ((4, 4), (4, 18), '0'),
     ((4, 4), (4, 19), '0'),
     (1, None, '0'),
     ((4, 4), (4, 20), 'HID_KEYBOARD_SC_KEYPAD_4_AND_LEFT_ARROW'),
     ((4, 4), (4, 21), 'HID_KEYBOARD_SC_KEYPAD_5'),
     ((4, 4), (4, 22), 'HID_KEYBOARD_SC_KEYPAD_6_AND_RIGHT_ARROW'),
     ((4, 4), (4, 23), '0'),],

    [((4, 4), (5, 0), '0'),
     ((4, 4), (5, 1), '0'),
     (1, None, '0'),
     ((5, 4), (5, 2), 'HID_KEYBOARD_SC_LEFT_SHIFT'),
     ((4, 4), (5, 3), 'HID_KEYBOARD_SC_NON_US_BACKSLASH_AND_PIPE'),
     ((4, 4), (5, 4), 'HID_KEYBOARD_SC_Z'),
     ((4, 4), (5, 5), 'HID_KEYBOARD_SC_X'),
     ((4, 4), (5, 6), 'HID_KEYBOARD_SC_C'),
     ((4, 4), (5, 7), 'HID_KEYBOARD_SC_V'),
     ((4, 4), (5, 8), 'HID_KEYBOARD_SC_B'),
     ((4, 4), (5, 9), 'HID_KEYBOARD_SC_N'),
     ((4, 4), (5, 10), 'HID_KEYBOARD_SC_M'),
     ((4, 4), (5, 11), 'HID_KEYBOARD_SC_COMMA_AND_LESS_THAN_SIGN'),
     ((4, 4), (5, 12), 'HID_KEYBOARD_SC_DOT_AND_GREATER_THAN_SIGN'),
     ((4, 4), (5, 13), 'HID_KEYBOARD_SC_SLASH_AND_QUESTION_MARK'),
     ((7, 4), (5, 14), 'HID_KEYBOARD_SC_RIGHT_SHIFT'),
     ((4, 4), (5, 16), '0'),
     (1, None, '0'),
     ((4, 4), (5, 17), '0'),
     ((4, 4), (5, 18), 'HID_KEYBOARD_SC_UP_ARROW'),
     ((4, 4), (5, 19), '0'),
     (1, None, '0'),
     ((4, 4), (5, 20), 'HID_KEYBOARD_SC_KEYPAD_1_AND_END'),
     ((4, 4), (5, 21), 'HID_KEYBOARD_SC_KEYPAD_2_AND_DOWN_ARROW'),
     ((4, 4), (5, 22), 'HID_KEYBOARD_SC_KEYPAD_3_AND_PAGE_DOWN'),
     ((4, 4), (5, 23), 'HID_KEYBOARD_SC_KEYPAD_ENTER')],

    [((4, 4), (6, 0), '0'),
     ((4, 4), (6, 1), '0'),
     (1, None, '0'),
     ((5, 4), (6, 2), 'HID_KEYBOARD_SC_LEFT_CONTROL'),
     ((5, 4), (6, 3), 'HID_KEYBOARD_SC_LEFT_GUI'),
     ((5, 4), (6, 4), 'HID_KEYBOARD_SC_LEFT_ALT'),
     ((25, 4), (6, 8), 'HID_KEYBOARD_SC_SPACE'),
     ((5, 4), (6, 12), 'HID_KEYBOARD_SC_RIGHT_ALT'),
     ((5, 4), (6, 13), 'HID_KEYBOARD_SC_RIGHT_GUI'),
     ((5, 4), (6, 14), 'HID_KEYBOARD_SC_APPLICATION'),
     ((5, 4), (6, 16), 'HID_KEYBOARD_SC_RIGHT_CONTROL'),
     (1, None, '0'),
     ((4, 4), (6, 17), 'HID_KEYBOARD_SC_LEFT_ARROW'),
     ((4, 4), (6, 18), 'HID_KEYBOARD_SC_DOWN_ARROW'),
     ((4, 4), (6, 19), 'HID_KEYBOARD_SC_RIGHT_ARROW'),
     (1, None, '0'),
     ((4, 4), (6, 20), 'HID_KEYBOARD_SC_KEYPAD_0_AND_INSERT'),
     ((4, 4), (6, 21), '0'),
     ((4, 4), (6, 22), 'HID_KEYBOARD_SC_KEYPAD_DOT_AND_DELETE'),
     ((4, 4), (6, 23), '0')]
]

alt_layouts = {}