Інструкція з використання бездротової спліт клавіатури Harper

Гайд по підключенню, роботі з Bluetooth-модулями, індикацією, підсвіткою, розкладками та прошивкою.

Як працює Harper

Harper – це бездротова спліт-клавіатура, що складається з двох половин. У кожній половині є свій bluetooth модуль: модуль лівої половини підʼєднується до компʼютера, модуль правої половини автоматично підʼєднується до лівої половини. Напряму до компʼютера модуль правої половини не підʼєднується, тому щоб клавіатура працювала та її бачив компʼютер, обидві половини повинні бути зарядженими та ввімкненими.

Курсив

Тут і надалі курсивом ми будемо виділяти частини тексту, що безпосередньо описують можливі дії з клавіатурою.

Щоб увімкнути клавіатуру, ввімкніть обидві половини за допомогою перемикачів, що знаходяться збоку:

Як підʼєднати Harper до компʼютера

fn

Тут та надалі ми будемо позначати клавішу переходу на 3-й шар як fn задля зручності (що таке 3-й шар, ми напишемо нижче, у розділі роботи з розкладкою).

Harper може працювати через USB як звичайна клавіатура так само, як і через Bluetooth, при цьому ви можете обирати засіб звʼязку самостійно, незалежно від того, підключена клавіатура зараз за допомогою дрота, чи ні. Це может бути корисним коли, наприклад, клавіатура підключена задля заряджання, а не дротової роботи.

Щоб обрати засіб звʼязку, через який ви хочете налаштувати комунікацію, чи то Bluetooth, чи USB, скористайтеся однією з двох комбінацій на лівій половині клавіатури:

(у нижній частині клавіатури при активній індикації можуть загорітися відповідні світлодіоди, але ми розкажемо про це нижче, у розділі про індикацію)

Ці ж самі комбінації ви можете використовувати не лише перед підключенням клавіатури, а й в процесі роботи, наприклад, коли через USB ви підключені до компʼютера, а через Bluetooth – до телефона. Тоді ці комбінації будуть миттєво перемикати вас на потрібний девайс.

Якщо ви обрали USB, вам не потрібно робити додаткових дій, клавіатура готова до використання.

У разі обрання Bluetooth, треба зʼєднати один з каналів клавіатури з компʼютером/планшетом/телефоном. Як це зробити дивіться нижче.

Підключення через Bluetooth

Harper за замовчуванням має 3 Bluetooth канали, які одночасно можуть бути підключено до 3 різних пристроїв. За допомогою комбінації клавіш ви можете миттєво перемикатися між цими пристроями, роблячи один з них активним.

5 замість 3

Апаратна та програмна частина Harper підтримує підключення 5 пристроїв, а не 3, але за замовчуванням ми налаштовуємо розкладку на меньшу кількість, цього достатньо більшості юзерів, а розміщення гарячих клавішів стає більш зрозумілим.

Щоб обрати потрібний вам канал підключення, натисніть комбінацію клавіш fn + {номер каналу}.

Коли ви вперше включаєте клавіатуру, ви знаходитеся на 1 каналі.

Якщо канал, що активний зараз, вільний (тобто не підключений до жодного пристрою), ваш компʼютер буде бачити Harper у списку доступних до підключення.

Після підʼєднання до компʼютера, клавіатура запамʼятає його MAC адресу і запише її у активний канал.

Якщо за якоїсь причини ви не бачите Harper у списку доступних пристроїв, можливо канал, що зараз обрано, вже зайнятий, і його треба скинути. Як це зробити – буде трохи нижче.

Тепер, коли клавіатуру підключено до обраного каналу, ви можете перейти до іншого каналу та підʼєднатися до іншого пристрою. Клавіатура запамʼятає MAC адресу і цього пристрою, та запише її у обраний канал. Наступного разу, коли ви перейдете на канал, що вже був підключений, вам не треба буде робити нове підключення, клавіатура одразу буде працювати.

Таким чином, ви можете під’єднати до 3 пристроїв (по одному на канал) і миттєво перемикатися між ними, якщо вони ввімкнені та знаходяться у радіусі дії Bluetooth.

Якщо треба видалити пристрій з памʼяті клавіатури, щоб під’єднати інший, скористайтеся комбінацією fn та клавіші очищення Bluetooth.

LED-Індикація

Harper має по 4 світлодіоди на кожній з половин, котрі відображають різні стани клавіатури. Деякі зі станів, наприклад індикація рівня заряду батарей, працює завжди, тоді як більшість індикацій вимкнені за замовчуванням, щоб економити заряд батареї та не відволікати вас від роботи.

Щоб увімкнути індикацію, натисніть комбінацію клавіш, як показано на картинці.

