ParsedPacket(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None, destination_logical_id=120, relay_count=0, periodic=False, di_changed=<mwings.common.CrossSectional object>, di_state=<mwings.common.CrossSectional object>, ai_voltage=<mwings.common.CrossSectional object>)

引数

名称	型	内容
`time_parsed`	`optional AwareDatetime`	パース時刻
`packet_type`	`common.PacketType`	パケット種別
`sequence_number`	`optional common.UInt16`	シーケンス番号
`source_serial_id`	`common.UInt32`	送信元のシリアルID
`source_logical_id`	`common.UInt8`	送信元の論理デバイスID
`lqi`	`optional common.UInt8`	電波通信品質
`supply_voltage`	`optional common.UInt16`	電源電圧（mV）
`destination_logical_id`	`common.UInt8`	送信先の論理デバイスID
`relay_count`	`common.UInt8`	中継回数
`periodic`	`bool`	定期送信か否か
`di_changed`	`common.CrossSectional[bool](4)`	デジタルインタフェースの変化の有無
`di_state`	`common.CrossSectional[bool](4)`	デジタルインタフェースの状態
`ai_voltage`	`common.CrossSectional[common.UInt16](4)`	アナログインタフェースの電圧

** で unpack した辞書を渡すことができます。

コンストラクタの引数へ指定する変数に加えて、次の @computed_field を持ちます。

名称	型	内容
`mwings_implementation`	`str`	MWings の実装（`"python"`のみ）
`mwings_version`	`str`	MWings のバージョン（PEP440形式）
`hostname`	`str`	ホストマシン名
`system_type`	`str`	システム種別（`"Linux"`など）

適用される field_validator

source_logical_id：値の範囲を自動的に検証します
- check_source_logical_id(lid)
time_parsed：タイムゾーンが付与されているかを自動的に検証します
- datetime_must_be_clear(dt)
ai_voltage：値の範囲を自動的に検証します
- check_ai_voltage(aiv)
destination_logical_id：値の範囲を自動的に検証します
- check_destination_logical_id(lid)

適用される field_serializer

packet_type：列挙子の名前をそのままJSON等に適用します
- serialize_packet_type(packet_type)
source_serial_id：16進表記の文字列をJSON等に適用します
- serialize_source_serial_id(source_serial_id)
time_parsed：ISO 8601形式の文字列をJSON等に適用します
- serialize_time_parsed(dt)

`to_df()`

to_df(include=None, exclude=None, verbose=True)

パースしたデータを pandas のデータフレーム形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	データフレームへ含めるカラム（メンバ）の集合
`exclude`	`optional set[str]`	データフレームへ含めないカラム（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）

戻り値

型	値	内容
`pd.DataFrame`	-	変換したデータフレーム

例外

EnvironmentError pandas のない場合

`to_dict()`

to_dict(include=None, exclude=None, verbose=True, spread=False, sort_keys=False)

パースしたデータを辞書形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	辞書へ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	辞書へ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`sort_keys`	`bool`	キーによるソートの有無

spread を設定すると、common.CrossSectional[T]型のデータを分割します。

戻り値

型	値	内容
`dict[str, Any]`	-	変換した辞書

`to_json()`

to_json(include=None, exclude=None, verbose=True, spread=False, indent=2, sort_keys=False)

パースしたデータをJSON形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	JSONへ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	JSONへ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`indent`	`optional int`	インデントの数（`None`で改行なし）
`sort_keys`	`bool`	キーによるソートの有無

spread を設定すると、common.CrossSectional[T]型のデータを分割します。

戻り値

型	値	内容
`str`	-	変換したJSON文字列

`model_*()`

上記に加えて、pydantic.BaseModelの各メソッドを利用できます。

2 - mwings.parsers.app_io モジュール

mwings.parsers.app_io

リモコンアプリから送信されたデータを表すパケットを解釈するパーサと、そのデータを扱います。

src/mwings/parsers/app_io.py

`PacketParser`

リモコンアプリから送信されたデータを表すパケットを解釈するパーサの静的クラス

継承：common.PacketParserBase

継承元のメンバを記載します。

`is_valid()`

is_valid(bare_packet)

与えられた素のパケットが有効であるか否かを確認します。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`bool`	`True`	有効、パース可
	`False`	無効、パース不可

`parse()`

parse(bare_packet)

与えられた素のパケットをパースします。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`optional ParsedPacket`	`ParsedPacket`の型をもつデータ	パースしたデータ
	`None`	パース不可

`ParsedPacket`

リモコンアプリから送信されたデータを表すパケットを解釈した結果を格納するための構造体

継承：common.ParsedPacketBase

継承元のメンバも合わせて記載します。

`ParsedPacket()`

ParsedPacket(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None, relay_count=0, di_state=<mwings.common.CrossSectional object>, di_valid=<mwings.common.CrossSectional object>, di_interrupt=<mwings.common.CrossSectional object>)

引数

継承元のプロパティも合わせて表記します。

名称	型	内容
`time_parsed`	`optional AwareDatetime`	パース時刻
`packet_type`	`common.PacketType`	パケット種別
`sequence_number`	`optional common.UInt16`	シーケンス番号
`source_serial_id`	`common.UInt32`	送信元のシリアルID
`source_logical_id`	`common.UInt8`	送信元の論理デバイスID
`lqi`	`optional common.UInt8`	電波通信品質
`supply_voltage`	`optional common.UInt16`	ADCを使わないため常に`None`
`relay_count`	`common.UInt8`	中継回数
`di_changed`	`common.CrossSectional[bool](12)`	デジタルインタフェースの変化の有無
`di_state`	`common.CrossSectional[bool](12)`	デジタルインタフェースの状態
`di_interrupt`	`common.CrossSectional[bool](12)`	デジタルインタフェースの割り込みの有無

** で unpack した辞書を渡すことができます。

コンストラクタの引数へ指定する変数に加えて、次の @computed_field を持ちます。

