[PENDING] Changed Helix OLED display to use oled_driver.c

[mtei]

Description

Changed Helix OLED display to use oled_driver.c

• Changed all keymap.c in helix/rev2/keymaps to use oled_driver.c
• Changed all keymap.c in helix/pico/keymaps to use oled_driver.c
• helix/rev1 uses helix/local_drivers/ssd1306.c as before.

This PR also added a build method that uses split_common so that split_common can be tried with Helix.
The default build method uses the previous code, but you can build using split_common as follows.

• build helix/rev1 (Helix alpha)

  $ make helix/rev1:KEY_MAP
  

• build helix/pico (HelixPico) with helix previous codes

  $ make helix/pico:KEY_MAP
  $ make helix/pico/back:KEY_MAP
  

• build helix/rev2 (Helix or Helix beta) with helix previous codes

  $ make helix:KEY_MAP
  $ make helix/rev2/back:KEY_MAP
  $ make helix/rev2/under:KEY_MAP
  $ make helix/rev2/oled:KEY_MAP
  $ make helix/rev2/oled/back:KEY_MAP
  $ make helix/rev2/oled/under:KEY_MAP
  

• build helix/pico (HelixPico) with split_common codes

  $ make helix/pico/sc:KEY_MAP
  $ make helix/pico/sc/back:KEY_MAP
  $ make helix/pico/sc/under:KEY_MAP
  

• build helix/rev2 (Helix) with split_common codes

  $ make helix/rev2/sc:KEY_MAP
  $ make helix/rev2/sc/back:KEY_MAP
  $ make helix/rev2/sc/under:KEY_MAP
  $ make helix/rev2/sc/oled:KEY_MAP
  $ make helix/rev2/sc/oledback:KEY_MAP
  $ make helix/rev2/sc/oledunder:KEY_MAP
  

All keymaps have been tested and verified to work.

Types of Changes

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

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]

先日、遊舎工房にお邪魔した時にお話した、helix の OLED ドライバを 標準の drivers/oled/oled_dirver.c への切り替え作業と、split_common をお試しするための作業が完成しました。

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

$ cd qmk_firmware
$ git checkout -b helix_change_to_use_oled_driver 0.7.46

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

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

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

$ cd qmk_firmware
$ git checkout -b helix_change_to_use_oled_driver 0.7.46
$ git push origin helix_change_to_use_oled_driver

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

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

$ cd qmk_firmware
$ git fetch origin pull/24/head:test_oled_driver
$ git checkout test_oled_driver

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

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

[mtei]

Excuse me, let me be pending this PR. すみません、この PR ちょっと保留にさせてください。

ないんさんも気がついたように、split_common にはいくつかの機能不足があって、現行の Helix のコードでできていることができなくなります。それもあって、split_common 利用はとりあえずオプション扱いで、デファオルトのコンパイルは従来通りのコードを使用しています。

また、この PR では、rev2 と pico の全部の keymap.c を ssd1306.c 使用から、drivers/oled_driver.c の使用に書き換えています。すでに qmk に登録されている keymap.c はテストが済んでいます。しかしフォークやクローンをしてローカルにカスタマイズしているユーザーへの配慮が足りていませんでした。
これは、qmk 本家の 別件のPR 7385 番のコメント issuecomment-554737000 で指摘があって、このまま本家に PR を出すと重大な変更扱いになって、マージされるのが四ヶ月くらい先になりそうな気配です。

なので、もっとマージしてもらいやすい形で、いくつかに分割して PR を作り直したいと思います。

お騒がせしてすみません。