menura.yaml

units:
  # for the key matrix
  # mx spacing
  kx: u
  ky: u
  edge_padding: 1
  preview_key_adj: 0.5  # how much to shrink the keys in the preview, so boxes aren't overlapping

  # stagger and splay
  ring_stagger: ky/2 + 2.5
  middle_stagger: 5
  index_stagger: -5
  inner_stagger: -2.5
  thumb_splay: -5
  thumb_spread: 0.525kx
  thumb_drop_offset: -1.2ky

  # for the case
  sw_hole: 14  # size of hole for switch in plate
  keycap_padding: 0.5  # extra room to account for keycap
  inner_wall_offset: 1  # manufacturing tolerance around pcb outline
  outer_wall_offset: 3  # main case wall thickness
  shadow_inner_offset: 1.2  # offset from inner wall for shadow line inner piece
  shadow_outer_offset: outer_wall_offset - shadow_inner_offset  # offset for shadow line outer piece

  # for other components
  # nb: mcu footprint has the port pointing to the left
  mcu_x: 33
  mcu_y: 18
  mcu_padding: 2.11  # extra buffer between mcu to make bottom edge cut straight with thumbs
  mcu_adj: 7  # adjustment to align mcu (but not the port) and switch
  diode_adj_x: -8.6  # diode adjustment in main switch matrix
  diode_adj_y: -1.9
  diode_adj_thumb: -8.2  # diode adjustment in thumb cluster
  m3: 3.2  # m3 hole diameter (for an m2 standoff)
  m2cs: 4.4  # m2 countersunk hole clearance diameter
  # MSK-12C02 type power switch
  pwr_x: 5.85
  pwr_y: 8.8
  pwr_adj: 1.12 # align edge cut to pads (not physical toggle switch)
  pwr_mcu_x_offset: 5
  pwr_mcu_y_offset: -0.5mcu_y - mcu_padding + 0.5pwr_x - pwr_adj
  # generic through hole 2 pin 3x6x4.3mm button/switch e.g. MJTP1243
  rst_x: 9
  rst_y: 3.5
  rst_pwr_x_offset: 2
  rst_pwr_y_offset: -2.5 + mcu_padding + 0.2
  jst_x: 8.9
  jst_y: 8.6
  jst_x_adj: 0.1
  jst_y_adj: 2.2
  vik_x: 11
  vik_y: 9.1
  vik_adj_x: 4.5
  vik_adj_y: 3 - vik_adj_x
  vik_tht_x: 17
  vik_tht_y: 16
  vik_tht_adj_x: 2.5
  vik_tht_adj_y: 15
  hole_x_adj: 7
  logo_x: 33
  logo_y: 10.5
  logo_rst_x_offset: 25

points:
  zones:
    matrix:
      key:
        padding: 0.5ky
        spread: kx
        bind: [0, 0, 0, 0]
      anchor:
        shift: [100, -100]
      rows:
        bottom:
        bird_bottom:
        home:
        bird_top:
        top:
      columns:
        pinky:
          rows.bottom.tags: [pinky_3x5]
          rows.bird_bottom.skip: true
          rows.home.tags: [matrix_common]
          rows.bird_top.skip: true
          rows.top.tags: [matrix_common]
        ring:
          key:
            stagger: ring_stagger
            tags: [matrix_common]
          rows.bird_bottom.skip: true
          rows.bird_top.skip: true
        middle:
          key:
            stagger: middle_stagger
            tags: [matrix_common]
          rows.bird_bottom.skip: true
          rows.bird_top.skip: true
        index:
          key:
            stagger: index_stagger
            tags: [matrix_common]
          rows.bird_bottom.skip: true
          rows.bird_top.skip: true
        inner:
          key:
            stagger: inner_stagger
          rows.bottom.tags: [inner_3x5]
          rows.bottom.bind: [0, 0, 4, 0]
          rows.home.tags: [inner_3x5]
          rows.top.tags: [inner_3x5]
          rows.bird_bottom.tags: [inner_bird]
          rows.bird_bottom.bind: [0, 0, 14, 0]
          rows.bird_top.tags: [inner_bird]
    thumbs:
      key:
        padding: ky
        spread: thumb_spread
        bind: [0, 0, 0, 0]
        splay: thumb_splay
        origin: [-0.5thumb_spread, -0.5ky]
      anchor:
        ref: matrix_index_bottom
        shift: [0, thumb_drop_offset]
      rows:
        cluster:
      columns:
        tucky:
          key:
            splay: 0
            tags: [3thumb]
            bind: [4, 2, 0, 0]
        midtucky:
          key.tags: [2thumb]
          key.bind: [4, 2, 0, 0]
        home:
          key.tags: [3thumb]
          key.bind: [0, 2, 0, 2]
        midreachy:
          key.tags: [2thumb]
          key.bind: [0, 0, 0, 2]
        reachy:
          key.tags: [3thumb]
          key.bind: [0, 0, 0, 2]
    mcu:
      key:
        width: mcu_x
        height: mcu_y
      anchor:
        ref: matrix_pinky_bottom
        shift: [mcu_adj, -0.5ky - 0.5mcu_y - mcu_padding]
    jst:
      key:
        width: jst_x
        height: jst_y
        rotate: 90
      anchor:
        ref: matrix_ring_bottom
        shift: [-jst_x_adj, -0.5ky - 0.5jst_y - jst_y_adj]
    pwr:
      key:
        width: pwr_x
        height: pwr_y
        rotate: 270
      anchor:
        ref: mcu
        shift: [0.5mcu_x + 0.5pwr_x + pwr_mcu_x_offset, pwr_mcu_y_offset]
    rst:
      key:
        width: rst_x
        height: rst_y
      anchor:
        ref: pwr
        shift: [rst_pwr_y_offset, 0.5pwr_y + 0.5rst_x + rst_pwr_x_offset]
        rotate: 90
    vik:
      key:
        width: vik_x
        height: vik_y
      anchor:
        ref: matrix_inner_bottom
        shift: [0.5kx + 0.5vik_x + vik_adj_x, -0.5ky + vik_adj_y]
        rotate: 135
    vik_tht:
      key:
        width: vik_tht_x
        height: vik_tht_y
      anchor:
        ref: matrix_middle_bottom
        shift: [-vik_tht_adj_x, -0.5ky - 0.5vik_tht_y - vik_tht_adj_y]
        rotate: 270
    mount_1:
      key:
        width: m3
        height: m3
      anchor:
        ref: matrix_ring_top
        shift: [-hole_x_adj, -0.5ky]
    mount_2:
      key:
        width: m3
        height: m3
      anchor:
        ref: matrix_ring_bottom
        shift: [-hole_x_adj, -0.5ky]
    mount_3:
      key:
        width: m3
        height: m3
      anchor:
        ref: matrix_index_top
        shift: [hole_x_adj, -0.5ky]
    mount_4:
      key:
        width: m3
        height: m3
      anchor:
        ref: thumbs_home_cluster
        shift: [0, 0.5ky]
    logo:
      key:
        width: logo_x
        height: logo_y
      anchor:
        ref: rst
        shift: [logo_rst_x_offset, -0.5rst_y +  0.5logo_y]