名称	型	内容
`mwings_implementation`	`str`	MWings の実装（`"python"`のみ）
`mwings_version`	`str`	MWings のバージョン（PEP440形式）
`hostname`	`str`	ホストマシン名
`system_type`	`str`	システム種別（`"Linux"`など）

適用される field_validator

source_logical_id：値の範囲を自動的に検証します
- check_source_logical_id(lid)
time_parsed：タイムゾーンが付与されているかを自動的に検証します
- datetime_must_be_clear(dt)

適用される field_serializer

packet_type：列挙子の名前をそのままJSON等に適用します
- serialize_packet_type(packet_type)
source_serial_id：16進表記の文字列をJSON等に適用します
- serialize_source_serial_id(source_serial_id)
time_parsed：ISO 8601形式の文字列をJSON等に適用します
- serialize_time_parsed(dt)

`to_df()`

to_df(include=None, exclude=None, verbose=True)

パースしたデータを pandas のデータフレーム形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	データフレームへ含めるカラム（メンバ）の集合
`exclude`	`optional set[str]`	データフレームへ含めないカラム（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）

戻り値

型	値	内容
`pd.DataFrame`	-	変換したデータフレーム

例外

EnvironmentError pandas のない場合

`to_dict()`

to_dict(include=None, exclude=None, verbose=True, spread=False, sort_keys=False)

パースしたデータを辞書形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	辞書へ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	辞書へ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`sort_keys`	`bool`	キーによるソートの有無

spread を設定すると、common.CrossSectional[T]型のデータを分割します。

戻り値

型	値	内容
`dict[str, Any]`	-	変換した辞書

`to_json()`

to_json(include=None, exclude=None, verbose=True, spread=False, indent=2, sort_keys=False)

パースしたデータをJSON形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	JSONへ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	JSONへ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`indent`	`optional int`	インデントの数（`None`で改行なし）
`sort_keys`	`bool`	キーによるソートの有無

spread を設定すると、common.CrossSectional[T]型のデータを分割します。

戻り値

型	値	内容
`str`	-	変換したJSON文字列

`model_*()`

上記に加えて、pydantic.BaseModelの各メソッドを利用できます。

3 - mwings.parsers.app_aria モジュール

mwings.parsers.app_aria

アリアアプリから送信されたデータを表すパケットを解釈するパーサと、そのデータを扱います。

src/mwings/parsers/app_aria.py

`PacketParser`

アリアアプリから送信されたデータを表すパケットを解釈するパーサの静的クラス

継承：common.PacketParserBase

継承元のメンバを記載します。

`is_valid()`

is_valid(bare_packet)

与えられた素のパケットが有効であるか否かを確認します。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`bool`	`True`	有効、パース可
	`False`	無効、パース不可

`parse()`

parse(bare_packet)

与えられた素のパケットをパースします。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`optional ParsedPacket`	`ParsedPacket`の型をもつデータ	パースしたデータ
	`None`	パース不可

`ParsedPacket`

アリアアプリから送信されたデータを表すパケットを解釈した結果を格納するための構造体

継承：common.ParsedPacketBase

継承元のメンバも合わせて記載します。

`ParsedPacket()`

ParsedPacket(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None, temp_100x=0, humid_100x=0, magnet_state=MagnetState.NOT_DETECTED, magnet_state_changed=False)

引数

継承元のプロパティも合わせて表記します。

名称	型	内容
`time_parsed`	`optional AwareDatetime`	パース時刻
`packet_type`	`common.PacketType`	パケット種別
`sequence_number`	`optional common.UInt16`	シーケンス番号
`source_serial_id`	`common.UInt32`	送信元のシリアルID
`source_logical_id`	`common.UInt8`	送信元の論理デバイスID
`lqi`	`optional common.UInt8`	電波通信品質
`supply_voltage`	`optional common.UInt16`	電源電圧（mV）
`temp_100x`	`common.Int16`	100倍された温度（セ氏）
`humid_100x`	`common.UInt16`	100倍された相対湿度
`magnet_state`	`common.MagnetState`	磁石の状態
`magnet_state_changed`	`bool`	磁石の状態の変化の有無

** で unpack した辞書を渡すことができます。

コンストラクタの引数へ指定する変数に加えて、次の @computed_field を持ちます。

名称	型	内容
`mwings_implementation`	`str`	MWings の実装（`"python"`のみ）
`mwings_version`	`str`	MWings のバージョン（PEP440形式）
`hostname`	`str`	ホストマシン名
`system_type`	`str`	システム種別（`"Linux"`など）

適用される field_validator

source_logical_id：値の範囲を自動的に検証します
- check_source_logical_id(lid)
time_parsed：タイムゾーンが付与されているかを自動的に検証します
- datetime_must_be_clear(dt)

適用される field_serializer

packet_type：列挙子の名前をそのままJSON等に適用します
- serialize_packet_type(packet_type)
source_serial_id：16進表記の文字列をJSON等に適用します
- serialize_source_serial_id(source_serial_id)
time_parsed：ISO 8601形式の文字列をJSON等に適用します
- serialize_time_parsed(dt)
magnet_state：列挙子の名前をそのままJSON等に適用します
- serialize_magnet_state(magnet_state)

`to_df()`

to_df(include=None, exclude=None, verbose=True)

パースしたデータを pandas のデータフレーム形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	データフレームへ含めるカラム（メンバ）の集合
`exclude`	`optional set[str]`	データフレームへ含めないカラム（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）

戻り値

型	値	内容
`pd.DataFrame`	-	変換したデータフレーム

例外

EnvironmentError pandas のない場合

`to_dict()`

to_dict(include=None, exclude=None, verbose=True, spread=False, sort_keys=False)

パースしたデータを辞書形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	辞書へ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	辞書へ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`sort_keys`	`bool`	キーによるソートの有無

戻り値

型	値	内容
`dict[str, Any]`	-	変換した辞書

`to_json()`

to_json(include=None, exclude=None, verbose=True, spread=False, indent=2, sort_keys=False)

パースしたデータをJSON形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	JSONへ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	JSONへ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`indent`	`optional int`	インデントの数（`None`で改行なし）
`sort_keys`	`bool`	キーによるソートの有無

