セクションの複数ページをまとめています。印刷またはPDF形式で保存...

最適な出力のために、Google Chrome（15以降）または Microsoft Edge（79以降）を推奨いたします。

2024-05-08 現在

MNLib

TWELITE PAL Scriptのうち、シリアルデータの読み込みやそれを解釈するコード

1: apppal.py

2: appbase.py

3: mwSerial.py

4: parseFmt.py parseFmt_*.py

TWELITE PAL Scriptのうち、シリアルデータの読み込みやそれを解釈するコードが入ったフォルダです。

1 - apppal.py

読み込んだバイト列を解釈して辞書オブジェクトに登録するクラス

`Class AppPAL`

AppBaseを継承し、得られたペイロードを解釈して、使いやすいデータに変換して、辞書オブジェクトに登録するクラスです。

定義するときのパラメータ

初期値が設定されているものは指定不要。

変数名	型	初期値	内容
port	string	None	開くシリアルポート名例：COM3、/dev/ttyUSB0 など
baud	int	115200	ボーレート
tout	float	0.1	シリアル通信するときのタイムアウト時間(秒)
sformat	string	Ascii	本設定値はAsciiで固定
autolog	boolean	False	ペイロードが解釈出来たときに自動でCSVファイルにログを出力する場合はTrue
err	boolean	False	エラーメッセージを出力する場合はTrue

`ReadSensorData()`

本メソッドでペイロードを読み込んだら、 TWELITE PAL 親機の書式フォーマットに従ってそのペイロードの解釈を行います。

TWELITE PAL 親機の書式フォーマット (ASCII形式のみ) を解釈しています。多くはその定義に従います。

パラメータ

なし

戻り値

データが読み込めた場合：True
読み込めなかった場合：False

辞書オブジェクトに格納されたデータのキーは下記の通りです。

EventIDなどのデータの意味に関しては、こちらもご確認ください。

キー	型	内容
ArriveTime	datetime	ペイロードを得たときの時間
LogicalID	int	子機の論理デバイスID
EndDeviceSID	int	子機のシリアル番号
RouterSID	int	最初に受信した中継機のシリアル番号 (親機が直接子機のパケットを受信した場合は0x80000000)
LQI	int	受信電波品質
SequenceNumber	int	パケットが送信されるごとにインクリメントされる続き番号 1からスタート、65535の次に0に戻る
Sensor	int	センサー種別（0x80で固定）
PALID	int	PAL基板ID
PALVersion	int	PAL基板バージョン
HALLIC	int	ホールICの状態
Temperature	float	温度(degC)
Humidity	float	湿度(%)
Illuminance	int	照度(lux)
AccelerationX	list,float	X軸の加速度(g)
AccelerationY	list,float	Y軸の加速度(g)
AccelerationZ	list,float	Z軸の加速度(g)
SamplingFrequency	int	加速度のサンプリング周波数
EventID	list,int	イベントの要因とイベントID
WakeupFactor	list,int	起床した要因等のデータ

`OutputCSV()`

辞書オブジェクトをCSVファイルに出力します。

パラメータ

なし

戻り値

なし

2 - appbase.py

シリアルデータ解釈のための基底クラス

`class AppBase`

本コードでは、すべてのTWELITE APPS 共通で必要な機能が実装されており、シリアルデータの読み込みに必要なシリアルポートの開閉処理やシリアルデータの読み込み、ログファイルの出力などの処理が記述された基底クラスです。
これを継承した apppal.py が得られたバイト列を解釈し、辞書オブジェクトにデータを入れてメイン関数に返します。

`GetDataDict()`

ペイロードの解釈し、データを格納した辞書オブジェクトを返します。

パラメータ

なし

戻り値

型	内容
Dict	ペイロードを解釈したデータを格納した辞書オブジェクト

3 - mwSerial.py

シリアルポートの管理を行うクラス

`Class MWSerial`

本クラスはシリアルの読み書きなど、シリアルポートの管理を行うクラスです。

定義するときのパラメータ

初期値が設定されているものは指定不要。

変数名	型	初期値	内容
port	string	None	開くシリアルポート名例：COM3、/dev/ttyUSB0 など
baud	int	115200	ボーレート
timeout	float	0.1	シリアル通信するときのタイムアウト時間(秒)
parity	int	serial.PARITY_NONE	パリティを指定する
stop	int	1	ストップビット
byte	int	8	データビット長
rtscts	int	0	RTSとCTSを有効にする場合は1
dsrdtr	int	0	DSRとDTRを有効にする場合は1
mode	string	Ascii	本設定値はAsciiで固定

