Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reduce Helix keyboard build variation #29

Conversation

mtei
Copy link

@mtei mtei commented Apr 2, 2020

Description

There are many build variation for the current Helix keyboard. It was a little too much, so I chose patterns that users often use and reduced the unnecessary ones.

This change does not change the build results.

All compile option patterns (click)
  • build helix/pico (HelixPico) with helix current codes

    $ make helix/pico:KEY_MAP
    $ make helix/pico/back:KEY_MAP
    $ make helix/pico/under:KEY_MAP
    
  • build helix/rev2 (Helix or Helix beta) with helix current codes
    Allways OLED enable.

    $ make helix:KEY_MAP
    $ make helix/rev2/back:KEY_MAP
    $ make helix/rev2/under:KEY_MAP
    
  • build helix/pico (HelixPico) with split_common codes
    RGBlight as backlight enable.

    $ make helix/pico/split_common:KEY_MAP
    
  • build helix/rev2 (Helix) with split_common codes
    OLED and RGBlight as backlight enable.

    $ make helix/rev2/split_common:KEY_MAP
    
Comparison of old and new (click)
build name in the previous version build name in the new version
helix/rev1 helix/rev1
helix/pico helix/pico
helix/pico/back helix/pico/back
helix/pico/under helix/pico/under
helix/pico/sc --
helix/pico/sc/back helix/pico/split_common
helix/pico/sc/under --
helix/rev2 (=helix) --
helix/rev2/back --
helix/rev2/back/oled --
helix/rev2/oled helix/rev2 (=helix)
helix/rev2/oled/back helix/rev2/back
helix/rev2/oled/under helix/rev2/under
helix/rev2/sc --
helix/rev2/sc/back --
helix/rev2/sc/oled --
helix/rev2/sc/oledback helix/rev2/split_common
helix/rev2/sc/oledunder --
helix/rev2/sc/under --
helix/rev2/under --
helix/rev2/under/oled --

Types of Changes

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

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

mtei added 6 commits April 2, 2020 19:46
| name in the previous version | name in the new version |
| ---------------------------- | ------------------------|
| helix/rev1                   | helix/rev1              |
| helix/pico                   | helix/pico              |
| helix/pico/back              | helix/pico/back         |
| helix/pico/under             | helix/pico/under        |
| helix/pico/sc                | --                      |
| helix/pico/sc/back           | helix/pico/split_common |
| helix/pico/sc/under          | --                      |
| helix/rev2 (=helix)          | --                      |
| helix/rev2/back              | --                      |
| helix/rev2/back/oled         | --                      |
| helix/rev2/oled              | helix/rev2 (=helix)    |
| helix/rev2/oled/back         | helix/rev2/back         |
| helix/rev2/oled/under        | helix/rev2/under        |
| helix/rev2/sc                | --                      |
| helix/rev2/sc/back           | --                      |
| helix/rev2/sc/oled           | --                      |
| helix/rev2/sc/oledback       | helix/rev2/split_common |
| helix/rev2/sc/oledunder      | --                      |
| helix/rev2/sc/under          | --                      |
| helix/rev2/under             | --                      |
| helix/rev2/under/oled        | --                      |
… post-processing

**Compilation result does not change**
This reverts commit 6229ed41f2ff8bac52015150837eaa51d9815e13.
@mtei mtei changed the title Reduce helix build variation Reduce Helix keyboard build variation Apr 2, 2020
@mtei
Copy link
Author

mtei commented Apr 2, 2020

先日相談した、ビルドパターンの削減です。

テストとプルリクの処理手順 (click)

私の手元の PC で、以下のようにブランチを作りました。

$ cd qmk_firmware
$ git checkout -b reduce_helix_build_variation 0.8.92

以下の手順を実行すれば、qmk へのpullreq が綺麗に出来るはずです。

まずないんさんの PC と Github リポジトリに qmk の最新をとりこみます。

次にないんさんの PC で、以下を実行

$ cd qmk_firmware
$ git checkout -b reduce_helix_build_variation 0.8.92
$ git push origin reduce_helix_build_variation

