Optical keyboard

[girishji]

Optical keyboard with Ergo layout

Description

This is an optical matrix keyboard corresponding to pcb here: https://github.com/girishji/optical-keyboard. It uses Gateron optical switches with a blackpill stm32f401 mcu. There is also a custom matrix to drive the Led's and PT's.

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

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

[drashna]

Lint has flagged a few issues. Please resolve.

[girishji]

Fixed the lint issue

[girishji]

Thanks, I fixed and committed (it says it cannot generate info.json, and I found a bug in the naming of keyboard to match dir name)

…

On Sun, 31 Jul 2022 at 01:53, Drashna Jaelre ***@***.***> wrote: Lint has flagged a few issues. Please resolve. — Reply to this email directly, view it on GitHub <#17852 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AD6DOYHVAJFV5BBLUAWEYC3VWW6BLANCNFSM55DSS4CA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[zvecr]

• should use custom matrix "lite"
  • currently not implementing debounce correctly
  • unnecessary duplication of code
• info.json render does not match keyboard layout

[girishji]

• should use custom matrix "lite"

  • currently not implementing debounce correctly

I am using an optical matrix. Optical switches do not need debounce. It takes about 15us for phototransistor to rise and IO pin will read accurate values after that. I get stable switching even at very high scan rates (delay of 20us between reading columns). Debounce code is not applicable here. No need to keep 2 matrix copies and deal with timers. This will slow down scan rate.

• unnecessary duplication of code

The duplication is unavoidable unless code is refactored in matrix_common

• info.json render does not match keyboard layout

I need some help here. How is this checked? I see 5x15 keys in info.json and it matches matrix definition

[girishji]

Hello Joel, I made the changes you requested and commited. I have some questions, please see the github page.

…

On Sun, 31 Jul 2022 at 16:50, Joel Challis ***@***.***> wrote: ***@***.**** requested changes on this pull request. - should use custom matrix "lite" - currently not implementing debounce correctly - unnecessary duplication of code - info.json render does not match keyboard layout ------------------------------ In keyboards/opticalkb/blackpill_f401.c <#17852 (comment)>: > @@ -0,0 +1,23 @@ +/* Copyright 2020 Sergey Vlasov (sigprof) File should be deleted ------------------------------ In keyboards/opticalkb/rules.mk <#17852 (comment)>: > +CONSOLE_ENABLE = no # Console for debug +COMMAND_ENABLE = no # Commands for debug and configuration +NKRO_ENABLE = no # Enable N-Key Rollover +BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow +AUDIO_ENABLE = no # Audio output +DYNAMIC_MACRO_ENABLE = yes # Dynamic macros + +LED_MATRIX_ENABLE = no + +# turn this off after debugging +# CONSOLE_ENABLE = yes + +# https://github.com/qmk/qmk_firmware/blob/master/docs/custom_matrix.md +CUSTOM_MATRIX = yes +SRC += matrix.c blackpill_f401.c ⬇️ Suggested change -SRC += matrix.c blackpill_f401.c +SRC += matrix.c ------------------------------ In keyboards/opticalkb/mcuconf.h <#17852 (comment)>: > @@ -0,0 +1,30 @@ +/* Copyright 2020 QMK File should be removed ------------------------------ In keyboards/opticalkb/halconf.h <#17852 (comment)>: > @@ -0,0 +1,28 @@ +/* Copyright 2020 QMK File should be removed ------------------------------ In keyboards/opticalkb/chconf.h <#17852 (comment)>: > @@ -0,0 +1,40 @@ +/* Copyright 2020 QMK File should be removed — Reply to this email directly, view it on GitHub <#17852 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AD6DOYETZ4T7QR5UHPJ53UDVW2HD5ANCNFSM55DSS4CA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[zvecr]

I am using an optical matrix. Optical switches do not need debounce. It takes about 15us for phototransistor to rise and IO pin will read accurate values after that

You should still implement it correctly, but set the DEBOUNCE config option to zero.

The duplication is unavoidable unless code is refactored in matrix_common

Using lite removes the duplication of various things, which is why its been suggested.

[zvecr]

Layout Layout:
┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐
│K0││K0││K0││K0││K0││K0││K0││K0││K0││K0││K0││K0││K0││K0││K0│
└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘
┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐
│K1││K1││K1││K1││K1││K1││K1││K1││K1││K1││K1││K1││K1││K1││K1│
└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘
┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐
│K2││K2││K2││K2││K2││K2││K2││K2││K2││K2││K2││K2││K2││K2││K2│
└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘
┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐
│K3││K3││K3││K3││K3││K3││K3││K3││K3││K3││K3││K3││K3││K3││K3│
└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘
┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐
│K4││K4││K4││K4││K4││K4││K4││K4││K4││K4││K4││K4││K4││K4││K4│
└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘

does not represent what is shown in

[girishji]

Layout Layout:
┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐
│K0││K0││K0││K0││K0││K0││K0││K0││K0││K0││K0││K0││K0││K0││K0│
└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘
┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐
│K1││K1││K1││K1││K1││K1││K1││K1││K1││K1││K1││K1││K1││K1││K1│
└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘
┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐
│K2││K2││K2││K2││K2││K2││K2││K2││K2││K2││K2││K2││K2││K2││K2│
└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘
┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐
│K3││K3││K3││K3││K3││K3││K3││K3││K3││K3││K3││K3││K3││K3││K3│
└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘
┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐┌──┐
│K4││K4││K4││K4││K4││K4││K4││K4││K4││K4││K4││K4││K4││K4││K4│
└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘└──┘

does not represent what is shown in

Thanks, changed it. I am not sure how I can verify this graphically though, but changed the geometry values

[girishji]

I am using an optical matrix. Optical switches do not need debounce. It takes about 15us for phototransistor to rise and IO pin will read accurate values after that

You should still implement it correctly, but set the DEBOUNCE config option to zero.

The duplication is unavoidable unless code is refactored in matrix_common

Using lite removes the duplication of various things, which is why its been suggested.

Thanks, changed as requested. I am glad setting DEBOUNCE to 0 eliminates all debouce related processing

[girishji]

Thank you, I think I have incorporated all suggestions

[girishji]

Please review and merge, thanks :)

[github-actions]

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

[github-actions]

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with bug, awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

[github-actions]

Thank you for your contribution!
This pull request has been automatically closed because it has not had activity in the last 30 days. Please feel free to give a status update now, ping for review, or re-open when it's ready.
// [stale-action-closed]