TWELITE Wings API / MWings for Python

• 1: TWELITE Wings API / MWings for Python
• 1.1: mwings モジュール
• 1.1.1: mwings.common モジュール
• 1.1.2: mwings.parsers モジュール
• 1.1.2.1: mwings.parsers.app_twelite モジュール
• 1.1.2.2: mwings.parsers.app_io モジュール
• 1.1.2.3: mwings.parsers.app_aria モジュール
• 1.1.2.4: mwings.parsers.app_cue モジュール
• 1.1.2.5: mwings.parsers.app_cue_pal_event モジュール
• 1.1.2.6: mwings.parsers.app_pal_openclose モジュール
• 1.1.2.7: mwings.parsers.app_pal_amb モジュール
• 1.1.2.8: mwings.parsers.app_pal_mot モジュール
• 1.1.2.9: mwings.parsers.app_uart_ascii モジュール
• 1.1.2.10: mwings.parsers.app_uart_ascii_extended モジュール
• 1.1.2.11: mwings.parsers.act モジュール
• 1.1.3: mwings.serializers モジュール
• 1.1.3.1: mwings.serializers.app_twelite モジュール
• 1.1.3.2: mwings.serializers.app_io モジュール
• 1.1.3.3: mwings.serializers.app_pal_notice モジュール
• 1.1.3.4: mwings.serializers.app_pal_notice_detailed モジュール
• 1.1.3.5: mwings.serializers.app_pal_notice_event モジュール
• 1.1.3.6: mwings.serializers.app_uart_ascii モジュール
• 1.1.4: mwings.utils モジュール

1 - TWELITE Wings API / MWings for Python

1.1 - mwings モジュール

Twelite

TWELITE のインタフェース

継承：threading.Thread

Twelite()

Twelite(port=None, rx_buffer_size=1024, timeout=100, tz=None, debugging=False)

引数

例外

• IOError シリアルポートが存在しないかビジー状態

add_listener()

@overload
add_listener(event, handler)
add_listener(event, handler)

受信ハンドラを登録します。

引数

戻り値

なし

on()

on(event)

受信ハンドラを登録します（デコレータ版）。

引数

戻り値

parse()

@overload
parse(character, use_lf=False)
parse(character, use_lf=False)
parse(character, use_lf=False)

与えられた受信データを解釈します。

引数

戻り値

例外

• RuntimeError シリアルポートを指定してしまっている
• ValueError 不正な文字データを検出

parse_line()

parse_line(line, use_lf=True)

一行の文字列として表現された受信データを解釈します。

引数

戻り値

例外

• RuntimeError シリアルポートを指定してしまっている

receive()

receive()

シリアルポートに届いたデータを解釈します。一つのパケットの解釈が終わるまで待機します。

引数

なし

戻り値

例外

• RuntimeError シリアルポートを指定していない

run()

run()

受信を行うサブスレッドを走らせます。threading.Thread.run() をオーバーライドしています。

引数

なし

戻り値

なし

send()

@overload
send(data)
send(data)

シリアルポートからコマンドを送信します。

引数

戻り値

例外

• RuntimeError シリアルポートを指定していない

set_timezone()

set_timezone(tz)

受信データへ適用するタイムゾーンを設定します。

引数

戻り値

なし

start()

start()

受信を行うサブスレッドを開始します。threading.Thread.start() をオーバーライドしています。

引数

なし

戻り値

なし

例外

• RuntimeError シリアルポートを指定していない

stop()

stop()

受信を行うサブスレッドを終了します。残りの受信データに対するハンドラの呼び出しを終えるまで待機します。これには数秒かかる場合があります。

引数

なし

戻り値

なし

例外

• RuntimeError シリアルポートを指定していない

update()

update()

シリアルポートへ届いたデータを解釈します。受信バッファのすべてのデータを処理したら、すぐに処理を抜けます。

引数

なし

戻り値

例外

• RuntimeError シリアルポートを指定していない

timezone

@property
update()

戻り値

1.1.1 - mwings.common モジュール

AccelEvent

加速度イベントの識別子

継承：enum.IntEnum

• DICE_1 サイコロ：1
• DICE_2 サイコロ：2
• DICE_3 サイコロ：3
• DICE_4 サイコロ：4
• DICE_5 サイコロ：5
• DICE_6 サイコロ：6
• SHAKE シェイク
• MOVE ムーブ
• NONE イベントなし

