マイクロリードラインを備えたマイクロコントローラーコンソール

マイクロコントローラーのさまざまな種類の組み込みグランドでコンソールインターフェイスを整理するように設計されたmicrorlライブラリ（ github ）を紹介します。

なぜMKでコンソールが必要なのですか？

テキストベースのコンソールインターフェイスには、すべてのパワーとシンプルさを備えた組み込みシステムの利点がいくつかあります（結局、テキストはLEDとは異なり、それ自体を物語っています！）。

• 比較的少ないMKリソースと最小限のハードウェアコストが必要です-UARTなどのシリアルインターフェイスまたはMKで利用可能な他のデバイス、組み込みUSBまたは外部USB-Comアダプター、またはマイクロコントローラーが非常に深刻な場合はTCPでもかまいません。
• 接続に便利-Com-port（Windowsの場合はパテ、Linuxの場合はminicom）をサポートする端末で十分です。
• 使いやすい-ターミナルへのカラー出力、自動追加のサポート、ホットキー、入力履歴。

そのため、ライブラリは現在以下をサポートしています。

• vt100端末の基本機能（ほとんどの端末エミュレーターがサポートしています）
• 機能をオン/オフしてメモリを節約できる構成ファイル（MKの場合は非常に重要です）。
• HOME、END、カーソルキー、バックスペースを理解します。
• ホットキーを理解している^ U ^ K ^ E ^ A ^ N ^ Pなど
• ナビゲーションの上下矢印とホットキーを使用した入力履歴
• 自動補完（自動置換？）

私は、Linuxのgnu readlineに類似したライブラリ、つまり、 端末の入力、文字列の処理、端末の制御シーケンスなどを担当する部分 主な目標は、コンパクトさ、使いやすさ、快適な作業に必要な最小限の機能です（大きなPCではなく、数十から数百KBのメモリを備えた小さなMKについてです）。

理論のビット

このトピックでは、ターミナルエコノミーの歴史と特徴について少し説明しましたが、 これについては繰り返しませんが、作業の原則について簡単に説明します。



ユーザーの観点から見ると、すべては端末で始まり、端末で終わります。これは、Wikipediaが言うように、 「端末は入力/出力デバイスであり、その主な機能はデータの表示と入力です。 」 gnome-terminal、rxvt、putty、minicomなど、さまざまな機能を備えたすべてのプラットフォーム用のターミナルエミュレータが多数あります。



ユーザーがキーボードのボタンを押すと、ターミナルはそれらを任意のチャネルを介してデバイスまたはシステムに送信し、画面に印刷するための文字を返します。 単純なテキスト文字に加えて、制御コードとサービス情報を送信するためにESCシーケンスが両側に送信されます。たとえば、キーボードから特別なコードが送信されます。 キー（Enter、カーソル、ESC、Backspaceなど）。 シーケンスは画面に戻り、カーソル位置の制御、画面のクリア、改行、文字の削除、色、フォントタイプの制御などを行います。



ESCシーケンスは、一般に、コード27のESC文字で始まり、その後に多数の印刷または非印刷文字で構成されるシーケンスコードが続くバイトのシーケンスです。 vt100端末の場合、コードは、たとえばここにあります 。 制御コードは、0〜31のコードを持つ印刷不能文字です（32は最初のASCII文字のコード-スペース）。



デバイス内のプログラム（コマンドラインを担当する部分）は、文字とシーケンスを受信し、ユーザーが入力した内容をコマンドラインバッファーに形成し、この行をターミナルに表示します（ローカルターミナルエコーをオフにする必要があります）。 デバイスは画面にテキストとESCシーケンスを印刷して、カーソル、色、カーソル位置、および「カーソルから行末までテキストを削除」などのコマンドを制御します。 実際、これはライブラリの主なタスクです-メモリと端末画面に行を作成し、ユーザーがそれを編集（行の任意の文字を削除、それに沿って移動など）できるようにし、適切なタイミングで高次インタープリターに処理のために渡します。



優れたコンソールには、入力の履歴が必要です。また、おそらく、より多くの自動アドオンが必要です。これがなければ、端末での操作はそれほど快適ではありません。

内部デバイス

ライブラリを使用するアプリケーションのアーキテクチャを検討してください。





図は、microrlとユーザーアプリケーションの相互作用のブロック図を示しています。 青い矢印は、イベントの発生時に呼び出されるコールバック関数を示し、緑の矢印は、実際にはすべての作業が行われるライブラリ関数の呼び出しを示します。



使用する前に、3つのコールバック関数（青）をインストールする必要があります。

void print (char * str); //      int execute (int argc, char * argv[]); //     ENTER char ** complete (int argc, char * argv[]); //     TAB
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

完全な機能はオプションです。リソースを節約するために、一般的に構成ファイルで自動補完を無効にできます。

入力ストリーム

