TWELITE Wings API / MWings

• 1: TWELITE Wings API / MWings for 32-bit Arduinos
• 1.1: TWELITE Wings API / MWings for 32-bit Arduinos
• 1.1.1: データ型と手続きの一覧
• 1.1.2: クラスの一覧
• 1.1.2.1: mwings::MWings クラス
• 2: TWELITE Wings API / MWings for Python
• 2.1: TWELITE Wings API / MWings for Python
• 2.1.1: mwings モジュール
• 2.1.1.1: mwings.common モジュール
• 2.1.1.2: mwings.parsers モジュール
• 2.1.1.2.1: mwings.parsers.app_twelite モジュール
• 2.1.1.2.2: mwings.parsers.app_io モジュール
• 2.1.1.2.3: mwings.parsers.app_aria モジュール
• 2.1.1.2.4: mwings.parsers.app_cue モジュール
• 2.1.1.2.5: mwings.parsers.app_cue_pal_event モジュール
• 2.1.1.2.6: mwings.parsers.app_pal_openclose モジュール
• 2.1.1.2.7: mwings.parsers.app_pal_amb モジュール
• 2.1.1.2.8: mwings.parsers.app_pal_mot モジュール
• 2.1.1.2.9: mwings.parsers.app_uart_ascii モジュール
• 2.1.1.2.10: mwings.parsers.app_uart_ascii_extended モジュール
• 2.1.1.2.11: mwings.parsers.act モジュール
• 2.1.1.3: mwings.serializers モジュール
• 2.1.1.3.1: mwings.serializers.app_twelite モジュール
• 2.1.1.3.2: mwings.serializers.app_io モジュール
• 2.1.1.3.3: mwings.serializers.app_pal_notice モジュール
• 2.1.1.3.4: mwings.serializers.app_pal_notice_detailed モジュール
• 2.1.1.3.5: mwings.serializers.app_pal_notice_event モジュール
• 2.1.1.3.6: mwings.serializers.app_uart_ascii モジュール
• 2.1.1.4: mwings.utils モジュール

1 - TWELITE Wings API / MWings for 32-bit Arduinos

1.1 - TWELITE Wings API / MWings for 32-bit Arduinos

1.1.1 - データ型と手続きの一覧

構造体

BarePacket

親機が子機から受信したパケットの電文情報から得た素のデータを格納します。

MWings_Common.h

データ

手続き

mwings::ParsedPacketBase

親機が子機から受信したパース済みデータを格納する構造体の抽象型です。

MWings_Common.h

データ

ParsedAppTwelitePacket

mwings::ParsedPacketBase から派生

親機が超簡単！標準アプリの子機から受信したデータを格納する構造体です。

AppTwelitePacketParser.h

データ

ParsedAppIoPacket

mwings::ParsedPacketBase から派生

親機がリモコンアプリの子機から受信したデータを格納する構造体です。

AppIoPacketParser.h

データ

ParsedAppAriaPacket

mwings::ParsedPacketBase から派生

親機がアリアアプリの子機（TWELITE ARIA モード）から受信したデータを格納する構造体です。

AppAriaPacketParser.h

データ

磁気イベントID

ParsedAppCuePacket

mwings::ParsedPacketBase から派生

親機がキューアプリの子機（TWELITE CUE モード）から受信したデータを格納する構造体です。

AppCuePacketParser.h

データ

加速度イベントID

磁気イベントID

ParsedAppPalAmbPacket

mwings::ParsedPacketBase から派生

親機がパルアプリの子機（環境センサーパル）から受信したデータを格納する構造体です。

AppPalAmbPacketParser.h

データ

ParsedAppPalMotPacket

mwings::ParsedPacketBase から派生

親機がパルアプリの子機（動作センサーパル）から受信したデータを格納する構造体です。

AppPalMotPacketParser.h

データ

ParsedAppPalOpenClosePacket

mwings::ParsedPacketBase から派生

親機がパルアプリの子機（開閉センサーパル）から受信したデータを格納する構造体です。

AppPalOpenClosePacketParser.h

データ

磁気イベントID

ParsedAppUartAsciiPacket

mwings::ParsedPacketBase から派生

親機がシリアル通信アプリの子機（Aモード）から受信したデータ（簡易形式）を格納する構造体です。

AppUartAsciiPacketParser.h

データ

ParsedAppUartAsciiExtendedPacket

mwings::ParsedPacketBase から派生

親機がシリアル通信アプリの子機（Aモード）から受信したデータ（拡張形式）を格納する構造体です。

AppUartAsciiExtendedPacketParser.h

データ

ParsedActPacket

mwings::ParsedPacketBase から派生

親機がactの子機から受信したデータを格納する構造体です。

ActPacketParser.h

データ

mwings::CommandBase

親機から子機に送信するコマンドデータを格納する構造体の抽象型です。

MWings_Common.h

データ

手続き

AppTweliteCommand

mwings::CommandBase から派生

