Initial support for the Keyboardio Atreus #8492

algernon · 2020-03-20T00:58:32Z

This is a quick patch to add support for the upcoming Keyboardio Atreus. This is a straightforward patch, except there's no info.json, because I don't have the capacity at the moment to craft a layout (hence why this PR is a draft). I may - and likely will - tweak it a bit in the next few days.

I did want to get a draft PR going, so folks who are interested in the Keyboardio Atreus, but want to use QMK with it, will have a starting point.

Types of Changes

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

noroadsleft

I think I'd prefer this go to keyboardio/atreus instead of atreus_kbio, but that's simply my opinion.

keyboards/atreus_kbio/keymaps/default/keymap.c

keyboards/atreus_kbio/readme.md

keyboards/atreus_kbio/rules.mk

algernon · 2020-03-20T12:36:30Z

I think I'd prefer this go to keyboardio/atreus instead of atreus_kbio, but that's simply my opinion.

I was considering that, but there's no keyboardio/ subdir yet. I'm ok with moving things to keyboardio/atreus though. If that's the recommendation, I'll do that, and then followup later with moving the model01 to keyboardio/model01 too.

algernon · 2020-03-20T13:29:41Z

I went ahead and force-pushed the branch, with @noroadsleft's suggestions included, and the keyboard moved to keyboards/keyboardio/atreus.

Come to think of it, it might make sense to do the model01->keyboardio/model01 move first. I'll prep a PR for that, and will rebase this on top of that.

algernon · 2020-03-20T13:43:54Z

...and now it's rebased on top of #8499.

drashna · 2020-03-21T06:21:02Z

Personally, I'd rather it not be rebased on the other PR, as that will definitely slow down/block this from being merged.

I do agree with using the /keyboardio/ folder though.

algernon · 2020-03-21T12:32:20Z

Well, there's no info.json yet, and I do not have the resources to create one in the near future, so this is going to be blocked for a while anyway, no?

I can rebase on master and just use the keyboardio dir, though, that makes sense. I'll push that in a bit.

noroadsleft · 2020-03-21T19:27:33Z

Well, there's no info.json yet, and I do not have the resources to create one in the near future, so this is going to be blocked for a while anyway, no?

I can probably do this by the end of today and send a PR to your fork.

noroadsleft · 2020-03-21T23:17:29Z

How's this?

noroadsleft@4f46169

algernon · 2020-03-22T00:26:04Z

That looks very nice. Thank you!

drashna · 2020-03-23T03:45:34Z

Yeah, noroads is our info.json master. :D

keyboards/keyboardio/atreus/rules.mk

drashna · 2020-03-24T05:26:08Z

@algernon okay with this being merged, as is?

technomancy · 2020-04-04T19:19:51Z

Thanks for putting this together! I've tested it on my board and everything works great, except for the reset functionality. The reset key causes it to disconnect and reconnect, but it does not enter the bootloader.

keyboards/keyboardio/atreus/rules.mk

technomancy · 2020-04-05T20:28:32Z

Oh hang on; I realized this is actually based on the old Atreus Classic layout rather than the new Keyboardio Atreus one; the parens should be on either side of the fn arrow cluster, but they are below the arrow cluster instead.

technomancy · 2020-04-05T20:53:34Z

I can't figure out how to do a PR to @algernon 's branch, so I'll just drop this commit here which updates it to use the fn layer that matches what this board ships with: technomancy@3284d77

The reset issue is still a problem, however given the accessible reset button on the reverse it's not as severe of a problem as it would be on the classic Atreus.

algernon · 2020-04-08T23:07:21Z

Sorry for the inactivity, I'll merge both the info.json and @technomancy's changes too ~tomorrow.

