アスキー書式の解釈を行うパーサーですが、TWESYS::TimeOutクラスをベースクラスに持つことで、タイムアウト処理を行っています。

メソッド

AsciiParser() - コンストラクタ

AsciiParser(size_t maxbuffsiz)
AsciiParser(SmplBuf_Byte& bobj)

パーサーオブジェクトを生成します。

生成時のパラメータにmaxbuffsizを与えると、maxbuffsizをバッファサイズとして動的にメモリ確保して、パーサーを初期化します。

あらかじめ生成されたSmplBuf_Byte配列bobjを参照して、パーサーを初期化することもできます。

_u8Parse()

uint8_t AsciiParser::_u8Parse(char_t u8byte)

アスキー書式の解釈アルゴリズムを実装します。バイトの入力のたびにタイムアウトのチェックを行います。

_vOutput()

void AsciiParser::_vOutput(TWEUTILS::SmplBuf_Byte& bobj, TWE::IStreamOut& p)

書式出力を行います。s_Output()メソッドを呼び出します。

s_Output(), vPutByte()

static void vPutByte(uint8_t u8byte, uint8_t* pu8lrc, TWE::IStreamOut& p)
static void s_vOutput(TWEUTILS::SmplBuf_Byte& bobj, TWE::IStreamOut& p)

vPutByte()は、ストリームに対して与えられたバイトu8byteをアスキー２文字で出力します。例えば0x9Aであれば"9A"という２バイト文字になります。

s_vOutput()は、ストリームに対して、与えられたバイト配列SmplBuf_Byteのバイト列をアスキー形式で出力します。

パーサーオブジェクトに１バイトずつ電文を投入することで、電文系列を解釈する状態遷移マシンです。

メソッド

Parse(), operator << ()

IParser& Parse(uint8_t u8b)
IParser& operator << (char_t c)

パーサーに１バイト入力します。入力のたびにパーサーの状態が変化し、パーサーの解釈が完了するとstate()がE_TWESERCMD_COMPLETEに変化し解釈完了状態となります。

state()

uint8_t state()

パーサーの状態を取得します。

operator bool(), is_complete()

operator bool()
bool is_complete()

パーサーの状態がE_TWESERCMD_COMPLETEの場合trueになります。

length()

uint16_t length()

パーサーで解釈済みのバイト列のデータ長を返します。

operator[]()

uint8_t operator[](int i)

パーサーの解釈済みのバイト列にアクセスします。

get_payload()

SmplBuf_Byte& get_payload()

パーサーの解釈済みのバイト列を格納した配列クラスSmplBuf_Byteを参照します。

set_payload()

template <typename T>
inline void set_payload(T& bobj)

inline void set_payload(uint8_t *b, uint8_t *e)

//例: buffに出力書式を格納する
AsciiParser format_ascii; // パーサー（出力用）
SmplBuf_ByteSL<256> buff; // 出力バッファ
uint8_t buff_raw[] = "ABCDE"; // データ列

format_ascii.set_payload(buff_raw, buff_raw + sizeof(buff_raw));

buff << format_ascii;
for(auto x : buff) putchar(x);

パーサーオブジェクトを用いて出力を構築する際に、データ列をコピーします。コピー元はSmplBuf_Byteデータ構造またはuint8_t*型の先頭と終端+1ポインタの組み合わせです。

reinit()

virtual void reinit()

パーサーの解釈途中の内容を破棄し、新たな解釈を始めます。

operator << ()

IStreamOut& operator << (TWE::IStreamOut& lhs, IParser& rhs)
IStreamOut& operator << (TWETERM::ITerm& lhs, IParser& rhs)

IStreamOutをベースクラスにもつストリームオブジェクトに、書式出力します。

メソッド

_u8Parse()

virtual uint8_t _u8Parse(char_t u8b) = 0

１バイト入力して解釈を進める仮想関数です。派生クラスにより実装されます。

_vOutput()

virtual inline void _vOutput(SmplBuf_Byte& bobj, IStreamOut& p) = 0

バイト配列bobjに格納されるバイト列に対応する書式をストリームpに出力する仮想関数です。派生クラスにより実装されます。

状態

書式を解釈して得られたデータ列は、受信したパケット情報が含まれます。ここでは、このデータ列のことをパケットデータと呼びます。

パケットデータはクラスで表現されます。TwePacketクラスのデータを解釈することで、その種別を判定し、各アプリケーションや接続ハードウェアに応じたデータ構造となります。TwePacketクラスは基底クラスでさらにパケット種別ごとの派生クラスとなります。

このオブジェクトは無線パケットのデータ量に準じたメモリ領域を消費し、また、アプリケーションでは多数のパケットを保持することも考えられます。メモリ管理を簡略化するためTwePacketをスマートポインタstd:shared_ptr<TwePacket>にて管理します。このスマートポインタをspTwePacketにtypedefしています。

以下に、TWELITE PALのパケットデータの場合のクラス関係を示します。TwePacketPalの基底クラスの一つDataPalはTWELITE PAL特有のデータを格納しています。TWELITE PALには、さらに接続されるセンサーパルによって格納すべきデータが異なります。TwePacketPalからさらにPalAmbやPalMotを生成します。例えばPalAmbには温室センサーの値や照度センサーの値が格納されます。このTwePacketPalをスマートポインタspTwePacketという形に生成するのがnewTwePacket()です。

spTwePacket型はスマートポインタですので、オブジェクトのコピー渡しによる記述を行うことで、コピーのオーバーヘッドを最小にしつつ、メモリーの管理を自動化できます。以下の例はパケットの履歴を管理する単純なクラスです。

パケットデータのバイト列を入力として、パケットの種別を判定します。また既に生成済みのオブジェクトの種別を返します。戻り値はです。

パケットデータは種別によってデータ構造が違いますが、様々な種類のパケットを一元管理するための基底クラスです。

spTwePacket はメモリ管理のためのスマートポインタです。std::shared_ptrを用いています。

TwePacketクラスは、パケットデータのパケット種別の管理を行います。また、パケットデータの解釈を行うための仮想関数parse()メソッドを定義しています。パケット特有のデータ構造に基づく解釈やデータの保存等の取り扱いは、派生クラスに実装します。