ユーザーアプリケーションは、ターミナルから文字を受信し（シリアルインターフェイス：UART、usb-cdc、tcp-socketなど）、関数を呼び出してライブラリに転送します（緑色の矢印）：

 void microrl_insert_char (char ch);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ESCシーケンスとカーソルの移動、Tab、Enter、Backspaceなどの操作を行う制御文字は、入力ストリームから抽出および処理され、キーボードから入力された残りの文字はコマンドラインバッファーに配置されます。

実行する

ユーザーがEnterキーを押すと（入力シーケンスで0x10または0x13コードが検出されます）、コマンドラインバッファーは「トークン」（スペースで区切られた単語）に分割され、 argcのこれらの単語の数とargvポインターの配列で実行関数が呼び出されます。



argv []配列の単語はNULLで終了します。つまり、通常の文字列関数を使用できるため、デスクトップアプリケーションのメイン関数のパラメーターを処理するのと同じくらい簡単で便利です。 すべてではありませんが、多くの人がこの技術に精通しているか、 情報を簡単に見つけることができます。



RAMを節約するために、入力されたすべてのスペースは文字 ' \ 0 'に置き換えられ、端末への出力はスペースに置き換えられます。 このため、トークンの先頭へのポインタを「収集」するだけで十分であり、すべてが自動的にNULLで終了するため、コマンドラインの入力と保存、および処理に1つのバッファを使用できます。







