Parser
シリアル電文パーサーの利用例
TWELITE 無線マイコンから UART (シリアルポート)経由での電文書式を解釈します。電文書式は、可読性・エラー検出などを目的として、伝送したいデータ列に対して所定の変換を行います。
ここではアスキー形式の解釈を行うAsciiParser
について解説します。
アスキー形式
アスキー形式は、バイナリで構成されたデータ列を文字列で表現する方法です。TWELITE無線マイコンでは最も良く用いられる形式です。
例えばバイト列で 00A01301FF123456
をアスキー形式で表現すると、以下のようになります。先頭は :
で B1
がチェックサム、終端は [CR:0x0d][LF:0x0a]
となります。
:00A01301FF123456B1[CR][LF]
終端のチェックサムを省略できます。チェックサムからCRLFの系列をX
に置き換えます。文字化けによる誤ったデータ系列には弱くなりますが、実験などでデータを送付したいときに便利です。
:00A01301FF123456X
定義
AsciiParser の使用方法
オブジェクトの生成
上記の例では parser_ascii
というオブジェクトを内部バッファ256バイトで生成しています。このバッファサイズは、書式の解釈後に必要なバイト数です。
ASCII形式では実際のバイト数の約2倍の書式になります。例えば書式が200バイトの系列の場合は、実データは約100バイトになります。
無線パケットの最大格納バイト数が100バイト強であるため、この例では余裕をもって256バイトのバッファとしています。
バイト列の解釈
このAsciiParserは1バイトずつの処理を行います。シリアルポートからは1バイトずつデータが到着するためです。
上記例では、シリアルポートから1バイト読み出してはparse_acsii
に1バイトずつ<<演算子を用いて読み込ませています。
直後のif(pars_ascii)
での判定は、アスキー形式の系列が正しく解釈できたかどうかを判定しています。
データ列の取り出し
解釈済みの系列はget_payload()
メソッドにて取得できます。get_payload()
はSmplBuf_Byte
の参照型を戻します。
以下のように配列にアクセスできます。
ASCII書式での出力
Parser
オブジェクトにデータ列が格納されている場合、>>
演算子を用いることで書式をシリアルポート(Serial
)やターミナル(ITerm
)などに出力することが出来ます。
通常は、解釈用のParser
オブジェクトと出力用のParser
オブジェクトは別々に用意します。
解釈用のオブジェクトはシリアル入力など都度処理が行われます。このオブジェクトを一時的なデータ出力の目的で使用すると、解釈中の内部データが破壊されます。
データ列の識別と対応オブジェクトの取得
パケットの生成
newTwePacket()
は入力されたデータ系列を解釈して、spTwePacket
型のオブジェクトを生成します。このオブジェクトはTwePacket
型のデータを格納するスマートポインタstd::shared_ptr
で、メモリ管理を簡素化することができます。
パケット種別はE_PKT
列挙体で定義されています。ここではTWELITE PALの出力形式PKT_PAL
の解釈を行います。
std::shared_ptr
の利用は、パケット情報を他にコピーして利用する場合を想定しています。例えば履歴配列に保存して、過去の情報を参照するような場合です。
オブジェクトは参照カウンタにより管理されていて、所有者が0になれば破棄されます。
解釈されたパケットの種別はidentify_packet_type()
により判別します。パケット種別はE_PKT
列挙体で定義されています。
PALパケットの解釈
解釈したパケットがE_PKT::PKT_PAL
と判定された場合は、refTwePacketPal()
によりTwePacketPal
型として参照できます。上記コード例ではユニバーサル参照auto&&
を用いて型名を推測させています。
PALボード種別解釈
PALのボード種別に応じたオブジェクトを生成して、ボード種別特有のデータにアクセスすることが出来ます。
上記の例では、MAG(OPEN-CLOSE SENSE PAL)のオブジェクトmag
を生成しています。ここではオープンクローズに応じた分岐にmag.u8MagStat
を読み出しています。
最終更新