メソッド

TwePacket() - コンストラクタ

デフォルトでは、未解釈状態として E_PKT::PKT_ERROR で初期化します。

~TwePacket() - デストラクタ

get_type()

parse()

パケットデータのバイト列を与えて、パケットデータを解釈する。

派生クラスで、そのパケットに対応するデータ構造を解釈するための実装を行います。

アプリケーションはsetup(),loop()の２つの関数で記述されますが、例えば１画面ごとに大きく振る舞いが違うもの（ここではサブアプリと呼びます）を複数定義して、メニューで切り替えるといった動作を行う場合は、そのままsetup(),loop()内に記述しては煩雑になります。また変数についても管理する必要があります。

setup(), loop(), 関連する変数の切り替えを簡素化するためMWM5ライブラリでは以下の2つの仕組みを実装しています。

• サブアプリ : setup(), loop(), 関連変数をクラスとしてまとめ、切り替える

• アプリハンドラ: サブアプリ内で setup(), loop() を切り替える

サブアプリ

上記例は説明に必要な最小限のコードのみを記述します。APP_DEFを継承したApp_Foo,App_Barが、２種類のサブアプリの定義となり、各々がsetup(),loop()メンバー関数を定義しています。実際には振る舞いごとに必要なメンバー変数やその他メンバー関数が定義されます。サブアプリの登録や切り替えはライブラリ定義のクラスオブジェクトthe_appに対して操作を行います。s_change_app()関数はサブアプリを切り替える要求（サブアプリ終了時など）に対して、実際の切り替え部を実装していて、この関数をsetup()中で呼び出すthe_app.setup()のパラメータとして渡しておきます。loop()中にはthe_app.loop()を記述しておきます。

サブアプリの定義

void setup()とvoid loop()を記述しておきます。setup()はサブアプリが初期化されるときに1度だけ呼び出されます。loop()はthe_app.loop()関数中で呼び出されます。

サブアプリの切り替え

実行中のサブアプリが終了する場合に呼び出されます。サブアプリは1以上のIDにより種別を管理し、切り替えのために関数int (*)(THE_APP_MGR&, int, int, int)を実装しておきます。

パラメータn_appselには、切り替えたいアプリケーションのIDが渡されます。パラメータはthe_app.exit()で指定した値です。-1が渡された場合は、デフォルトのサブアプリに切り替えるよう記述しておきます。

• パラメータprev_appには、直前のサブアプリIDです。直前が無ければ0となります。

• パラメータexit_idは、サブアプリがthe_app.exit()で指定した値です。

サブアプリ切り替え関数内部ではthe_app.new_app<T>()（Tは次に生成するサブアプリのクラス）を呼び出しています。この呼び出しによりクラスTのオブジェクトが生成され、同時にこれまで動作していたサブアプリのオブジェクトは破棄されます。

the_app.new_app<T>()

setup()とサブアプリ切り替え関数内で呼び出し、サブアプリのオブジェクトを生成し、同時に現在のサブアプリを破棄します。

• テンプレートパラメータTはサブアプリ定義クラスでAPP_DEFを継承している必要があります。

• テンプレートパラメータargsは、コンストラクタに渡されるパラメータです。オブジェクトはnew T(std::forward(args)...)で生成されます。サブアプリがパラメータを指定しないデフォルトコンストラクタで構築される場合は何も指定しません。パラメータを指定する場合はサブアプリのコンストラクタの定義が必要です（例えばApp_Foo::App_Bar(int)を定義しておいてthe_app.new_app<App_Bar>(exit_id)）。

the_app.exit()

サブアプリのloop()内で呼び出し、loop()を抜けた直後にサブアプリを切り替えます。

上記の例のように大本のloop()からはthe_app.loop()が呼び出され、さらにサブアプリのloop()が呼び出されます。サブアプリのloop()中でthe_app.exit()が呼び出されると、the_app.loop()内でアプリケーションの切り替えが行われます。実際に切り替えているのはユーザが定義するサブアプリ切り替え関数です。

• パラメータexit_codeは、サブアプリの終了コードを指定します。任意の数を指定できます。

• パラメータnext_appは、次のサブアプリを明示的に指定する意味合いの識別子です。-1はデフォルトのサブアプリ、0は切り替えを行わない、1以上が次のサブアプリの識別子と意味付けをしています。

the_app.query_appobj()

大本のloop()からthe_appで生成したサブアプリのクラスオブジェクトを参照し、さらにサブアプリが指定したvoid*型のポインタデータを取得します。

例えば、サブアプリ構築時に共通のクラスオブジェクトを持っていて（例えばメイン画面となるターミナル画面）、大本のloop()から共通のオブジェクトにアクセスします（例えばメイン画面上の文字列を取得）。

アプリハンドラ

アプリハンドラAPP_HNDLRは、サブアプリ中での簡易的なsetup(),loop()処理の切り替えを行います。例えば、リスト一覧→リスト選択後、エラーといった複数の画面を切り替えるような動作です。

サブアプリの実装ではAPPDEFを継承しましたが、さらにAPP_HNDLR<S>（Sはサブアプリクラスを指定します）を継承します。サブアプリ中に処理関数（アプリハンドラ）を実装し、アプリハンドラを切り替えます。

上記がアプリハンドラを用いたときのソース構造の例です。

hndr_scr_def()とhndr_scr_next()がアプリハンドラ関数です。パラメータとしてevとargが与えられ、evはEV_SETUP,EV_LOOP,EV_EXITのいずれかになり、setup(),loop()と終了処理に対応します。

アプリハンドラ関数

アプリハンドラ関数はsetup(),loop()に相当する処理を行います。加えてハンドラが切り替えられる、つまり現在登録されているハンドラが終了するときの処理を記述できます。

パラメータevに対応した処理を記述します。

パラメータargは、APP_HNDLR::new_hnbdlr()やAPP_HNDLR::loop()でパラメータが与えられたときに、値が格納されます。

APP_HNDLR::new_hndlr()