戻り値

型	値	内容
`str`	-	変換したJSON文字列

`model_*()`

上記に加えて、pydantic.BaseModelの各メソッドを利用できます。

4 - mwings.parsers.app_cue モジュール

mwings.parsers.app_cue

キューアプリ（TWELITE CUEモード）から送信されたデータを表すパケットを解釈するパーサと、そのデータを扱います。

src/mwings/parsers/app_cue.py

`PacketParser`

キューアプリ（TWELITE CUEモード）から送信されたデータを表すパケットを解釈するパーサの静的クラス

継承：common.PacketParserBase

継承元のメンバを記載します。

`is_valid()`

is_valid(bare_packet)

与えられた素のパケットが有効であるか否かを確認します。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`bool`	`True`	有効、パース可
	`False`	無効、パース不可

`parse()`

parse(bare_packet)

与えられた素のパケットをパースします。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`optional ParsedPacket`	`ParsedPacket`の型をもつデータ	パースしたデータ
	`None`	パース不可

`ParsedPacket`

キューアプリ（TWELITE CUEモード）から送信されたデータを表すパケットを解釈した結果を格納するための構造体

継承：common.ParsedPacketBase

継承元のメンバも合わせて記載します。

`ParsedPacket()`

ParsedPacket(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None, sample_count=10, samples_x=<mwings.common.TimeSeries object>, samples_y=<mwings.common.TimeSeries object>, samples_z=<mwings.common.TimeSeries object>, has_accel_event=False, accel_event=AccelEvent.NONE, magnet_state=MagnetState.NOT_DETECTED, magnet_state_changed=False)

引数

継承元のプロパティも合わせて表記します。

名称	型	内容
`time_parsed`	`optional AwareDatetime`	パース時刻
`packet_type`	`common.PacketType`	パケット種別
`sequence_number`	`optional common.UInt16`	シーケンス番号
`source_serial_id`	`common.UInt32`	送信元のシリアルID
`source_logical_id`	`common.UInt8`	送信元の論理デバイスID
`lqi`	`optional common.UInt8`	電波通信品質
`supply_voltage`	`optional common.UInt16`	電源電圧（mV）
`sample_count`	`common.UInt8`	各軸の加速度サンプルの数
`samples_x`	`common.TimeSeries[common.Int16]`	X軸の加速度サンプル
`samples_y`	`common.TimeSeries[common.Int16]`	Y軸の加速度サンプル
`samples_z`	`common.TimeSeries[common.Int16]`	Z軸の加速度サンプル
`has_accel_event`	`bool`	加速度イベントの有無
`accel_event`	`common.AccelEvent`	加速度イベント
`magnet_state`	`common.MagnetState`	磁石の状態
`magnet_state_changed`	`bool`	磁石の状態の変化の有無

** で unpack した辞書を渡すことができます。

コンストラクタの引数へ指定する変数に加えて、次の @computed_field を持ちます。

名称	型	内容
`mwings_implementation`	`str`	MWings の実装（`"python"`のみ）
`mwings_version`	`str`	MWings のバージョン（PEP440形式）
`hostname`	`str`	ホストマシン名
`system_type`	`str`	システム種別（`"Linux"`など）

適用される field_validator

source_logical_id：値の範囲を自動的に検証します
- check_source_logical_id(lid)
time_parsed：タイムゾーンが付与されているかを自動的に検証します
- datetime_must_be_clear(dt)

適用される field_serializer

packet_type：列挙子の名前をそのままJSON等に適用します
- serialize_packet_type(packet_type)
source_serial_id：16進表記の文字列をJSON等に適用します
- serialize_source_serial_id(source_serial_id)
time_parsed：ISO 8601形式の文字列をJSON等に適用します
- serialize_time_parsed(dt)
accel_event：列挙子の名前をそのままJSON等に適用します
- serialize_accel_event(accel_event)
magnet_state：列挙子の名前をそのままJSON等に適用します
- serialize_magnet_state(magnet_state)

`to_df()`

to_df(include=None, exclude=None, verbose=True)

パースしたデータを pandas のデータフレーム形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	データフレームへ含めるカラム（メンバ）の集合
`exclude`	`optional set[str]`	データフレームへ含めないカラム（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）

戻り値

型	値	内容
`pd.DataFrame`	-	変換したデータフレーム

例外

EnvironmentError pandas のない場合

`to_dict()`

to_dict(include=None, exclude=None, verbose=True, spread=False, sort_keys=False)

パースしたデータを辞書形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	辞書へ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	辞書へ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`sort_keys`	`bool`	キーによるソートの有無

spread を設定しても、common.TimeSeries[T]型の時系列データは分割しません。

戻り値

型	値	内容
`dict[str, Any]`	-	変換した辞書

`to_json()`

to_json(include=None, exclude=None, verbose=True, spread=False, indent=2, sort_keys=False)

パースしたデータをJSON形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	JSONへ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	JSONへ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`indent`	`optional int`	インデントの数（`None`で改行なし）
`sort_keys`	`bool`	キーによるソートの有無

spread を設定しても、common.TimeSeries[T]型の時系列データは分割しません。

戻り値

型	値	内容
`str`	-	変換したJSON文字列

`model_*()`

上記に加えて、pydantic.BaseModelの各メソッドを利用できます。

5 - mwings.parsers.app_cue_pal_event モジュール

mwings.parsers.app_cue_pal_event

キューアプリ（動作パルモード：ダイス／ムーブモード）から送信されたデータを表すパケットを解釈するパーサと、そのデータを扱います。

src/mwings/parsers/app_cue_pal_event.py

`PacketParser`

キューアプリ（動作パルモード：ダイス／ムーブモード）から送信されたデータを表すパケットを解釈するパーサの静的クラス

継承：common.PacketParserBase

継承元のメンバを記載します。

`is_valid()`

is_valid(bare_packet)

与えられた素のパケットが有効であるか否かを確認します。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`bool`	`True`	有効、パース可
	`False`	無効、パース不可

`parse()`