outlines:
  _preview_keys36:
    - what: rectangle
      size: [kx-preview_key_adj, ky-preview_key_adj]
      where:
        - matrix_common
        - /.*_3x5/
        - 3thumb
  _preview_keys30:
    - what: rectangle
      size: [kx-preview_key_adj, ky-preview_key_adj]
      where:
        - matrix_common
        - inner_bird
        - 2thumb
  _preview_components:
    - what: rectangle
      size: [mcu_x, mcu_y]
      where: mcu
    - what: rectangle
      size: [jst_x, jst_y]
      where: jst
    - what: rectangle
      size: [pwr_x, pwr_y]
      where: pwr
    - what: rectangle
      size: [rst_x, rst_y]
      where: rst
    - what: rectangle
      size: [vik_x, vik_y]
      where: vik
    - what: rectangle
      size: [vik_tht_x, vik_tht_y]
      where: vik_tht
    - what: rectangle
      size: [logo_x, logo_y]
      where: logo
  _mounting_holes:
    - what: circle
      radius: m3 / 2
      where: /mount_.*/
  _mounting_screws:
    - what: circle
      radius: m2cs / 2
      where: /mount_.*/
  _board:
    - what: polygon
      operation: stack
      points:
        - ref: matrix_pinky_bottom
          shift: [-0.5kx - edge_padding, -0.5ky - mcu_y - 2*mcu_padding]
        - ref: matrix_pinky_top
          shift: [-0.5kx - edge_padding, 0.5 ky + edge_padding]
        - ref: matrix_ring_top
          shift: [-0.5kx - edge_padding, 0.5ky + edge_padding]
        - ref: matrix_middle_top
          shift: [-0.5kx, 0.5ky + edge_padding]
        - ref: matrix_middle_top
          shift: [0.5kx, 0.5ky + edge_padding]
        - ref: matrix_inner_top
          shift: [0.5kx + edge_padding, 0.5ky + edge_padding]
        - ref: matrix_inner_bottom
          shift: [0.5kx + edge_padding, 0.25ky]
        - ref: thumbs_reachy_cluster
          shift: [0.5kx + edge_padding, 0.5ky + edge_padding]
        - ref: thumbs_reachy_cluster
          shift: [0.5kx + edge_padding, -0.5ky - edge_padding]
  _pcb:
    - what: outline
      name: _board
      fillet: 2
  preview_36:
    - _pcb
    - ^_preview_keys36
    - ^_preview_components
    - ^_mounting_holes
  preview_30:
    - _pcb
    - ^_preview_keys30
    - ^_preview_components
    - ^_mounting_holes
  _board_inner_wall:
    - what: outline
      name: _board
      expand: inner_wall_offset
      joints: 1
  _board_outer_wall:
    - what: outline
      name: _board
      expand: inner_wall_offset + outer_wall_offset
      joints: 1
  _shadow_inner_wall:
    - what: outline
      name: _board
      expand: inner_wall_offset + shadow_inner_offset
      joints: 1
  _shadow_outer_wall:
    - what: outline
      name: _board
      expand: inner_wall_offset + shadow_outer_offset
      joints: 1
  _board_outlines:
    - _board_inner_wall
    - ^_board_outer_wall
    - ^_shadow_inner_wall
    - ^_shadow_outer_wall
  _case_components:
    - what: rectangle
      size: [mcu_x, mcu_y]
      where: mcu
    - what: rectangle
      size: [pwr_x, pwr_y]
      where: pwr
    - what: rectangle
      size: [rst_x, rst_y]
      where: rst
    - what: rectangle
      size: [vik_x, vik_y]
      where: vik
    - what: rectangle
      size: [jst_x, jst_y]
      where: jst
  case_bottom:
    - _board_outlines
    - ^_mounting_screws
    - ^_case_components
  _plate_3x5_3_switches:
    - what: rectangle
      size: sw_hole
      where:
        - matrix_common
        - /.*_3x5/
        - 3thumb
  _plate_3x5_3_keycaps:
    - what: rectangle
      bound: true
      size: [kx + keycap_padding, ky + keycap_padding]
      where:
        - matrix_common
        - /.*_3x5/
        - 3thumb
  case_plate_3x5_3:
    - case_bottom
    - ^_plate_3x5_3_switches
    - ^_plate_3x5_3_keycaps
  _plate_23332_2_switches:
    - what: rectangle
      size: sw_hole
      where:
        - matrix_common
        - inner_bird
        - 2thumb
  _plate_23332_2_keycaps:
    - what: rectangle
      bound: true
      size: [kx + keycap_padding, ky + keycap_padding]
      where:
        - matrix_common
        - inner_bird
        - 2thumb
  case_plate_23332_2:
    - case_bottom
    - ^_plate_23332_2_switches
    - ^_plate_23332_2_keycaps
  _plate_23332_3_switches:
    - what: rectangle
      size: sw_hole
      where:
        - matrix_common
        - inner_bird
        - 3thumb
  _plate_23332_3_keycaps:
    - what: rectangle
      bound: true
      size: [kx + keycap_padding, ky + keycap_padding]
      where:
        - matrix_common
        - inner_bird
        - 3thumb
  case_plate_23332_3:
    - case_bottom
    - ^_plate_23332_3_switches
    - ^_plate_23332_3_keycaps
  _plate_3x5_2_switches:
    - what: rectangle
      size: sw_hole
      where:
        - matrix_common
        - /.*_3x5/
        - 2thumb
  _plate_3x5_2_keycaps:
    - what: rectangle
      bound: true
      size: [kx + keycap_padding, ky + keycap_padding]
      where:
        - matrix_common
        - /.*_3x5/
        - 2thumb
  case_plate_3x5_2:
    - case_bottom
    - ^_plate_3x5_2_switches
    - ^_plate_3x5_2_keycaps
  _plate_33332_3_switches:
    - what: rectangle
      size: sw_hole
      where:
        - matrix_common
        - pinky_3x5
        - inner_bird
        - 3thumb
  _plate_33332_3_keycaps:
    - what: rectangle
      bound: true
      size: [kx + keycap_padding, ky + keycap_padding]
      where:
        - matrix_common
        - pinky_3x5
        - inner_bird
        - 3thumb
  case_plate_33332_3:
    - case_bottom
    - ^_plate_33332_3_switches
    - ^_plate_33332_3_keycaps
