Because the key matrix and the actual keyboard layout may be different, it would be nice to be able to write a keymap with a different layout from the key matrix, like the QMK Firmware layout macro. https://beta.docs.qmk.fm/developing-qmk/c-development/hardware_keyboard_guidelines#less-than-keyboard_name.h-greater-than

If the Ruby syntax can handle this, I hope you can provide a sample of how to write it.

When I download the most recent tagged release, 0.9.14 it works perfectly on my two Seeed XIAO RP2040 boards.

I am quite excited by PRK and interested in poking at the source (and hopefully sending in some pull requests!). I can successfully run the tests and build the latest few commits to master with the Docker image. Unfortunately, when I load the built uf2 file onto either of my boards, the board will not mount the PRKFirmware volume. Unfortunately it seems something is corrupted in the uf2? (Thankfully I can reboot the board back into bootsel mode and load the 0.9.14 firmware again.)

I am running a Mac with Intel Core i5 processor. Here's what I'm doing:

git checkout master
git pull master
rake deep_clean
docker compose build
docker compose run --rm prk rake setup
docker compose run --rm prk rake
# steep checks pass
# tests pass
# binaries are successfully built
# ...
# [100%] Linking CXX executable prk_firmware-0.9.14-20220629-d921fc5.elf
#   adding: prk_firmware-0.9.14-20220629-d921fc5.uf2 (deflated 73%)
# [100%] Built target prk_firmware-0.9.14-20220629-d921fc5

ls build
# ... lots of things ...
# prk_firmware-0.9.14-20220629-d921fc5.uf2

# 👉🔘 Reboot Seed XIAO RP2040 into bootsel mode
# Drag-and-drop flash_nuke.uf2 to /Volumes/RPI-RP2
# volume unmounts, then mounts again

# Drag-and-drop prk_firmware-0.9.14-20220629-d921fc5.uf2 onto the RPI-RP2 volume
# The volume unmounts and then nothing happens.

Please let me know if I can provide any other details. Thank you!

Only during the breath effect, the LED flickers for a moment periodically. It does not depend on the value of Hue or Speed, and may occur when Value is changed, but the reproducibility is not good. This phenomenon does not occur with other effects.

https://user-images.githubusercontent.com/88352328/181024985-96310a65-fb6c-46dd-9b2e-84b3a0a4f976.MOV