parse(bare_packet)

与えられた素のパケットをパースします。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`optional ParsedPacket`	`ParsedPacket`の型をもつデータ	パースしたデータ
	`None`	パース不可

`ParsedPacket`

キューアプリ（動作パルモード：ダイス／ムーブモード）から送信されたデータを表すパケットを解釈した結果を格納するための構造体

継承：common.ParsedPacketBase

継承元のメンバも合わせて記載します。

`ParsedPacket()`

ParsedPacket(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None, ai1_voltage=0, accel_event=AccelEvent.NONE)

引数

継承元のプロパティも合わせて表記します。

名称	型	内容
`time_parsed`	`optional AwareDatetime`	パース時刻
`packet_type`	`common.PacketType`	パケット種別
`sequence_number`	`optional common.UInt16`	シーケンス番号
`source_serial_id`	`common.UInt32`	送信元のシリアルID
`source_logical_id`	`common.UInt8`	送信元の論理デバイスID
`lqi`	`optional common.UInt8`	電波通信品質
`supply_voltage`	`optional common.UInt16`	電源電圧（mV）
`ai1_voltage`	`common.UInt16`	`AI1`の電圧（mV）
`accel_event`	`common.AccelEvent`	加速度イベント

** で unpack した辞書を渡すことができます。

コンストラクタの引数へ指定する変数に加えて、次の @computed_field を持ちます。

名称	型	内容
`mwings_implementation`	`str`	MWings の実装（`"python"`のみ）
`mwings_version`	`str`	MWings のバージョン（PEP440形式）
`hostname`	`str`	ホストマシン名
`system_type`	`str`	システム種別（`"Linux"`など）

適用される field_validator

source_logical_id：値の範囲を自動的に検証します
- check_source_logical_id(lid)
time_parsed：タイムゾーンが付与されているかを自動的に検証します
- datetime_must_be_clear(dt)

適用される field_serializer

packet_type：列挙子の名前をそのままJSON等に適用します
- serialize_packet_type(packet_type)
source_serial_id：16進表記の文字列をJSON等に適用します
- serialize_source_serial_id(source_serial_id)
time_parsed：ISO 8601形式の文字列をJSON等に適用します
- serialize_time_parsed(dt)
accel_event：列挙子の名前をそのままJSON等に適用します
- serialize_accel_event(accel_event)

`to_df()`

to_df(include=None, exclude=None, verbose=True)

パースしたデータを pandas のデータフレーム形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	データフレームへ含めるカラム（メンバ）の集合
`exclude`	`optional set[str]`	データフレームへ含めないカラム（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）

戻り値

型	値	内容
`pd.DataFrame`	-	変換したデータフレーム

例外

EnvironmentError pandas のない場合

`to_dict()`

to_dict(include=None, exclude=None, verbose=True, spread=False, sort_keys=False)

パースしたデータを辞書形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	辞書へ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	辞書へ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`sort_keys`	`bool`	キーによるソートの有無

spread を設定すると、common.CrossSectional[T]型のデータを分割します。common.TimeSeries[T]型の時系列データは分割しません。

戻り値

型	値	内容
`dict[str, Any]`	-	変換した辞書

`to_json()`

to_json(include=None, exclude=None, verbose=True, spread=False, indent=2, sort_keys=False)

パースしたデータをJSON形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	JSONへ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	JSONへ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`indent`	`optional int`	インデントの数（`None`で改行なし）
`sort_keys`	`bool`	キーによるソートの有無

spread を設定すると、common.CrossSectional[T]型のデータを分割します。common.TimeSeries[T]型の時系列データは分割しません。

戻り値

型	値	内容
`str`	-	変換したJSON文字列

`model_*()`

上記に加えて、pydantic.BaseModelの各メソッドを利用できます。

6 - mwings.parsers.app_pal_openclose モジュール

mwings.parsers.app_pal_openclose

パルアプリ（開閉パル）から送信されたデータを表すパケットを解釈するパーサと、そのデータを扱います。

src/mwings/parsers/app_pal_openclose.py

`PacketParser`

パルアプリ（開閉パル）から送信されたデータを表すパケットを解釈するパーサの静的クラス

継承：common.PacketParserBase

継承元のメンバを記載します。

`is_valid()`

is_valid(bare_packet)

与えられた素のパケットが有効であるか否かを確認します。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`bool`	`True`	有効、パース可
	`False`	無効、パース不可

`parse()`

parse(bare_packet)

与えられた素のパケットをパースします。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`optional ParsedPacket`	`ParsedPacket`の型をもつデータ	パースしたデータ
	`None`	パース不可

`ParsedPacket`

パルアプリ（開閉パル）から送信されたデータを表すパケットを解釈した結果を格納するための構造体

継承：common.ParsedPacketBase

継承元のメンバも合わせて記載します。

`ParsedPacket()`

ParsedPacket(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None, ai1_voltage=0, magnet_state=MagnetState.NOT_DETECTED, magnet_state_changed=False)

引数

継承元のプロパティも合わせて表記します。

名称	型	内容
`time_parsed`	`optional AwareDatetime`	パース時刻
`packet_type`	`common.PacketType`	パケット種別
`sequence_number`	`optional common.UInt16`	シーケンス番号
`source_serial_id`	`common.UInt32`	送信元のシリアルID
`source_logical_id`	`common.UInt8`	送信元の論理デバイスID
`lqi`	`optional common.UInt8`	電波通信品質
`supply_voltage`	`optional common.UInt16`	電源電圧（mV）
`ai1_voltage`	`common.UInt16`	`AI1`の電圧（mV）
`magnet_state`	`common.MagnetState`	磁石の状態
`magnet_state_changed`	`bool`	磁石の状態の変化の有無

** で unpack した辞書を渡すことができます。

コンストラクタの引数へ指定する変数に加えて、次の @computed_field を持ちます。

名称	型	内容
`mwings_implementation`	`str`	MWings の実装（`"python"`のみ）
`mwings_version`	`str`	MWings のバージョン（PEP440形式）
`hostname`	`str`	ホストマシン名
`system_type`	`str`	システム種別（`"Linux"`など）

