@fujiy/wccp NPM

WASA Common Command&Telemetry Protocol

コマンドおよびテレメトリに用いる，統一されたシリアライズフォーマット．

コマンドやテレメトリのフォーマットを規定する．バイナリ形式でデータを表現することで，テキストフォーマットと比べてデータサイズを削減する．

パケットの内容についてはスキーマレス，すなわちパケットの定義を知らなくてもある程度はデコード可能とする．これにより各所でスキーマ定義を共有する手間を削減し，迅速な開発を可能にする．

CANやUARTを用いた有線通信，LoRa等による無線通信，SDカードへの記録等に用いる．バスによって接続された同一システム内におけるのローカルな情報のやり取りに加えて，無線等により連携した複数の独立したシステム間の通信にも用いる．

パケットを情報の単位とする．パケットはヘッダ部と，0以上32未満のエントリからなる．エントリの順序は保持されなければならない．

項目	サイズ	備考
種別	1 bit	`0`：コマンド，`1`：テレメトリ
パケット種別ID	7 bit	`0x7F`以外の値．基本的にASCIIコードにおける英数字
送信元システムID	3 bit	`0`: ローカル
送信元ノードID	5 bit	バス内におけるノードID（後述）
送信先システムID	3 bit	`0`：リモートに送信しない，`0b111`：ブロードキャスト
エントリ数	5 bit	エントリの数．パケットのバイト数ではない
シーケンス番号	8 bit	送信元ノード毎にインクリメントされる値

エントリはデータの種類を表すタイプと，データ自体であるペイロード部からなる．一つのパケットの中に同じタイプのエントリが含まれていてもよく，その場合は配列のように解釈すると便利である．

項目	サイズ
タイプ	1 byte
ペイロード	0~4 byte

ユーザーが指定するタイプは64~127の範囲の値，ASCIIコードでA~Z, a~zを基本とし，その下位6bitを用いる．上位2bitはペイロードのサイズ（バイト数）を表す．

上位2bitとペイロードのサイズの対応は

である．

ペイロードは0~4byteのリトルエンディアンのバイト列である．バイト列をどのデータ型として解釈するかは自由である．言い換えると，パケットのデータのみを見てデータ型を判別することはできず，別途スキーマを知っている必要がある．

データ型が何であるかにかかわらず，ペイロードの上位2あるいは3あるいは4 byteが0x00である場合には，そのバイトを省略してサイズを決定する．

標準でサポートする，ペイロードのデータ型を解釈する方法を以下に示す．

符号付き整数は２の補数，浮動小数点数はIEEE 754で定められた表現である． float16は半精度浮動小数点数（10進で約3桁の精度）である．

上述のパケットプロトコルを用いたバスについて規定する．

モジュール間をUARTでデイジーチェーン接続する．モジュールあたり2つのUARTを使用する．両端同士を接続してリング状にすることで信頼性を向上させる．

2 years ago