アプリハンドラを初回生成する（サブアプリクラスのsetup()）、またはアプリハンドラ内から次のアプリハンドラへ切り替えます。

• パラメータhnd_nextはアプリハンドラ関数（メンバー関数のポインタ）を指定します。

• パラメータargはアプリハンドラ関数のEV_SETUP呼び出し時のパラメータを指定します。（EV_SETUPによる初期化時の処理を分岐したいときに利用します）

APP_HNDLR::loop()

サブアプリのloop()から毎回呼び出します。

• パラメータargを指定するとアプリハンドラにその値が渡されます。

APP_HNDLR::on_close()

サブアプリのデストラクタから呼び出すようにしてください。

この記述を省略した場合、サブアプリのオブジェクトが破棄されるときに、アプリハンドラも破棄されますが EX_EXIT メッセージが呼び出されません。

アプリハンドラごとの独自データ

アプリハンドラは、サブアプリ内でsetup(),loop()コンテキスト切り替えの仕組みで、サブアプリ下でのメンバー関数の実行という携帯です。そのため、アクセスできるデータはサブアプリのメンバー変数となります。

ここでは、アプリハンドラ独自のデータを保持するクラスを追加します。

データを格納するクラスの準備

APPHNDLR_DCを継承したクラスを準備します。このクラスにはアプリハンドラ内で使用するデータやメンバー関数を定義します。以下の例ではDC_MyAppHndlrというクラスを定義しています。

以下の定義を行う必要があります。

• static const int CLS_ID : データ格納クラス種別を識別するための個別のIDです。

• int get_class_id() : CLS_IDを戻すメンバ関数です。

• コンストラクタ : サブアプリクラスオブジェクトをパラメータとします。このオブジェクトは上記の例ではappに保存しDC_MyAppHndlrからサブアプリにアクセスする目的で利用します。

• 継承したAPPHNDLR_DCをAPPHNDLR_DC(CLS_ID)として初期化します。

サブアプリでのfriend宣言

DC_MyAppHndlrはサブアプリのメンバー変数や関数にアクセスすることも多いためfriend宣言しておきます。もちろん一般のクラス設計のようにpublicインタフェースを用意してカプセル化してもよいのですが、この場合、カプセル化の利点があまりなく記述が煩雑になるためです。

アプリハンドラ内での利用

アプリハンドラではAPP_HNDLR::use<>()を用いてデータオブジェクトを取得します。オブジェクトの生成・破棄は暗黙に行われます。別のアプリハンドラに切り替えられたときにデータオブジェクトが破棄されます。

上記の例では、アプリハンドラ関数の最初でdcを取得しています。初回呼び出しにオブジェクトが生成され、それ以降は生成されたオブジェクトを参照します。

あとは生成されたdcオブジェクトを操作します。

以下のパケットに対応します。

パーサーは、シリアルポートからの電文を解釈し、その内容を読み取ります。

• - 電文形式を解釈します

• - 解釈した電文の内容を読み取ります

書式パーサーは、IParserを基底クラスとして、書式ごとに派生クラスを実装します。

パーサーは、シリアルポートのように１バイトずつ入力されるデバイスを想定し、１バイト単位での解釈を行い、都度状態を遷移する状態遷移マシンとして実装されます。

パケットデータのバイト列を入力として、パケット種別の判定と、種別に応じたspTwePacketオブジェクトを生成します。

spTwePacket newTwePacket(
		uint8_t* p,
		uint8_t u8len,
		E_PKT eType = E_PKT::PKT_ERROR)

spTwePacket newTwePacket(
		TWEUTILS::SmplBuf_Byte& sbuff,
		E_PKT eType = E_PKT::PKT_ERROR)

事前にidentify_packet_type()を用いてパケットの種別E_PKTが特定できている場合はeTypeを与えます。

戻り値はspTwePacketです。

PALは接続されるセンサーなどによってパケットデータ構造が異なりますが、DataPalでは共通部のデータ構造を保持します。

struct DataPal {
	uint8_t u8lqi;        // LQI値

	uint32_t u32addr_rpt; // 中継器のアドレス

	uint32_t u32addr_src; // 送信元のアドレス
	uint8_t u8addr_src;   // 送信元の論理アドレス

	uint16_t u16seq;      // シーケンス番号

	E_PAL_PCB u8palpcb;		// PAL基板の種別
	uint8_t u8pkt_type;　　// Packet タイプ (0:PalDataInfo付, 1:シンプル)
	uint8_t u8sensors;		// データに含まれるセンサーデータの数 (MSB=1はエラー)
	uint8_t u8snsdatalen; // センサーデータ長(バイト数), MSB=1は動的確保

	uint8_t au8snsdata[32]; // センサーデータ（解釈前の生データ）
	std::unique_ptr<uint8_t[]> uptr_snsdata; // センサーデータ（動的確保）
};

PALのパケットデータ構造は大まかに２つのブロックからなり、全てのPAL共通部と個別のデータ部になります。個別のデータ部は、パケットの解釈を行わずそのまま格納しています。取り扱いを単純化するため32バイトを超えるデータは動的に確保するuptr_snsdataに格納します。

個別のデータ部は、PalBaseをベースクラスに持つ構造体に格納されます。この構造体は、TwePacketPalに定義されるジェネレータ関数により生成されます。

u8pkt_typeが0の時はPalDataInfoデータ構造が付与された形式となります。比較的複雑な情報を格納するための形式です。1の場合はPAL基板ごとに決められた標準的な形式でデータが格納されています。

TwePacketAppIOクラスは、標準アプリApp_IOのシリアルメッセージ(0x81)を解釈したものです。

class TwePacketAppIO : public TwePacket, public DataAppIO { ... };

パケットデータ内の諸情報はparse()実行後にDataTweliteに格納されます。

spTwePacketからの参照

TwePacketAppIO& refTwePacketAppIO(spTwePacket& p)

spTwePacketオブジェクトからTwePacketAppIOオブジェクトを参照します。spTwePacketにTwePacketAppIO以外が格納されている場合は、未解釈のオブジェクトを戻します。

実行例

if (parse_ascii) { // アスキー形式のパーサーの解釈完了
  auto&& pkt = newTwePacket(parse_ascii.get_payload());
		
	if (identify_packet_type(pkt) == E_PKT::PKT_APPIO) { // パケット解釈成功時
	  auto&& x = refTwePacketAppIO(pkt);
		  
		the_screen // LCDスクリーン上のターミナルに情報を表示
				<< printfmt(":Lq=%d:Ad=%08X", x.u8lqi, x.u32addr_src)
				<< printfmt(":ID=%02X", x.u8addr_src)
				<< printfmt(":DI=%08b", x.DI_mask)
				;
	}
}

	struct PalEvent {
		// uint8_t b_stored;       // 格納されていたら true
		uint8_t u8event_source; // 予備
		uint8_t u8event_id;     // イベントID
		uint32_t u32event_param;// イベントパラメータ
	};

PALイベントは、センサーなどの情報を直接送るのではなく、センサー情報を加工し一定の条件が成立したときに送信される情報です。例えば加速度センサーの静止状態から一定以上の加速度が検出された場合などです。

イベントデータが存在する場合はTwePacketPalの.is_PalEvent()がtrueになることで判定でき、.get_PalEvent()によりPalEventデータ構造を得られます。

対応するパケット種別はE_PKT定義を参照してください。

PALの各センサーのデータ構造体はすべてPalBaseを継承します。センサーデータの格納状況u32StoredMaskの情報が含まれます。

	struct PalBase {
		uint32_t u32StoredMask;
	};

派生構造体に定義されるSTORE_COMP_MASKとu32StoreMaskが一致すれば、全てのセンサーのデータが適切に解釈され、格納されていることになります。

TwePacketPalクラスは、TWELITE PALのパケットデータを解釈したものです。このクラスはTWELITE PAL（センサーデータなど上り方向）共通に取り扱います。

class TwePacketPal : public TwePacket, public DataPal { ... };

PAL共通データはDataPalに定義されています。

PALの各センサー基板特有のデータを取り出すためのジェネレータ関数を用意しています。

spTwePacketからの参照

TwePacketPal& refTwePacketPal(spTwePacket& p)

spTwePacketオブジェクトからTwePacketPalオブジェクトを参照します。spTwePacketにTwePacketPal以外が格納されている場合は、未解釈のオブジェクトを戻します。

実行例

if (parse_ascii) { // アスキー形式のパーサーの解釈完了
  if (identify_packet_type(parse_ascii.get_payload()) == E_PKT::PKT_PAL) {
    auto&& pkt = newTwePacket(parse_ascii.get_payload(), E_PKT::PKT_PAL);
    
    if (pkt == E_PKT::PKT_PAL) { // パケット解釈成功時
      auto&& pal = refTwePacketPal(pkt);
      
      // 開閉センサーパル
      if (pal.u8palpcb == E_PAL_PCB::MAG) {
        PalMag mag = pal.get_PalMag();
        if (mag.u8MagStat == 0) {
          // OPEN
        } else {
          // CLOSE
        }
      }
    }
  }
}

パケットデータ定関数

has_palEvent()

bool has_PalEvent()
bool is_PalEvent()

パケットにイベント情報が含まれるかを判定します。

get_PalDataType()

E_PAL_DATA_TYPE get_PalDataType()

パケットの種別を判定します。種別はE_PAL_DATA_TYPEとして判定されます。

has_data_info()

bool has_data_info()

パケットプロパティ（パケットの補助情報）が含まれているか判定します。含まれている場合はPalDataInfoで定義されるメンバーにアクセスできます。

is_data_source_timer()

bool is_data_source_timer()

パケットプロパティが存在する場合に呼び出しは有効。タイマー由来からの送信の場合trueを返します。

ジェネレータ関数

センサーPALの各種データを取り出すためのジェネレータ関数です。

get_PalMag()

PalMag get_PalMag()

.u8palpcb==E_PAL_PCB::MAGの場合、開閉センサーパルのデータPalMagを取り出します。

get_PalAmb()

PalAmb get_PalAmb()

.u8palpcb==E_PAL_PCB::AMBの場合、環境センサーパルのデータPalAmbを取り出します。

get_PalMot()

PalMot get_PalMot()

.u8palpcb==E_PAL_PCB::MOTの場合、動作センサーパルのデータPalMotを取り出します。

get_PalEvent()

PalEvent get_PalEvent()

.is_PalEvent()がtrueの場合PalEvent(PALイベント)を取り出します。

本関数はspTwePacketオブジェクトをTwePacket&として参照します。

TwePacket& refTwePacket(spTwePacket& p)

//例
  auto&& pkt = newTwePacket(p, len); // パケットの生成
  
  if (refTwePacket(pkt).get_type() == E_PKT::PKT_TWELITE) {
    // App_Twelite の処理
  }

struct PalMot : public PalBase {
	static const int MAX_SAMPLES = 16;

	static const uint8_t U8VARS_CT = MAX_SAMPLES + 1; // センサー数
	static const uint32_t STORE_COMP_MASK = 0b11; // 電圧と加速度サンプル１あればコンプとする

	uint16_t u16Volt; // 電源電圧
	uint8_t u8sample_rate_code; // サンプリング周波数 (0: 25Hz, 4:100Hz)
  
	uint8_t u8samples; // 格納サンプル数
	int16_t i16X[16];  // X軸 (ミリG)
	int16_t i16Y[16];  // Y軸
	int16_t i16Z[16];  // Z軸
};

※ パケット間の各サンプルの連続性を確認するには、パケットのシーケンス番号の抜けが無いことを確認してください。

struct TweCUE : public PalBase {
	static const int MAX_SAMPLES = 10;

	static const uint8_t U8VARS_CT = MAX_SAMPLES + 3; // センサー数
	static const uint32_t STORE_COMP_MASK = 0b1111; // 電圧と開閉状況、ADC1、加速度サンプル１あればコンプとする

	uint16_t u16Volt;	// 電源電圧
	uint16_t u16Adc1;	// ADC1電圧

	uint8_t u8MagStat;  // 開閉状況 (0:磁石が遠い, 1/2:磁石検出)
	uint8_t bMagRegularTransmit; // 定期送信の時に 1, 磁石検出では 0

	uint8_t u8samples;  // 格納サンプル数
	uint8_t u8sample_rate_code; // サンプリング周波数 (0: 25Hz, 4:100Hz)

	int16_t i16X[10]; // X軸 (ミリG)
	int16_t i16Y[10]; // Y軸
	int16_t i16Z[10]; // Z軸
};

※ パケット間の各サンプルの連続性を確認するには、パケットのシーケンス番号の抜けが無いことを確認してください。

TwePacketActStdクラスは、アクト(Act)のサンプルなどの無線パケットを親機・中継器アプリApp_Wingsで受信したときの形式です。(App_UARTの拡張形式とほぼ同じになります）

class TwePacketActStd : public TwePacketAppUART

spTwePacketからの参照

TwePacketActStd& refTwePacketActStd(spTwePacket& p)

spTwePacketオブジェクトからTwePacketActStdオブジェクトを参照します。spTwePacketにTwePacketActStd以外が格納されている場合は、未解釈のオブジェクトを戻します。

実行例

if (parse_ascii) { // アスキー形式のパーサーの解釈完了
  auto&& pkt = newTwePacket(parse_ascii.get_payload());
    
    if (identify_packet_type(pkt) == E_PKT::PKT_ACT_STD) { // パケット解釈成功時
      auto&& x = refTwePacketActStd(pkt);
      
  		the_screen // LCDスクリーン上のターミナルに情報を表示
  				<< printfmt(":Lq=%d:Ad=%08X", x.u8lqi, x.u32addr_src)
  				<< printfmt(":ID=%02X", x.u8addr_src)
  				;
  
      if (x.payload.length() > 5) {
        auto p = act.payload.begin();
        
        // 先頭４バイトはActコードで無線パケット先頭に設定した４文字アルファベット
        the_screen << ":FOURCC=";
        for(int i = 0; i < 4; ++i, ++p)
            the_screen << printfmt("%c", *p);
        
        // 残りはHEXで表示（Actコードごとによって違う)
        the_screen << ":DATA=";
        for(; p != x.payload.end(); ++p) {
    			the_screen << printfmt("%02X", *p);
    		}
      }
    }
  }
}

TwePacketTweliteクラスは、標準アプリApp_Tweliteの0x81コマンドを解釈したものです。

class TwePacketTwelite : public TwePacket, public DataTwelite { ... };

パケットデータ内の諸情報はparse()実行後にDataTweliteに格納されます。

spTwePacketからの参照

TwePacketTwelite& refTwePacketTwelite(spTwePacket& p)

spTwePacketオブジェクトからTwePacketTweliteオブジェクトを参照します。spTwePacketにTwePacketTwelite以外が格納されている場合は、未解釈のオブジェクトを戻します。

実行例

if (parse_ascii) { // アスキー形式のパーサーの解釈完了
  auto&& pkt = newTwePacket(parse_ascii.get_payload());
		
	if (identify_packet_type(pkt) == E_PKT::PKT_TWELITE) { // パケット解釈成功時
	  auto&& x = refTwePacketTwelite(pkt);
		  
		the_screen // LCDスクリーン上のターミナルに情報を表示
				<< printfmt(":Lq=%d:Ad=%08X", x.u8lqi, x.u32addr_src)
				<< printfmt(":ID=%02X", x.u8addr_src)
				<< printfmt(":DI=%04b", x.DI_mask)
				;
	}
}

TwePacketActStdのデータ部。 （書式はApp_UARTと同一でDataAppUART型を流用しています）

struct DataAppUART {
		/**
		 * 送信元のアドレス
		 */
		uint32_t u32addr_src;

		/**
		 * 送信先のアドレス
		 */
		uint32_t u32addr_dst;

		/**
		 * 送信元の論理ID
		 */
		uint8_t u8addr_src;

		/**
		 * 宛先の論理ID
		 */
		uint8_t u8addr_dst;

		/**
		 * LQI値
		 */
		uint8_t u8lqi;

		/**
		 * 未使用
		 */
		uint8_t u8response_id;

		/**
		 * データ部の長さ
		 */
		uint16_t u16paylen;

		/**
		 * データ部配列
		 */
		TWEUTILS::SmplBuf_Byte payload;
	};

TwePacketAppUartクラスは、App_UARTの拡張書式を親機・中継器アプリApp_Wingsで受信したときの形式です。

class TwePacketAppUART : public TwePacket, public DataAppUART

spTwePacketからの参照

TwePacketAppUART& refTwePacketAppUART(spTwePacket& p)

spTwePacketオブジェクトからTwePacketAppUARTオブジェクトを参照します。spTwePacketにTwePacketAppUART以外が格納されている場合は、未解釈のオブジェクトを戻します。

実行例

if (parse_ascii) { // アスキー形式のパーサーの解釈完了
  auto&& pkt = newTwePacket(parse_ascii.get_payload());
    
    if (identify_packet_type(pkt) == E_PKT::PKT_APPUART) { // パケット解釈成功時
      auto&& x = refTwePacketAppUART(pkt);
      
  		the_screen // LCDスクリーン上のターミナルに情報を表示
  				<< printfmt(":Lq=%d:Ad=%08X", x.u8lqi, x.u32addr_src)
  				<< printfmt(":ID=%02X", x.u8addr_src)
  				;
  
      if (x.payload.length() > 0) {
        auto p = act.payload.begin();
        
        // HEXで表示
        the_screen << ":DATA=";
        for(; p != x.payload.end(); ++p) {
    			the_screen << printfmt("%02X", *p);
    		}
      }
    }
  }
}

TwePacketTweliteのデータ部分。

struct DataTwelite {
		//送信元のシリアル#
		uint32_t u32addr_src;
		
		// 送信元の論理ID
		uint8_t u8addr_src;

		// 宛先の論理ID
		uint8_t u8addr_dst;

		// 送信時のタイムスタンプ
		uint16_t u16timestamp;

		// 低レイテンシ送信時のフラグ
		bool b_lowlatency_tx;

		// リピート中継回数
		uint16_t u8rpt_cnt;