適用される field_validator

source_logical_id：値の範囲を自動的に検証します
- check_source_logical_id(lid)
time_parsed：タイムゾーンが付与されているかを自動的に検証します
- datetime_must_be_clear(dt)

適用される field_serializer

packet_type：列挙子の名前をそのままJSON等に適用します
- serialize_packet_type(packet_type)
source_serial_id：16進表記の文字列をJSON等に適用します
- serialize_source_serial_id(source_serial_id)
time_parsed：ISO 8601形式の文字列をJSON等に適用します
- serialize_time_parsed(dt)
magnet_state：列挙子の名前をそのままJSON等に適用します
- serialize_magnet_state(magnet_state)

`to_df()`

to_df(include=None, exclude=None, verbose=True)

パースしたデータを pandas のデータフレーム形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	データフレームへ含めるカラム（メンバ）の集合
`exclude`	`optional set[str]`	データフレームへ含めないカラム（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）

戻り値

型	値	内容
`pd.DataFrame`	-	変換したデータフレーム

例外

EnvironmentError pandas のない場合

`to_dict()`

to_dict(include=None, exclude=None, verbose=True, spread=False, sort_keys=False)

パースしたデータを辞書形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	辞書へ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	辞書へ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`sort_keys`	`bool`	キーによるソートの有無

戻り値

型	値	内容
`dict[str, Any]`	-	変換した辞書

`to_json()`

to_json(include=None, exclude=None, verbose=True, spread=False, indent=2, sort_keys=False)

パースしたデータをJSON形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	JSONへ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	JSONへ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`indent`	`optional int`	インデントの数（`None`で改行なし）
`sort_keys`	`bool`	キーによるソートの有無

戻り値

型	値	内容
`str`	-	変換したJSON文字列

`model_*()`

上記に加えて、pydantic.BaseModelの各メソッドを利用できます。

7 - mwings.parsers.app_pal_amb モジュール

mwings.parsers.app_pal_amb

パルアプリ（環境パル）から送信されたデータを表すパケットを解釈するパーサと、そのデータを扱います。

src/mwings/parsers/app_pal_amb.py

`PacketParser`

パルアプリ（環境パル）から送信されたデータを表すパケットを解釈するパーサの静的クラス

継承：common.PacketParserBase

継承元のメンバを記載します。

`is_valid()`

is_valid(bare_packet)

与えられた素のパケットが有効であるか否かを確認します。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`bool`	`True`	有効、パース可
	`False`	無効、パース不可

`parse()`

parse(bare_packet)

与えられた素のパケットをパースします。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`optional ParsedPacket`	`ParsedPacket`の型をもつデータ	パースしたデータ
	`None`	パース不可

`ParsedPacket`

パルアプリ（環境パル）から送信されたデータを表すパケットを解釈した結果を格納するための構造体

継承：common.ParsedPacketBase

継承元のメンバも合わせて記載します。

`ParsedPacket()`

ParsedPacket(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None, ai1_voltage=0, temp_100x=0, humid_100x=0, illuminance=0)

引数

継承元のプロパティも合わせて表記します。

名称	型	内容
`time_parsed`	`optional AwareDatetime`	パース時刻
`packet_type`	`common.PacketType`	パケット種別
`sequence_number`	`optional common.UInt16`	シーケンス番号
`source_serial_id`	`common.UInt32`	送信元のシリアルID
`source_logical_id`	`common.UInt8`	送信元の論理デバイスID
`lqi`	`optional common.UInt8`	電波通信品質
`supply_voltage`	`optional common.UInt16`	電源電圧（mV）
`ai1_voltage`	`common.UInt16`	`AI1`の電圧（mV）
`temp_100x`	`common.Int16`	100倍された温度（セ氏）
`humid_100x`	`common.UInt16`	100倍された相対湿度
`illuminance`	`common.UInt32`	照度（lx）

** で unpack した辞書を渡すことができます。

コンストラクタの引数へ指定する変数に加えて、次の @computed_field を持ちます。

名称	型	内容
`mwings_implementation`	`str`	MWings の実装（`"python"`のみ）
`mwings_version`	`str`	MWings のバージョン（PEP440形式）
`hostname`	`str`	ホストマシン名
`system_type`	`str`	システム種別（`"Linux"`など）

適用される field_validator

source_logical_id：値の範囲を自動的に検証します
- check_source_logical_id(lid)
time_parsed：タイムゾーンが付与されているかを自動的に検証します
- datetime_must_be_clear(dt)

適用される field_serializer

packet_type：列挙子の名前をそのままJSON等に適用します
- serialize_packet_type(packet_type)
source_serial_id：16進表記の文字列をJSON等に適用します
- serialize_source_serial_id(source_serial_id)
time_parsed：ISO 8601形式の文字列をJSON等に適用します
- serialize_time_parsed(dt)

`to_df()`

to_df(include=None, exclude=None, verbose=True)

パースしたデータを pandas のデータフレーム形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	データフレームへ含めるカラム（メンバ）の集合
`exclude`	`optional set[str]`	データフレームへ含めないカラム（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）

戻り値

型	値	内容
`pd.DataFrame`	-	変換したデータフレーム

例外

EnvironmentError pandas のない場合

`to_dict()`

to_dict(include=None, exclude=None, verbose=True, spread=False, sort_keys=False)

パースしたデータを辞書形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	辞書へ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	辞書へ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`sort_keys`	`bool`	キーによるソートの有無

戻り値

型	値	内容
`dict[str, Any]`	-	変換した辞書

`to_json()`

to_json(include=None, exclude=None, verbose=True, spread=False, indent=2, sort_keys=False)

パースしたデータをJSON形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	JSONへ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	JSONへ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`indent`	`optional int`	インデントの数（`None`で改行なし）
`sort_keys`	`bool`	キーによるソートの有無

戻り値

型	値	内容
`str`	-	変換したJSON文字列

`model_*()`

上記に加えて、pydantic.BaseModelの各メソッドを利用できます。