親機から超簡単！標準アプリの子機へ送信するコマンドデータを格納する構造体です。

AppTweliteCommandSerializer.h

データ

AppIoCommand

mwings::CommandBase から派生

親機から超簡単！標準アプリの子機へ送信するコマンドデータを格納する構造体です。

AppIoCommandSerializer.h

データ

AppPalNoticeCommand

mwings::CommandBase から派生

親機からパルアプリ（通知パル）の子機へ送信するコマンドデータを格納する構造体です。

AppPalNoticeCommandSerializer.h

データ

AppPalNoticeDetailedCommand

mwings::CommandBase から派生

親機からパルアプリ（通知パル）の子機へ送信するコマンドデータを格納する構造体です（詳細形式）。

AppPalNoticeDetailedCommandSerializer.h

データ

AppPalNoticeEventCommand

mwings::CommandBase から派生

親機からパルアプリ（通知パル）の子機へ送信するコマンドデータ（詳細形式）を格納する構造体です。

AppPalNoticeEventCommandSerializer.h

データ

AppUartAsciiCommand

mwings::CommandBase から派生

親機からシリアル通信アプリ（Aモード）の子機へ送信するコマンドデータ（簡易形式）を格納する構造体です。

AppUartAsciiCommand.h

データ

Twelite.send(command.u8DestinationLogicalId, command.u8CommandId,
                 command.u8Data, command.u16DataSize);

AppPalNoticeRGBWColor

AppPalNoticeDetailedCommand で使用する点灯色（RGBW）を定義した構造体です。

AppPalNoticeDetailedCommandSerializer.h

データ

手続き

列挙型

AppPalNoticeColor

uint8_t ベースの enum class ?

AppPalNoticeCommand で使用する点灯色を定義した列挙型です。

AppPalNoticeCommandSerializer.h

AppPalNoticeBlinkSpeed

uint8_t ベースの enum class

AppPalNoticeCommand で使用する点滅速度を定義した列挙型です。

AppPalNoticeCommandSerializer.h

その他のデータ型

手続き

GetAppTweliteSerializedCommandPayloadSize()

constexpr 関数 ?

AppTweliteCommand をシリアライズしたあとの固定長データのペイロードサイズを返す関数です。

AppTweliteCommandSerializer.h

GetAppAppPalNoticeSerializedCommandPayloadSize()

constexpr 関数

AppPalNoticeCommand をシリアライズしたあとの固定長データのペイロードサイズを返す関数です。

AppPalNoticeCommandSerializer.h

GetAppAppPalNoticeDetailedSerializedCommandPayloadSize()

constexpr 関数

AppPalNoticeDetailedCommand をシリアライズしたあとの固定長データのペイロードサイズを返す関数です。

AppPalNoticeDetailedCommandSerializer.h

GetAppAppPalNoticeEventSerializedCommandPayloadSize()

constexpr 関数

AppPalNoticeEventCommand をシリアライズしたあとの固定長データのペイロードサイズを返す関数です。

AppPalNoticeEventCommandSerializer.h

1.1.2 - クラスの一覧

1.1.2.1 - mwings::MWings クラス

コンストラクタ

MWings()

コンストラクタです。内部変数を初期化します。

MWings()

MWings.h

引数

なし

デストラクタ

~MWings()

デストラクタです。確保したバッファを開放します。

~MWings()

公開メンバ関数

begin()

TWELITE を初期化し、指定した設定で起動します。

    bool begin(HardwareSerial& serial,
                   const int indicatorPin = -1,
                   const int resetPin = -1,
                   const int programPin = -1,
                   const uint8_t channel = 18,
                   const uint32_t appId = 0x67720102,
                   const uint8_t retryCount = 2,
                   const uint8_t txPower = 3,
                   const int rxBufferSize = 1024,
                   const int timeout = 100,
                   HardwareSerial* debugSerial = nullptr);

MWings.cpp

引数

戻り値

end()

すべての内部変数を初期化します。

inline void end()

MWings.h

引数

なし

戻り値

なし

update()

シリアル受信バッファを読み出し、親機から送られた ModBus ASCII 形式のデータをパースします。

void update();

MWings.h

引数

なし

戻り値

なし

on() <BarePacket>

すべての子機から送られたデータに対して行う処理を登録します。

inline void on(void (*callback)(const BarePacket& packet))

MWings.h

引数

戻り値

なし

on() <ParsedAppTwelitePacket>

超簡単！標準アプリの子機から送られたデータに対して行う処理を登録します。

inline void on(void (*callback)(const ParsedAppTwelitePacket& packet))

MWings.h

引数

戻り値

なし

on() <ParsedAppIoPacket>

リモコンアプリの子機から送られたデータに対して行う処理を登録します。

inline void on(void (*callback)(const ParsedAppIoPacket& packet))

MWings.h

引数

戻り値

なし

on() <ParsedAppAriaPacket>