		// LQI値
		uint16_t u8lqi;

		// DIの状態 (true がアクティブ Lo,GND)
		bool DI1, DI2, DI3, DI4;
		// DIの状態ビットマップ (LSBから順にDI1,2,3,4)
		uint8_t DI_mask;

		// DIアクティブならtrue (過去にアクティブになったことがある)
		bool DI1_active, DI2_active, DI3_active, DI4_active;
		// DIのアクティブビットマップ(LSBから順にDI1,2,3,4)
		uint8_t DI_active_mask;

		// モジュールの電源電圧[mV]
		uint16_t u16Volt;

		// AD値 [mV]
		uint16_t u16Adc1, u16Adc2, u16Adc3, u16Adc4;
		// ADがアクティブ（有効）なら 1 になるビットマップ (LSBから順にAD1,2,3,4)
		uint8_t Adc_active_mask;
};

本ライブラリのターミナル（コンソール）は、文字列ベースの画面を構成することを目的としてます。

以下に設計時の考慮事項を記載します。

• 固定幅の画面構成を行うこと

• 日本語の表示が可能であること

• ソースコード中に直接日本語文字列を含められるようにすること

  • UTF-8でソースコードを記述する前提とする

  • 内部処理をUnicodeとすること

  • UTF-8デコードが出来るようにすること

• 旧来のキャラクター型のインタフェースを実装できるよう、いくつかのエスケープシーケンスを実装しておくこと

  • ただしANSIエスケープシーケンスの完全な互換性を目的とはしない

• 文字色、背景色、太字といった表示属性に対応すること

• カーソルを表示・非表示にできること

• 画面の順方向のスクロールに対応すること

• カラム数を超えて文字列を出力した場合は、折り返しを行えること

  • 右端カラムへの文字出力を行った場合、その時点では折り返しを行わないようにすること

    • 上記を実装は、折り返し処理の実装より優先すること

• 複数のターミナル表示を画面上に同時に表示できること

• 毎回全画面書き換えといったような描画パフォーマンスの悪い実装でないこと

  • 変更がある行のみを書き換える行単位の描画を行うようにした

• フォントを選択できること

  • 配布可能なフォントをライブラリ内に同梱しておくこと

  • より大きな文字を表示するため、倍角表示に対応すること

本ライブラリのターミナルは、大まかに分けて２要素から構成されます。

• ターミナル画面上の文字列を管理するクラスや関数をまとめた TWETERM

• フォントの管理と描画に関連するクラスや関数をまとめた TWEFONT

M5Stack の 320x240 LCD 用のターミナルの実装です。ITermを実装しています。

本クラスはnamespace TWEARD内に定義されます。

メソッド

TWETerm_M5_Console - コンストラクタ

TWETerm_M5_Console(
			uint8_t u8c, uint8_t u8l,
			Rect drawArea, M5Stack& _M5)

TWETerm_M5_Console(
			uint8_t u8c, uint8_t u8l,
			TWETERM::SimpBuf_GChar* pAryLines, TWETERM::GChar* pBuff,
			Rect drawArea, M5Stack& _M5)

ITermのコンストラクタにdrawAreaと_M5のパラメータが追加されています。

drawAreaは、LCD内のターミナル描画エリアを決めます。Rect構造体で指定しx,y,w,hを指定します。(x,y)は領域の左上の座標、(w,h)は領域の幅と高さです。

_M5は、M5Stackのグローバルインスタンス M5を指定します。

例：

TWETerm_M5_Console the_screen(64, 20, { 0, 16, 320, 192 }, M5);

カラム最大値を64、行数の最大値を20、左上座標を (0, 16)、領域サイズを (320, 192) として the_screen オブジェクトを構築します。

メソッド

refresh()

ITerm::refresh()の実装です。この関数により画面の描画を行います。loop()関数内で定期的に呼び出します。

本実装では、パフォーマンスの向上のため、原則として描画変更の必要にある行のみを上書きします。画面全領域を再描画したい場合はforce_refresh()メソッドを呼び出します。

以下の例では32msごとに描画を行います。

void loop() {
		static uint32_t u32mills;

		uint32_t u32now = millis();
		if (u32now - u32mills > 32) {
			the_screen.refresh();

			u32mills = u32now;
		}
}

set_font()

void set_font(uint8_t u8id, uint8_t u8col_request = 0, uint8_t u8row_request = 0)

フォントを指定します。

u8idはフォントIDを指定します。

u8col_requestは、設定したいカラム数を指定します。指定した数値が領域サイズに対して大きい場合は指定領域に入るように値が丸められます。0を指定した場合は、領域サイズから計算できる最大のカラム数に設定されます。

u8row_requestは、設定したい行数を指定します。指定した数値が領域サイズに対して大きい場合は指定領域に入るように値が丸められます。0を指定した場合は、領域サイズから計算できる最大の行数に設定されます。

font_width(), font_height(), font_id()

uint8_t font_id()
uint8_t font_width()
uint8_t font_height()

font_id()は、指定したフォントのIDを返します。

font_width()は、指定したフォントの幅をピクセル数で返します。ダブル幅のピクセル数は、この値の２倍になります。

font_height()は、指定したフォントの高さをピクセル数で返します。

set_color()

void set_color(uint16_t color, uint16_t bgcolor = 0)

ターミナルの文字色と背景色を指定します。

colorは文字色を指定します。

bgcolorは背景色を指定します。

uint16_t c = color565(255, 127, 0); // R:255, G:127, B:0

set_color_table()

void set_color_table(const uint16_t* ptbl)

ターミナルで使用できる８色のテーブルを指定します。ptblはuint16_t型の配列で８つの要素が必要です。

例

static const uint16_t COLTBL_MAIN[8] = {
	BLACK,
	RED,
	GREEN,
	YELLOW,
	color565(127, 127, 255), // BLUE,
	color565(255, 0, 142), // MAGENTA,
	CYAN,
	ALMOST_WHITE
};

the_screen.set_color_table(COLTBL_MAIN);

上記の例では青とマゼンダの色調を変えたテーブルを指定し、ターミナルオブジェクト the_screenに指定しています。