ないんさんの GitHub リポジトリで、この PR のタイトルの右にある編集ボタンを押して
マージ先のブランチを、reduce_helix_build_variation に変更します。(まだマージはしません。)

ないんさんの PC で、以下を実行すれば、私のところの reduce_helix_build_variation とまったく同じ内容のブランチが test_reduce_helix という名前で出来上がるので、内容の確認と動作の確認をします。

$ cd qmk_firmware
$ git fetch origin pull/29/head:test_reduce_helix
$ git checkout test_reduce_helix

確認が終了したら、ないんさんの GitHub リポジトリで、マージをします。

最後に reduce_helix_build_variation ブランチを qmk に PullRequest すれば、綺麗な PR になると思います。

なお、少し前に、「qmk firmware の追いかけ方とプルリクのやり方」という文章を書いたのでよかったら参考にしてください。
https://gist.github.com/mtei/d4e64dee304088d7662771c024e3d2c7

@MakotoKurauchi MakotoKurauchi changed the base branch from master to reduce_helix_build_variation April 4, 2020 02:12
@MakotoKurauchi MakotoKurauchi merged commit ae529e1 into MakotoKurauchi:reduce_helix_build_variation Apr 4, 2020
@MakotoKurauchi
Copy link
Owner

ありがとうございます!
いつも助かります!

@mtei
Copy link
Author

mtei commented Apr 26, 2020

本家にだした、PR 8669 が3週間も放置された挙句やっとレビューされました。
ですが、scsplit_common にリネームしたのが、重大な変更とみなされたようで、breaking change フラグをつけられてしましました。
あまり納得いかないですが、仕方ないので、名前をもどして、#31 をつくりました。

@mtei
Copy link
Author

mtei commented Oct 22, 2020

本家にだした、PR 8669 が、相変わらずマージされていなくて、コンフリクトがでています。
PR #32 では、以下の三点の変更を追加しました。

  • 本家のコンフリクトを解消するために master からの部分的なマージをしました。
  • Breaking Chang 扱いになっているので、Change Log を書く必要があったので追加しました。
    内容をこちらで確認してくださいませ。 https://github.com/mtei/qmk_firmware/blob/reduce_helix_build_variation3/docs/ChangeLog/20201128/PR8669.md
  • ビルドターゲットに helix/rev2/qmk_confhelix/pico/qmk_conf を追加しました。
    QMK configurator 上ではこれを選択すれば、ビルドが多分うまくいきます。
    コマンドライン上でこのターゲットを普通のキーマップで指定すると、キーマップの rules.mk が無視されます。

master からの merge をしているので差分がすごいことになっています。
今回の変更内容を確認するにはこちらを見るのが簡単です。https://github.com/mtei/qmk_firmware/commits/reduce_helix_build_variation3

なにか、変更の必要な事項が見つかったらご指摘ください。#32 のマージ前に直しの commit を追加します。

#32 を取り込んだ後、qmk 本家の PR 8669 のページで、タイトル右横の edit ボタンを押して、マージ先を develop に切り替えると、作業は完了です。

今月の31日が、今回の Breaking Change の受付締め切りなので、そのまえによろしくお願いします。

@MakotoKurauchi
Copy link
Owner

ありがとうございます!
対応しました。

@mtei mtei deleted the reduce_helix_build_variation branch December 21, 2020 21:06
MakotoKurauchi pushed a commit that referenced this pull request Apr 9, 2022
* [keyboard] Initial support for Anne Pro 2

* [keyboard][AnnePro2] Keymap:update to a reasonable keymap with caps+hjkl => arrow