AppPalNoticeBlinkSpeed

通知パル／点滅速度の識別子

継承：enum.IntEnum

• ALWAYS_ON 常時点灯
• SLOW おちついた点滅
• MEDIUM ほどほどの点滅
• FAST せわしない点滅

AppPalNoticeColor

通知パル／点灯色の識別子

継承：enum.IntEnum

• RED 赤
• GREEN 緑
• BLUE 青
• YELLOW 黄
• PURPLE 紫
• LIGHT_BLUE 水色
• WHITE 白
• WARM_WHITE 暖かな白

AppPalNoticeRGBWColor

通知パル／RGBWによる点灯色のデータ

継承：pydantic.BaseModel

AppPalNoticeRGBWColor()

AppPalNoticeRGBWColor(*, red=0, green=0, blue=0, white=15)

引数

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

u16()

u16()

RGBWの16ビット表現を取得します。

引数

なし

戻り値

BarePacket

素のパケットデータ

継承：pydantic.BaseModel

BarePacket()

BarePacket(payload, checksum=None, logical_and_command_id=None)

引数

第3引数を指定する場合は、ペイロードの冒頭を省略します。

i16_at()

i16_at(index)

指定した位置の符号あり16ビット整数を取得します。

引数

戻り値

i32_at()

i32_at(index)

指定した位置の符号あり32ビット整数を取得します。

引数

戻り値

i8_at()

i8_at(index)

指定した位置の符号あり8ビット整数を取得します。

引数

戻り値

u16_at()

u16_at(index)

指定した位置の符号なし16ビット整数を取得します。

引数

戻り値

u32_at()

u32_at(index)

指定した位置の符号なし32ビット整数を取得します。

引数

戻り値

u8_at()

u8_at(index)

指定した位置の符号なし8ビット整数を取得します。

引数

戻り値

u8_from()

u8_from(index)

指定した位置に続くバイト列を取得します。

引数

戻り値

CommandBase

コマンドの抽象基底クラス

継承：ABC, pydantic.BaseModel

CommandBase()

CommandBase(*, destination_logical_id=120)

引数

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

is_valid()

is_valid()

コマンドデータが有効であるか否かを確認します。

引数

なし

戻り値

CommandSerializerBase

コマンドシリアライザの静的抽象基底クラス

継承：ABC

serialize()

serialize(command)

与えられたコマンドを素のパケットのバイト列へ展開します。

引数

戻り値

CrossSectional[T]

特定の時刻における横断的なデータ列を格納するためのタプルに相当するクラス

継承：common.FixedTuple[T]

CrossSectional[T]()

CrossSectional[T](length, elements)

引数

例外

• ValueError 要素の数が不正

DtypedDecimal

pandas の dtype 属性を保持する数値型のための抽象基底クラス

get_dtype()

get_dtype()

pandas の dtype 識別子を取得します。

引数

なし

戻り値

FixedList[T]

固定長リストに相当するクラス

継承：MutableSequence[T]

FixedList[T]()

FixedList[T](length, initial_elements)

引数

例外

• ValueError 要素の数が不正

insert()

insert(index, value)

指定した位置へ要素を配置します。

引数

戻り値

なし

例外

• IndexError 位置が不正

FixedTuple[T]

固定長タプルに相当するクラス

継承：Sequence[T]

FixedTuple[T]()

FixedTuple[T](length, elements)

引数

例外

• ValueError 要素の数が不正

Float32

32ビット浮動小数点数を格納するクラス

継承：float, common.DtypedDecimal

Float32()

Float32(value=None)

引数

例外

• ValueError 範囲外の値

Float64

64ビット浮動小数点数を格納するクラス

継承：float, common.DtypedDecimal

Float64()

Float64(value=None)

引数

例外

• ValueError 範囲外の値

Int16

16ビット整数を格納するクラス

継承：int, common.DtypedDecimal

Int16()

Int16(value=None)

引数

例外

• ValueError 範囲外の値

hex()

hex()

16進数表記の文字列を取得します。

Python 組み込み関数の hex() は int のサブクラスを受け付けません。float に対する組み込みメソッド hex() と同じように扱えるようにしています。

引数

なし

戻り値

Int32

