"""
Keyboard definition for the Aivia Osmium custom keyboard.
Auto-generated from C:/Users/Clemens Haffner/Desktop/easykeymap_windows_2_06_02/keyboard-layout.json
"""

#
# READ THIS
#
# This file contains a description of the various parameters that
# must be defined in order to completely describe the new keyboard.
# This file must be correct for the firmware to work, however if
# if is incorrect reprogramming the board won't cause any damage.
#
# This tool that created this file did not have all the information
# needed to make a perfect config.  Check over all the data for
# correctness.  Definitely make sure to fix the matix rows/columns in
# keyboard_definition, which are almost certainly wrong.
#
# This file uses two helper functions to make the configuration
# easier.  For more complicated hardware, it may be necessary to
# set the parameters by hand.  Look at other configs, such as
# boards/sigma.py, for examples if you want to try it.
#

# The first decision you have to make is to choose a hardware
# build.  A handwire board using a Teensy2.0 will probably want
# ATmega32U4_16MHz_TKL or ATmega32U4_16MHz_SIXTY.  The sizes are
# defined in the templates/__init__.py file of the keymapper.
# Leave the rest of the imports like they are here.

import easykeymap.templates.AT90USB1286_16MHz_COSTAR as firmware
from easykeymap.ioports import *
from easykeymap.helper import make_matrix_config, make_led_config


# The name of the board in the "New" dialog

description = "Aivia Osmium"

# Unique string to identify THIS exact hardware layout.  If you change
# this file after saving layouts in the GUI, bump the unique_id to
# prevent corrupted builds.

unique_id = "OSMIUM_001"

# The name of the .cfg file the system will try to find for altered
# layout options.  See the configs subdir of the keymapper.

cfg_name = "osmium"


# Hand-wired boards usually use Teensy controllers.  Set this to
# True to make sure that the bootloader works.

teensy = True

# If your board has an exposed switch for going into the bootloader,
# you can set this to True and the system won't prompt you to add a
# BOOT key to your layout.

hw_boot_key = True


# These two parameters define the size of the keyboard in the display.
# Must be whole numbers in units of quarter key lengths.  A TKL
# usually is 6 rows high with a 1/2 key length gutter under the Fn row.
# Therefore int(6.5*4).  Apply the same logic the width.  Remember
# we are talking visual width, not number of columns.

display_height = 26
display_width = 90


# The number of rows and columns in the matrix.  In a hand-wired board
# each of these will correspond to a single pin.

num_rows = 8
num_cols = 18


# Keyboards work by scanning a matrix to check each key.  The scan
# works by setting an active row/column (strobing) and then reading
# the status of every switch that crosses it (sensing).
# strobe_cols tells the firmware which direction you have your diodes
# installed.  If diodes go from column to row, then strobe_cols must
# be False.  If diodes go from row to column, then strobe_cols must be
# True.

strobe_cols = True

# strobe_low tells the firmware if a row/column should be activated
# by pulling the pin high or low.  Hand-wired boards will almost always
# use strobe_low = True

strobe_low = True


# The matrix_hardware, matrix_strobe, matrix_sense parameters tell
# the firmware how to initialize the ports, what pins must be set
# for each row/column, and what order to strobe/sense.  These are
# complicated and are explained fully elsewhere.  It is easiest to
# configure the matrix by using the make_matrix_config function as
# shown below.  Just customize 'rows' and 'cols' for your project.

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


# The num_leds, num_ind, led_hardware, backlighting, num_bl_enab,
# and bl_modes parameters tell the firmware how to operate the LEDs
# for indicators (for example, Caps Lock) and for backlighting.  In
# order to fine-tune the configs, these may have to be defined manually
# but it is easiest to use make_led_config.
# LED_DRIVER_PULLUP is used when the pin is connected to the anode of
# the LED and the cathode is connected to ground.
# LED_DRIVER_PULLDOWN is used when the pin is connected to the cathode
# of the LED and the anode is connected to the power supply.
# Hand-wired boards will usually want to use LED_DRIVER_PULLDOWN.
# If there are no backlights, just leave the list empty (ie. just []).

num_leds, num_ind, led_hardware, backlighting, num_bl_enab, bl_modes = make_led_config(
    led_pins = [B3, B4, B5],
    led_dir=LED_DRIVER_PULLUP,
    backlight_pins = [B6],
    backlight_dir=LED_DRIVER_PULLUP
)