* :(

* changed to use HSI

* support for annepro2 c18

* keyboard/annepro2: Very stupid matrix scan bug fix.

* typo

* swap COL14/13

* keyboard/annepro2: startup secondary LED MCU

* keyboard/annepro2: typo fix

* Add IO Values

* Disable Combo feature

* Update default keymap to Anne Pro 2 Official Keymap

* keyboard/annepro2: keymap layer name changes

* keyboard/annepro2 BLE Support

* Fix keymap comment

FN1 ESC was listed as ~ instead of `

* keyboard/annepro2: Bluetooth path

* Keyboard annepro2 bidir led comms (#5)

* Added bidirectional shine comms and moved led functionality to new file

* Added bidirectional shine comms and moved led functionality to new file

* Restore original functionality to existing keymaps using new shine commands

* Fix dangling bracketless if statements

* PR cleanup

* add custom keycodes to switch led profiles

* Optimize code

* switch to prev profile before turning leds off

* Add persistent led support with eeprom (#9)

* adding HT32 support to chibios SPI master driver

* add support for W25X20CL SPI eeprom

* add makefile flag for eeprom feature

* add spi support to keyboard startup and config

* example keymap using eeprom profile loading

* Cleanup to fix C15 eeprom/spi build errors (#11)

* Cleanup to fix C15 eeprom/spi build errors

* add newline at eof

* LED Masking support for Shine

Introduce companion update to ledSetMask and ledClearMask.
In keymap `codetector` there is example of how to map caps_lock
to the caps_lock key light on the keyboard.

* [AnnePro2]: update bluetooth connection

* Merge the custom keys enums on annepro2.h (#13)

* Keyboard annepro2 ble caps lock (#12)

* Move matrix_scan_kb out of board.c to annepro2.c

* add buffer clear after init and caplock polling

* Add support for LED intensity (#15)

* Improve logic for switching off and on of LEDs (#16)

* Implement animation speed (#17)

* Include logic to send solid colors as foreground to shine and add sample profiles (#14)

Include the logic to send a solid color from qmk to shine. That solid color will act as a foreground (will override the current profile) until reset (witch will reactivate the current profile).
This functionality depends on changes made for shine as well.

Include 3 new profiles:

    default-full-caps -> same as default, but with the logic of using the red foreground color on caps lock.
    default-layer-indicators -> same as default, but with the logic of red foreground on caps lock, green foreground on FN1 and blue foreground on FN2.
    thomazmoura -> my own profile as a sample of an over-engineered advanced case scenario.

* Implement reactive lighting effects (#18)

* Added multiarrow keymap (#19)

* Add LED documentation (#26)

* add LED documentation

* add LED documentation to other default profiles

* Implement QMK's IAP default keybind (#29)

* Add keymap for going into IAP

* switch to default QMK keybind for IAP mode

* implement bluetooth IAP mode

* Make default config more like Obins stock default (#30)

* Add new message type for resetting foreground color (#31)

* annepro2(bluetooth): add media keys support (qmk#41)

* Asynchronous, robust serial protocol. (qmk#39)

* bla personal ap2-c18 keymap.

* Bidirectional, asynchronous message-based communication with Shine.

- Requires a matching Shine version.
- Protocol is resiliant to loosing bytes during communication, chips won't lock
  waiting for bytes that aren't coming.
- Chips resynchronize in event of loosing a byte using a AA0D header.

Regressions:
- Key masking/locking doesn't work right now. (did it work before?)
- Not all user keymaps build against it.

* Clang-format + code to ease reducing speed of LED UART.

- Did clang-format --style=file -i on multiple files according to
  coding_conventions_c.md

- Added separate serial speed for IAP boot and Led communication, it's possible
  that reducing this to 9600 helped someone with faulty HW. With this code they
  can do it with simple replacing of a value.

* Main chip can set/clear foreground using a mask mechanism.

- Some preparations for selective colouring.

* Selective mask works - tested on capslock.

- Migrated personal keymaps to new status API.

* Clear the foreground colors to show profile when it's modified.

- Show example of achieving selective caps-lock painting + foreground painting
  for layers.
- annepro2LedMaskSetRow is implemented, but still requires testing.

* Implement the QMK side of led blinking to indicate the command was received.

- This stupidly blinks the key when user presses one of the bluetooth commands
to let the user know that the command was received and forwarded to the BT chip.

- TODO: Row/col key positions are hardcoded and not taken from the keymap.

* Reduce memory footprint.

Applying code review suggestions. Moved msgId to globals - preparing for
transmission without copying payload when no retries are necessary.

Added empty readme.md files - required by QMK lint.

Co-authored-by: Tomasz bla Fortuna <bla@thera.be>

* Let the LED chip settle a bit before waking it from the bootloader. (qmk#42)

At least for one person that helps to reliably get the LEDs working without
disconnecting/reconnecting the power to the board multiple times.

Co-authored-by: Tomasz bla Fortuna <bla@thera.be>

* annepro2: rename KEYMAP to LAYOUT, as required by new version of QMK

* annepro2: update ChibiOS configuration files

* annepro2: fix undefined reference to dprint and timer_read32

* annepro2: update ChibiOS MCU name

* update spi driver, fix bad merging with master

* annepro2: add readme and info.json

* annepro2: make code compatible with QMK coding conventions

* tmk_core: temporary fix to allow HT32 based keyboards to work without patched ChibiOS-contrib (AnnePro2)

* AnnePro2: removed core changes

* AnnePro2: Leave only default keymaps

Missing keymaps will be restored in another PR

* annepro2: add licence information

* annepro2: satisfy qmk lint

* annepro2: fix drashna's suggestions

* annepro2: fix matrix

* annepro2: apply code review suggestions

* annepro2: apply remaining code review suggestions

* annepro2: update info.json

* annepro2: remove include

* annepro2: rename keymap to layout

* annepro2: fix typing

* annepro2: apply suggestions from tzarc's code review

Co-authored-by: Nick Brassel <nick@tzarc.org>

* annepro2: more fixes

* annepro2: apply suggestions from code review

Co-authored-by: Joel Challis <git@zvecr.com>

* annepro2: rename file

* more fixes

* Apply suggestions from @tzarc code review

Co-authored-by: Nick Brassel <nick@tzarc.org>

* Update keyboards/annepro2/protocol.h

Co-authored-by: Nick Brassel <nick@tzarc.org>

* Update keyboards/annepro2/chconf.h

Co-authored-by: Nick Brassel <nick@tzarc.org>

* apply CR suggestions

* upgrade readme

* IAP

* update IAP comments, defines

* led fix

* init fix

* annepro2: GPIO cleanup

* annepro2: ioline

* change waiting time

* Start develop for 2022q2

* [Core] Squeeze AVR some more with `-mrelax` and `-mcall-prologues` (qmk#16269)

* Rework generate-api CLI command to use .build directory (qmk#16441)

* Remove `send_unicode_hex_string()` (qmk#16518)

* Change data driven "str" type to represent a quoted string literal (qmk#16516)

* Change data driven "str" type to represent a quoted string literal

* Update docs

* Map data driven `DESCRIPTION` as string literal (qmk#16523)

* update bootloader

* Revert "Merge pull request #2 from qmk/develop"

This reverts commit 9c76065, reversing
changes made to 240745d.

* Revert "update bootloader"

This reverts commit 240745d.

* fix rules.mk

* change PROGRAM_CMD

Co-authored-by: codetector <codetector@codetector.cn>
Co-authored-by: Fagl4 <18francisco18@gmail.com>
Co-authored-by: Jakob Gillich <jakob@gillich.me>
Co-authored-by: tech2077 <tech2077@gmail.com>
Co-authored-by: jcdeA <31413538+JcdeA@users.noreply.github.com>
Co-authored-by: Thomaz Moura <5599621+thomazmoura@users.noreply.github.com>
Co-authored-by: Darkhan <darkhanu@gmail.com>
Co-authored-by: Paco <70448173+packorf@users.noreply.github.com>
Co-authored-by: jmarmstrong1207 <32995055+jmarmstrong1207@users.noreply.github.com>
Co-authored-by: 1Conan <7620342+1Conan@users.noreply.github.com>
Co-authored-by: Tomasz bla Fortuna <blagh@thera.be>
Co-authored-by: Tomasz bla Fortuna <bla@thera.be>
Co-authored-by: Nick Brassel <nick@tzarc.org>
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: QMK Bot <hello@qmk.fm>
Co-authored-by: Stefan Kerkmann <karlk90@pm.me>
Co-authored-by: Ryan <fauxpark@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants