コマンドを生成するシリアライザと、そのデータを扱います。
セクションの複数ページをまとめています。 印刷またはPDF形式で保存...
最適な出力のために、Google Chrome（15以降）または Microsoft Edge（79以降）を推奨いたします。
mwings.serializers モジュール
mwings.serializers- 1: mwings.serializers.app_twelite モジュール
- 2: mwings.serializers.app_io モジュール
- 3: mwings.serializers.app_pal_notice モジュール
- 4: mwings.serializers.app_pal_notice_detailed モジュール
- 5: mwings.serializers.app_pal_notice_event モジュール
- 6: mwings.serializers.app_uart_ascii モジュール
1 - mwings.serializers.app_twelite モジュール
mwings.serializers.app_twelite超簡単！標準アプリへ送信するパケットを表すコマンドを生成するシリアライザと、そのデータを扱います。
CommandSerializer
超簡単！標準アプリへ送信するパケットを表すコマンドを生成するシリアライザの静的クラス
継承元のメンバを記載します。
serialize()
serialize(command)
与えられたコマンドを素のパケットのバイト列へ展開します。
引数
| 名称 | 型 | 内容 |
|---|---|---|
command | Command | コマンドデータ |
戻り値
| 型 | 値 | 内容 |
|---|---|---|
optional common.BarePacket | common.BarePacket | 展開したデータ |
None | 無効なコマンドデータである |
Command
超簡単！標準アプリへ送信するパケットを表すコマンドを生成する際に用意するデータを格納するための構造体
継承元のメンバも合わせて記載します。
Command()
Command(*, destination_logical_id=120, di_to_change=<mwings.common.FixedList object>, di_state=<mwings.common.FixedList object>, pwm_to_change=<mwings.common.FixedList object>, pwm_duty=<mwings.common.FixedList object>)
引数
| 名称 | 型 | 内容 |
|---|---|---|
destination_logical_id | common.UInt8 | 送信先の論理デバイスID |
di_to_change | common.FixedList[bool](4) | 変更するデジタルインタフェース |
di_state | common.FixedList[bool](4) | 変更後のデジタルインタフェースの状態 |
pwm_to_change | common.FixedList[bool](4) | 変更する PWM インタフェース |
pwm_duty | common.FixedList[int](4) | 変更後の PWM インタフェースのデューティ |
**で unpack した辞書を渡すことができます。
pwm_to_change の値は、0-1024の範囲を指定します。0xFFFF指定時は無効となります。is_valid()
is_valid()
コマンドデータが有効であるか否かを確認します。
引数
なし
戻り値
| 型 | 値 | 内容 |
|---|---|---|
bool | True | 有効 |
False | 無効 |
model_*()
上記に加えて、
pydantic.BaseModelの各メソッドを利用できます。2 - mwings.serializers.app_io モジュール
mwings.serializers.app_ioリモコンアプリへ送信するパケットを表すコマンドを生成するシリアライザと、そのデータを扱います。
CommandSerializer
リモコンアプリへ送信するパケットを表すコマンドを生成するシリアライザの静的クラス
継承元のメンバを記載します。
serialize()
serialize(command)
与えられたコマンドを素のパケットのバイト列へ展開します。
引数
| 名称 | 型 | 内容 |
|---|---|---|
command | Command | コマンドデータ |
戻り値
| 型 | 値 | 内容 |
|---|---|---|
optional common.BarePacket | common.BarePacket | 展開したデータ |
None | 無効なコマンドデータである |
Command
リモコンアプリへ送信するパケットを表すコマンドを生成する際に用意するデータを格納するための構造体
継承元のメンバも合わせて記載します。
Command()
Command(*, destination_logical_id=120, di_to_change=<mwings.common.FixedList object>, di_state=<mwings.common.FixedList object>)
引数
| 名称 | 型 | 内容 |
|---|---|---|
destination_logical_id | common.UInt8 | 送信先の論理デバイスID |
di_to_change | common.FixedList[bool](12) | 変更するデジタルインタフェース |
di_state | common.FixedList[bool](12) | 変更後のデジタルインタフェースの状態 |
**で unpack した辞書を渡すことができます。
is_valid()
is_valid()
コマンドデータが有効であるか否かを確認します。
引数
なし
戻り値
| 型 | 値 | 内容 |
|---|---|---|
bool | True | 有効 |
False | 無効 |
model_*()
上記に加えて、
pydantic.BaseModelの各メソッドを利用できます。3 - mwings.serializers.app_pal_notice モジュール
mwings.serializers.app_pal_noticeパルアプリ（通知パル）へ送信するパケットを表すコマンドを生成するシリアライザと、そのデータを扱います。
CommandSerializer
パルアプリ（通知パル）へ送信するパケットを表すコマンドを生成するシリアライザの静的クラス
継承元のメンバを記載します。
serialize()
serialize(command)
与えられたコマンドを素のパケットのバイト列へ展開します。
引数
| 名称 | 型 | 内容 |
|---|---|---|
command | Command | コマンドデータ |
戻り値
| 型 | 値 | 内容 |
|---|---|---|
optional common.BarePacket | common.BarePacket | 展開したデータ |
None | 無効なコマンドデータである |
Command
パルアプリ（通知パル）へ送信するパケットを表すコマンドを生成する際に用意するデータを格納するための構造体
継承元のメンバも合わせて記載します。
Command()
Command(*, destination_logical_id=120, color=AppPalNoticeColor.WHITE, blink_speed=AppPalNoticeBlinkSpeed.ALWAYS_ON, brightness=8, duration_in_sec=5)
引数
| 名称 | 型 | 内容 |
|---|---|---|
destination_logical_id | common.UInt8 | 送信先の論理デバイスID |
color | common.AppPalNoticeColor | 点灯色の名称 |
blink_speed | common.AppPalNoticeBlinkSpeed | 点滅の速度 |
brightness | common.UInt8 | 明るさ |
duration_in_sec | common.UInt8 | 点灯（点滅）の合計時間（秒） |
**で unpack した辞書を渡すことができます。
is_valid()
is_valid()
コマンドデータが有効であるか否かを確認します。
引数
なし
戻り値
| 型 | 値 | 内容 |
|---|---|---|
bool | True | 有効 |
False | 無効 |
model_*()
上記に加えて、
pydantic.BaseModelの各メソッドを利用できます。4 - mwings.serializers.app_pal_notice_detailed モジュール
mwings.serializers.app_pal_notice_detailedパルアプリ（通知パル）へ送信する詳細なパケットを表すコマンドを生成するシリアライザと、そのデータを扱います。
CommandSerializer
パルアプリ（通知パル）へ送信する詳細なパケットを表すコマンドを生成するシリアライザの静的クラス
継承元のメンバを記載します。
serialize()
serialize(command)
与えられたコマンドを素のパケットのバイト列へ展開します。
引数
| 名称 | 型 | 内容 |
|---|---|---|
command | Command | コマンドデータ |
戻り値
| 型 | 値 | 内容 |
|---|---|---|
optional common.BarePacket | common.BarePacket | 展開したデータ |
None | 無効なコマンドデータである |
Command
パルアプリ（通知パル）へ送信する詳細なパケットを表すコマンドを生成する際に用意するデータを格納するための構造体
継承元のメンバも合わせて記載します。
Command()
Command(*, destination_logical_id=120, color=AppPalNoticeRGBWColor(red=0, green=0, blue=0, white=15), blink_duty_percentage=100, blink_period_in_sec=1.0, duration_in_sec=1)
引数
| 名称 | 型 | 内容 |
|---|---|---|
destination_logical_id | common.UInt8 | 送信先の論理デバイスID |
color | common.AppPalNoticeRGBWColor | 点灯色のRGBW値 |
blink_duty_percentage | common.UInt8 | 点灯時間の割合（%） |
blink_period_in_sec | common.Float64 | 点滅の周期（秒） |
duration_in_sec | common.UInt8 | 点灯（点滅）の合計時間 |
**で unpack した辞書を渡すことができます。
is_valid()
is_valid()
コマンドデータが有効であるか否かを確認します。
引数
なし
戻り値
| 型 | 値 | 内容 |
|---|---|---|
bool | True | 有効 |
False | 無効 |
model_*()
上記に加えて、
pydantic.BaseModelの各メソッドを利用できます。5 - mwings.serializers.app_pal_notice_event モジュール
mwings.serializers.app_pal_notice_eventパルアプリ（通知パル）へ送信するイベントデータのパケットを表すコマンドを生成するシリアライザと、そのデータを扱います。
CommandSerializer
パルアプリ（通知パル）へ送信するイベントデータのパケットを表すコマンドを生成するシリアライザの静的クラス
継承元のメンバを記載します。
serialize()
serialize(command)
与えられたコマンドを素のパケットのバイト列へ展開します。
引数
| 名称 | 型 | 内容 |
|---|---|---|
command | Command | コマンドデータ |
戻り値
| 型 | 値 | 内容 |
|---|---|---|
optional common.BarePacket | common.BarePacket | 展開したデータ |
None | 無効なコマンドデータである |
Command
パルアプリ（通知パル）へ送信するイベントデータのパケットを表すコマンドを生成する際に用意するデータを格納するための構造体
継承元のメンバも合わせて記載します。
Command()
Command(*, destination_logical_id=120, event_id=0)
引数
| 名称 | 型 | 内容 |
|---|---|---|
destination_logical_id | common.UInt8 | 送信先の論理デバイスID |
event_id | common.UInt8 | イベントID |
**で unpack した辞書を渡すことができます。
is_valid()
is_valid()
コマンドデータが有効であるか否かを確認します。
引数
なし
戻り値
| 型 | 値 | 内容 |
|---|---|---|
bool | True | 有効 |
False | 無効 |
model_*()
上記に加えて、
pydantic.BaseModelの各メソッドを利用できます。6 - mwings.serializers.app_uart_ascii モジュール
mwings.serializers.app_uart_asciiシリアル通信アプリへ送信するデータ（書式モード：簡易形式）のパケットを表すコマンドを生成するシリアライザと、そのデータを扱います。
CommandSerializer
シリアル通信アプリへ送信するデータ（書式モード：簡易形式）のパケットを表すコマンドを生成するシリアライザの静的クラス
継承元のメンバを記載します。
serialize()
serialize(command)
与えられたコマンドを素のパケットのバイト列へ展開します。
引数
| 名称 | 型 | 内容 |
|---|---|---|
command | Command | コマンドデータ |
戻り値
| 型 | 値 | 内容 |
|---|---|---|
optional common.BarePacket | common.BarePacket | 展開したデータ |
None | 無効なコマンドデータである |
Command
シリアル通信アプリへ送信するデータ（書式モード：簡易形式）のパケットを表すコマンドを生成する際に用意するデータを格納するための構造体
継承元のメンバも合わせて記載します。
Command()
Command(*, destination_logical_id=120, command_id=0, data)
引数
| 名称 | 型 | 内容 |
|---|---|---|
destination_logical_id | common.UInt8 | 送信先の論理デバイスID |
command_id | common.UInt8 | コマンドID |
data | bytes | データ |
**で unpack した辞書を渡すことができます。
is_valid()
is_valid()
コマンドデータが有効であるか否かを確認します。
引数
なし
戻り値
| 型 | 値 | 内容 |
|---|---|---|
bool | True | 有効 |
False | 無効 |
model_*()
上記に加えて、
pydantic.BaseModelの各メソッドを利用できます。