qmk_firmware/docs/ja/feature_encoders.md

2.2 KiB

エンコーダ

以下を rules.mk に追加することで基本的なエンコーダがサポートされます:

ENCODER_ENABLE = yes

さらに、以下を config.h に追加します:

#define ENCODERS_PAD_A { B12 }
#define ENCODERS_PAD_B { B13 }

各 PAD_A/B 変数は配列を定義するため、複数のエンコーダを定義することができます。例えば:

#define ENCODERS_PAD_A { encoder1a, encoder2a }
#define ENCODERS_PAD_B { encoder1b, encoder2b }

エンコーダの時計回りの方向が間違っている場合は、A と B のパッド定義を交換することができます。define を使って逆にすることもできます:

#define ENCODER_DIRECTION_FLIP

さらに、エンコーダが各戻り止め(デテント)間に登録するパルス数を定義する解像度は、次のように定義できます:

#define ENCODER_RESOLUTION 4

分割キーボード

分割キーボードのそれぞれの側のエンコーダに異なるピン配列を使っている場合、右側のピン配列を以下のように定義することができます:

#define ENCODERS_PAD_A_RIGHT { encoder1a, encoder2a }
#define ENCODERS_PAD_B_RIGHT { encoder1b, encoder2b }

コールバック

コールバック関数を <keyboard>.c に記述することができます:

bool encoder_update_kb(uint8_t index, bool clockwise) {
    if (!encoder_update_user(index, clockwise)) {
        return false;
    }
    
}

あるいは keymap.c に記述することもできます:

bool encoder_update_user(uint8_t index, bool clockwise) {
    if (index == 0) { /* First encoder */
        if (clockwise) {
            tap_code(KC_PGDN);
        } else {
            tap_code(KC_PGUP);
        }
    } else if (index == 1) { /* Second encoder */
        if (clockwise) {
            tap_code(KC_DOWN);
        } else {
            tap_code(KC_UP);
        }
    }
    return true;
}

ハードウェア

エンコーダの A と B の線は MCU に直接配線し、C/common 線はグランドに配線する必要があります。