8 - mwings.parsers.app_pal_mot モジュール

mwings.parsers.app_pal_mot

パルアプリ（動作パル）やキューアプリ（動作パルモード：加速度計測）から送信されたデータを表すパケットを解釈するパーサと、そのデータを扱います。

src/mwings/parsers/app_pal_mot.py

`PacketParser`

パルアプリ（動作パル）やキューアプリ（動作パルモード：加速度計測）から送信されたデータを表すパケットを解釈するパーサの静的クラス

継承：common.PacketParserBase

継承元のメンバを記載します。

`is_valid()`

is_valid(bare_packet)

与えられた素のパケットが有効であるか否かを確認します。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`bool`	`True`	有効、パース可
	`False`	無効、パース不可

`parse()`

parse(bare_packet)

与えられた素のパケットをパースします。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`optional ParsedPacket`	`ParsedPacket`の型をもつデータ	パースしたデータ
	`None`	パース不可

`ParsedPacket`

パルアプリ（動作パル）やキューアプリ（動作パルモード：加速度計測）から送信されたデータを表すパケットを解釈した結果を格納するための構造体

継承：common.ParsedPacketBase

継承元のメンバも合わせて記載します。

`ParsedPacket()`

ParsedPacket(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None, ai1_voltage=0, sample_count=16, samples_x=<mwings.common.TimeSeries object>, samples_y=<mwings.common.TimeSeries object>, samples_z=<mwings.common.TimeSeries object>, sampling_frequency=25)

引数

継承元のプロパティも合わせて表記します。

名称	型	内容
`time_parsed`	`optional AwareDatetime`	パース時刻
`packet_type`	`common.PacketType`	パケット種別
`sequence_number`	`optional common.UInt16`	シーケンス番号
`source_serial_id`	`common.UInt32`	送信元のシリアルID
`source_logical_id`	`common.UInt8`	送信元の論理デバイスID
`lqi`	`optional common.UInt8`	電波通信品質
`supply_voltage`	`optional common.UInt16`	電源電圧（mV）
`ai1_voltage`	`common.UInt16`	`AI1`の電圧（mV）
`sample_count`	`common.UInt8`	各軸の加速度サンプルの数
`samples_x`	`common.TimeSeries[common.Int16]`	X軸の加速度サンプル
`samples_y`	`common.TimeSeries[common.Int16]`	Y軸の加速度サンプル
`samples_z`	`common.TimeSeries[common.Int16]`	Z軸の加速度サンプル
`sampling_frequency`	`common.UInt16`	加速度サンプリング周波数

** で unpack した辞書を渡すことができます。

コンストラクタの引数へ指定する変数に加えて、次の @computed_field を持ちます。

名称	型	内容
`mwings_implementation`	`str`	MWings の実装（`"python"`のみ）
`mwings_version`	`str`	MWings のバージョン（PEP440形式）
`hostname`	`str`	ホストマシン名
`system_type`	`str`	システム種別（`"Linux"`など）

適用される field_validator

source_logical_id：値の範囲を自動的に検証します
- check_source_logical_id(lid)
time_parsed：タイムゾーンが付与されているかを自動的に検証します
- datetime_must_be_clear(dt)
sampling_frequency：値を検証します
- check_sampling_frequency(freq)

適用される field_serializer

packet_type：列挙子の名前をそのままJSON等に適用します
- serialize_packet_type(packet_type)
source_serial_id：16進表記の文字列をJSON等に適用します
- serialize_source_serial_id(source_serial_id)
time_parsed：ISO 8601形式の文字列をJSON等に適用します
- serialize_time_parsed(dt)

`to_df()`

to_df(include=None, exclude=None, verbose=True)

パースしたデータを pandas のデータフレーム形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	データフレームへ含めるカラム（メンバ）の集合
`exclude`	`optional set[str]`	データフレームへ含めないカラム（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）

戻り値

型	値	内容
`pd.DataFrame`	-	変換したデータフレーム

例外

EnvironmentError pandas のない場合

`to_dict()`

to_dict(include=None, exclude=None, verbose=True, spread=False, sort_keys=False)

パースしたデータを辞書形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	辞書へ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	辞書へ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`sort_keys`	`bool`	キーによるソートの有無

spread を設定しても、common.TimeSeries[T]型の時系列データは分割しません。

戻り値

型	値	内容
`dict[str, Any]`	-	変換した辞書

`to_json()`

to_json(include=None, exclude=None, verbose=True, spread=False, indent=2, sort_keys=False)

パースしたデータをJSON形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	JSONへ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	JSONへ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`indent`	`optional int`	インデントの数（`None`で改行なし）
`sort_keys`	`bool`	キーによるソートの有無

spread を設定しても、common.TimeSeries[T]型の時系列データは分割しません。

戻り値

型	値	内容
`str`	-	変換したJSON文字列

`model_*()`

上記に加えて、pydantic.BaseModelの各メソッドを利用できます。

9 - mwings.parsers.app_uart_ascii モジュール

mwings.parsers.app_uart_ascii

シリアル通信アプリ（書式モード：簡易形式）から送信されたデータを表すパケットを解釈するパーサと、そのデータを扱います。

src/mwings/parsers/app_uart_ascii.py

`PacketParser`

シリアル通信アプリ（書式モード：簡易形式）から送信されたデータを表すパケットを解釈するパーサの静的クラス

継承：common.PacketParserBase

継承元のメンバを記載します。

`is_valid()`

is_valid(bare_packet)

与えられた素のパケットが有効であるか否かを確認します。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`bool`	`True`	有効、パース可
	`False`	無効、パース不可

`parse()`

parse(bare_packet)

与えられた素のパケットをパースします。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`optional ParsedPacket`	`ParsedPacket`の型をもつデータ	パースしたデータ
	`None`	パース不可

`ParsedPacket`

シリアル通信アプリ（書式モード：簡易形式）から送信されたデータを表すパケットを解釈した結果を格納するための構造体

継承：common.ParsedPacketBase

継承元のメンバも合わせて記載します。

