Write firmware for the Ferris keyboard #9634

pierrechevalier83 · 2020-07-03T09:15:07Z

Add firmware for the Ferris keyboard (https://github.com/pierrechevalier83/ferris/)

Description

The ferris is an ergonomic split 34 key keyboard named and decorated after the rustlang mascot.
It has an onboard atmega32u4 microcontroller on the left hand side and an io expander (mcp23017)
on the right hand side.

There has been one prototype round with 5 samples so far, which is why I am
adding the keyboard to "handwired" for now rather than the top level directory.
That may move in the future if and when more are produced and sold.

Took inspiration from the gergoplex and the ergodox_ez firmware for the
split matrix with io_expander on the right hand.
Cleaned up a lot of bit fiddling on the mcu side by taking inspiration
from the split_custom in quantum.
Still bit fiddling on the mcp side as it is particularly natural to do
so with the abstractions provided by the i2c protocol. Would be good to
clean that up and abstract away the wiring from the generic i2c code in
a similar fashion as quantum and the mcp side behave.

One improvement over the ergodox_ez and the gergoplex firmwares is that
the wiring is straight forward as opposed to swapping rows and columns
in two different places that end up cancelling out for some reason.

I have flashed this firmware to a board and used it for over a day with no issues.

Types of Changes

Issues Fixed or Closed by This PR

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).

Took inspiration from the gergoplex and the ergodox_ez firmware for the split matrix with io_expander on the right hand. Cleaned up a lot of bit fiddling on the mcu side by taking inspiration from the `split_custom` in quantum. Still bit fiddling on the mcp side as it is particularly natural to do so with the abstractions provided by the i2c protocol. Would be good to clean that up and abstract away the wiring from the generic i2c code in a similar fashion as quantum and the mcp side behave. One improvement over the ergodox_ez and the gergoplex firmwares is that the wiring is straight forward as opposed to swapping rows and columns in two different places that end up cancelling out for some reason. At this stage, I have flashed this firmware to a board and have verified that all keys are behaving as intended by shorting pins. I still have to solder in some switches and test that everything works correctly at normal typing speeds, but I don't expect any major issues given I'm building up on previous effort, including the debouncing code from the ergodox_ez.

keyboards/handwired/ferris/config.h

keyboards/handwired/ferris/matrix.c

keyboards/handwired/ferris/ferris.h

keyboards/handwired/ferris/keymaps/default/rules.mk

keyboards/handwired/ferris/rules.mk

keyboards/handwired/ferris/info.json

keyboards/handwired/ferris/rules.mk

keyboards/handwired/ferris/ferris.h

keyboards/handwired/ferris/ferris.c

keyboards/handwired/ferris/matrix.c

Didn't play nicely in the configurator Co-authored-by: Ryan <[email protected]>

Co-authored-by: Ryan <[email protected]>

pierrechevalier83 · 2020-07-16T19:13:41Z

Thanks a lot for the detailed and informative review! 😄 I think I've addressed all comments now :)

tzarc

Just a couple more, now that the dust has settled somewhat. Rest looks good!

keyboards/handwired/ferris/config.h

keyboards/handwired/ferris/ferris.c

keyboards/handwired/ferris/keymaps/default/keymap.c

keyboards/handwired/ferris/matrix.c

pierrechevalier83 · 2020-07-16T22:03:58Z

Thanks again for the great review, @tzarc. I think the only point that remains is to decide if the opinionated settings in config.h should move to the default keymap or not.

tzarc · 2020-07-16T22:09:38Z

Thanks again for the great review, @tzarc. I think the only point that remains is to decide if the opinionated settings in config.h should move to the default keymap or not.

Well, try making a personal keymap and attempt to override one of the values?

pierrechevalier83 · 2020-07-16T22:17:31Z

Thanks again for the great review, @tzarc. I think the only point that remains is to decide if the opinionated settings in config.h should move to the default keymap or not.

Well, try making a personal keymap and attempt to override one of the values?

Ah ok. You're saying users can't actually override it. Ok. Will move it. Thanks for saving me from myself 😁

…map config These setting happen to be unused in the default keymap at the moment, as it has only one layer with no homerow modifiers and no mouse key; but I would like to keep it there for two reasons: * It can serve as an example to people creating their own keymap * I plan to design a more usable default keymap that uses these features once this PR which adds the Ferris keyboard is merged.

tzarc · 2020-07-16T23:43:04Z

LGTM!

pierrechevalier83 · 2020-07-16T23:44:29Z

LGTM!

I know I've already said it, but this was a really great review! I learned a lot and I like the code a lot better know. Thanks so much for taking the time :)

tzarc · 2020-07-16T23:45:10Z

LGTM!

I know I've already said it, but this was a really great review! I learned a lot and I like the code a lot better know. Thanks so much for taking the time :)