As for the bootloader: the Keyboardio Atreus ships with Catelina, a custom version of that too. To enter bootloader mode, one needs to hold the bottom left key (Esc by default), even if reset via a keypress. So holding Esc and then pressing the reset macro (or the other way around, if you're fast enough) should put you into bootloader mode.

noroadsleft · 2020-04-09T02:19:13Z

To enter bootloader mode, one needs to hold the bottom left key (Esc by default), even if reset via a keypress. So holding Esc and then pressing the reset macro (or the other way around, if you're fast enough) should put you into bootloader mode.

This should absolutely be stated in the main readme.

the Keyboardio Atreus ships with [Caterina], a custom version of that too.

This line makes me very sad. 😢

@noroadsleft

Many thanks to @noroadsleft for reviews & suggestions. Signed-off-by: Gergely Nagy <[email protected]>

Previously this was using the Classic Atreus layout.

Erovia · 2020-10-05T18:11:48Z

keyboards/keyboardio/atreus/config.h

+
+/* USB Device descriptor parameter */
+
+#define VENDOR_ID       0x1209


I'm a bit concerned about this VID.
It's already used by a few boards with VIA support:
https://github.com/the-via/keyboards/blob/master/src/duckle/vitamins_included.json#L3
https://github.com/the-via/keyboards/blob/master/src/jiran/jiran.json#L3

(The fact that 2 VIA-enabled board already uses it is another topic.)

1209 is the VID for pid.codes -- it's properly registered: http://pid.codes/1209/2303/

Erovia · 2020-10-05T18:12:46Z

keyboards/keyboardio/atreus/config.h

+#define DEVICE_VER      0x0000
+#define MANUFACTURER    Keyboardio
+#define PRODUCT         Atreus
+#define DESCRIPTION     QMK keyboard firmware for the Keyboardio Atreus


Suggested change

#define DESCRIPTION QMK keyboard firmware for the Keyboardio Atreus

As per https://docs.qmk.fm/#/pr_checklist

Erovia · 2020-10-05T18:17:51Z

keyboards/keyboardio/atreus/readme.md

+
+Make example for this keyboard (after setting up your build environment):
+
+    make keyboardio/atreus:default:avrdude


Suggested change

make keyboardio/atreus:default:avrdude

make keyboardio/atreus:default

Flashing example for this keyboard:

make keyboardio/atreus:default:flash

Erovia · 2020-10-05T18:18:11Z

keyboards/keyboardio/atreus/rules.mk

+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration


Suggested change

BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration

BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration

Erovia

Without noroadsleft's suggestions, does not build.

evantravers · 2020-10-05T18:50:44Z

@Erovia: I have a copy of the branch with @noroadsleft's suggestions... is there an acceptable way for me to make your changes and swap out the branch so that this can get done, or is that impolite to @algernon who did the initial work?

Here's the branch if anyone wants it: https://github.com/evantravers/qmk_firmware/tree/keyboardio/atreus

qmk#8492

evantravers · 2020-10-07T15:38:27Z

I created a PR for my adjusted branch… if that's rude or not kosher I am very sorry… just trying to get this in master to help all those new atreus owners. :P

jmorag · 2020-10-07T22:15:33Z

What version of avrdude does this use, @evantravers? I'm on 6.3. Tried running make keyboardio/atreus:default:flash on your branch and am getting

avrdude: Error: butterfly programmer uses avr_write_page() but does not
provide a cmd() method.
 *** page 125 (addresses 0x5d7e - 0x5dfd) failed to write

Writing | ################################################## | 100% 9.74s

avrdude: 24062 bytes of flash written
avrdude: verifying flash memory against .build/keyboardio_atreus_default.hex:
avrdude: load data flash data from input file .build/keyboardio_atreus_default.hex:
avrdude: input file .build/keyboardio_atreus_default.hex auto detected as Intel Hex
avrdude: input file .build/keyboardio_atreus_default.hex contains 24062 bytes
avrdude: reading on-chip flash data:

Reading | #                                                  | 2% 0.00savrdude: butterfly_recv(): programmer is not responding
Reading | ##                                                 | 4% 5.01savrdude: butterfly_recv(): programmer is not responding
Reading | ################################################## | 100% 10.16s

avrdude: verifying ...
avrdude: verification error, first mismatch at byte 0x0000
         0xff != 0x0c
avrdude: verification error; content mismatch

avrdude: safemode: Fuses OK (E:CB, H:D8, L:FF)

avrdude done.  Thank you.

make[1]: *** [tmk_core/avr.mk:318: flash] Error 1
Make finished with errors
make: *** [Makefile:579: keyboardio/atreus:default:flash] Error 1

evantravers · 2020-10-07T22:51:51Z

@jmorag I'm using avrdude version 6.3 as well. Make sure you have checked out the right branch… I know mine works, but the changes requested haven't been made to the branch on this PR.

Xyverz · 2020-10-08T15:31:52Z

I can confirm that Evan's branch works for me. I'm currently typing this response on my KeyboardIO Atreus.

* Initial support for the Keyboardio Atreus Many thanks to noroadsleft for reviews & suggestions. * Add QMK Configurator layout support * Update the fn layer of the Keyboardio Atreus to the new layout. Previously this was using the Classic Atreus layout. * Implement noroadleft's changes from #8492 * Follow Erovia's recommendations #8492 * Correct braces * Change correct rules.mk * Remove comments * Fix BOOTMAGIC_ENABLE I had edited the wrong file earlier. * Remove comment * Updates rules.mk Thank you noroadsleft. Co-authored-by: Gergely Nagy <[email protected]> Co-authored-by: Phil Hagelberg <[email protected]>

algernon · 2020-10-09T14:36:23Z

Closing, #10570 is the successor of this, and that's been merged, so this one's really obsolete.

rrix · 2020-10-23T21:59:43Z

Tried running make keyboardio/atreus:default:flash on your branch and am getting

(sorry to comment on a closed PR, but this got me, too so i'm gonna leave a breadcrumb)

try to disable ModemManager on your system or apply the udev rules referenced in #8060 . it's mentioned in the upstream Keyboardio/Chrysalis docs and maybe should be added to the device QMK readme.

skullydazed · 2020-10-24T19:16:32Z

This is also a situation qmk doctor will warn about. You can use that to check if you're affected.

* Initial support for the Keyboardio Atreus Many thanks to noroadsleft for reviews & suggestions. * Add QMK Configurator layout support * Update the fn layer of the Keyboardio Atreus to the new layout. Previously this was using the Classic Atreus layout. * Implement noroadleft's changes from qmk#8492 * Follow Erovia's recommendations qmk#8492 * Correct braces * Change correct rules.mk * Remove comments * Fix BOOTMAGIC_ENABLE I had edited the wrong file earlier. * Remove comment * Updates rules.mk Thank you noroadsleft. Co-authored-by: Gergely Nagy <[email protected]> Co-authored-by: Phil Hagelberg <[email protected]>

algernon added the keyboard label Mar 20, 2020

drashna approved these changes Mar 20, 2020

View reviewed changes

drashna requested a review from a team March 20, 2020 08:44

noroadsleft requested changes Mar 20, 2020

View reviewed changes

drashna requested a review from a team March 21, 2020 06:19

drashna approved these changes Mar 23, 2020

View reviewed changes

drashna requested a review from a team March 23, 2020 03:46

fauxpark approved these changes Mar 23, 2020

View reviewed changes

noroadsleft reviewed Mar 24, 2020

View reviewed changes

keyboards/keyboardio/atreus/rules.mk Show resolved Hide resolved

noroadsleft approved these changes Mar 24, 2020

View reviewed changes

noroadsleft requested changes Apr 5, 2020

View reviewed changes

keyboards/keyboardio/atreus/rules.mk Show resolved Hide resolved

algernon and others added 3 commits April 10, 2020 12:05

Initial support for the Keyboardio Atreus

1cb98bc

Many thanks to @noroadsleft for reviews & suggestions. Signed-off-by: Gergely Nagy <[email protected]>

Add QMK Configurator layout support

ab6ebef

Update the fn layer of the Keyboardio Atreus to the new layout.

daccc66

Previously this was using the Classic Atreus layout.

algernon marked this pull request as ready for review April 10, 2020 10:05

Erovia requested changes Oct 5, 2020

View reviewed changes

evantravers added a commit to evantravers/qmk_firmware that referenced this pull request Oct 5, 2020

Implement @noroadleft's changes from qmk#8492

025d142

evantravers added a commit to evantravers/qmk_firmware that referenced this pull request Oct 5, 2020

Follow @Erovia's recommendations

c01044f

qmk#8492

evantravers added a commit to evantravers/qmk_firmware that referenced this pull request Oct 5, 2020

Implement @noroadleft's changes from qmk#8492

70128cd

evantravers added a commit to evantravers/qmk_firmware that referenced this pull request Oct 5, 2020

Follow @Erovia's recommendations

1daaddc

qmk#8492

evantravers mentioned this pull request Oct 7, 2020

Updated: Keyboardio/atreus #10570

Merged

algernon closed this Oct 9, 2020

algernon deleted the keyboardio/atreus branch October 9, 2020 14:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial support for the Keyboardio Atreus #8492

Initial support for the Keyboardio Atreus #8492

algernon commented Mar 20, 2020

noroadsleft left a comment

algernon commented Mar 20, 2020

algernon commented Mar 20, 2020

algernon commented Mar 20, 2020

drashna commented Mar 21, 2020

algernon commented Mar 21, 2020

noroadsleft commented Mar 21, 2020

noroadsleft commented Mar 21, 2020

algernon commented Mar 22, 2020

drashna commented Mar 23, 2020

drashna commented Mar 24, 2020

technomancy commented Apr 4, 2020

technomancy commented Apr 5, 2020

technomancy commented Apr 5, 2020

algernon commented Apr 8, 2020

noroadsleft commented Apr 9, 2020

Erovia Oct 5, 2020

tzarc Oct 6, 2020

Erovia Oct 5, 2020

Erovia Oct 5, 2020

Erovia Oct 5, 2020

Erovia left a comment

evantravers commented Oct 5, 2020 •

edited

Loading

evantravers commented Oct 7, 2020

jmorag commented Oct 7, 2020

evantravers commented Oct 7, 2020

Xyverz commented Oct 8, 2020 •

edited

Loading

algernon commented Oct 9, 2020

rrix commented Oct 23, 2020

skullydazed commented Oct 24, 2020


		/* USB Device descriptor parameter */

		#define VENDOR_ID 0x1209


		Make example for this keyboard (after setting up your build environment):

		make keyboardio/atreus:default:avrdude

	BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
	BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration

Initial support for the Keyboardio Atreus #8492

Initial support for the Keyboardio Atreus #8492

Conversation

algernon commented Mar 20, 2020

Types of Changes

Checklist

noroadsleft left a comment

Choose a reason for hiding this comment

algernon commented Mar 20, 2020

algernon commented Mar 20, 2020

algernon commented Mar 20, 2020

drashna commented Mar 21, 2020

algernon commented Mar 21, 2020

noroadsleft commented Mar 21, 2020

noroadsleft commented Mar 21, 2020

algernon commented Mar 22, 2020

drashna commented Mar 23, 2020

drashna commented Mar 24, 2020

technomancy commented Apr 4, 2020

technomancy commented Apr 5, 2020

technomancy commented Apr 5, 2020

algernon commented Apr 8, 2020

noroadsleft commented Apr 9, 2020

Erovia Oct 5, 2020

Choose a reason for hiding this comment

tzarc Oct 6, 2020

Choose a reason for hiding this comment

Erovia Oct 5, 2020

Choose a reason for hiding this comment

Erovia Oct 5, 2020

Choose a reason for hiding this comment

Erovia Oct 5, 2020

Choose a reason for hiding this comment

Erovia left a comment

Choose a reason for hiding this comment

evantravers commented Oct 5, 2020 • edited Loading

evantravers commented Oct 7, 2020

jmorag commented Oct 7, 2020

evantravers commented Oct 7, 2020

Xyverz commented Oct 8, 2020 • edited Loading

algernon commented Oct 9, 2020

rrix commented Oct 23, 2020

skullydazed commented Oct 24, 2020

evantravers commented Oct 5, 2020 •

edited

Loading

Xyverz commented Oct 8, 2020 •

edited

Loading