アリアアプリ（TWELITE ARIA モード）の子機から送られたデータに対して行う処理を登録します。

inline void on(void (*callback)(const ParsedAppAriaPacket& packet))

MWings.h

引数

戻り値

なし

on() <ParsedAppCuePacket>

キューアプリ（TWELITE CUE モード）の子機から送られたデータに対して行う処理を登録します。

inline void on(void (*callback)(const ParsedAppCuePacket& packet))

MWings.h

引数

戻り値

なし

on() <ParsedAppPalOpenClosePacket>

パルアプリ（開閉センサーパル）の子機から送られたデータに対して行う処理を登録します。

inline void on(void (*callback)(const ParsedAppPalOpenClosePacket& packet))

MWings.h

引数

戻り値

なし

on() <ParsedAppPalAmbPacket>

パルアプリ（環境センサーパル）の子機から送られたデータに対して行う処理を登録します。

inline void on(void (*callback)(const ParsedAppPalAmbPacket& packet))

MWings.h

引数

戻り値

なし

on() <ParsedAppPalMotPacket>

パルアプリ（動作センサーパル）の子機から送られたデータに対して行う処理を登録します。

inline void on(void (*callback)(const ParsedAppPalMotPacket& packet))

MWings.h

引数

戻り値

なし

on() <ParsedAppUartAsciiPacket>

シリアル通信アプリ（Aモード）の子機から送られたデータ（簡易形式）に対して行う処理を登録します。

inline void on(void (*callback)(const ParsedAppUartAsciiPacket& packet))

MWings.h

引数

戻り値

なし

on() <ParsedAppUartAsciiExtendedPacket>

シリアル通信アプリ（Aモード）の子機から送られたデータ（拡張形式）に対して行う処理を登録します。

inline void on(void (*callback)(const ParsedAppUartAsciiExtendedPacket& packet))

MWings.h

引数

戻り値

なし

on() <ParsedActPacket>

act の子機から送られたデータに対して行う処理を登録します。

inline void on(void (*callback)(const ParsedActPacket& packet))

MWings.h

引数

戻り値

なし

send() <uint8_t*, int, uint8_t>

任意のコマンド（ModBus ASCII 形式）を親機に送信します。

inline bool send(const uint8_t* const payload,
                     const int payloadSize,
                     const uint8_t checksum)

MWings.h

引数

戻り値

send() <uint8_t*, int>

任意のコマンド（ModBus ASCII 形式）を親機に送信します（チェックサム自動付与）。

inline bool send(const uint8_t* const payload,
                     const int payloadSize)

MWings.h

引数

戻り値

send() <uint8_t, uint8_t, uint8_t* int, uint8_t>

任意のコマンド（ModBus ASCII 形式）を親機に送信します。

inline bool send(const uint8_t logicalId,
                     const uint8_t commandId,
                     const uint8_t* const payload,
                     const int payloadSize,
                     const uint8_t checksum)

MWings.h

引数

戻り値

send() <uint8_t, uint8_t, uint8_t* int>

任意のコマンド（ModBus ASCII 形式）を親機に送信します（チェックサム自動付与）。

inline bool send(const uint8_t logicalId,
                     const uint8_t commandId,
                     const uint8_t* const payload,
                     const int payloadSize)

MWings.h

引数

戻り値

send() <AppTweliteCommand>

超簡単！標準アプリの端末を操作するためのコマンドを親機に送信します。

inline bool send(AppTweliteCommand& command)

MWings.h

引数

戻り値

send() <AppIoCommand>

リモコンアプリの端末を操作するためのコマンドを親機に送信します。

inline bool send(AppIoCommand& command)

MWings.h

引数

戻り値

send() <AppPalNoticeCommand>

パルアプリ（通知パル）の端末を操作するためのコマンドを親機に送信します。

inline bool send(AppPalNoticeCommand& command)

MWings.h

引数

戻り値

send() <AppPalNoticeDetailedCommand>

パルアプリ（通知パル）の端末を操作するためのコマンド（詳細形式）を親機に送信します。

inline bool send(AppPalNoticeDetailedCommand& command)

MWings.h

引数

戻り値

send() <AppPalNoticeEventCommand>

パルアプリ（通知パル）の端末を操作するためのコマンド（イベント）を親機に送信します。

inline bool send(AppPalNoticeEventCommand& command)

MWings.h

引数

戻り値

send() <AppPalUartAsciiCommand>

シリアル通信アプリ（Aモード）の端末を操作するためのコマンド（簡易形式）を親機に送信します。

inline bool send(AppPalUartAsciiCommand& command)

MWings.h

引数

戻り値

2 - TWELITE Wings API / MWings for Python

2.1 - TWELITE Wings API / MWings for Python

2.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()

戻り値

2.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() と同じように扱えるようにしています。

引数

なし

戻り値

2.1.1.2 - mwings.parsers モジュール

2.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_*()

2.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_*()

2.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_*()

2.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_*()

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

引数

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