DOCSEARCHbyAlgolia
Submit Docs

SliceMK Documentation

website·Indexed 31 days ago

https://docs.slicemk.com

Documentation for SliceMK ergonomic keyboards, featuring guides for the ErgoDox Wireless, ZMK firmware configuration, and hardware specifications. Includes details on flashing UF2 bootloaders, keycap and switch compatibility for MX and Kailh Choc V1, and wireless connectivity setup using central and peripheral devices.

Tokens
9.5K
Snippets
20
Records
82
Agent score
59%

What's inside SliceMK

  1. Overview of ZMK firmware for SliceMK keyboards

    ZMK is the recommended firmware for SliceMK keyboards, offering a wireless-friendly design and high customization. Key capabilities include:

    • Fully customizable keymaps with up to 32 layers.
    • Advanced behaviors such as mod-tap, sticky keys, and caps word.
    • Support for both USB dongle and fully-wireless setups.
    • Ability to switch seamlessly between multiple devices (phones, tablets, computers).
    • Optimized for low power consumption and long battery life.

  2. Overview of ErgoDox Wireless keyboard models

    The ErgoDox Wireless is an ergonomic, split wireless keyboard. This documentation applies to the following product models: ErgoDoxLP Wireless, ErgoDox Wireless Lite, and ErgoDox Wireless Pro.

  3. Understand SliceMK ErgoDox Wireless central and peripheral roles

    The SliceMK ErgoDox Wireless uses a central/peripheral architecture. The 'central' handles the keyboard logic and communication with the host, while the 'peripheral' sends data to the central.

    • If using a dongle: The dongle is the central. Both keyboard halves are peripherals.
    • If not using a dongle: The left half is the central. The right half is the peripheral.

    Key constraints:

    • Peripheral halves cannot be used directly; connecting a peripheral half via USB will not output any data.
    • When updating keymaps, only the central (dongle or left half) needs to be reflashed unless the wireless communication protocol has changed.

  4. Configure and update the keyboard keymap

    Use the keymap configurator to define your layout.

    Initial Setup: Keep the 'testing' layer in the example keymap to verify all keys are working before customizing.

    Updating the Keymap:

    1. Place the central (dongle or left half) in bootloader mode.
    2. Copy the updated zmk-dongle.uf2 (for dongles) or zmk-left.uf2 (for left-half centrals) to the device.
    3. Press keys on the peripherals to reconnect them to the central.

    Important: Always save a copy of the slicemk_ergodox.json file from the build archive, as the build server deletes keymaps after a few hours.

  5. Print a to-scale ErgoDox keyboard template

    To visualize the physical size and fit of the ErgoDox keyboard, download the appropriate PDF template for your paper size. To ensure the printout is accurate and matches the actual keyboard dimensions, you must print at '100% scale'. Do not use options like 'fit to page width', as this will distort the dimensions. The printout includes a built-in ruler to verify the scale against a physical ruler.

  6. Flash initial ZMK firmware to the central (Dongle setup)

    When using a USB dongle as the central controller, follow these steps to flash the initial firmware:

    1. Build the firmware using the keymap configurator, selecting the dongle as the 'Build Target'.
    2. Plug in the USB dongle and place it in bootloader mode (LED pulses slowly).
    3. Copy zmk-dongle.uf2 to the dongle's virtual drive. The LED will flash quickly during the process and turn off when finished.
    4. Press keys on the keyboard halves to initiate bonding with the dongle.

  7. Determine switch quantity for ErgoDoxLP Wireless

    For the ErgoDoxLP Wireless model, 76 switches are required. It is recommended to purchase 90 switches to ensure you have 10-20 extra as backups.

  8. Use SliceMK wireless keyboards while charging

    SliceMK wireless keyboards (running ZMK firmware) function normally while charging. During charging, the keyboard can output data via either USB (acting as a wired keyboard) or via Bluetooth (acting as a wireless keyboard).

  9. Install switches on SliceMK ErgoDox Wireless

    When installing switches:

    • If foam is preinstalled, loosen the screws slightly first to allow the plate and PCB to realign.
    • Install switches in the corners first to ensure the plate is completely aligned with the PCB before filling in the rest.

  10. Clear a specific Bluetooth profile

    To vacate a Bluetooth profile and assign it to a different device, or to reestablish a bond:

    1. Activate the desired profile using the &bt BT_SEL key.
    2. Delete the "SliceMK ErgoDox" bond from the device previously associated with that profile to prevent it from attempting to reconnect.
    3. Press the &bt BT_CLR key to clear the profile.
    4. The central will begin advertising, allowing a new device to connect.

  11. Select MX-compatible keycaps for ErgoDox Wireless Lite and Pro

    When choosing keycaps for MX-compatible ErgoDox keyboards (such as the ErgoDox Wireless Lite and ErgoDox Wireless Pro), keep the following definitions and constraints in mind:

    • Alphas: The 40 main keys (A-Z, numbers, punctuation).
    • Modifiers: The 36 remaining outside and thumb cluster keys. Ensure the keycap set you choose explicitly includes ErgoDox modifiers.
    • Sizing: Keycaps are measured in units (U). 1U is standard, 1.5U is 150% of standard, and 2U is 200% of standard.

    Note: For ErgoDoxLP Wireless keyboards, use Kailh Choc V1 keycaps instead of MX keycaps.

  12. Identify SliceMK Ergodox PCB version for flashing

    Before flashing firmware, you must determine the PCB version for both the left and right keyboard halves. This is done by checking the INFO_UF2.TXT file located within the SliceMK bootloader virtual drive.

    Warning: Loading firmware for the incorrect PCB version may cause irreversible hardware damage to the keyboard PCB.