Skip to content

Framework Laptop 16 Keyboards - #1

Draft
JohnAZoidberg wants to merge 537 commits into
masterfrom
lotus
Draft

Framework Laptop 16 Keyboards#1
JohnAZoidberg wants to merge 537 commits into
masterfrom
lotus

Conversation

@JohnAZoidberg

@JohnAZoidbergJohnAZoidberg commented Dec 16, 2022•
edited
Loading

Copy link
Copy Markdown
Member

Building:

qmk compile -kb framework/ansi -km default
qmk compile -kb framework/iso -km default
qmk compile -kb framework/jis -km default
qmk compile -kb framework/numpad -km default
qmk compile -kb framework/gridpad -km default

Other commands:

# Flash firmware (device must be in bootloader mode)
qmk flash -kb framework/ansi -km default
# Render layout with labels
qmk info -kb framework/ansi -km default -m
# Render layout matrix information
qmk info -kb framework/ansi -km default -m
# Show console output of connected QMK devices
qmk console

Resources:

Tasks

  • Make sure it works on our board, not just RasperryPi Pico
    • Change 16MB flash size to 1MB. No need
    • Make sure GPIOs are properly mapped. Pretty sure it's fine. Need to undefine PICO_FL16
  • USB VID and PID (tested)
  • Signal BOOT_DONE
  • Reading key input via ADC
    • Implement logic
    • Make sure the matrix ligns up with the actual electrical matrix
    • Implement actually reading from ADC
  • Single-zone PWM backlight
    • Test that it works
  • Capslock/Numlock LED
    • Test that it works
  • Enable RGB backlight with IS31FL3743A (see docs/feature_rgb_matrix.md)
    • Map LED positions. TODO: Probably needs some adjustment still
    • Fix numpad RGB mapping
    • Pull SDB(GP29) low to put IS31FL3743A into low power mode
    • Make sure mapping from keycode to LED is correct
    • Make sure mapping of LEDs IS31FL3743A matrix is correct
    • Make sure mapping of LEDs to absolute coordinates is correct
    • Make sure it's persisted. Currently it emulated EEPROM in the last 64K of flash. See: platforms/chibios/drivers/wear_leveling/wear_leveling_rp2040_flash_config.h.
  • Try debugging
    • Using HID console (Works with qmk console)
    • Using debugger
  • Split variants
    • Layouts
      • ANSI (78 keys)
      • ISO (79 keys)
      • JIS (83 keys)
      • Numpad (21 keys)
      • Gridpad (23 keys)
    • Fix key position and sizes in info.json
  • Enable VIA support
    • Add configs for each layout
      • ANSI
      • ISO
      • JIS
      • Numpad
      • Gridpad
    • Enable VIA in config.
  • Special Media Keys
  • Support FN lock
  • Support firmware update via software only, without mechanical intervention. This would be used in the factory for flashing the firmware.
  • Figure out a way to put the serial number, which won't be overridden by reflashing QMK
  • Remove mouse report
  • Move spacebar LED to the middle

@github-actionsgithub-actionsBot removed the via label Dec 20, 2022
@JohnAZoidberg

JohnAZoidberg commented Dec 20, 2022

Copy link
Copy Markdown
MemberAuthor

Fixed the build and made sure that GH Actions also tests that.

@JohnAZoidberg

JohnAZoidberg commented Dec 20, 2022•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

image
Debugging via print and uprintf console works

kiram9
kiram9 reviewed Dec 21, 2022
View reviewed changes
Comment threadkeyboards/lotus/config.h Outdated
Comment threadkeyboards/lotus/keymaps/default/keymap.c Outdated
Comment threadkeyboards/lotus/keymaps/default/keymap.c Outdated
Comment threadkeyboards/lotus/matrix.c Outdated
Comment threadkeyboards/lotus/matrix.c Outdated
Comment threadkeyboards/lotus/matrix.c Outdated
Comment threadkeyboards/lotus/matrix.c Outdated
JohnAZoidberg
JohnAZoidberg commented Dec 22, 2022
View reviewed changes
Comment threadkeyboards/lotus/config.h Outdated
JohnAZoidberg
JohnAZoidberg commented Dec 22, 2022
View reviewed changes
Comment threadkeyboards/lotus/keymaps/78_ansi/keymap.c Outdated
@JohnAZoidberg
JohnAZoidbergforce-pushed the lotus branch 3 times, most recently from 0e78ecb to 8098783CompareDecember 29, 2022 15:33
@JohnAZoidberg

JohnAZoidberg commented Jan 5, 2023

Copy link
Copy Markdown
MemberAuthor

Firmware sizes currently:

> ls -lh .build/*uf2
-rw-rw-r-- 1 zoid zoid 98K Jan 5 17:47 .build/lotus_ansi_default.uf2
-rw-rw-r-- 1 zoid zoid 95K Jan 5 18:15 .build/lotus_gridpad_default.uf2
-rw-rw-r-- 1 zoid zoid 85K Jan 5 18:14 .build/lotus_iso_default.uf2
-rw-rw-r-- 1 zoid zoid 85K Jan 5 18:15 .build/lotus_jis_default.uf2
-rw-rw-r-- 1 zoid zoid 84K Jan 5 18:15 .build/lotus_numpad_default.uf2

Much of that is UF2 overhead. The last byte in the .hex file is 0xC244 (49732), so the FW is roughly 50K big.

@JohnAZoidberg

JohnAZoidberg commented Jan 7, 2023•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Testing while twisting potentiometer to provide ADC voltage, set the threshold at 3V:

Framework Computer Inc:Lotus Keyboard:1: Col 10 - Row 5 - State: 0, Voltage: 3.11 Framework Computer Inc:Lotus Keyboard:1: 5 ms (200 Hz) Framework Computer Inc:Lotus Keyboard:1: Temperature: 19.88 Framework Computer Inc:Lotus Keyboard:1: ADC Voltage: 3.9 Framework Computer Inc:Lotus Keyboard:1: Col 10 - Row 6 - State: 0, Voltage: 3.09 Framework Computer Inc:Lotus Keyboard:1: 6 ms (166 Hz) Framework Computer Inc:Lotus Keyboard:1: Temperature: 19.88 Framework Computer Inc:Lotus Keyboard:1: ADC Voltage: 3.5 Framework Computer Inc:Lotus Keyboard:1: Col 10 - Row 7 - State: 0, Voltage: 3.05 Framework Computer Inc:Lotus Keyboard:1: 5 ms (200 Hz) Framework Computer Inc:Lotus Keyboard:1: Temperature: 19.64 Framework Computer Inc:Lotus Keyboard:1: ADC Voltage: 3.2 Framework Computer Inc:Lotus Keyboard:1: Col 11 - Row 0 - State: 0, Voltage: 3.09 Framework Computer Inc:Lotus Keyboard:1: 6 ms (166 Hz) Framework Computer Inc:Lotus Keyboard:1: Temperature: 19.88 Framework Computer Inc:Lotus Keyboard:1: ADC Voltage: 2.98 Framework Computer Inc:Lotus Keyboard:1: Col 11 - Row 1 - State: 1, Voltage: 2.98 Framework Computer Inc:Lotus Keyboard:1: 5 ms (200 Hz) Framework Computer Inc:Lotus Keyboard:1: Temperature: 19.64 Framework Computer Inc:Lotus Keyboard:1: ADC Voltage: 2.96 Framework Computer Inc:Lotus Keyboard:1: Col 11 - Row 2 - State: 1, Voltage: 2.96 Framework Computer Inc:Lotus Keyboard:1: 5 ms (200 Hz) Framework Computer Inc:Lotus Keyboard:1: Temperature: 19.64 Framework Computer Inc:Lotus Keyboard:1: ADC Voltage: 2.92 Framework Computer Inc:Lotus Keyboard:1: Col 11 - Row 3 - State: 1, Voltage: 2.92 Framework Computer Inc:Lotus Keyboard:1: 6 ms (166 Hz) Framework Computer Inc:Lotus Keyboard:1: Temperature: 19.64 Framework Computer Inc:Lotus Keyboard:1: ADC Voltage: 2.87 Framework Computer Inc:Lotus Keyboard:1: Col 11 - Row 4 - State: 1, Voltage: 2.87 Framework Computer Inc:Lotus Keyboard:1: 5 ms (200 Hz) Framework Computer Inc:Lotus Keyboard:1: Temperature: 19.88 Framework Computer Inc:Lotus Keyboard:1: ADC Voltage: 2.83 Framework Computer Inc:Lotus Keyboard:1: Col 11 - Row 5 - State: 1, Voltage: 2.83 Framework Computer Inc:Lotus Keyboard:1: 6 ms (166 Hz) Framework Computer Inc:Lotus Keyboard:1: Temperature: 19.88 Framework Computer Inc:Lotus Keyboard:1: ADC Voltage: 2.80 Framework Computer Inc:Lotus Keyboard:1: Col 11 - Row 6 - State: 1, Voltage: 2.80

@JohnAZoidberg

JohnAZoidberg commented Jan 7, 2023

Copy link
Copy Markdown
MemberAuthor

Works out of the box with a raspberry pi pico.
Does not drive the column GPIOs because GP29 is not present on the pico, which we need to use for SDB to enable the RGB controller.
I remapped that to GP22 for now.
Will have to undefine PICO_LOTUS when we do a build for the factory next week.

@JohnAZoidberg

JohnAZoidberg commented Jan 7, 2023•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Printing many times per cycle on the console slows QMK down A LOT! Will have to measure latency without logging every matrix scan.

@JohnAZoidberg

JohnAZoidberg commented Jan 11, 2023

Copy link
Copy Markdown
MemberAuthor

Current ANSI FW size:

Without LTO: 61924
With LTO: 49668

JohnAZoidberg
JohnAZoidberg commented Jan 12, 2023
View reviewed changes
Comment threadkeyboards/lotus/matrix.c Outdated
mux_select_row(row);

// Wait for column select to settle and propagate to ADC
wait_us(30);

@JohnAZoidbergJohnAZoidbergJan 12, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably way too high. With 30us we get only 100Hz scanrate because the inner loop is executed 16*8=3840 times.
To get 1000Hz scan rate we need to keep the scan under 1000us.

@kiram9 can you help me figure out an estimate?
I'm not quite sure what many of the words on the datasheets mean.
MUX: http://www.sg-micro.com/uploads/soft/20220512/1652340158.pdf
Pico datasheet says: "Capturing a sample takes 96 clock cycles (96 × 1/48MHz) = 2μs per sample (500ksps)." But currently I'm using the function that sleeps until the interrupt wakes it up when the measurement is done.

JohnAZoidberg
JohnAZoidberg commented Jan 12, 2023
View reviewed changes
Comment threadkeyboards/lotus/matrix.c Outdated
*/
static void read_adc(void) {
// Need to sleep a bit, otherwise we seem to get stuck
wait_us(5);

@JohnAZoidbergJohnAZoidbergJan 12, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems to be fine now actually, changed some other code and probably don't need this anymore.

@JohnAZoidberg
JohnAZoidberg removed the request for review from kiram9February 8, 2023 06:47
@JohnAZoidberg
fl16: Validate serial number with CRC32B checksum
ca08e93
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fl16: Fix white backlight not recovering after reset
9c752c1
If the backlight brightness was changed and the keyboard unplugged and
replugged, the lights would stay off. They should come back to the
previous value, which will happen automatically but the code would
override.
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fl16/macropad: Add factory mode
ddfb8f4
Factory mode enables layer 2 which has a regular keycode mapped to every
key. This way the factory can easily test whether the keys are working
or not.
It can either be disabled again or it'll turn of itself when the
keyboard resets.
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fl16: Refactor factory mode
436a9cc
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fl16: Update to v0.2.2
a7e5bc8
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fixup! fl16/macropad: Add factory mode
d7e3152
@JohnAZoidberg
fl16: Apply clang-format
3ca08b7
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fl16: More clang-format
dd025c9
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fl16: More clang-format
1c977e7
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fl16: Clean up
bec48a2
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fl16: Use pre-defined constants
5e71123
Our schematic uses these custom names but they just map to the
per-controller names.
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
keyboards/framework: Update URLs to already working ones
a7e2f5d
Previous URLs are not set up yet.
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
keyboards/framework/macropad: Data driven layout
6d1c3a7
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
keyboards/framework/numpad: Use datadriven layout
6b7686f
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
keyboards/framework: numpad has no numlock LED
662d6fb
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
keyboards/framework/ansi: Use datadriven layout
6b85436
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
keyboards/framework/iso: Use datadriven layout
e89d734
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
keyboards/framework/jis: Use datadriven layout
941a5ab
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
keyboards/framework/ansi: Move LEDs under artwork
46b2bca
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fl16: Move capslock pin into info.json
e3b5129
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fl16: Remove default debounce value
f342035
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fl16: Replace KC_SCRN with G(KC_P)
1bbe5ea
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
fl16: Move into laptop16 subfolder
faf98a9
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
keyboards/framework: Use QK_KB instead of SAFE_RANGE
89be4f3
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@JohnAZoidberg
framework: Update debug to print voltage
d4af07b
Signed-off-by: Daniel Schaefer <dhs@frame.work>
@pdalpra

pdalpra commented Feb 20, 2024

Copy link
Copy Markdown

@JohnAZoidberg Sorry to hijack this PR but is it the current best source to build a custom firmware (=> not using VIA's web UI) ?

@Blue-Sauce

Blue-Sauce commented Feb 20, 2024

Copy link
Copy Markdown

@JohnAZoidberg Sorry to hijack this PR but is it the current best source to build a custom firmware (=> not using VIA's web UI) ?

v0.2.9 is the latest version. You can find it here
https://github.com/FrameworkComputer/qmk_firmware/tree/v0.2.9/

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kiram9kiram9kiram9 left review comments

Assignees

No one assigned

Labels

CIcoredocumentationkeyboardkeymappythontranslationvia

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

20 participants

@JohnAZoidberg@pdalpra@Blue-Sauce@kiram9@qmk-bot@noroadsleft@tzarc@zvecr@fauxpark@filterpaper@purdeaandrei@KarlK90@Xelus22@drashna@dunk2k@rastersoft@ThePurox@CheeseL0ver@waffle87@dkao