Після цього різні дії з клавіатурою будуть відображатися індикацією доки клавіатуру не буде вимкнено.

Індикацію можна поділити на дві групи: одна група це індикації, що ініціюються користувачем, інша група – автомаична індикація, що реагує на події.

До першої групи відноситься індикація стану батарей.

Якщо натиснути на лівій половині клавіатури комбінацію, що відображено на картинці, клавіатура покаже поточний рівень заряду окремо на кожній половині.

Стан батареї на компʼютері

Також не забувайте, що протокол BLE підтримує відображення стану батареї на компʼютері/телефоні/планшеті, а з новою прошивкую ви можете бачити навіть стан обох половин.

Про індикації, що реагують на події, ми розкажемо далі, їх багато, і вони не такі прості. Майте на увазі, що ці цндикації можуть йти одна за одною, а можуть не йти, все залежить саме від стану клавіатури, та від того, яка подія виникла.

Індикація активного шару

Про шари та їх налаштування ми розкажемо нижче, у відповідному розділі. Що вам треба знати зараз, так це те, що, коли індикація увімкнена, під час переходу на інший шар (1, 2, 3) відповідна кількість активних діодів буде світитись на індикації, доки ви не повернетесь на нульовий шар.

Індикація про зміну Bluetooth/USB

Коли клавіатура одночасно підключена і через Bluetooth і через USB, при переключенні між цими каналами індикація блимне один раз білим, якщо переключились на Bluetooth, або синім – якщо на USB:

Індикація зміни Bluetooth профіля

Коли відбувається переключення на інший Bluetooth профіль, індикатори блимнуть один раз світлодіодом з відповідним номером. Світодіоди спрацьовують лише у момент зміни каналу. Якщо ви знаходитеся на першому каналі і перемикаєтесь на перший канал, світодіоди не будуть реагувати.

Індикація відсутнього підключення

Ця індикація відбувається на правій половині, та говорить про те, що вона не може пдʼєднатися до лівої (індикатор будеблимати постійно,доки конект не зʼявиться).

Це може виникати через особливості зашифрованих протоколів блютузу. Що можна зробити у такому разі:

• Почекати 5–7 хвилин, випити чаю
• Зробити Reset (один раз) кожної половини
• Очистити усі канали на лівій половині (див. вище)
• Скинути прошивку та завантажити її заново (див. нижче)

Коли проблему з підключенням правої половини буде вирішено та вона підключиться до лівої, ви побачите нову індикацію (теж на правій половині).

Розкладка

Шари та налаштування

Harper працює на базі прошивки ZMK. Найбазовіша річ, що є у цій системи – це шари. Тобто, ви маєте якусь конфігурацію клавіш, але легко, однією кнопкою можете перемкнути клавіатуру на абсолютно іншу конфігурацію. Це можна робити у різний спосіб: можна просто перейти на інший шар, натиснувши клавішу, і залишитися на ньому; чи активувати шар, доки ви тримаєте відповідну клавішу; або перестрибувати між шарами не послідовно, та дуже багато інших, ви можете детальніше вивчити весь функціонал на офіційному сайті: https://zmk.dev/docs/behaviors/layers

4 шари

Наразі у базовій прошивці ми надаємо конфігурацію для чотирьох слоїв, але ви можете самостійно додавати стільки, скільки вам треба. Лише дочитайте цей мануал до кінця і зверніть увагу на четвертий шар, який ми використовуємо у цій інструкції як основний шар для налаштувань.

За замовчуванням ви завжди знаходитесь на нульовому шарі. У прошивці, з якою клавіатура вирушає до вас, ми налаштували ще три шари, перемикання на які працює як “momentary layer” за допомогою ось цих клавіш:

Перші три шари (0-2) ми у своїй конфігурації відводимо для друкування, навігації, тощо:

Четвертий шар ми у цій інструкції називаємо шаром FN та використовуємо для налаштувань самої клавіатури та її підключення, про що вже розповіли вище.

Також цей шар використовується для управління підсвіткою, розкажемо про нього нижче, у розділі про це.

Окрім шарів ZMK має різні функції, їх багато, але всі вони підтримуються, хоча за замовчуванням ми не використовуємо їх у базовій конфігурації. Ви можете самостійно конфігурувати клавіатуру під ваші вимоги: https://zmk.dev/docs/behaviors

Як змінити розкладку

Найскладніша частина взаємодії з клавіатурою – це процес змінення налаштувань, бо, з технічного боку це є оновленням прошивки. На щастя, цей процес автоматизовано та не потребує багато знань чи вмінь.

Створення власної розкладки

