hoboNicola keyboard and adapter library. Copyright (C) Takeshi Higasa, okiraku-camera.tokyo
これまでのhoboNicolaLibraryの履歴などについては、ブログの投稿を参照してください (以下の内容と重複する箇所もあります)。
hoboNicolaライブラリは、一般的なUSBキーボードをほぼNICOLAキーボードとして使うためのアダプター用ファームウェアとして2018年頃に作りました。このライブラリを使うことで、入力時の配列を(ほぼ)NICOLA配列にすると同時に、NICOLA規格に準じた親指キー同時打鍵入力が可能となります。hoboNicolaライブラリを組み込んだアダプター(USB-USB, PS/2-USB)のことを、hoboNicolaアダプターと称しており、回路などはブログ等で公開されています。
hoboNicolaアダプターはPCなどのホスト側に接続したときふつうのUSBキーボードのように振る舞います。アダプターは物理的なキーボードからの受けたHID Usage ID(キーコード)を使って配列の変更や同時打鍵処理などを行った後、ホストにキーコードを送り出します。
このライブラリは、日本語USBキーボードだけではなくPS/2インタフェースのキーボードや、USレイアウトのキーボード用のアダプターとしても使うことができます。また、キーボードPCBのマイコンに組み込むことで使い手の都合に合わせた親指シフトキーボードのファームウェアとすることも可能です。
hoboNicolaアダプターやキーボードの、NICOLAモードでの文字記号配列は以下のようにしています(バージョン1.7.0以降)。
NICOLA規格での配列規定とは若干ことなっているので、「ほぼ」NICOLAと称してます。
NICOLA規格の詳細については、http://nicola.sunicom.co.jp/spec/jisdraft.htm を参照してください。
hoboNicolaは、アダプターに接続したキーボードから出力されるキーコードや、hoboNicolaを組み込んだキーボード(hoboNicolaキーボード)の基本配列に定義されているコードに基づいて、上図のような配列への変更や親指キー同時打鍵処理を行います。左右の親指キーに割り当てることができるキーは以下のようになっています。
| 親指キー | (初期設定) | 設定1 | 設定2 |
|---|---|---|---|
| 親指左 | 無変換(F14)キー | 空白キーまたは無変換(F14)キー | 無変換(F14)キー |
| 親指右 | 変換(F15)キー | 変換(F15)キー | 変換(F15)キーまたは空白キー |
Windowsのハードウェアキーボードレイアウトを「英語キーボード(101/102キー)」としている場合、変換キーや無変換キーは使えません。そういった場合、F14およびF15キーで代用することにしています。
アダプターの場合、接続しているキーボードで同時打鍵に使う親指キーの出力コードのカスタマイズにより、F14やF15を出力する必要があります。
hoboNicolaキーボードではUSレイアウトで使うとき、無変換をF14に、変換をF15に置き換えて出力するようにしています。
この表にないキーを親指キーとして使うためには、プログラムの若干の変更が必要になります。ただ、左右の親指キーの単独打鍵は日本語入力IMEに対する変換操作の指示でもあるため、親指キーとして使うキー(コード)を変更するときには、IMEのカスタマイズも関係してくることを意識しておく必要があります。
hoboNicolaアダプターは、コントローラとして使うマイコンと、USBやPS/2といったキーボードインタフェース回路を組み合わせたものです。物理的なキーボード側はUSBホストとしてふるまい、PCなどのホストと接続する側はUSBデバイスとしてふるまう必要があります。USBデバイスとしての機能を備えたマイコンを使ったArduinoボードやオリジナルのPCBと、MAX3421EEなどのUSBホストコントローラを組み合わせるのが一般的な構成方法です。
今まで動作を確認しているArduinoボードは以下のとおりです。ビルドのためには各ボード用のBSP (Board Support Package)あるいはコアパッケージの導入が必要です。
- AVR
- Arduino Leonardo (ATmega32u4 +5V/16MHz)
- SparkFun Pro Micro (ATmega32u4 +3.3V/8MHz and +5V/16MHz)
- SAMD21
- Adafruit QTPy SAMD21 (SAMD21E18)
- Seeed Studio XIAO SAMD21, Seeeduino XIAO (SAMD21G1)
- nRF52840
- Seeed Studio XIAO nRF52840
- SwitchScience ISP1807 Micro Board
- RP2040
- Seeed Studio XIAO RP2040
- Adafruit KB2040
- Raspberry Pi Pico
AVRやRP2040については、オリジナルPCBでの動作も確認しています。
hoboNicolaLibrary はArduinoのライブラリとして導入することを前提としています。
現在のところ以下の開発ツールでビルドできることを確認しています。
- Windows用のArduino(1.8.19)
- Visual Studio Code(1.80.0) Arduino-extension 0.6 とarduino-cliが導入済みであること。
- Arduino IDE (2.x.x) でもビルドできると思いますが確認していません。
いくつかのUSBホストコントローラー用の実装やキーボードPCB用の実装は Arduino スケッチ (.inoファイル) として examples ディレクトリに入っているので、ターゲットとするデバイスやマイコンに応じたスケッチを開き、別名で保存するところから、開発を始めることができます。
USBホストコントローラーごとに実装例を用意してあり、USBキーボード用の実装は4種類のマイコン(ATMega32U4, ATSAMD21, nRF52840 and RP2040)での動作を確認しています。AVR以外のマイコンを用いる場合、Adafruit TinyUSB ライブラリの導入が必須です。
- ch9350_hobo_nicola
- CH9350L をUSBホストコントローラーとして用いるアダプター用の実装です。現在のところ更新を停止しています。
- usb_hobo_nicola
- MAX3421EE (USB Host Shield) をUSBホストコントローラーとして用いるアダプター用の実装です。felis/USB_Host_Shield_2.0 に依存していますが、hoboNicola用の修正を加えた一式をhoboNicolaLibrary内に含んでいるので新たな導入は不要です。
- rp_hobo_nicola
- 専用のUSB-Hostコントローラを用いずRP2040単独で構成するアダプター用の実装です。この実装では、sekigon-gonnoc/Pico-PIO-USB と Adafruit_TinyUSB Library が必須です。
- ps2_hobo_nicola
- PS/2キーボード用アダプターの実装例でATMega32U4のみが対象です。
hoboNicolaLibraryを組み込んだ自作キーボード用の実装例です。RP2040を使ったキーボードでは、Adafruit TinyUSB ライブラリの導入が必須です。
- xd87
- XD87 PCB (https://kprepublic.com/) を使った自作キーボード用の実装です。ターゲットのマイコンは ATMega32U4 (+5V/16MHz) なので Arduino Leonardo または SparkFun Pro Micro をターゲットしてビルドします。このキーボードについては こちらを参照のこと。
- xd64
- XD64(ver3) PCB ver3 (https://kprepublic.com/) を使った自作キーボード用の実装です。ターゲットのマイコンはXD87と同じです。このキーボードについては こちらを参照のこと。
- nk60_hobo_nicola
- RP2040を載せたオリジナルPCBを使った自作60%キーボード用の実装です。ハードウェアについては、ブログの投稿を参照。
- nk80_rev2_hobo_nicola
- RP2040を載せたオリジナルPCBを使った自作80%キーボード用の実装です。 こちらを参照。
なお、hoboNicolaライブラリを自作キーボードに適用する際には、キーボードPCBの回路構成を知っておく必要があります。
アダプターやキーボードのフォトギャラリーはこちら 。
The hobo-Nicola library is firmware for hardware adapters that allow general Japanese USB keyboard to be used as "almost NICOLA keyboard". By using this library, you can get (almost) NICOLA layout kayboard. And at the same time, you can use simultaneous typing method with Thumb-shift keys according to the NICOLA standard. Adapters (USB-USB, PS/2-USB) that incorporate the hobo-Nicola library are called hobo-Nicola adapters, and their circuits are publicly published.
The hoboNicola adapter behaves as a USB HID keyboard when connected to a host such as PC. The adapter uses the HID Usage ID (keycode) received from the physical keyboard to change the layout and perform simultaneous keystroke processing, etc., and then sends the keycode to the host.
This library can be used not only for Japanese USB keyboards, but also as adapters for PS/2 interface keyboards and US layout keyboards. In addition, it is also possible to make the firmware of the keyboard itself. You can build the almost NICOLA keyboard by incorporating this library into the micro controller of the keyboard PCB.
The NICOLA keyboard is one of the keyboard standards for typing Japanese using PCs and WSs, established at the end of the 20th century. This standard inherits the input method of a dedicated word processor called ”OASYS", which had been manufactured by Fujitsu.
It features a unique key layout for typing the many Japanese kana and symbols with fewer keys. And it has a simultaneous typing method with the two Thumb-shift keys to select kanas, numbers and symbols from multiplexed keys.
For details, please refer to the following site (written in Japanese). http://nicola.sunicom.co.jp/spec/jisdraft.htm
Photo gallery of adapters and keyboards is here