コマンドの処理は、ライブラリユーザーによって実行関数で実行されます。実際、これはシェルですが、このフレーズを恐れないでください。D、通常のif-else if-elseが最も単純なシェルです。

 /*    "help", "mem clear"  "mem dump"*/ int execute (int argc, char * argv[]) { int i = 0; if (!strcmp (argv[i], "mem")) { i++; if ((i < argc) && (!strcmp (argv[i], "dump"))) { mem_dump (); } else if ((i < argc) && (!strcmp(argv[i], "clear"))) { mem_clear(); } else { printf ("\"mem\" needs argument {dump|clear}\n"); } } else if (!strcmp (argv[i], "help")) { print_help (); } else { printf ("%s: cmd not found\n"); } return 0; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

完全な自動アドオン

ユーザーが自動アドオンを希望する場合は、Tabキーを押します。これは、コンソールを操作するすべてのユーザーにとって永続的な習慣です。 ここでも、集計コードがキャッチされたときに同じことを行います-再びargvのポインターで行を切り取りますが、行全体ではなく、最初からカーソルまでのセクションのみを切り取ります（通常、カーソルの下の単語を補完しますか？）。 同じint argcとchar * argv []がコールバックcompleteに渡されます。1つのトリックがあります。カーソルが空白の場合、新しい単語を開始します。 具体的な何かを補足するものではないようです。この場合、空の文字列は最後のargv [argc-1]要素にあります。

なぜこれが必要なのですか？ オートコンプリートのコールバック関数で、ユーザーが既に入力したコマンドと、特定の何かを完了しているかどうかを明確にするため、または単にタブをクリックして使用可能なコマンドを表示します。 ご覧のとおり、真に「スマート」な追加を行うためのすべてが揃っています。これは、成人用コンソールよりも悪くありません。



重要!! 配列の最後の要素は常にNULLでなければなりません！

最初の要素でNULLを返す場合（[NULL]）-これは、追加のオプションがないことを意味します。

NULL（["help"] [NULL]）の前に配列の前に要素が1つある場合-オプションが1つしかないことを意味し、完全に置き換えられます。

配列に複数の要素がある場合（["clean"] ["clear"] [NULL]）-単語の一般的な部分のみが補完されます（存在する場合）。

入力履歴

十分なRAMがある場合は、構成に入力履歴のサポートを含めてください。使いやすさが向上します。 お金を節約するために、リングバッファが使用されます。そのため、覚えられる最後のコマンドラインの長さは言えません。長さによって異なります。 履歴内の検索は、上/下矢印またはホットキーCtrl + n Ctrl + p（bashで試してください！）を使用して、通常どおり実行されます。 単純に機能します。メッセージが順番にバッファにコピーされ、スペースがない場合は、表示されるまで古いメッセージを削除し、行がメモリにコピーされ、最後のメッセージへのポインタがその後にシフトされます。 バッファの最後に到達すると、0を飛び越えて円を描きます。

資源

アプリケーションにコンソールを実装するために必要なのは、小さなメモリとシリアルの双方向インターフェースです。UART（USB-RS232コンバーター経​​由を含む）、usb-cdc、シリアルcom-portプロファイルを備えたワイヤレスbluetooth-serialモジュール、tcpソケットなどを使用できます。 、PCとコントローラー間で接続でき、ターミナルエミュレーターが機能するすべての機能。



メモリについては、Atmega8（8ビット）コントローラー（例はソースにあります）およびARM7コアのAT91SAM7S64（16/32ビット）コントローラーの-0s最適化を使用してGCCですべてを収集しました。 比較のために、2つのバージョンで収集しました：削除されたバージョン-自動追加なし、カーソル矢印の入力と処理の履歴なし、完了、これが結果です

  ARM AVR  1,5 1,6  3,1 3,9
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

16/32ビットARMコアがAVRを実行していることに注目してください！

測定はライブラリ自体に対してのみ行われ、USART処理（RMのUSB-CDC）も通訳も考慮されていなかったと言わなければなりません。 これはシェルです。

AVRのソースの例では約6 KBのフラッシュ（8つのうち）が必要ですが、ライブラリの機能には「包括的」なものがあります。4に絞り込むことができます。しかし、コントローラーのメモリ量は飛躍的に増加しているため、128または512KBのフラッシュを搭載したSTまたはNXP MKを使用しているユーザーを驚かせることはありません。



RAMについては、すべてがシンプルで、ライブラリには内部変数に〜30バイトが必要です。さらに、コマンドライン用のバッファーが必要です-設定で長さを決定し、入力履歴用のバッファーが必要です（ただし、この実装では256バイト以下） 。

ユースケース：

デバッグソフトウェア 。 他のデバイス/システム/プロトコルからイベントをエミュレートすることにより、ロジックとアルゴリズムをデバッグし、パラメーターを変更し、経験値を選択できます。

 #   > print status state machine: receive #    > set low_value 23 #   > set speed 9200 > send_msg 23409823 #   > map dump 0 8 0x40 0x0 0x0 0x0 0x34 0x12 0xFF 0xFF #     > rise_event alarm #   > calc_crc16 0x92A1
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

デバイス構成 CLIを介したパラメーターの設定は、バイナリデータの書き込みよりも簡単です。追加のユーティリティは不要で、特別なインターフェイスは必要ありません。 端末とCOMポート（アダプターを介した仮想ポートを含む）を備えたPCで実行されます。 ユーザー（多く）は、必要に応じてCLIを使用できます。

 #   > set phone_0 8952920xxxx > set dial_delay 150 > set alarm_level low > set user_name Eugene > set temperature 36 > print config 0 phone: 8952920xxxx dial delay: 150 ms alarm level: low user name: Eugene temperature: 36
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

モニタリング リクエストに応じて、サブシステム、バッファ、またはカウンタのデータを印刷できます。

 #     1  4   > print ADC_val 1 4 121, 63, 55, 0 #    > get operation_count 87 #   > print stat statistics: counted 299 pulse, smaller is 11 ms, longer is 119 ms
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

インタラクティブなデバイス管理 。 リレーをオンにし、頭を30度回転させ、カメラの電源を入れ、左に足を踏みます。 Bluetoothシリアルモジュールを使用すると、コンソールからモバイルロボットを操縦できます。 その考えは明確だと思います。



さらに、パスワードまたはワンタイム/ N回のアクセスを使用して承認を整理できます。

そしてもちろん、ターミナルの擬似グラフィック！ 「コンソール」という文字通りの意味でのゲーム機！ ：D



ご覧のとおり、このようなインターフェイスは、メインのインターフェイスではなく、デバッグ、構成、または複製のように、非常に不適切な場合があります。

叙情的な余談

ライブラリを記述するというアイデアは、lircの複雑なインフラストラクチャの代わりとして、USB IRレシーバーIRinを作成したときに生まれました。 私のUSBドングルは、システム内に特別なドライバーなしで/ dev / ACM0として定義されています。これは本質的に仮想COMポートです。 リモートコントロールボタンを押すと、ドングルはAsciiに 「 NEC 23442 」という形式の文字列-押したボタンのコードをポートに送信します。 ボタンの処理は非常に簡単です。通常のbashスクリプトは、ボタンコードによる大きなスイッチで/ dev / ACM0を読み取ります。

いいね！ 他に何が必要ですか？ シンプルで便利、複雑な設定も、lircもありません。 しかし、どういうわけか、ポートから「 NEC D12C0A 」の代わりに文字列「 VOLUME_UP 」を取得したかった...しかし、デバイスにボタンが1つしかなく、それがまだ使用されていない場合の対応の設定方法 とても簡単です！ minicomターミナルエミュレータを介して仮想com-port " / dev / ACM0 "を開きます

 $minicom -D /dev/ACM0 -b 115200
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コンソールを入手してください！ 次に、コマンドを入力します。

 > set_name VOLUME_UP #      .
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ボタンのエイリアスはAT24C16 2KB EEPROMに保存されます。 さらに、リモコンのボタンを押したときに繰り返し押す速度などのパラメーターがあります。 次のコマンドでインストールできます。

 > repeat_speed 500
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

まだできる

 > eeprom print 1 60 #        1  60
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

まあ、楽しいチーム

 > eeprom format #     
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

おわりに

近い将来、Arduino SDKのライブラリを作成します。

例についてはソースを参照してください。unix*およびAVRの例があります。 AVRの場合は、hexファイルをダウンロードしてフラッシュし、試してみてください！ このアプリケーションでは、ポートPORTBおよびPORTDの入力/出力ラインを有効/無効にすることができます。



おもしろかったですね：D

ご清聴ありがとうございました！



github github.com/Helius/microrlへのリンク