32ビット整数を格納するクラス

継承：int, common.DtypedDecimal

Int32()

Int32(value=None)

引数

例外

• ValueError 範囲外の値

hex()

hex()

16進数表記の文字列を取得します。

Python 組み込み関数の hex() は int のサブクラスを受け付けません。float に対する組み込みメソッド hex() と同じように扱えるようにしています。

引数

なし

戻り値

Int8

8ビット整数を格納するクラス

継承：int, common.DtypedDecimal

Int8()

Int8(value=None)

引数

例外

• ValueError 範囲外の値

hex()

hex()

16進数表記の文字列を取得します。

Python 組み込み関数の hex() は int のサブクラスを受け付けません。float に対する組み込みメソッド hex() と同じように扱えるようにしています。

引数

なし

戻り値

MagnetState

磁石イベントの識別子

継承：enum.IntEnum

• NOT_DETECTED 磁石なし
• N_POLE_IS_CLOSE N極が近くにある
• S_POLE_IS_CLOSE S極が近くにある

PacketParserBase

パケットパーサの静的抽象基底クラス

継承：ABC

is_valid()

is_valid(bare_packet)

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

引数

戻り値

parse()

parse(bare_packet)

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

引数

戻り値

PacketType

パケット種別の識別子

継承：enum.StrEnum

• BARE 素のパケット（未パース）
• ACT act
• APP_TWELITE 超簡単！標準アプリ
• APP_IO リモコンアプリ
• APP_ARIA アリアアプリ
• APP_CUE キューアプリ（TWELITE CUE モード）
• APP_CUE_PAL_EVENT キューアプリ（動作パルモード：ダイス／ムーブモード）
• APP_PAL_OPENCLOSE パルアプリ（開閉パル）
• APP_PAL_AMB パルアプリ（環境パル）
• APP_PAL_MOT パルアプリ（動作パル）／キューアプリ（動作パルモード：加速度計測）
• APP_UART_ASCII シリアル通信アプリ（書式モード：簡易形式）／超簡単！標準アプリ／リモコンアプリ
• APP_UART_ASCII_EXTENDED シリアル通信アプリ（書式モード：拡張形式）

ParsedPacketBase

パース済みパケットの抽象基底クラス

継承：ABC, pydantic.BaseModel

ParsedPacketBase()

ParsedPacketBase(*, time_parsed=None, packet_type=PacketType.BARE, sequence_number=None, source_serial_id=0, source_logical_id=0, lqi=None, supply_voltage=None)

引数

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

to_df()

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

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

引数

戻り値

例外

• EnvironmentError pandas のない場合

to_dict()

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

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

引数

戻り値

to_json()

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

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

引数

戻り値

SomeCallable

TypeVar("SomeCallable", bound=Callable[..., Any])

各種ハンドラを表す型

SomeCommand

TypeVar(‘SomeCommand’, bound=CommandBase)

各種コマンドデータを表す型

SomeParsedPacket

TypeVar(‘SomeParsedPacket’, bound=ParsedPacketBase)

各種パケットデータを表す型

T

TypeVar("T")

ジェネリクスで利用する型

TimeSeries[T]

時系列データを格納するためのタプルに相当するクラス

継承：common.FixedTuple[T]

TimeSeries[T]()

TimeSeries[T](length, elements)

引数

例外

• ValueError 要素の数が不正

Timezone

全体へ適用するtzinfo

UInt16

16ビット非不整数を格納するクラス

継承：int, common.DtypedDecimal

UInt16()

UInt16(value=None)

引数

例外

• ValueError 範囲外の値

hex()

hex()

16進数表記の文字列を取得します。

Python 組み込み関数の hex() は int のサブクラスを受け付けません。float に対する組み込みメソッド hex() と同じように扱えるようにしています。

引数

なし

戻り値

UInt32

32ビット非不整数を格納するクラス

継承：int, common.DtypedDecimal

UInt32()

UInt32(value=None)

引数

例外

• ValueError 範囲外の値

hex()

hex()

16進数表記の文字列を取得します。

Python 組み込み関数の hex() は int のサブクラスを受け付けません。float に対する組み込みメソッド hex() と同じように扱えるようにしています。

引数

なし

戻り値

UInt8

8ビット非不整数を格納するクラス

継承：int, common.DtypedDecimal