ユーティリティ関数

color565()

constexpr uint16_t color565(uint8_t r, uint8_t g, uint8_t b)

r, g, b を指定して、565形式の色コードを生成します。

フォント定義と関連する手続きをまとめたクラスです。

このクラスオブジェクトはフォントジェネレータcreateFont???()によりライブラリ内部で生成・管理され、ユーザがコンストラクタを用いて直接オブジェクトを生成することはありません。

メソッド（ユーザ利用）

get_width()

uint8_t get_width()
uint8_t get_width(uint16_t wc)

パラメータを省略した場合は、フォントのシングル幅文字の幅を返します。この値にはフォント生成時に指定した文字間スペースも含まれます。

wcを指定した場合は、Unicode wcに対応するフォントの幅を返します。日本語などダブル幅のフォントの場合は、シングル幅の２倍の値が戻ります。

get_height()

uint8_t get_height()

フォントの高さを返します。この値にはフォント生成時に指定した行間スペースも含まれます。

is_default()

bool is_default()

デフォルトフォントのオブジェクトである場合 true を返します。

get_font_code()

uint8_t get_font_code()

フォントIDを取得します。

メソッド（内部利用）

find_font_index()

int find_font_index(uint16_t c)

Unicode c に対応する、ダブル幅フォント定義配列インデックスを検索します。

戻り値は、字形データが存在する場合は、インデックス配列のインデックス（データ配列のインデックスが計算できる）、存在しない場合は-1を返します。

フォント定義は、インデックス配列、データ配列の２つから構成されます。インデックス配列の各値は昇順に並んだ Unicode になっていて、データ配列のインデックスに対応しています。

以下の例ではインデックス配列の IDX=829 が U+5a2f で "娯" という文字です。データ配列の対応する番地を参照すれば、この字形データが格納されています。

// インデックス配列 M+10dotフォント
const uint16_t font_mplus_f10j_idx[FONT_MP10_DBL_CHARS] {
  0x0391, // IDX=0 U+0391
  0x0392, // IDX=1 U+0392
  0x0393, // IDX=2 U+0392
  ...
  0x5a2f, // IDX=892 U+5a2f (娯)
  ...
}

// データ配列
const uint8_t font_mplus_f10j_data[FONT_MP10_DBL_CHARS*FONT_MP10_DATA_ROWS*2] = {
  ...
  0x00,0x00,0x47,0x80,0x54,0x80,0xf7,0x80,0x50,0x00,
　  0x5f,0x80,0xa0,0x80,0xff,0x80,0x45,0x00,0x58,0x80, // 3864/u5a2f idx=892
  ...
};

インデックス配列内の値は昇順に並ぶよう構成した目的は、本関数で実装されている二分探索を利用するためです。

ITerm型のターミナルオブジェクトに対して、<<演算子を用いてターミナル属性を指定するヘルパークラス。

void putmsg(ITerm& trm, const char *msg) {
    trm << TermAttr(TERM_COLOR_FG_RED | TERM_BOLD);
    trm << msg;
    trm << TermAttr(TERM_ATTR_OFF);
}

上記の例では、出力ターミナルをtrmに対して、文字色を赤で太字にしてmsgを出力し、属性をクリアします。

TermAttr() - コンストラクタ

TermAttr(GChar::tAttr attr = 0)

attrをパラメータとします。attrは後述のGChar::tAttr 定数一覧で指定します。

指定は以下の組み合わせになります。

• TERM_ATTR_OFF (すべての属性のクリア)

• 以下の論理和

  • TERM_BOLD

  • TERM_REVERSE

  • 文字色のいずれか

  • 背景色のいずれか

GChar::tAttr 定数

色設定以外の属性

文字色

背景色

下記のPAL基板に対応します。

パケット送信要因。PalDataInfo::e_data_causeで使用されます。

PAL/CUEのパケットがどのような原因で送信されたかなどを付加する補助情報です。例えばタイマー送信かセンサーの発報によるものかなどの情報が含まれます。TwePacketPalが本構造体を継承しており単独では使用しません。

struct PalDataInfo {
  E_SNSCD e_data_source;
  E_CAUSE e_data_cause;
};

エスケープシーケンスは ESC 文字 '\033' で始まり何文字かで完結する制御コードです。

本ライブラリが動作するプログラム上や、シリアルポートの先にあるマイコンから制御文字をターミナルに投入することで、様々な画面制御（画面のクリア、カーソルの移動、色などの表示属性の変更）を行うことが出来ます。

以下に対応するエスケープシーケンスを記述します。表中の ESC はエスケープ文字 '\033'、イタリックの n や m は数字の入力です。

フォントをスクリーン上に描画します。

以下の例では、Bボタンを押すたびに、事前に生成したフォントID=10のフォントを用いて固定の文字列を描画します。

関数定義

fontを用い、左上座標(x,y)に、文字色fg、背景色bg、オプションoptで文字を描画します。

uint16_t cをパラメターとして与えた場合は、Unicode c に対応する文字を１文字描画します。

const char *sをパラメータとして与えた場合は、sをUTF-8としてデコードし、文字列として出力します。

const uint16_t* sをパラメータとして与えた場合は、Unicode文字列として描画します。

optはオプションのビットマップです。以下の指定が可能です。

• 0x01 - 太字指定

• 0x02 - カーソルの描画

戻り値は、描画が行われればX(幅)方向に描画したピクセル数を返し、エラーなどが発生したときは0を返します。

実装について

実装時では以下のM5StackのAPIを利用しています。

• M5.Lcd.startWrite()

• M5.Lcd.setWindow()

• M5.Lcd.endWrite()

• tft_Write_16()

wchar_t型のです。

MWM5では文字列を表す配列として多用されています。

フォントジェネレータ関数は、収録フォントごとに定義されています。関数パラメータは共通で、以下のようになります。

上記は東雲フォント16ドット版（常用漢字収録）のジェネレータの例です。

idは、ユーザが指定するフォントID。

line_spaceはフォントの行間スペースをピクセル数で指定します。

char_spaceは文字間スペースでピクセルで指定します。文字間スペースはシングル幅のフォントの指定です。ダブル幅のフォントの場合は倍になります。

