USBキーボードのキー出力表示
（ホストモード　HIDクラス）
（→プロジェクトファイル(Harmony Ver.2.04版 )　ダウンロード）

＜仕様＞
　・PIC32MZにUSBキーボードを接続して各キーの出力情報をキャラクタ液晶とTeraTermに表示すること。
　・接続するキーボードは、日本語109キーボードとする。
　・PICに接続するキャラクタ液晶はI2Cインターフェースの液晶とする。
　・PIC-PC間のUARTは以下とする。
　　　通信速度：9600bps、データ長：8ビット、パリティ：なし、ストップビット：１、フロー制御：なし
　・キャラクタ液晶には下記を表示のこと。
　　①PIC立ち上がり完了：
　　　　　　1行目：　USB device HID
　　　　　　2行目：　Keyboard demo
　　②USB初期化完了：　
　　　　　　1行目：　Please Connect
　　　　　　2行目：　Keyboard !!
　　③各キーデータ取得時：
　　　　　　1行目：　取得キーコード（0x　+　16進数表示）　　　例：　0x04 　0xFFFFFF89
　　　　　　2行目：　
　　　　　　　　図形表示キーの場合：　既定の図形　　例：　abcd... ABCD...　1234　!"#$<>?\...　　　　　　
　　　　　　　　機能キーの場合：　キーボードに記載してある文字　または機能がわかる文字
　　　　　　　　　　　　　　　　　　　　　　例：　Esc　Kanji(半角/全角 漢字キー）　PrintScreen　Enter　10key Enter　F1

　・TeraTermには下記を実施のこと。
　　①USB初期化完了：　***Connect Keyboard***　を表示する
　　②USBキーボードの接続を検出した場合：　---Keyboard Connected---　を表示する。
　　③図形表示キー：　打鍵されたキーに対応する図形 （例：　 abcd... ABCD...　1234　!"#$<>?\...）　
　　④メインキーのEnterが打鍵された場合：　改行と復帰を行う
　　⑤　④を除く機能キー：　キーボードに記載してある文字　または機能がわかる文字（代用文字）を表示すること　
　　　　　　　　　　　　　　　　　　（例：　Esc　Kanji(半角/全角 漢字キー）　PrintScreen　Enter　10key Enter　F1）
　　　　　　　　

＜回路図＞（→PDFファイル）

＜外観＞PIC32MZ評価ボード（→購入方法）を使った実験品の外観です。
　　　　　　　汎用モジュール評価ボード（段積みボード）には本テーマと関係ない部品が多々実装されています

＜キーボード用USBコネクタ接続部の詳細＞

＜動作結果＞（→　　動画　：1080ｐのHD動画を見ることができます。）　

	分類	シフト 操作	例			備考
			表示図形 (代用文字)	キーコード keyCode	TeraTerm と　キャラクタ液晶の画像例
①	アルファベットの 　　　小文字  abcdefghijklmn opqrstuvwxyz	無	a	0x04
②	アルファベットの 　　　大文字 ABCDEFGHIJKLMN OPQRSTUVWXYZ	有	A	0x04
③	数字 12456789	無	1	0x1E
④	記号 !"#$%&'()	有	！	0x1E
⑤	機能 Esc、Tab、Caps Lock、 Back Space、Insert Delete、End、Page Up、 Page Down、Print Screen 他	無関係	Esc	0x29
⑥	テンキー系 NumLock、1234567890 /*-+. Enter	無	10Key Enter	0x58
⑦	日本語系 半角/全角　漢字 無変換、変換 カタカナ　ひらがな　ローマ字	無関係	Muhenkan	0xFFFFFF8B

　以下は、サンプルプログラムで使用した各キーのキーコード(keyCode)一覧表です。　尚、灰色のセルはサンプルプログラム
（Harmony v.2.04のライブラリ）の中の変数keyCodeでは呼び出せなかったキーです。　
　　下表のキーボードは日本語109キーボードです。　英語101キーボードをはじめキーボードにはたくさんの種類があります。キーボードにより
　キーコードはかなり異なるので他のキーボードを使用する場合は注意が必要です。

＜解説＞ 以下に、記載してある内容は要点だけです。　詳細はプロジェクトファイルを精読願います
　　 　　　　（以下は、Harmony v2.04 をもとに作成しています。最新のバージョンとは異なることがあるかもしれませんので注意してください。）
　　
■　MHC設定
　　■ Options　

項目	①Config設定 Device & Project Configuration 　 > PIC32MZ2048 Device Configuration	②Heap Size設定 Device & Project Configuration 　>Project Configuration >XC32(Global Opton) 　>XC32-ld >General	③USB Library設定 Harmony Framework Configuration 　> USB Library
MHC
備考	デフォルトからの変更要領： 　FPLLIDIV: DIV3 　FPLLICLK: PLL_POSC 　POSCMOD: EC システムクロック周波数：　200MHz 外部 　主発振器：　24MHz #pragma config FNOSC = SPLL #pragma config POSCMOD = EC #pragma config FPLLIDIV = DIV_3 #pragma config FPLLICLK = PLL_POSC #pragma config FPLLMULT = MUL_50 #pragma config FPLLODIV = DIV_2	デフォルトからの変更要領： 　Heap Size(byte): 4096	デフォルトからの変更要領： 　□Use USB Stack? チェック追加 　□USB Host 　チェック追加 　Host Max Interface Per Deice: 5 　□USE　HID Host Client Driver: チェック追加 　□Use HID Host keyboard driver: チェック追加
項目	④I2C設定 Harmony Framework Configuration 　> Drivers
MHC
備考	デフォルトからの変更要領： 　□USE I2C Driver? チェック追加 　I2C Module ID: I2C_ID_2 　I2C CLOCK FREQUENCY(Hz): 100000

　　■Pin Settings

項目	ポート設定（その１）	ポート設定（その2）
MHC
備考	デフォルトからの変更要領： UARTポート設定 RC2:　U6TX RG9:　U6RX	デフォルトからの変更要領： I2Cポート設定 RA2：　SCL2 RA3：　SCLA

■ I2Cインターフェースのキャラクタ液晶表示ライブラリの追加要領
　　キャラクタ液晶表示のライブラリ　lcd_ACM1602_lib_i2c.h　と　lcd_ACM1602_lib_i2c.cを　main.cと同じフォルダにコピーして、
　プロジェクトに追加します。
　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　　（使い方　→　I2Cインターフェースキャラクタ液晶表示制御 参照）

　　プロジェクトへの追加は以下のようにします。

■app.hに、青字部の修正、追加をします。

　①APP_STATESの列挙型変数を以下のように変更します。
　　typedef enum
　　{
　　　　/* Application pixels put*/
　　　　APP_STATE_INIT=0,
　　　　APP_STATE_OPEN_HOST_LAYER,
　　　　APP_STATE_WAIT_FOR_HOST_ENABLE,
　　　　APP_STATE_HOST_ENABLE_DONE,
　　　　APP_STATE_WAIT_FOR_DEVICE_ATTACH,
　　　　APP_STATE_DEVICE_ATTACHED,
　　　　APP_STATE_READ_HID,
　　　　APP_STATE_DEVICE_DETACHED,
　　　　APP_STATE_CHANGE_DEVICE_PARAMETERS,
　　　　APP_USART_STATE_DRIVER_OPEN,
　　　　APP_USART_STATE_CHECK_FOR_STRING_TO_SEND,
　　　　APP_USART_STATE_DRIVER_WRITE,
　　　　APP_STATE_ERROR
　　} APP_STATES;

　②構造体APP_DATAのメンバーを以下のように変更します。
　　typedef struct
　　{
　　　　/* USB Application's current state*/
　　　　APP_STATES state;

　　　　/* USART Application task state */
　　　　APP_STATES usartTaskState;

　　　　/* Unique handle to USB HID Host Keyboard driver */
　　　　USB_HOST_HID_KEYBOARD_HANDLE handle;

　　　　/* Unique handle to USART driver */
　　　　DRV_HANDLE usartDriverHandle;

　　　　/* Number of bytes written by the USART write*/
　　　　uint32_t nBytesWritten;

　　　　/* Size of the buffer to be written */
　　　　uint32_t stringSize;

　　　　/* Buffer used for USART writing */
　　　　uint8_t string[64];

　　　　/* Holds the current offset in the string buffer */
　　　　uint16_t currentOffset;

　　　　/* Flag used to determine if data is to be written to USART */
　　　　bool stringReady;

　　　　/* Flag used to select CAPSLOCK sequence */
　　　　bool capsLockPressed;

　　　　/* Flag used to select SCROLLLOCK sequence */
　　　　bool scrollLockPressed;

　　　　/* Flag used to select NUMLOCK sequence */
　　　　bool numLockPressed;

　　　　/* Holds the output Report*/
　　　　uint8_t outputReport;

　　　　/* Application current data buffer */
　　　　USB_HOST_HID_KEYBOARD_DATA data;

　　　　/* Application last data buffer */
　　　　APP_DATA_LAST_DATA lastData;

　　　　} APP_DATA;

　　以下、app.h

■app.cに、青字部の修正、追加をします。

　　①　MHCが作成したapp.cを修正するより、マイクロチップのサンプルソフトhid_basic_keyboardのapp.c
　　　（ "C:\microchip\harmony\v2_04\apps\usb\host\hid_basic_keyboard"）を修正した方が
　　　簡単なので　app.cを入れ替えます。


　　②インクルードファイルを追加します。stdio.hがないと、sprintf( )がコンパイラのバージョンによってコンパイルでエラーが
　　　　でることがあります。
　　#include "stdio.h"


　　③キャラクタ液晶制御のバッファーを定義します。　またキャラクタ液晶とTeraTermに表示する文字列も定義します。
　　char Buf[32];
　　char strUART[16];
　　char moji_Esc[] = "Esc";
　　char moji_Tab[] = "Tab";
　　char moji_Enter[] = "Enter";
　　char moji_BackSpace[] = "Back Space";
　　char moji_CapsLock[] = "Caps Lock";
　　……
　　……
　　char moji_F10[] = "F10";
　　char moji_F11[] = "F11";
　　char moji_F12[] = "F12";
　　char moji_10keyEnter[] = "10key Enter";


　　④NOP()による遅延関数　delay_us( )、delay_ms( )を定義しておきます。
　　int delay_Clock = 200000000; //200MHz

　　void delay_us(volatile unsigned int usec) //1μsec遅延
　　{
　　　　volatile int count;

　　　　count = (int)(delay_Clock/20000000)*usec;
　　……
　　……


　　⑤　keyValueに係るコメントを追加しただけです。　PICの制御には無関係です。
　　/* Usage ID to Key map table */
　　const char *keyValue[] =
　　{
　　　　……
　　　　……
　　}

　
　　⑥　USB初期化に際して、APP_Tasks( )から呼び出されます。
　　void APP_USBHostHIDKeyboardEventHandler(USB_HOST_HID_KEYBOARD_HANDLE handle,
　　USB_HOST_HID_KEYBOARD_EVENT event, void * pData)
　　{
　　　　switch ( event)
　　　　{
　　　　　　case USB_HOST_HID_KEYBOARD_EVENT_ATTACH:
　　　　　　appData.handle = handle;
　　　　　　appData.state = APP_STATE_DEVICE_ATTACHED;
　　……
　　……
　　｝


　　⑦　英数字が打鍵された場合、キャラクタ液晶やTeraTermに文字を表示するための補助関数です。　
　　void ys_Char(USB_HID_KEYBOARD_KEYPAD _keyCode) //英数文字キー
　　{
　　　　//I2Cキャラクタ液晶表示
　　　　lcd_ACM1602_cmd_i2c(0x80); //1行目の先頭へ
　　　　sprintf(Buf,"key=0x%02X ",_keyCode);
　　　　lcd_ACM1602_str_i2c(Buf);

　　　　lcd_ACM1602_cmd_i2c(0xC0); //2行目の先頭へ
　　　　sprintf(Buf,"%c ",appData.string[appData.currentOffset]);
　　　　lcd_ACM1602_str_i2c(Buf);
　　}


　　⑧　記号が打鍵された場合、キャラクタ液晶やTeraTermに文字を表示するための補助関数です。
　　　　対象の記号キーは　keyCodeが　16進表示で0x〇〇と表示できるキーです。
　　void ys_Char_0xXX(USB_HID_KEYBOARD_KEYPAD _keyCode, char myChar) //一般記号文字キー
　　{
　　　　……
　　　　……
　　}


　　⑨記号が打鍵された場合、キャラクタ液晶やTeraTermに文字を表示するための補助関数です。
　　　　対象の記号キーは　keyCodeが　16進表示で0xFFFFFF〇〇と表示できるキーです。 具体的には　\ と　_　の場合です。
　　void ys_Char_0xFFFF(USB_HID_KEYBOARD_KEYPAD _keyCode, char myChar) //特別扱い文字キー：　　\　_
　　{
　　　　……
　　　　……
　　}


　　⑩エンターキーが打鍵された場合、キャラクタ液晶やTeraTermに文字を表示するための補助関数です。
　　void ys_Function_Enter(USB_HID_KEYBOARD_KEYPAD _keyCode) //エンターキー
　　{
　　　　……
　　　　……
　　}


　　⑪一般機能キー（Esc、Tab、ファンクションキーなど）が打鍵された場合、キャラクタ液晶やTeraTermに文字を
　　表示するための補助関数です。
　　void ys_Function_0xXX(USB_HID_KEYBOARD_KEYPAD _keyCode, char* str0) //一般機能キー
　　{
　　　　……
　　　　……
　　｝


　　⑫特別扱い機能キー（"カタカナ" "変換" "無変換"キー）が打鍵された場合、キャラクタ液晶やTeraTermに文字を
　　　表示するための補助関数です。
　　　void ys_Function_0xFFFF(USB_HID_KEYBOARD_KEYPAD _keyCode, char* str0) //特別扱い機能キー //"カタカナ" "変換" "無変換"
　　{
　　　　……
　　　　……
　　｝


　　⑬シフトしない場合の　各キー毎の分岐をおこなう関数です。
　　void ys_NonShift_MapKey(USB_HID_KEYBOARD_KEYPAD keyCode, uint8_t outputReport) //非シフトモードのキーマップ関数
　　{
　　　　……
　　　　……
　　｝


　　⑭シフトした場合の　各キー毎の分岐を行う関数です。
　　void ys_Shift_MapKey(USB_HID_KEYBOARD_KEYPAD keyCode, uint8_t outputReport) //シフトモードのキーマップ関数
　　{
　　　　……
　　　　……
　　｝

　　⑮取得したキーコードを最初に分岐させる関数です。
　　void APP_MapKeyToUsage(USB_HID_KEYBOARD_KEYPAD keyCode) //keyCode: 打鍵キーコード
　　｛
　　　　……
　　　　……
　　｝


　　⑯PICが立ち上がったらキャラクタ液晶に"USB device HID" と "Keyboard demo"　を表示しています。
　　　void APP_Initialize ( void )
　　{
　　　……
　　　……
　　　lcd_ACM1602_cmd_i2c(0x80); //1行目の先頭へ
　　　lcd_ACM1602_str_i2c("USB device HID ");

　　　delay_ms(1000);

　　　cd_ACM1602_cmd_i2c(0xC0); //2行目の先頭へ
　　　lcd_ACM1602_str_i2c(" Keyboard demo ");


　　⑰UARTに　表示データを送信しています。　APP_Tasks( ) １サイクル毎に最後で呼ばれています。
　　void APP_USART_Tasks(void)
　　｛
　　　　……
　　　　……
　　｝

　　⑱　APP_STATE_INIT　は、USB初期化に際し一度だけ呼ばれます。
　　void APP_Tasks ( void )
　　｛
　　　　 switch ( appData.state )
　　　　{
　　　　　　/* Application's initial state. */
　　　　　　case APP_STATE_INIT:


　　⑲　USBの初期化が完了して、キーボード用USBコネクタの接続待ちのステートです。　キーボード用のUSBコネクタが
　　　　途中で抜かれた場合　このステートでの待ちとなります。
　　　　case APP_STATE_HOST_ENABLE_DONE:


　　⑳　キーボード用のUSBが接続された時に通過するステートです。この後キーボードとの送受信ステートAPP_STATE_READ_HIDに
　　　　移行します。
　　　　case APP_STATE_DEVICE_ATTACHED:


　　(21) キーボードとの送受信ステートです。　このステート内で複数回キーボード情報を取得します。　すなわち　APP_Tasks( )
　　　　　１サイクルの中で複数回のキーボード情報が取得されます。
　　　　case APP_STATE_READ_HID:

　　（22）APP_Tasks( ) １サイクルの最後に　APP_USART_Tasks( )が呼ばれ　UARTへの送信が行われます。
　　　　 /* Call the USART task routine */
　　　　APP_USART_Tasks(); //UART]側に送信


以下、app.c