# Define the default assignments of the indicator LEDs.  The length
# of this list must equal the length of led_pins.  For each LED, the
# first string is the description of the key shown in the GUI.  The
# second string is the default function assigned to that LED.  LED
# functions must be strings as defined in led_assignments of gui.py.
# Common choices are 'Num Lock', 'Caps Lock', 'Scroll Lock', 'Win Lock',
# 'Fn1 Active', 'Recording', 'Backlight', and 'Unassigned'.

led_definition = (('led0', 'Num Lock'),
 ('led1', 'Caps Lock'),
 ('led2', 'Scroll Lock'))


# Define your layout.  This is a list of rows.  Each row is a list
# of keys.  Each key is a tuple of three items.  First item is a tuple
# defining the width,height of the key.  If it is just a number, it
# will be a space instead of a key.  All units are in quarter key lengths,
# so a standard key would be (4,4).  Second item is a tuple defining the
# row,column in the matrix for that key.  Third item is the default scancode
# for that key, from scancodes.py.  If a row is a number instead of a list,
# it will just make a vertical spacer.
# ((key width, key height), (matrix row, matrix column), 'default mapping')
# Bei space HID_KEYBOARD_SC_SPACE statt 0 verwendet

keyboard_definition = [[((4, 4), (4, 2), 'HID_KEYBOARD_SC_ESCAPE'),
  (4, None, '0'),
  ((4, 4), (6, 3), 'HID_KEYBOARD_SC_F1'),
  ((4, 4), (6, 4), 'HID_KEYBOARD_SC_F2'),
  ((4, 4), (2, 4), 'HID_KEYBOARD_SC_F3'),
  ((4, 4), (4, 4), 'HID_KEYBOARD_SC_F4'),
  (2, None, '0'),
  ((4, 4), (5, 1), 'HID_KEYBOARD_SC_F5'),
  ((4, 4), (4, 7), 'HID_KEYBOARD_SC_F6'),
  ((4, 4), (2, 8), 'HID_KEYBOARD_SC_F7'),
  ((4, 4), (6, 8), 'HID_KEYBOARD_SC_F8'),
  (2, None, '0'),
  ((4, 4), (6, 14), 'HID_KEYBOARD_SC_F9'),
  ((4, 4), (5, 14), 'HID_KEYBOARD_SC_F10'),
  ((4, 4), (4, 14), 'HID_KEYBOARD_SC_F11'),
  ((4, 4), (7, 14), 'HID_KEYBOARD_SC_F12'),
  (1, None, '0'),
  ((4, 4), (5, 12), 'HID_KEYBOARD_SC_PRINT_SCREEN'),
  ((4, 4), (1, 12), 'HID_KEYBOARD_SC_SCROLL_LOCK'),
  ((4, 4), (1, 1), 'HID_KEYBOARD_SC_PAUSE'),
  (1, None, '0'),
  ((3, 4), (3, 0), 'SCANCODE_M1'),
  ((3, 4), (4, 0), 'SCANCODE_M2'),
  ((3, 4), (5, 0), 'SCANCODE_M3'),
  ((3, 4), (6, 0), 'SCANCODE_M4'),
  ((3, 4), (1, 0), 'SCANCODE_M5')],
 2,
 [((4, 4), (6, 2), 'HID_KEYBOARD_SC_GRAVE_ACCENT_AND_TILDE'),
  ((4, 4), (5, 2), 'HID_KEYBOARD_SC_1_AND_EXCLAMATION'),
  ((4, 4), (5, 3), 'HID_KEYBOARD_SC_2_AND_AT'),
  ((4, 4), (5, 4), 'HID_KEYBOARD_SC_3_AND_HASHMARK'),
  ((4, 4), (5, 5), 'HID_KEYBOARD_SC_4_AND_DOLLAR'),
  ((4, 4), (6, 5), 'HID_KEYBOARD_SC_5_AND_PERCENTAGE'),
  ((4, 4), (6, 6), 'HID_KEYBOARD_SC_6_AND_CARET'),
  ((4, 4), (5, 6), 'HID_KEYBOARD_SC_7_AND_AND_AMPERSAND'),
  ((4, 4), (5, 7), 'HID_KEYBOARD_SC_8_AND_ASTERISK'),
  ((4, 4), (5, 8), 'HID_KEYBOARD_SC_9_AND_OPENING_PARENTHESIS'),
  ((4, 4), (5, 11), 'HID_KEYBOARD_SC_0_AND_CLOSING_PARENTHESIS'),
  ((4, 4), (6, 11), 'HID_KEYBOARD_SC_MINUS_AND_UNDERSCORE'),
  ((4, 4), (6, 7), 'HID_KEYBOARD_SC_EQUAL_AND_PLUS'),
  ((8, 4), (2, 14), 'HID_KEYBOARD_SC_BACKSPACE'),
  (1, None, '0'),
  ((4, 4), (6, 10), 'HID_KEYBOARD_SC_INSERT'),
  ((4, 4), (6, 15), 'HID_KEYBOARD_SC_HOME'),
  ((4, 4), (6, 9), 'HID_KEYBOARD_SC_PAGE_UP'),
  (1, None, '0'),
  ((4, 4), (0, 13), 'HID_KEYBOARD_SC_NUM_LOCK'),
  ((4, 4), (0, 10), 'HID_KEYBOARD_SC_KEYPAD_SLASH'),
  ((4, 4), (0, 9), 'HID_KEYBOARD_SC_KEYPAD_ASTERISK'),
  ((4, 4), (7, 9), 'HID_KEYBOARD_SC_KEYPAD_MINUS')],
 [((6, 4), (2, 2), 'HID_KEYBOARD_SC_TAB'),
  ((4, 4), (1, 2), 'HID_KEYBOARD_SC_Q'),
  ((4, 4), (1, 3), 'HID_KEYBOARD_SC_W'),
  ((4, 4), (1, 4), 'HID_KEYBOARD_SC_E'),
  ((4, 4), (1, 5), 'HID_KEYBOARD_SC_R'),
  ((4, 4), (2, 5), 'HID_KEYBOARD_SC_T'),
  ((4, 4), (2, 6), 'HID_KEYBOARD_SC_Y'),
  ((4, 4), (1, 6), 'HID_KEYBOARD_SC_U'),
  ((4, 4), (1, 7), 'HID_KEYBOARD_SC_I'),
  ((4, 4), (1, 8), 'HID_KEYBOARD_SC_O'),
  ((4, 4), (1, 11), 'HID_KEYBOARD_SC_P'),
  ((4, 4), (2, 11), 'HID_KEYBOARD_SC_OPENING_BRACKET_AND_OPENING_BRACE'),
  ((4, 4), (2, 7), 'HID_KEYBOARD_SC_CLOSING_BRACKET_AND_CLOSING_BRACE'),
  (1, None, '0'),
  ((5, 8), (0, 14), 'HID_KEYBOARD_SC_ENTER'),
  (1, None, '0'),
  ((4, 4), (6, 13), 'HID_KEYBOARD_SC_DELETE'),
  ((4, 4), (5, 15), 'HID_KEYBOARD_SC_END'),
  ((4, 4), (5, 9), 'HID_KEYBOARD_SC_PAGE_DOWN'),
  (1, None, '0'),
  ((4, 4), (1, 13), 'HID_KEYBOARD_SC_KEYPAD_7_AND_HOME'),
  ((4, 4), (1, 10), 'HID_KEYBOARD_SC_KEYPAD_8_AND_UP_ARROW'),
  ((4, 4), (1, 9), 'HID_KEYBOARD_SC_KEYPAD_9_AND_PAGE_UP'),
  ((4, 8), (1, 15), 'HID_KEYBOARD_SC_KEYPAD_PLUS')],
 [((7, 4), (2, 3), 'HID_KEYBOARD_SC_CAPS_LOCK'),
  ((4, 4), (3, 2), 'HID_KEYBOARD_SC_A'),
  ((4, 4), (3, 3), 'HID_KEYBOARD_SC_S'),
  ((4, 4), (3, 4), 'HID_KEYBOARD_SC_D'),
  ((4, 4), (3, 5), 'HID_KEYBOARD_SC_F'),
  ((4, 4), (4, 5), 'HID_KEYBOARD_SC_G'),
  ((4, 4), (4, 6), 'HID_KEYBOARD_SC_H'),
  ((4, 4), (3, 6), 'HID_KEYBOARD_SC_J'),
  ((4, 4), (3, 7), 'HID_KEYBOARD_SC_K'),
  ((4, 4), (3, 8), 'HID_KEYBOARD_SC_L'),
  ((4, 4), (3, 11), 'HID_KEYBOARD_SC_SEMICOLON_AND_COLON'),
  ((4, 4), (4, 11), 'HID_KEYBOARD_SC_APOSTROPHE_AND_QUOTE'),
  ((4, 4), (0, 11), 'HID_KEYBOARD_SC_NON_US_HASHMARK_AND_TILDE'),
  (-19, None, '0'),
  ((4, 4), (2, 13), 'HID_KEYBOARD_SC_KEYPAD_4_AND_LEFT_ARROW'),
  ((4, 4), (2, 10), 'HID_KEYBOARD_SC_KEYPAD_5'),
  ((4, 4), (2, 9), 'HID_KEYBOARD_SC_KEYPAD_6_AND_RIGHT_ARROW')],
 [((5, 4), (2, 16), 'HID_KEYBOARD_SC_LEFT_SHIFT'),
  ((4, 4), (4, 3), 'HID_KEYBOARD_SC_NON_US_BACKSLASH_AND_PIPE'),
  ((4, 4), (0, 2), 'HID_KEYBOARD_SC_Z'),
  ((4, 4), (0, 3), 'HID_KEYBOARD_SC_X'),
  ((4, 4), (0, 4), 'HID_KEYBOARD_SC_C'),
  ((4, 4), (0, 5), 'HID_KEYBOARD_SC_V'),
  ((4, 4), (7, 5), 'HID_KEYBOARD_SC_B'),
  ((4, 4), (7, 6), 'HID_KEYBOARD_SC_N'),
  ((4, 4), (0, 6), 'HID_KEYBOARD_SC_M'),
  ((4, 4), (0, 7), 'HID_KEYBOARD_SC_COMMA_AND_LESS_THAN_SIGN'),
  ((4, 4), (0, 8), 'HID_KEYBOARD_SC_DOT_AND_GREATER_THAN_SIGN'),
  ((4, 4), (7, 11), 'HID_KEYBOARD_SC_SLASH_AND_QUESTION_MARK'),
  ((11, 4), (3, 16), 'HID_KEYBOARD_SC_RIGHT_SHIFT'),
  (5, None, '0'),
  ((4, 4), (4, 15), 'HID_KEYBOARD_SC_UP_ARROW'),
  (5, None, '0'),
  ((4, 4), (3, 13), 'HID_KEYBOARD_SC_KEYPAD_1_AND_END'),
  ((4, 4), (3, 10), 'HID_KEYBOARD_SC_KEYPAD_2_AND_DOWN_ARROW'),
  ((4, 4), (3, 9), 'HID_KEYBOARD_SC_KEYPAD_3_AND_PAGE_DOWN'),
  ((4, 8), (3, 15), 'HID_KEYBOARD_SC_KEYPAD_ENTER')],
 [((5, 4), (6, 1), 'HID_KEYBOARD_SC_LEFT_CONTROL'),
  ((5, 4), (2, 0), 'HID_KEYBOARD_SC_LEFT_GUI'),
  ((5, 4), (4, 12), 'HID_KEYBOARD_SC_LEFT_ALT'),
  ((25, 4), (4, 13), 'HID_KEYBOARD_SC_SPACE'),
  ((5, 4), (7, 12), 'HID_KEYBOARD_SC_RIGHT_ALT'),
  ((5, 4), (3, 17), 'HID_KEYBOARD_SC_RIGHT_GUI'),
  ((5, 4), (5, 10), 'SCANCODE_WINLOCK'),
  ((5, 4), (0, 1), 'HID_KEYBOARD_SC_RIGHT_CONTROL'),
  (-1, None, '0'),
  ((4, 4), (7, 15), 'HID_KEYBOARD_SC_LEFT_ARROW'),
  ((4, 4), (7, 13), 'HID_KEYBOARD_SC_DOWN_ARROW'),
  ((4, 4), (7, 10), 'HID_KEYBOARD_SC_RIGHT_ARROW'),
  (-1, None, '0'),
  ((8, 4), (4, 10), 'HID_KEYBOARD_SC_KEYPAD_0_AND_INSERT'),
  ((4, 4), (4, 9), 'HID_KEYBOARD_SC_KEYPAD_DOT_AND_DELETE')]]


# Just leave this here as-is.
alt_layouts = {}

# Just leave this here as-is.
KMAC_key = None