Skip to content

Latest commit

 

History

History
97 lines (61 loc) · 5 KB

options-ports.md

File metadata and controls

97 lines (61 loc) · 5 KB
Raw

Port configuration options

Each heading in this document represents a recognized configuration key in YAML files for the DMOTE application.

This specific document describes options for the shape and position of any individual port. One set of such options will exist for each entry in ports, a section whose place in the larger hierarchy can be seen here. Example uses for ports:

  • One port for the connection between the two halves of a reflected keyboard without a central housing. Such ports are usually TRRS or 4P4C (“RJ9”), but you can use practically anything with enough wires.
  • An external USB port for interfacing with your computer, such as a full-size USB A port. You might want this when your MCU either has no such port attached or the attached port is too weak for direct human use (cf. shelf) or difficult to get into a good position.
  • Additional USB ports, connected via internal hub or to an integrated microphone clip, phone charger etc.
  • A speaker for QMK audio.
  • An LCD screen for QMK video.
  • An exotic human interface device, such as a large rotary encoder or trackball, not supported by this application as a type of keyboard switch.
  • Assortment drawers built into a large rear or central housing.

Notice ports attached directly to microcontroller boards are treated in the mcu section, not here.

There are limited facilities for specifying the shape of a port. For making anything other than a cuboid or cylindroid socket, get as close as possible with tweaks, then make your own adapter and/or widen the socket with a soldering iron or similar tools to fit a more complex object.

Table of contents

Parameter include

If true, include the port. The main use of this option is for disabling ports defined in other configuration files. The default value is false for consistency with other inclusion parameters.

Parameter body

A code identifying the body in which the port is cut.

Parameter type

A code identifying a common type of port. The following values are recognized.

  • modular-4p4c-616e: modular connector 4P4C, socket 616E, minus the vertical stripe.
  • usb-c: USB C.
  • usb-full-2b: full-size USB 2 B.
  • usb-full-3b: full-size USB 3 B.
  • usb-full-a: full-size USB A.
  • usb-micro-2b: USB micro 2 B.
  • usb-mini-b: USB mini B.* custom-cuboid, meaning that size (below) will take effect, describing a cuboid shape.
  • custom-cylindroid, which is like custom-cuboid but the shape has an ellipse as its cross-section in the xy plane (before any rotation).

Parameter size

An [x, y, z] vector specifying the size of the port in mm. This is used only with custom-* port types.

For custom-cylindroid, the orientation of the cylinder is along the y axis, and therefore x and z are the two diameters of the elliptic cross-section, while y determines the length of the cylindroid.

Section alignment

How the port lines itself up at its position.

Parameter segment

Which vertical segment of the port itself to place at its anchor. The default value here is 0, meaning the ceiling of the port.

Parameter side

Which wall or corner of the port itself to place at its anchor. The default value here is N (nominal north), which is the open face of the port.

Section anchoring

Where to place the port. By default, ports face nominal north. The concept of anchoring is explained here, along with the parameters available in this section.

Section holder

A map describing a positive addition to the case on five sides of the port: Every side but the front.

Parameter include

If true, build a wall around the port.

Parameter alias

A name for the holder, to allow anchoring other features to it.

Parameter thickness

A number specifying the thickness of the holder’s wall on each side, in mm.

⸻

This document was generated from the application CLI.