Go to file
ben f6b8989767
ben/kinesis360/pipeline/head This commit looks good Details
Clean up README
2024-06-13 18:37:40 +02:00
.github/workflows.disabled disable github workflows 2024-06-13 18:01:37 +02:00
.pipeline halfway build keymap-editor-web 2023-10-20 11:44:50 +02:00
assets Readme rewrite (#222) 2023-09-07 09:09:48 +00:00
bin use header 2023-10-08 16:21:24 +02:00
build jekins file, tarball, less weird stuff, proper layers in dockerfile 2023-10-05 19:04:20 +02:00
config adjust indenting in keymap 2024-06-13 18:36:17 +02:00
dist halfway build keymap-editor-web 2023-10-20 11:44:50 +02:00
firmware Add local build option with Docker and README 2022-05-20 16:59:56 -03:00
manuals manuals 2023-09-14 08:24:42 +02:00
target halfway build keymap-editor-web 2023-10-20 11:44:50 +02:00
.dockerignore halfway build keymap-editor-web 2023-10-20 11:44:50 +02:00
.gitignore halfway build keymap-editor-web 2023-10-20 11:44:50 +02:00
CHANGELOG.md Add CHANGELOG (#221) 2023-09-07 08:55:41 +00:00
Dockerfile jekins file, tarball, less weird stuff, proper layers in dockerfile 2023-10-05 19:04:20 +02:00
Jenkinsfile fix wtf in Jenkinsfile 2024-06-13 18:35:40 +02:00
LICENSE Initial commit 2022-04-01 10:43:58 -07:00
Makefile pull on build 2023-12-07 12:34:58 +01:00
README.md Clean up README 2024-06-13 18:37:40 +02:00
UPGRADE.md V3.0 Update 2023-07-06 17:41:42 +01:00
settings-reset.uf2 V3.0 Update 2023-07-06 17:41:42 +01:00

README.md

ADV360-PRO-ZMK

Fork of: KinesisCorporation/Adv360-Pro-ZMK

Overview

Git

Repository
git.sudo.is ben/kinesis360
Codeberg benk/kinesis360
GitHub benediktkr/kinesis360

Use Tap-Dance

Tap-Dance: https://zmk.dev/docs/behaviors/tap-dance

  • Both: tap C -> C
  • Normal layer: tap,tap C -> ctrl C
  • Mac layer: tap,tap C -> cmd C

KinesisCorporation/Adv360-Pro-ZMK

Modifying the keymap

The ZMK documentation covers both basic and advanced functionality and has a table of OS compatibility for keycodes. Please note that the RGB Underglow, Backlight and Power Management sections are not relevant to the Advantage 360 Pro's custom ZMK fork. For more information see this note

There is a GUI for editing the keymap. It is available at https://kinesiscorporation.github.io/Adv360-Pro-GUI. This repository is also compatible with certain other web based ZMK keymap editors.

Certain ZMK features require knowing the exact key positions in the matrix. They can be found in both image and text format here

Building the Firmware with GitHub Actions

Setup

  1. Fork this repo.
  2. Enable GitHub Actions on your fork.

Build firmware

  1. Push a commit to trigger the build.
  2. Download the artifact.

Building the Firmware in a local container

Setup

Software
  • Either Podman or Docker is required, Podman is preferred if both are present.
  • Make is also required
Windows specific
  • If compiling on Windows use WSL2 and Docker Docker Setup Guide.
  • Install make using sudo apt-get install make.
  • The repository can be cloned directly into the WSL2 instance or accessed through the C: mount point WSL provides by default (/mnt/c/path-to-repo).

Build firmware

  1. Execute make.
  2. Check the firmware directory for the latest firmware build.

Cleanup

The built docker container and compiled firmware files can be deleted with make clean. This might be necessary if you updated your fork from V2.0 to V3.0 and are encountering build failures

Flashing firmware

Follow the programming instruction on page 8 of the Quick Start Guide to flash the firmware.

Overview

  1. Extract the firmwares from the downloaded archive.
  2. Connect the left side keyboard to USB.
  3. Press Mod+macro1 to put the left side into bootloader mode; it should attach to your computer as a USB drive.
  4. Copy left.uf2 to the USB drive and it will disconnect.
  5. Power off both keyboards (by unplugging them and making sure the switches are off).
  6. Turn on the left side keyboard with the switch.
  7. Connect the right side keyboard to USB to power it on.
  8. Press Mod+macro3 to put the right side into bootloader mode to attach it as a USB drive.
  9. Copy right.uf2 to the mounted drive.
  10. Unplug the right side keyboard and turn it back on.
  11. Enjoy!

Note: There are also physical reset buttons on both keyboards which can be used to enter and exit the bootloader mode. Their location is described in section 2.7 on page 9 in the User Manual and use is described in section 5.9 on page 14.

Upgrading from V2 to V3

If you are upgrading from V2 to V3, and if the flashing didn't work as expected (i.e. if you are unable to pair the keyboard via Bluetooth), then consider resetting both halves of the keyboard to its native state. Make sure to use the settings-reset.uf2 file from the V3 branch of this repository. After doing this, proceed with the flashing instructions above.

Changelog

The changelog for both the config repo and the underlying ZMK fork that the config repo builds against can be found here

Note

By default this config repository references a customised version of ZMK with Advantage 360 Pro specific functionality and changes over base ZMK. The Kinesis fork is regularly updated to bring the latest updates and changes from base ZMK however will not always be completely up to date.

Whilst the Advantage 360 Pro is compatible with base ZMK some of the more advanced features will not work, and Kinesis cannot provide customer service for usage of base ZMK. Likewise the ZMK community cannot provide support for either the Kinesis keymap editor, nor any usage of the Kinesis custom fork.

Other support

Further support resources can be found on Kinesis.com: