Skip to content

Instantly share code, notes, and snippets.

@koktoh
Last active February 3, 2021 17:41
Show Gist options
  • Save koktoh/aec29f5296b8d98ba165f939454ae172 to your computer and use it in GitHub Desktop.
Save koktoh/aec29f5296b8d98ba165f939454ae172 to your computer and use it in GitHub Desktop.

BrownSugar Macro ビルドガイド

bs_macro

キット内容

  • PCB x1
  • トッププレート x1
  • ボトムプレート x1
  • OLED カバープレート x1
  • SK6812MINI x8 (実装用 x7 + 予備 x1)
  • ダイオード x9
  • 抵抗 x2
  • タクトスイッチ x1
  • Kailh Choc ソケット x7
  • M2 3mm ねじ x12
  • スペーサー 3.5mm x4
  • スペーサー 8mm x2

その他必要なもの

すべて遊舎工房秋月電子通商で揃います

ロータリーエンコーダについて

ロータリーエンコーダは、以下のものに対応しています

  • 一般的なロータリーエンコーダ(Alps EC12系)(製品例)
  • プッシュスイッチ内蔵ロータリーエンコーダ(Alps EC11系)(製品例)
  • 単色LED内蔵ロータリーエンコーダ(製品例)

ビルドガイド

Overview

  1. SK6812MINI の実装
  2. ダイオードの実装
  3. ロータリーエンコーダ関係の部品の実装
  4. Kailh Choc ソケットの実装
  5. ロータリーエンコーダの実装
  6. 組み立て
  7. ファームウェア書き込み

基本的に背の低い部品からはんだ付けしてください

SK6812MINI の実装

始めに SK6812MINI をはんだ付けします
SK6812MINI は熱に弱いため、手早くはんだ付けしましょう

動作確認

先にファームウェアを書き込み、SK6812MINI が正しく点灯するか確認することをお勧めします
もしもすべて点灯しなかった場合、以下を参考に交換してください

bs_macro_top bs_macro_bottom

  1. はんだ付けに問題ないか確認
  2. 点灯していない SK6812MINI の前の SK6812MINI を交換
    • 例:4番が点灯していない場合、3番を交換

ダイオードの実装

D2, D4 ~ D9 のダイオードを取り付けます

ロータリーエンコーダに関係するダイオード / 抵抗の実装

BrownSugar Macro は、各ジャンパをブリッジすることでロータリーエンコーダの種類を選択することができます

ロータリーエンコーダの選定

まずは、使用するロータリーエンコーダと取り付け位置を決定してください
以下、取り付けるロータリーエンコーダの種類と位置によって使用部品が変わります

取り付け位置は表側から見た時のものです

ジャンパのブリッジ

以下の表に従って、ブリッジするジャンパを選択してください

取り付け位置 プッシュスイッチなし プッシュスイッチあり LED 内蔵
不要 JP2 JP4
不要 JP1 JP3

ダイオード / 抵抗の取り付け

以下の表に従って、取り付ける部品と位置を選択してください

実装する部品は各ロータリーエンコーダに対して、ダイオードか抵抗どちらかのみにしてください

取り付け位置 プッシュスイッチなし プッシュスイッチあり LED 内蔵
不要 ダイオード D3 抵抗 R2
不要 ダイオード D1 抵抗 R1

Kailh Choc ソケットの実装

ソケットをはんだ付けします
以下の画像を参考に、方向に注意して実装してください

socket

ロータリーエンコーダの実装

最後にロータリーエンコーダをはんだ付けします

組み立て

付属のねじとスペーサーで組み立ててください
トッププレートは、ねじを緩めに仮締めした後、いくつかスイッチを嵌めてから本締めすると、正しい位置に固定しやすくなります

トッププレートの方向

トッププレートには方向があります
写真のように、少し高さが広い穴がある行が上になるように取り付けてください
この穴がロータリーエンコーダ用の穴になります

また、つまみの大きさによっては穴が通らない可能性があるので、すべて組み立ててからつまみを取り付けることをお勧めします

bs_macro_top_plate

ファームウェアの書き込み

準備

  1. 公式のチュートリアルに従って環境を構築
  2. ファームウェアのダウンロード
    • 現在 QMK Firmware 公式には PR 等していないため、こちらの個人のリポジトリよりクローンしてください
    • git clone -b dev/bs_macro --depth 1 https://github.com/koktoh/qmk_firmware_koktoh

書き込み

先ほどダウンロードしたファームウェアのディレクトリ内で make コマンドを実行してください
上記のコマンドのまま実行した場合、 qmk_firmware_koktoh ディレクトリ内で実行します

make bs_macro:default:avrdude

キーマップ

使用するロータリーエンコーダの種類によって、3つのキーマップを用意しています

  • default
    • 全ロータリーエンコーダ対応
  • general
    • 一般的なロータリーエンコーダ(プッシュスイッチあり / なし両対応)のみ
  • inside_led
    • LED 内蔵ロータリーエンコーダのみ

以上で組み立ては終了です
お疲れ様でした

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