diff --git a/README.md b/README.md index a0bf0f7..307a3dc 100644 --- a/README.md +++ b/README.md @@ -155,9 +155,28 @@ If you wish to instead connect a different midi device while using _c_l_i_k_r_ a The default mapping outputs `channel0: cc0 – cc3` on the 4 knobs and cv inputs of _c_l_i_k_r_ – this can be customised by editing the _c_l_i_k_r_ firmware. Tact buttons do not send midi by default but this can be enabled also in the firmware +one thing to note is that the _c_l_i_k_r_ keyboard only sends _key_press_ commands, not any _key_release_ commands - for this reason "gated" presses will not work - if your __FN__ key is not working with c_l_i_k_r then make sure that __SETTINGS -> sampler -> FUNC_GATED == off__ (same for ACTION_GATED) + +[sending key_release commands may be possible in a future firmware updates so let me know if this is important to you ! ] + ## flashing firmware to micro-controller -[coming soon] +if you have got a kit from the shop the default firmware will be pre-configured - still you can follow this guide so you can edit the code and update the firmware. + +### install guide + +all _underscores_ projects with micro-controllers use [platformio](https://platformio.org/) with [visual studio code](https://code.visualstudio.com/) to edit, flash and monitor the code. + +- first download (and unzip) the code in this repo - easiest is [as a zip](https://github.com/cyberboy666/c_l_i_k_r/archive/refs/heads/main.zip) or you can clone using git if you are comfortable with this +- next download, install and open [visual studio code](https://code.visualstudio.com/#alt-downloads) +- now open the extension tab within vscode on left vertical menu (or press ctrl-shift-x) and search for `platformio` to install this extension + +![image](https://user-images.githubusercontent.com/12017938/158495161-7c3114fc-814b-4acc-b142-4a9522370473.png) + +- connect the micro-controller to computer via usb, open the c_l_i_k_r software folder (ctrl-k ctrl-o) in vscode and find the _platformio_ commands (either in left vertical menu under _platformio_ or little tick/arrow symbols along bottom blue bar) - `PlatformIO: Upload` should flash the default code to your micro-controller + +![image](https://user-images.githubusercontent.com/12017938/158495844-99466196-086a-47d2-b803-2b5941d33ac5.png) +