`ParsedPacket()`

ParsedPacket(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None, command_id=0, data=b'')

引数

継承元のプロパティも合わせて表記します。

名称	型	内容
`time_parsed`	`optional AwareDatetime`	パース時刻
`packet_type`	`common.PacketType`	パケット種別
`sequence_number`	`optional common.UInt16`	取得不可、常に`None`
`source_serial_id`	`common.UInt32`	送信元のシリアルID
`source_logical_id`	`common.UInt8`	送信元の論理デバイスID
`lqi`	`optional common.UInt8`	取得不可、常に`None`
`supply_voltage`	`optional common.UInt16`	取得不可、常に`None`
`commnad_id`	`common.UInt8`	コマンドID
`data`	`bytes`	データ

** で unpack した辞書を渡すことができます。

コンストラクタの引数へ指定する変数に加えて、次の @computed_field を持ちます。

名称	型	内容
`mwings_implementation`	`str`	MWings の実装（`"python"`のみ）
`mwings_version`	`str`	MWings のバージョン（PEP440形式）
`hostname`	`str`	ホストマシン名
`system_type`	`str`	システム種別（`"Linux"`など）
`data_base64`	`str`	データのBase64表記
`data_hexstr`	`str`	データの16進数表記

dataはJSON等に含まれません。data_base64やdata_hexstrを利用してください。

適用される field_validator

source_logical_id：値の範囲を自動的に検証します
- check_source_logical_id(lid)
time_parsed：タイムゾーンが付与されているかを自動的に検証します
- datetime_must_be_clear(dt)
sampling_frequency：値を検証します
- check_sampling_frequency(freq)
data：長さを自動的に検証します
- check_data(data)

適用される field_serializer

packet_type：列挙子の名前をそのままJSON等に適用します
- serialize_packet_type(packet_type)
source_serial_id：16進表記の文字列をJSON等に適用します
- serialize_source_serial_id(source_serial_id)
time_parsed：ISO 8601形式の文字列をJSON等に適用します
- serialize_time_parsed(dt)
``

`to_df()`

to_df(include=None, exclude=None, verbose=True)

パースしたデータを pandas のデータフレーム形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	データフレームへ含めるカラム（メンバ）の集合
`exclude`	`optional set[str]`	データフレームへ含めないカラム（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）

戻り値

型	値	内容
`pd.DataFrame`	-	変換したデータフレーム

例外

EnvironmentError pandas のない場合

`to_dict()`

to_dict(include=None, exclude=None, verbose=True, spread=False, sort_keys=False)

パースしたデータを辞書形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	辞書へ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	辞書へ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`sort_keys`	`bool`	キーによるソートの有無

戻り値

型	値	内容
`dict[str, Any]`	-	変換した辞書

`to_json()`

to_json(include=None, exclude=None, verbose=True, spread=False, indent=2, sort_keys=False)

パースしたデータをJSON形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	JSONへ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	JSONへ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`indent`	`optional int`	インデントの数（`None`で改行なし）
`sort_keys`	`bool`	キーによるソートの有無

戻り値

型	値	内容
`str`	-	変換したJSON文字列

`model_*()`

上記に加えて、pydantic.BaseModelの各メソッドを利用できます。

10 - mwings.parsers.app_uart_ascii_extended モジュール

mwings.parsers.app_uart_ascii_extended

シリアル通信アプリ（書式モード：拡張形式）から送信されたデータを表すパケットを解釈するパーサと、そのデータを扱います。

src/mwings/parsers/app_uart_ascii_extended.py

`PacketParser`

シリアル通信アプリ（書式モード：拡張形式）から送信されたデータを表すパケットを解釈するパーサの静的クラス

継承：common.PacketParserBase

継承元のメンバを記載します。

`is_valid()`

is_valid(bare_packet)

与えられた素のパケットが有効であるか否かを確認します。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`bool`	`True`	有効、パース可
	`False`	無効、パース不可

`parse()`

parse(bare_packet)

与えられた素のパケットをパースします。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`optional ParsedPacket`	`ParsedPacket`の型をもつデータ	パースしたデータ
	`None`	パース不可

`ParsedPacket`

シリアル通信アプリ（書式モード：拡張形式）から送信されたデータを表すパケットを解釈した結果を格納するための構造体

継承：common.ParsedPacketBase

継承元のメンバも合わせて記載します。

`ParsedPacket()`

ParsedPacket(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None, destination_serial_id=120, command_id=0, data=b'')

引数

継承元のプロパティも合わせて表記します。

名称	型	内容
`time_parsed`	`optional AwareDatetime`	パース時刻
`packet_type`	`common.PacketType`	パケット種別
`sequence_number`	`optional common.UInt16`	取得不可、常に`None`
`source_serial_id`	`common.UInt32`	送信元のシリアルID
`source_logical_id`	`common.UInt8`	送信元の論理デバイスID
`lqi`	`common.UInt8`	電波通信品質
`supply_voltage`	`optional common.UInt16`	取得不可、常に`None`
`destination_serial_id`	`common.UInt32`	送信先のシリアルID
`commnad_id`	`common.UInt8`	コマンドID
`data`	`bytes`	データ

** で unpack した辞書を渡すことができます。

コンストラクタの引数へ指定する変数に加えて、次の @computed_field を持ちます。

名称	型	内容
`mwings_implementation`	`str`	MWings の実装（`"python"`のみ）
`mwings_version`	`str`	MWings のバージョン（PEP440形式）
`hostname`	`str`	ホストマシン名
`system_type`	`str`	システム種別（`"Linux"`など）
`data_base64`	`str`	データのBase64表記
`data_hexstr`	`str`	データの16進数表記

dataはJSON等に含まれません。data_base64やdata_hexstrを利用してください。

適用される field_validator

source_logical_id：値の範囲を自動的に検証します
- check_source_logical_id(lid)
time_parsed：タイムゾーンが付与されているかを自動的に検証します
- datetime_must_be_clear(dt)
sampling_frequency：値を検証します
- check_sampling_frequency(freq)
data：長さを自動的に検証します
- check_data(data)