UInt8()

UInt8(value=None)

引数

例外

• ValueError 範囲外の値

hex()

hex()

16進数表記の文字列を取得します。

Python 組み込み関数の hex() は int のサブクラスを受け付けません。float に対する組み込みメソッド hex() と同じように扱えるようにしています。

引数

なし

戻り値

1.1.2 - mwings.parsers モジュール

1.1.2.1 - mwings.parsers.app_twelite モジュール

PacketParser

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

継承：common.PacketParserBase

is_valid()

is_valid(bare_packet)

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

引数

戻り値

parse()

parse(bare_packet)

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

引数

戻り値

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_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>)

引数

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

to_df()

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

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

引数

戻り値

例外

• EnvironmentError pandas のない場合

to_dict()

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

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

引数

戻り値

to_json()

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

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

引数

戻り値

model_*()

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

PacketParser

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

継承：common.PacketParserBase

is_valid()

is_valid(bare_packet)

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

引数

戻り値

parse()

parse(bare_packet)

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

引数

戻り値

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>)

引数

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

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

to_df()

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

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

引数

戻り値

例外

• EnvironmentError pandas のない場合

to_dict()

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

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

引数

戻り値

to_json()

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

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

引数

戻り値

model_*()

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

PacketParser

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

継承：common.PacketParserBase

is_valid()

is_valid(bare_packet)

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

引数

戻り値

parse()

parse(bare_packet)

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

引数

戻り値

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)

引数

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

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

to_df()

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

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

引数

戻り値

例外

• EnvironmentError pandas のない場合

to_dict()

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

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

引数

戻り値

to_json()

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

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

引数

戻り値

model_*()

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

PacketParser

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

継承：common.PacketParserBase

is_valid()

is_valid(bare_packet)

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

引数

戻り値

parse()

parse(bare_packet)

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

引数

戻り値

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)

引数

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

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

to_df()

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

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

引数

戻り値

例外

• EnvironmentError pandas のない場合

to_dict()

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

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

引数

戻り値

to_json()

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

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

引数

戻り値

model_*()

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

PacketParser

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

継承：common.PacketParserBase

is_valid()

is_valid(bare_packet)

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

引数

戻り値

parse()

parse(bare_packet)

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

引数

戻り値

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)

引数

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

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

to_df()

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

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

引数

戻り値

例外

• EnvironmentError pandas のない場合

to_dict()

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

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

引数

戻り値

to_json()

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

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

引数

戻り値

model_*()

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

PacketParser

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

継承：common.PacketParserBase

is_valid()

is_valid(bare_packet)

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

引数

戻り値

parse()

parse(bare_packet)

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

引数

戻り値

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)

引数

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

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

to_df()

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

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

引数

戻り値

例外

• EnvironmentError pandas のない場合

to_dict()

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

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

引数

戻り値

to_json()

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

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

引数

戻り値

model_*()

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

PacketParser

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

継承：common.PacketParserBase

is_valid()

is_valid(bare_packet)

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

引数

戻り値

parse()

parse(bare_packet)

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

引数

戻り値

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)

引数

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

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

to_df()

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

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

引数

戻り値

例外

• EnvironmentError pandas のない場合

to_dict()

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

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

引数

戻り値

to_json()

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

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

引数

戻り値

model_*()

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

PacketParser

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

継承：common.PacketParserBase

is_valid()

is_valid(bare_packet)

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

引数

戻り値

parse()

parse(bare_packet)

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

引数

戻り値

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)

引数

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

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

to_df()

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

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

引数

戻り値

例外

• EnvironmentError pandas のない場合

to_dict()

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

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

引数

戻り値

to_json()

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

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

引数

戻り値

model_*()

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

PacketParser

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

継承：common.PacketParserBase

is_valid()

is_valid(bare_packet)

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

引数

戻り値

parse()

parse(bare_packet)

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

引数

戻り値

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'')

引数

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

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

to_df()

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

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

引数

戻り値

例外

• EnvironmentError pandas のない場合

to_dict()

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

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

引数

戻り値

to_json()

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

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

引数

戻り値

model_*()

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

PacketParser

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

継承：common.PacketParserBase

is_valid()

is_valid(bare_packet)

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

引数

戻り値

parse()

parse(bare_packet)

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

引数

戻り値

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'')

引数

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