I would like to have a key where pressing it automatically writes ```, or some other list of characters. Composite keys seem close to what I want, but those press them at the same time instead of one after another. Is this possible?

Fix #148

• To work with iPad, split HID interface for Joystick.
• To work with Mac, send HID report only if the report changed except Joystick report.
• Additionally, remove BIOS keyboard function because it was not working correctly.

I checked this version works with iPhone 8.

prk_firmware-0.9.18-20221121-a09fbed.uf2.zip

I get the following error. https://gist.github.com/Taro-Hayashi/cb3bf5fcbdd13c5e02cc76c89f3c2959

According to the error in Docker, the lemon (The Lemon Parser Generator) executable is not supported? I need someone else to try, as likely to be my shallow understanding or environmentally dependent. I have confirmed Hello World in Ruby and Blink in PICO SDK.

I used PRKFirmware 0.9.14 and created the Firmware using the following document. https://github.com/picoruby/prk_firmware/wiki/VIA-and-Remap

If I fill in the keymap directly in via_map.txt, it works fine. On the other hand, when I connect to Remap, the keyboard is detected by the information in prk-conf.txt, but the following anomaly occurs and I cannot change the keymap properly.

• The keymap displayed in Remap is different from what I set.
• When I edit the keymap in Remap and flash it, the changes are reflected in only some keys.
• When I flash a keymap in Remap, the file is corrupted.
• The key tester in Remap is not working.

#Windows10 #Chrome (103.0.5060.114) #PRK Firmware (0.9.14) #keyboard:OLSK60 (Adafruit KB2040) https://github.com/techmech-keeb/OLSK60/tree/main/PRK_Firmware

Tone

API

tone.new(pin)

Set pin to use Tone.

tone.set_tones( [ [tone1,tone_ms1], [tone2, tone_ms2], ... ] )

Set tone sequence. (overwrites current sequence)

tone.start()

Start sequence.

kbd.keys_press?

true if any key in keyboard report, else false.

Limitation

tone_ms*tone < 1,000,000

tone: 0 or >25

Example

require "tone"

tone = Tone.new(14)

tone.set_tones( [[349,250],[466,375],[440,375],[349,250],[0,125],[349,375],[392,1000], [0,125],[392,250],[523,375],[440,375],[392,250],[0,125],[392,375],[349,1000] ] )
tone.start

press = false

kbd.before_report do
    if kbd.keys_press? 
        unless press
            press = true
            tone.set_tones( [ [440,50],[880,50] ] )
            tone.start
        end
    elsif press
        press = false
    end
end

kbd.start!

UF2

https://github.com/yswallow/prk_firmware/releases/tag/0.9.17-pio-tone

#32 #138

Hello

Thanks for sharing your very interesting project!

I m interested in building a binary but, I guess the instructions in the wiki will only work in linux right? for me reading about it for the first time it was not obvious I tried and fail miserable in Macos catalina (suggestion add some pointers for the environment and requisites).

Then I tried and fail building the Dockerfile

last messages:

=> => transferring context: 2B 0.0s => [build 2/16] RUN apt-get update && apt-get install --no-install-recommends -y 207.0s => [build 3/16] WORKDIR /prk_firmware 0.5s => [build 4/16] COPY . . 0.3s => [build 5/16] WORKDIR /prk_firmware/src/ruby 0.4s => ERROR [build 6/16] RUN bundle install 1.2s

[build 6/16] RUN bundle install: #10 1.161 Could not locate Gemfile

executor failed running [/bin/sh -c bundle install]: exit code: 10

Environment

version: v0.9.12

keymap.rb:

# Initialize a Keyboard
kbd = Keyboard.new

# Initialize GPIO assign
kbd.init_pins(
  [ 27 ], # row0, row1,... respectively
  [ 6,7,8,9 ]  # col0, col1,... respectively
)

kbd.add_layer :default, %i(
  KC_LSFT KC_A KC_B LAYER_C
)
kbd.add_layer :raise, %i(
  ________ KC_1 KC_2 ________
)

kbd.define_mode_key :LAYER_C, [ :KC_C, :raise, 200, nil ]

kbd.start!

hardware:

How to reproduce

1. press & hold KC_LSFT and...
2. tap KC_A => A 🙆‍♂️
3. tap KC_B => B 🙆‍♂️
4. tap LAYER_C =>
   • expected: C
   • actual: reported nothing 🤔
5. tap KC_A =>
   • expected: A
   • actual: 1 🤔

Background

• In order to take advantage of the VIA feature (#57), VID and PID should be configurable
• According to @yoichiro, Remap uses the "product name" in addition to the above

Solution

• Dragging and dropping via-conf.txt file (then reboot the board) changes the values
  

• The format of the content: [VID]:[PID]:[Product name]

Example

If via-conf.txt includes this content,

0xbc42:0x0003:MyKeyboardName

these values are going to be applied as the image shows:

Hello PRK,

I am interested in this next generation keyboard firmware!

So I've tried the Dockerfile in 0.9.20, but it failed docker build. It seems to be a problem related to rake setup according the log.

I would appreciate it if you could fix this error.

Thank you.

~/prk/prk_firmware ❯❯❯ docker -v                                                                   ✘ 127 master ✱ ◼
Docker version 20.10.21, build baeda1f
~/prk/prk_firmware ❯❯❯ docker build -t test:1.0 -f Dockerfile .                                          master ✱ ◼
[+] Building 182.2s (12/13)                                                                                          => [internal] load build definition from Dockerfile                                                           0.0s
 => => transferring dockerfile: 658B                                                                           0.0s
 => [internal] load .dockerignore                                                                              0.0s
 => => transferring context: 2B                                                                                0.0s
 => [internal] load metadata for http://docker.io/manjarolinux/base:latest                                            3.3s
 => [auth] manjarolinux/base:pull token for [http://registry-1.docker.io](https://t.co/oumdBKZToB)                                               0.0s
 => [1/8] FROM http://docker.io/manjarolinux/[email protected]:9b74335bdc8ee94f816578ca3af04214fe9d024acba886fa62a0923a34  17.3s
 => => resolve http://docker.io/manjarolinux/[email protected]:9b74335bdc8ee94f816578ca3af04214fe9d024acba886fa62a0923a341  0.0s
 => => sha256:41ecfa93b6e0ebbc1d8f539fd538fc6a0a6ddc4b9f6dca050e3dacb3b39d8d54 901B / 901B                     0.0s
 => => sha256:82943290e75e46e5d4095862a63e45d942f12c738f7c984ac52b2a37b957004a 260.06MB / 260.06MB            10.3s
 => => sha256:9b74335bdc8ee94f816578ca3af04214fe9d024acba886fa62a0923a341b758c 741B / 741B                     0.0s
 => => sha256:769c82043b30e14fbd917b385c41170f9ca8ee1fd0c9d96c3bebc61a21f752bc 529B / 529B                     0.0s
 => => extracting sha256:82943290e75e46e5d4095862a63e45d942f12c738f7c984ac52b2a37b957004a                      6.5s
 => [internal] load build context                                                                              0.5s
 => => transferring context: 27.25MB                                                                           0.5s
 => [2/8] RUN pacman -Sy --noconfirm   cmake   arm-none-eabi-gcc   arm-none-eabi-newlib   ca-certificates    125.9s
 => [3/8] RUN git clone https://github.com/raspberrypi/pico-sdk.git -b 1.4.0                                   4.0s  => [4/8] RUN cd /pico-sdk/lib && git submodule update --init ./                                              29.7s  => [5/8] WORKDIR /prk_firmware                                                                                0.0s  => [6/8] COPY . .                                                                                             0.3s  => ERROR [7/8] RUN rake setup                                                                                 1.4s ------                                                                                                               > [7/8] RUN rake setup:                                                                                            #12 1.420 rake aborted!                                                                                             #12 1.420 Don't know how to build task 'setup' (See the list of available tasks with `rake --tasks`)
#12 1.422 
#12 1.422 (See full trace by running task with --trace)
------
executor failed running [/bin/sh -c rake setup]: exit code: 1
⏰182.82s total
~/prk/prk_firmware ❯❯❯                                                                               ✘ 1 master ✱ ◼

I've noticed that when I do a large duplex matrix it crashes the RP2040 and the only way to get it to come back is to nuke the flash and put PRK back on it.

Here is the keymap.rb that I used for testing just in case I did something wrong

kbd = Keyboard.new

row0 = 1
row1 = 2
row2 = 3
row3 = 4
row4 = 5
row5 = 6
col0 = 7
col1 = 8
col2 = 9
col3 = 10
col4 = 11
col5 = 12
col6 = 13
col7 = 14
col8 = 16

# Init duplex matrix
kbd.init_matrix_pins(
  [
    [ [row0, col0], [col0, row0], [row0, col1], [col1, row0], [row0, col2], [col2, row0], [row0, col3], [col3, row0], [row0, col4], [col4, row0], [row0, col5], [col5, row0], [row0, col6], [col6, row0], [row0, col7], [col7, row0], [row0, col8], [col8, row0] ],
    [ [row1, col0], [col0, row1], [row1, col1], [col1, row1], [row1, col2], [col2, row1], [row1, col3], [col3, row1], [row1, col4], [col4, row1], [row1, col5], [col5, row1], [row1, col6], [col6, row1], [row1, col7], [col7, row1], [row1, col8], [col8, row1] ],
    [ [row2, col0], [col0, row2], [row2, col1], [col1, row2], [row2, col2], [col2, row2], [row2, col3], [col3, row2], [row2, col4], [col4, row2], [row2, col5], [col5, row2], [row2, col6], [col6, row2], [row2, col7], [col7, row2], [row2, col8], [col8, row2] ],
    [ [row3, col0], [col0, row3], [row3, col1], [col1, row3], [row3, col2], [col2, row3], [row3, col3], [col3, row3], [row3, col4], [col4, row3], [row3, col5], [col5, row3], [row3, col6], [col6, row3], [row3, col7], [col7, row3], [row3, col8], [col8, row3] ],
    [ [row4, col0], [col0, row4], [row4, col1], [col1, row4], [row4, col2], [col2, row4], [row4, col3], [col3, row4], [row4, col4], [col4, row4], [row4, col5], [col5, row4], [row4, col6], [col6, row4], [row4, col7], [col7, row4], [row4, col8], [col8, row4] ],
    [ [row5, col0], [col0, row5], [row5, col1], [col1, row5], [row5, col2], [col2, row5], [row5, col3], [col3, row5], [row5, col4], [col4, row5], [row5, col5], [col5, row5], [row5, col6], [col6, row5], [row5, col7], [col7, row5], [row5, col8], [col8, row5] ]
  ]
)
kbd.add_layer :default, %i(
      KC_1          KC_2          KC_3          KC_4     KC_5 KC_6 KC_7 KC_8 KC_9 KC_0 KC_1 KC_2 KC_3 KC_4 KC_5 KC_6 KC_7 KC_8
      KC_1          KC_2          KC_3          KC_4     KC_5 KC_6 KC_7 KC_8 KC_9 KC_0 KC_1 KC_2 KC_3 KC_4 KC_5 KC_6 KC_7 KC_8
      KC_1          KC_2          KC_3          KC_4     KC_5 KC_6 KC_7 KC_8 KC_9 KC_0 KC_1 KC_2 KC_3 KC_4 KC_5 KC_6 KC_7 KC_8
      KC_1          KC_2          KC_3          KC_4     KC_5 KC_6 KC_7 KC_8 KC_9 KC_0 KC_1 KC_2 KC_3 KC_4 KC_5 KC_6 KC_7 KC_8
      KC_1          KC_2          KC_3          KC_4     KC_5 KC_6 KC_7 KC_8 KC_9 KC_0 KC_1 KC_2 KC_3 KC_4 KC_5 KC_6 KC_7 KC_8
      KC_1          KC_2          KC_3          KC_4     KC_5 KC_6 KC_7 KC_8 KC_9 KC_0 KC_1 KC_2 KC_3 KC_4 KC_5 KC_6 KC_7 KC_8
)


kbd.start!

Condition

• Split-type

Flow

• Overwriting a keymap.rb happens on the anchor
• Anchor pings a special signal to the partner in order to start copying the keymap.rb
• Both halves switch into XMODEM (or something like that) mode
• Anchor transfers the keymap.rb (or compiled VM code) to the partner
• Partner saves the keymap.rb file in the flash
• Partner sends a signal to finalize the flow
• Both halves switch back to keyboard mode and reload the new keymap

Consideration

• Are there cases where a user wants to have a different keymap on the partner half?

My board is detected in BootSel mode. The PRKFirmware drive appears when I install the UF2 file... but once I unplug the board and plug it back in, nothing appears and the keyboard won't work.

I have this issue with KMK as well. It was solved there by defining, then decreasing the startup delay multiplier. I set and adjusted this variable: PICO_XOSC_STARTUP_DELAY_MULTIPLIER. This value is set in a file called: pico-sdk-configboard.h

To do this I had to create my own board within circuitPython and compile my own UF2 file.

I think this all stems from some possible timing mismatches with the crystal on our board.

Is there a way to deal with this in PRK please?

I wanted to make a key that presses backspace if tapped, and keypad enter if held for a while. This is what I ended up writing:

kbd.define_mode_key :ENTER_DEL, [ :KC_BSPACE, Proc.new { kbd.send_key(:KC_KP_ENTER); puts "Enter" }, 10000, nil]

(the long time and the puts is just for testing) However, if I keep it pressed, "Enter" appears in the console several times.

Now that I think about it, this might be intended behavior. If it is, I would like to request some way of doing what I want here; a key which does one key if tapped, and another if pressed for a while.

Combos are a popular feature in other keyboard firmwares like QMK and KMK which let you chord two keypresses together to perform an action. For example: press A and B together within a 50ms period and you will send C. If the timer times out, the user releases a combo key within its timeout, or the user presses another key that would not match with a chord, the original keypress will be sent instead. The timeout should be user-configurable to account for differences in dexterity, preferably defined individually for each combo.

QMK page on combos KMK page on combos