pcbs:
  menura:
    outlines:
      main:
        outline: _pcb
    footprints:
      sw_hotswap:
        what: mx
        where:
          - /matrix_.*/
          - 3thumb
        params:
          designator: "SW"
          from: ""
          to: ""
      sw_hotswap_2thumb:
        what: mx
        where: 2thumb
        params:
          designator: "SW"
          from: ""
          to: ""
        adjust.rotate: 180
      diode_matrix:
        what: diode
        where: /matrix_.*/
        params:
          from: ""
          to: ""
        adjust:
          shift: [diode_adj_x, diode_adj_y]
          rotate: 90
      diode_3thumb:
        what: diode
        where: 3thumb
        params:
          from: ""
          to: ""
        adjust:
          shift: [0, diode_adj_thumb]
          rotate: 180  # point to the right
      diode_2thumb:
        what: diode
        where: 2thumb
        params:
          from: ""
          to: ""
        adjust:
          shift: [0, diode_adj_thumb]
          rotate: 180
      mcu:
        what: promicro
        where: mcu
        params:
          designator: "MCU"
      jst:
        what: jstph
        where: jst
        params:
          pos: ""
          neg: ""
      pwr:
        what: slider
        where: pwr
        params:
          designator: "PWR"
          from: ""
          to: ""
      rst:
        what: button
        where: rst
        params:
          designator: "RSW"
          from: ""
          to: ""
      vik:
        what: pad
        where: vik
        params:
          designator: "VIK"
          net: ""
      vik_tht:
        what: pad
        where: vik_tht
        params:
          designator: "VIK"
          net: ""
      mounting_holes:
        what: pad
        where: /mount_.*/
        params:
          designator: "H"
          net: ""
      logo:
        what: pad
        where: logo
        params:
          designator: "LOGO"
          net: ""