Створіть акаунт на Github, або авторизуйтесь, якщо він в вас уже є.

Перейдіть у наш репозиторій Harper з налаштуванням та натисніть Fork, потім Create fork. Це створить вашу власну копію налаштувань клавіатури у вашому акаунті.

Тепер перейдіть у конфігуратор розкладки. У лівому верхньому кутку змініть Source з Demo Keyboard на Github.

Авторизуйтесь через свій Github акаунт та надайте конфігуратору права доступу до свого акаунту.

Встановіть Keymap Editor та надайте йому права доступу до того репозиторію, у якому знаходиться ваша копія налаштувань клавіатури.

Тепер ви можете редагувати вашу копію налаштувань клавіатури, єдине, що залишилося, це активувати Workflow, щоб після редагування ваші налаштування зібрались у нову прошивку автоматично.

Поверніться до свого Github акаунту та перейдіть у репозиторій з налаштуваннями клавіатури — за замовчуванням він має назву harper-zmk-config.

Перейдіть у розділ Actions та натисніть I understand my workflows, go ahead and enable them

На цьому підготування завершено, всі ці дії треба зробити лише раз, і тепер ви можете редагувати вашу розкладку. Поверніться до редактору (https://nickcoutsos.github.io/keymap-editor/), зробіть зміни у розкладці, які вам потрібні, та натисніть Save. Це збереже зміни та запустить збирання нової прошивки.

 Зачекайте 5–10 хвилин, попийте чаю (або кави, якщо чай вже пили) 🙂

Натисніть на іконку завантаження зібраної прошивки, вас направить у відповідний воркфлоу. Завантажте файл firmware, та розпакуйте архів після завантаження.

Завантаження прошивки у клавіатуру

В архіві буде 2 файли: для лівої половини та для правої половини.

Підʼєднайте потрібну половину вашого Harper до компʼютера через USB кабель (Harper має буди вимкненим). Біля перемикача для включення клавіатури є кнопка Reset — натисніть її двічі.

Клавіатура зʼявиться на вашому компʼютері у вигляді флешки.

Щоб встановити на клавіатуру свої налаштування розкладки, просто перетягніть або скопіюйте файл тієї половинки, яку ви під’єднали, у цю флешку.

Якщо щось пішло не за планом

Через особливості роботи протоколу Bluetooth може статися ситуація, що клавіатура перестане зʼєднуватися з компʼютером або між собою. Це можливо чи після завантаження нової прошивки, чи за інших причин. У цьому випадку треба використовувати файл скидання прошивки (файл можна знайти тут). Зробити це можна так само, як описано вище, але закидувати у флешку треба не файл для конкретної половинки, а файл з базовою прошивкою. Це треба зробити для кожної половинки.

Bluetooth Pairing

Bluetooth протокол це не стабільне зʼєднання між девайсами на окремій частоті, як то є в звичайному радіоприймачі. Замість цього використовується таблиця з можливих частот, між якими зʼєднані пристрої завжди перестрибують, і лише зʼєднані девайси, що пройшли процедуру сполучення (pairing) знають точно, на якій саме частоті повинен бути обмін пакетами саме у цей час.
Це дає по-перше стабільність, бо вірогідність отримати вільну частоту значно підвищується, а по-друге безпеку, бо перехопити пакети не знаючи правильної частоти не вийде.

Pairing Mode – це стан пристрою, коли він не має налаштованої пари і готовий приймати конект, тобто зберігати інформацію про підключення.

Таким чином:
1. Якщо клавіатуру не видно у списку пристроїв, це означає, що вона у собі вже має конект до якогось девайса на обраному каналі, та не перебуває у Pairing mode. Щоб підключити обраний канал до нового пристрою треба його очистити з боку клавіатури.
2. Клавіатуру видно у списку, але неможливо підключитися. Це означає, що якась зі сторін (або обидві) вже має налаштований конект, але ключі не співпадають. Тобто Bluetooth намагається стрибати по таблиці частот, але це не виходить синхронно, тому конект не проходить, збережений конект треба видалити з обох сторін.

Встановлення прошивки для скидання – це свого роду hard reset, який повністю видаляє інформацію про існуюче зʼєднання, даючи змогу робити нове. Після нього можна знову спробувати завантажити у клавіатуру свої налаштування.

У разі, якщо ви щось зламали та не знаєте, що саме, ви можете в будь-який момент встановити базову версію прошивки, яку ви можете завантажити у готовому вигляді: firmware.zip

RGB підсвічування

Тепер, коли ми завершили технічну частину, можна трохі відпочити та подивитися на веселку.

Увімкніть підсвічування

Оберіть ефект

Регулюйте швидкість анімації

Регулюйте яскравість