Add keyboard Jris65 - Githubissues

sizezero commented 2 weeks ago

Description

Add keyboard Jris65 from MyKeyClub

Types of Changes

[ ] Core
[ ] Bugfix
[ ] New feature
[ ] Enhancement/optimization
[x] Keyboard (addition or update)
[ ] Keymap/layout/userspace (addition or update)
[ ] Documentation

Issues Fixed or Closed by This PR

None

Checklist

[x] My code follows the code style of this project: C, Python
[x] I have read the PR Checklist document and have made the appropriate changes.
[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.
[x] I have read the CONTRIBUTING document.
[ ] I have added tests to cover my changes.
[x] I have tested the changes and verified that they work and don't break anything (as well as I can manage).

dunk2k commented 2 weeks ago

can directory structure be changed to accomodate hotswap and solder variants? e.g.

jris65/
├─info.json # shared settings in this file
├─hotswap/
│ └─keyboard.json
├─solder/
│ └─keyboard.json
└─keymaps/
  ├─default/
  └─via/

sizezero commented 2 weeks ago

I could but hotswap and solder have the same controller and layouts so the files in each directory would be identical. Same with R1 and R2. Do you want me to do this anyway?

On Sun, Jun 16, 2024 at 9:34 AM Duncan Sutherland @.***> wrote:

can directory structure be changed to accomodate hotswap and solder variants? e.g.

jris65/ ├─info.json # shared settings in this file ├─hotswap/ │ ├─keymaps/ │ │ ├─default/ │ │ └─via/ │ └─keyboard.json └─solder/ ├─keymaps/ │ ├─default/ │ └─via/ └─keyboard.json

— Reply to this email directly, view it on GitHub https://github.com/qmk/qmk_firmware/pull/23936#issuecomment-2171764336, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABP5WM7WENYFOGPNBR6ODH3ZHW47TAVCNFSM6AAAAABJMTK5VWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNZRG43DIMZTGY . You are receiving this because you authored the thread.Message ID: @.***>

dunk2k commented 2 weeks ago

I could but hotswap and solder have the same controller and layouts so the files in each directory would be identical. Same with R1 and R2. Do you want me to do this anyway?

Settings (i.e. layouts, processor, bootloader, etc.) that apply to both solder and hotswap would be in an info.json file above hotswap and solder directories."pid" would be different for each variant.

Solder does have a bottom row layout (tsangan blocker) that's not available on hotswap 😉

sizezero commented 2 weeks ago

I see. I don't have the solder version of the board so is it ok if I just create info.json with the common settings and dupe the existing layouts into hotswap/ and solder/? This would allow someone who has a solder board to enter the correct layout for solder.

On Sun, Jun 16, 2024 at 9:55 AM Duncan Sutherland @.***> wrote:

I could but hotswap and solder have the same controller and layouts so the files in each directory would be identical. Same with R1 and R2. Do you want me to do this anyway?

Settings(i.e. layouts, processor, bootloader, etc.) that apply to both board would be in an info.json file above hotswap and solder directories. "pid" would be different for each variant.

Solder does have a bottom row layout (tsangan blocker) that's not available on hotswap 😉

— Reply to this email directly, view it on GitHub https://github.com/qmk/qmk_firmware/pull/23936#issuecomment-2171769661, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABP5WM3SF7CQDTGAQBCQGG3ZHW7PXAVCNFSM6AAAAABJMTK5VWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNZRG43DSNRWGE . You are receiving this because you authored the thread.Message ID: @.***>

sizezero commented 2 weeks ago

I also don't know what the pid would be for the solder variant.

On Sun, Jun 16, 2024 at 10:06 AM Robert Kleemann @.***> wrote:

I see. I don't have the solder version of the board so is it ok if I just create info.json with the common settings and dupe the existing layouts into hotswap/ and solder/? This would allow someone who has a solder board to enter the correct layout for solder.

On Sun, Jun 16, 2024 at 9:55 AM Duncan Sutherland < @.***> wrote:

I could but hotswap and solder have the same controller and layouts so the files in each directory would be identical. Same with R1 and R2. Do you want me to do this anyway?

Settings(i.e. layouts, processor, bootloader, etc.) that apply to both board would be in an info.json file above hotswap and solder directories. "pid" would be different for each variant.

Solder does have a bottom row layout (tsangan blocker) that's not available on hotswap 😉

— Reply to this email directly, view it on GitHub https://github.com/qmk/qmk_firmware/pull/23936#issuecomment-2171769661, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABP5WM3SF7CQDTGAQBCQGG3ZHW7PXAVCNFSM6AAAAABJMTK5VWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNZRG43DSNRWGE . You are receiving this because you authored the thread.Message ID: @.***>

dunk2k commented 2 weeks ago

I see. I don't have the solder version of the board

On that note, could you make this PR for hotswap variant only?

sizezero commented 2 weeks ago

I assume I should still split out into a top level info.json with a hotswap/ dir. Should I create an empty solder/ directory with a readme in it that says it's unimplemented?

On Sun, Jun 16, 2024 at 10:14 AM Duncan Sutherland @.***> wrote:

I see. I don't have the solder version of the board

On that note, could you make this PR for hotswap variant only?

— Reply to this email directly, view it on GitHub https://github.com/qmk/qmk_firmware/pull/23936#issuecomment-2171774742, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABP5WMYXMZ3ZN5S7UP2WBPLZHXBY7AVCNFSM6AAAAABJMTK5VWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNZRG43TINZUGI . You are receiving this because you authored the thread.Message ID: @.***>

dunk2k commented 2 weeks ago

I assume I should still split out into a top level info.json with a hotswap/ dir.

Considering you haven't a solder PCB to test, I'd recommend a hotswap/ (sub-)directory but not having the parent info.json file.
Instead, all settings for hotswap board are defined in jris65/hotswap/keyboard.json, i.e. you can't define and/or test what you don't have available/to hand 😉

Should I create an empty solder/ directory with a readme in it that says it's unimplemented?

Rather than an empty directory, I would mention in jris65/readme.md that the solder variant has yet to be added (to qmk_firmware repo).

dunk2k commented 2 weeks ago

Firmware files from vendor confirm matrix positions for hotswap and solder 😉

sizezero commented 2 weeks ago

Is there anything that I have to do to unblock the pull request? I see a "1 change requested" but I can't find an open request anywhere.

dunk2k commented 1 week ago

Could file /keyboard/mykeyclub/jris65/rules.mk be added with the following contents?:

DEFAULT_FOLDER = jris65/hotswap

This ensures when someone compiles -kb jris65 it'll get from hotswap directory instead of failing

sizezero commented 1 week ago

DEFAULT_FOLDER = jris65/hotswap

I assume this is only supposed to help the qmk command not make?

make mykeyclub/jris65:default
QMK Firmware 0.10.14
usage: qmk list-layouts [-h] [-kb KEYBOARD]
qmk list-layouts: error: argument -kb/--keyboard: invalid keyboard_folder value: 'mykeyclub/jris65'

sizezero commented 1 week ago

Due to the build failure, I'm guessing the correct setting is:

DEFAULT_FOLDER = mykeyclub/jris65/hotswap

make mykeyclub/jris65:default works now.

qmk / qmk_firmware

Add keyboard Jris65 #23936

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist