Skip to content

Latest commit

 

History

History
205 lines (120 loc) · 6.67 KB

Quickstart.md

File metadata and controls

205 lines (120 loc) · 6.67 KB

Install the drivers

** Windows **

Nothing to do.

** Mac **

Nothing to do.

** Debian, Ubuntu, Mint **

Run the following command in a terminal:

  • sudo apt-get install dfu-util

Download https://raw.githubusercontent.com/kiibohd/controller/master/98-kiibohd.rules

sudo cp 98-kiibohd.rules /etc/udev/rules.d
sudo udevadm control --reload-rules
sudo udevadm trigger

** Fedora **

Run the following command in a terminal:

  • sudo dnf install dfu-util

Download https://raw.githubusercontent.com/kiibohd/controller/master/98-kiibohd.rules

sudo cp 98-kiibohd.rules /etc/udev/rules.d
sudo udevadm control --reload-rules
sudo udevadm trigger

** Arch **

Run the following command in a terminal:

  • sudo pacman -S dfu-util

Download https://raw.githubusercontent.com/kiibohd/controller/master/98-kiibohd.rules

sudo cp 98-kiibohd.rules /etc/udev/rules.d
sudo udevadm control --reload-rules
sudo udevadm trigger

** Other Linux **

sudo cp 98-kiibohd.rules /etc/udev/rules.d
sudo udevadm control --reload-rules
sudo udevadm trigger

Download the IC Configurator

** Windows **

configurator-install

v1.1.0 NEW: Download Windows Configurator

  • Fixes backend URL to use standard HTTP ports (works better with aggressive firewalls)

** Mac **

v1.1.0 NEW: Download OSX App

  • Fixes backend URL to use standard HTTP ports (works better with aggressive firewalls)

** Debian, Ubuntu, Mint **

v1.1.0 NEW: [https://github.com/kiibohd/configurator/releases/download/v1.1.0/kiibohd-configurator-1.1.0-linux-x86_64.AppImage)

  • chmod +x kiibohd-configurator-1.1.0-linux-x86_64.AppImage
  • ./kiibohd-configurator-1.1.0-linux-x86_64.AppImage

** Fedora **

v1.1.0 NEW: Download AppImage

  • chmod +x kiibohd-configurator-1.1.0-linux-x86_64.AppImage
  • ./kiibohd-configurator-1.1.0-linux-x86_64.AppImage

** Arch **

v1.1.0 NEW:

  • Download AppImage
  • chmod +x kiibohd-configurator-1.1.0-linux-x86_64.AppImage
  • ./kiibohd-configurator-1.1.0-linux-x86_64.AppImage

** Other Linux **

v1.1.0 NEW:

Other releases are available on github: Browse all

Choose your device

configurator

Configure your Layout

Keys can be reassigned by clicking a switch and then clicking an action below. For more information see the Keys page.

keymap

Applying your changes

Press the lightning bolt icon at the top right of the toolbar.

compile

Once the download is complete you should see a green success message

compile-success

Entering Flash Mode.

** Kira **

Pressing Right Shift + Right Control + Esc will enter flash mode.

Alternatively, flip your Kira over find the reset button hole. Press the button with a thin object to put the keyboard into flash mode. You can use this method if your layout does not have a flashing hotkey assigned, or the layout is unknown.

flash-switch

Once in flash mode the orange led should be lit. bootloader-led

** WhiteFox / Nightfox **

Pressing Fn + Esc will enter flash mode.

Fallback Method

whitefox-flash

  1. Flip your Keyboard over.
  2. With the keys down you should see a small hole on the the buttom of the board.
  3. While the keyboard is plugged in, use a paperclip or other small object to press the button inside the case.

** K-Type **

Pressing Fn + Esc will enter flash mode.

Fallback Method

ktype-flash

  1. Flip your Keyboard over.
  2. With the keys down you should see a small hole on the the buttom of the board.
  3. While the keyboard is plugged in, use a paperclip or other small object to press the button inside the case.

** Gemini Dusk/Dawn **

Pressing Fn + Esc will enter flash mode.

Fallback Method

ktype-flash

  1. Flip your Keyboard over.
  2. With the keys down you should see a small hole on the the far right middle edge.
  3. While the keyboard is plugged in, use a paperclip or other small object to press the button inside the case through this hole.

Flashing

Once in flash mode, the red (no keyboard is in flash mode) text should disappear. You can then press the purple flash button.

flash

Exiting Flash Mode

The keyboard exists flash mode automatically after a successful flash.

If you do not wish to change the firmware you may press ESC or unplug the keyboard to exit flash mode manually.

Done

Enjoy your new layout. For more advanced features and configuration please see the Configurator section of this wiki.