No problemo chief!

pierrechevalier83 · 2020-07-17T08:49:23Z

@fauxpark, I think I addressed all of your comments too now. Thanks for the thorough review 😀

keyboards/handwired/ferris/ferris.c

keyboards/handwired/ferris/readme.md

keyboards/handwired/ferris/matrix.c

pierrechevalier83 · 2020-07-17T12:25:08Z

Sorry, closed it by mistake 😨

pierrechevalier83 · 2020-07-17T15:48:59Z

@fauxpark , I think that's all review comments addressed again, FYI 🦀😀

tzarc requested a review from a team July 14, 2020 01:11

tzarc added the keyboard label Jul 14, 2020

tzarc requested changes Jul 14, 2020

View reviewed changes

keyboards/handwired/ferris/config.h Outdated Show resolved Hide resolved

keyboards/handwired/ferris/matrix.c Show resolved Hide resolved

tzarc requested a review from a team July 14, 2020 01:18

fauxpark requested changes Jul 14, 2020

View reviewed changes

pierrechevalier83 added 3 commits July 16, 2020 18:12

Remove rotation from info.json and label the keys as per default keymap

c2f454a

Comply with minor review feedback points

57efc42

Use CUSTOM_MATRIX=lite to remove boilerplate

77b2644

fauxpark requested changes Jul 16, 2020

View reviewed changes

pierrechevalier83 and others added 10 commits July 16, 2020 19:57

Update keyboards/handwired/ferris/info.json

b0e43e6

Didn't play nicely in the configurator Co-authored-by: Ryan <[email protected]>

Remove MIDI_ENABLE from rules.mk

51484a4

Co-authored-by: Ryan <[email protected]>

Remove FAUXCLICKY_ENABLE from rules.mk

036be05

Co-authored-by: Ryan <[email protected]>

Prefer wait_ms over _delay_ms

aaa00ca

Co-authored-by: Ryan <[email protected]>

Remove unused include

ed945d2

Co-authored-by: Ryan <[email protected]>

Remove unused include

f1eb8a1

Co-authored-by: Ryan <[email protected]>

Remove unused include

7ea80b9

Co-authored-by: Ryan <[email protected]>

Remove unused includeh

aedd945

Co-authored-by: Ryan <[email protected]>

Use dprint over print and remove include for print.h

4394f7c

Remove all unused includes

b0b20b0

tzarc requested changes Jul 16, 2020

View reviewed changes

pierrechevalier83 added 2 commits July 16, 2020 23:00

Remove unused code

90a970e

Cleanups thanks to code review

c6685bd

tzarc approved these changes Jul 16, 2020

View reviewed changes

tzarc requested a review from a team July 16, 2020 23:42

fauxpark requested changes Jul 17, 2020

View reviewed changes

keyboards/handwired/ferris/ferris.c Outdated Show resolved Hide resolved

keyboards/handwired/ferris/readme.md Outdated Show resolved Hide resolved

keyboards/handwired/ferris/matrix.c Show resolved Hide resolved

Consolidate mcp logic inside matrix.c

e825033

pierrechevalier83 closed this Jul 17, 2020

pierrechevalier83 reopened this Jul 17, 2020

fauxpark approved these changes Jul 17, 2020

View reviewed changes

tzarc merged commit a8c2307 into qmk:master Jul 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Write firmware for the Ferris keyboard #9634

Write firmware for the Ferris keyboard #9634

pierrechevalier83 commented Jul 3, 2020 •

edited

Loading

pierrechevalier83 commented Jul 16, 2020

tzarc left a comment

pierrechevalier83 commented Jul 16, 2020

tzarc commented Jul 16, 2020

pierrechevalier83 commented Jul 16, 2020

tzarc commented Jul 16, 2020

pierrechevalier83 commented Jul 16, 2020

tzarc commented Jul 16, 2020

pierrechevalier83 commented Jul 17, 2020

pierrechevalier83 commented Jul 17, 2020

pierrechevalier83 commented Jul 17, 2020

Write firmware for the Ferris keyboard #9634

Write firmware for the Ferris keyboard #9634

Conversation

pierrechevalier83 commented Jul 3, 2020 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

pierrechevalier83 commented Jul 16, 2020

tzarc left a comment

Choose a reason for hiding this comment

pierrechevalier83 commented Jul 16, 2020

tzarc commented Jul 16, 2020

pierrechevalier83 commented Jul 16, 2020

tzarc commented Jul 16, 2020

pierrechevalier83 commented Jul 16, 2020

tzarc commented Jul 16, 2020

pierrechevalier83 commented Jul 17, 2020

pierrechevalier83 commented Jul 17, 2020

pierrechevalier83 commented Jul 17, 2020

pierrechevalier83 commented Jul 3, 2020 •

edited

Loading