`SerialSelect`

PCに接続されたシリアルポートを検索し、使用するシリアルポートをユーザー選択します。

シリアルポートが1ポートしかない場合は自動的にそのポート名を使用します。
シリアルポートがない場合はNoneを指定します。
シリアルポート名を引数に指定した場合はそのシリアルポートを使用します。

パラメータ

変数名	型	初期値	内容
portname	string	None	開くシリアルポート名 (例：COM3、/dev/ttyUSB0 など) 自動選択する場合は、指定しないこと。

変数名

型

初期値

内容

portname

string

None

開くシリアルポート名 (例：COM3、/dev/ttyUSB0 など)

自動選択する場合は、指定しないこと。

戻り値

なし

4 - parseFmt.py parseFmt_*.py

TWELITE シリアル書式パーサ

`class FmtBase`

書式パーサーの基底クラスで共通手続きを定義する。これを継承した FmtAscii (アスキー形式 ASCII形式), FmtBinary (バイナリ形式 Binary形式) を利用する。

書式パーサーは、シリアル入力を想定し、アスキー形式の場合は１行単位でバイナリ形式の場合は１バイト単位で入力系列を解釈し、その系列が書式で定義されるヘッダ、フッタ、チェックサムを満足した時、解釈の完了とし、ヘッダ、フッタを除いた内容（ペイロード）を格納する。

`process(c)`

入力文字列の解釈を行う。解釈後は is_complete() が true を返した場合、解釈が成功し get_payload() によりペイロードを得ることができる。ペイロードは続く process() 処理などを実行すると内容を保証しないため、解釈終了後に速やかに利用します。

続けて別の系列を解釈したい場合は、そのまま process() を実行する。

パラメータ

パラメータ内容

c 解釈したい入力系列。１バイト単位の解釈と系列単位の解釈の２種類に対応する。１バイト単位の入力では、int型のアスキーコード、str型、bytes型、list型の長さ1の系列。系列単位の入力では list 型、str型、bytes型の１系列を処理する。データに複数系列ある場合や途中で切れている場合は処理できない。

パラメータ	内容
`c`	解釈したい入力系列。１バイト単位の解釈と系列単位の解釈の２種類に対応する。１バイト単位の入力では、int型のアスキーコード、str型、bytes型、list型の長さ1の系列。系列単位の入力では list 型、str型、bytes型の１系列を処理する。データに複数系列ある場合や途中で切れている場合は処理できない。

戻り値

なし

`is_comp()`

process() 処理後に呼び出し、書式解釈の完了状況を知らせる。true を得た場合は get_peyload() または get_payload_in_str() メソッドにより、ペイロードを取得する。

続く process() などの処理により、内部格納されるペイロードは初期化や破壊されるため、速やかにデータをコピーします。

パラメータ

なし

戻り値

値	内容
`true`	解釈に成功した。ペイロードが利用できる。
`false`	解釈に失敗した、または、書式の途中である。

`get_payload()`

ペイロードを返す。

パラメータ

なし

戻り値

ヘッダやフッタが含まれないペイロード部を list型バイト列として返します。

`reinit()`

明示的に内部を初期状態にします。

パラメータ

なし

戻り値

なし

その他メソッド

内部で利用する目的でいくつかのメソッドが定義されています。詳細はソースコードを参照してください。

コード例

系列単位の解釈

str 型の系列 a を解釈し、pay にペイロード情報保存します。pay には [ 0x78, 0x80, 0x01, ... , 0x00 ] が格納されます。

import parseFmt_Ascii

fmta=parseFmt_Ascii.FmtAscii()
a = ':7880010F0F0380030002800200DF'
pay = []

fmta.process(a)

if fmta.is_comp():
    pay = fmta.get_payload()

１バイト単位の解釈

バイナリの系列 b について、１バイトごと process() メソッドにより系列の解釈を進めます。終端の 0x04 を投入した時点で、解釈が完了しペイロードが pay に保管されます。

import parseFmt_Binary

fmtb=parseFmt_Binary.FmtBinary()
b = [0xA5, 0x5A, 0x80, 0x05, 0x78, 0x00, 0x11, 0x22, 0x33, 0x78, 0x04]
pay = []

for x in b:
  fmtb.process(x)

  if fmtb.is_comp():
    pay = fmtb.get_payload()
    break