適用される field_serializer

packet_type：列挙子の名前をそのままJSON等に適用します
- serialize_packet_type(packet_type)
source_serial_id：16進表記の文字列をJSON等に適用します
- serialize_source_serial_id(source_serial_id)
time_parsed：ISO 8601形式の文字列をJSON等に適用します
- serialize_time_parsed(dt)
``

`to_df()`

to_df(include=None, exclude=None, verbose=True)

パースしたデータを pandas のデータフレーム形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	データフレームへ含めるカラム（メンバ）の集合
`exclude`	`optional set[str]`	データフレームへ含めないカラム（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）

戻り値

型	値	内容
`pd.DataFrame`	-	変換したデータフレーム

例外

EnvironmentError pandas のない場合

`to_dict()`

to_dict(include=None, exclude=None, verbose=True, spread=False, sort_keys=False)

パースしたデータを辞書形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	辞書へ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	辞書へ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`sort_keys`	`bool`	キーによるソートの有無

戻り値

型	値	内容
`dict[str, Any]`	-	変換した辞書

`to_json()`

to_json(include=None, exclude=None, verbose=True, spread=False, indent=2, sort_keys=False)

パースしたデータをJSON形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	JSONへ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	JSONへ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`indent`	`optional int`	インデントの数（`None`で改行なし）
`sort_keys`	`bool`	キーによるソートの有無

戻り値

型	値	内容
`str`	-	変換したJSON文字列

`model_*()`

上記に加えて、pydantic.BaseModelの各メソッドを利用できます。

11 - mwings.parsers.act モジュール

mwings.parsers.act

act から送信されたデータを表すパケットを解釈するパーサと、そのデータを扱います。

src/mwings/parsers/act.py

`PacketParser`

act から送信されたデータを表すパケットを解釈するパーサの静的クラス

継承：common.PacketParserBase

継承元のメンバを記載します。

`is_valid()`

is_valid(bare_packet)

与えられた素のパケットが有効であるか否かを確認します。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`bool`	`True`	有効、パース可
	`False`	無効、パース不可

`parse()`

parse(bare_packet)

与えられた素のパケットをパースします。

引数

名称	型	内容
`bare_packet`	`common.BarePacket`	素のパケットデータ

戻り値

型	値	内容
`optional ParsedPacket`	`ParsedPacket`の型をもつデータ	パースしたデータ
	`None`	パース不可

`ParsedPacket`

act から送信されたデータを表すパケットを解釈した結果を格納するための構造体

継承：common.ParsedPacketBase

継承元のメンバも合わせて記載します。

`ParsedPacket()`

ParsedPacket(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None, command_id=0, data=b'')

引数

継承元のプロパティも合わせて表記します。

名称	型	内容
`time_parsed`	`optional AwareDatetime`	パース時刻
`packet_type`	`common.PacketType`	パケット種別
`sequence_number`	`optional common.UInt16`	取得不可、常に`None`
`source_serial_id`	`common.UInt32`	送信元のシリアルID
`source_logical_id`	`common.UInt8`	送信元の論理デバイスID
`lqi`	`optional common.UInt8`	電波通信品質
`supply_voltage`	`optional common.UInt16`	取得不可、常に`None`
`commnad_id`	`common.UInt8`	コマンドID
`data`	`bytes`	データ

** で unpack した辞書を渡すことができます。

コンストラクタの引数へ指定する変数に加えて、次の @computed_field を持ちます。

名称	型	内容
`mwings_implementation`	`str`	MWings の実装（`"python"`のみ）
`mwings_version`	`str`	MWings のバージョン（PEP440形式）
`hostname`	`str`	ホストマシン名
`system_type`	`str`	システム種別（`"Linux"`など）
`data_base64`	`str`	データのBase64表記
`data_hexstr`	`str`	データの16進数表記

dataはJSON等に含まれません。data_base64やdata_hexstrを利用してください。

適用される field_validator

source_logical_id：値の範囲を自動的に検証します
- check_source_logical_id(lid)
time_parsed：タイムゾーンが付与されているかを自動的に検証します
- datetime_must_be_clear(dt)
sampling_frequency：値を検証します
- check_sampling_frequency(freq)

適用される field_serializer

packet_type：列挙子の名前をそのままJSON等に適用します
- serialize_packet_type(packet_type)
source_serial_id：16進表記の文字列をJSON等に適用します
- serialize_source_serial_id(source_serial_id)
time_parsed：ISO 8601形式の文字列をJSON等に適用します
- serialize_time_parsed(dt)
``

`to_df()`

to_df(include=None, exclude=None, verbose=True)

パースしたデータを pandas のデータフレーム形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	データフレームへ含めるカラム（メンバ）の集合
`exclude`	`optional set[str]`	データフレームへ含めないカラム（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）

戻り値

型	値	内容
`pd.DataFrame`	-	変換したデータフレーム

例外

EnvironmentError pandas のない場合

`to_dict()`

to_dict(include=None, exclude=None, verbose=True, spread=False, sort_keys=False)

パースしたデータを辞書形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	辞書へ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	辞書へ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`sort_keys`	`bool`	キーによるソートの有無

戻り値

型	値	内容
`dict[str, Any]`	-	変換した辞書

`to_json()`

to_json(include=None, exclude=None, verbose=True, spread=False, indent=2, sort_keys=False)

パースしたデータをJSON形式へ変換します。

引数

名称	型	内容
`include`	`optional set[str]`	JSONへ含めるキー（メンバ）の集合
`exclude`	`optional set[str]`	JSONへ含めないキー（メンバ）の集合
`verbose`	`bool`	システム情報の有無（他の引数が`None`の場合のみ）
`spread`	`bool`	時系列でないlist-likeデータの分割の有無
`indent`	`optional int`	インデントの数（`None`で改行なし）
`sort_keys`	`bool`	キーによるソートの有無

戻り値

型	値	内容
`str`	-	変換したJSON文字列

`model_*()`

上記に加えて、pydantic.BaseModelの各メソッドを利用できます。