u32Optは、フォントのオプションを指定します。オプションはU32_OPT_FONT_TATEBAIとU32_OPT_FONT_YOKOBAIがあり、論理和で指定します。

フォントジェネレータの戻り値はFontDef&になっています。この戻り値はライブラリ内部のフォント管理テーブルに生成されたオブジェクトへの参照です。既に登録済みのIDであるばあいは、そのIDに対して上書きを行います。登録できなかった場合は.is_default()メソッドがtrueになるデフォルトフォントが返されます。

ターミナル（コンソール）の基底クラスで、画面上の文字列を管理する。このクラスは、実際の画面描画についての手続きは含まれず、このクラスを継承したサブクラスによって画面描画を実装します。

メソッド

ITerm() - コンストラクタ

カラム数u8cと行数u8lを指定して、ターミナルを構築する。カラム数と行数はターミナルで管理できる最大の値を指定する。ターミナルのサイズ変更を行った場合でも各々の最大の値を超える変更は行われない。

pAryLinesとpBuffを指定する場合は、ITerm内でのメモリ確保は行われず、外部で確保済みの配列を利用する。

~ITrem() - デストラクタ

動的にメモリを確保した場合は、そのメモリ領域を破棄します。

clear(), home(), clear_screen()

clear()は画面バッファのクリア、home()はカーソル位置をホームポジションに移動、clear_screen()は両者を実行します。

clear_line()

指定行をクリアする。fill_blankをtrueにすると指定行を空白で埋める。

refresh(), force_refresh()

サブクラスにより実装される画面更新描画のためのメソッドです。描画方法は２種類あり、メンバー変数u32Dirtyに定義されるビットマスクに対応した行のみを再描画するものと、force_refresh()メソッドによる画面全体を再描画するものがあります。

画面全体の再描画では、いったん背景を背景色で塗りつぶしてから再描画します。初回の描画ではforce_refresh()を行うようにしてください。

write()

ターミナルに１文字書き出します。カーソル位置に文字を書き出します。16bit wchar_t型のUnicodeを渡します。

char_t (char) 型のパラメータを渡した場合は、入力をUTF-8として取り扱います。例えば0x7F までのASCII文字はそのままwrite(wchar_t)が呼び出され、３バイトのUTF-8エンコードされた日本語文字は、連続して３バイトを投入した時点でwrite(wchar_t)が呼び出されます。

get_height(), get_width()

ターミナルの行数、カラム数を返す。

move_cursor()

カーソル位置を指定場所に移動する。

戻り値はITerm&（自身）で続けて出力メソッドなどを記述できる。

operator <<

<<演算子を用いてターミナルに文字列を書き出します。

メソッド (サブクラス実装用)

namespace TWEFONT には、フォントの定義やフォント描画のための手続きをまとめています。

フォントの生成

フォントはFontDefクラスにより管理されます。フォントごとに用意されるFontDefクラスオブジェクトのジェネレータ関数により生成され、ライブラリ内部で生成時に指定したフォントIDと紐づけて管理されます。フォントは最大７つまで定義できます。フォント作成時に字間・行間・倍角を指定することができます。同じフォントに対して複数のフォントIDの登録が可能です。

下記の例では、フォントID 10 に16ドットの東雲フォント（縦倍角・横倍角指定）を、フォントIDを11に同じフォントですが倍角指定なし、行間を１ピクセルとしたフォント定義を行います。

コンパイル時に、ジェネレータ関数createFont???()を呼び出されたフォントのデータがリンクされます。

フォントデータについて

本ライブラリには、作者が事実上パブリックドメイン（著作権等取扱はソースヘッダに含まれるクレジットを参照ください）を宣言しているフォントをいくつか含めています。

本ライブラリに含めるにあたって、以下の調整を行っています。

• 大本がBDF形式を変換し、描画ルーチンに適したデータ構造とした

• これらフォントをUnicodeとして取り扱うための参照テーブルを用意した

• latin1補助文字 U+00A0～u+00FFについて、フォント定義があるものについては収録した

• JIS X201 半角カナ U+FF61～U+FF9F について、フォント定義があるものについては収録した

• 常用漢字（2645 文字）のフォントデータと、全収録（東雲フォントのみ、一部未収録字形があります）を用意した

日本語フォントのジェネレータ

ジェネレータ関数createFont???()には収録文字数に応じて３種類のジェネレータを用意しています。文字セットの生成は{MWM5ライブラリ}/fontsフォルダにあるスクリプトによって行います。

東雲フォント (12,14,16ドット)

12,14,16ドット版をライブラリに含めています。

常用漢字のみのジェネレータ (createFontShinonome12???(), createFontShinonome14???() , createFontShinonome16???())を呼び出します。

MP+フォント (10ドット, 12ドット)

ジェネレータ createFontMP10???()または createFontMP12???() を呼び出します。

8x6 LCD フォント

ジェネレータ createFontLcd8x6() を呼び出します。

latin拡張文字や日本語フォントは含まれません。

このフォントはいずれかのジェネレータ関数createFont???()が呼び出されたときに、デフォルトとしてフォントID=0に登録されます。

フォントIDについて

フォントIDは作成したフォントごとに割り当てられます。

IDは 0..32 の値を指定可能ですが、ユーザが登録できるのは 1..32 で最大７フォント登録できます。

ID=0 のフォントは 8x6 LCD フォントに割り当てられます。

フォント情報の取得

ターミナルでの使用

フォントの描画について

※ パケット間の各サンプルの連続性を確認するには、パケットのシーケンス番号の抜けが無いことを確認してください。

によりフォント生成したクラスオブジェクトを参照します。

関数定義

idにはフォント生成時に指定したフォントIDを指定します。

戻り値は で、ライブラリ内のフォント管理配列内に格納されたオブジェクトへの参照です。

idに0を指定すると、フォントID=0のデフォルトフォントを戻します。存在しないIDを指定した場合も、どうようにデフォルトフォントを戻します。FontDefオブジェクトがデフォルトフォントかどうかはメソッド.is_default()により判定できます。

uint8_t型のです。