mwings::MWings クラス

32ビット Arduino ボードのための MWings メインクラス

mwings::MWings クラスの解説です。

スケッチで利用する Twelite オブジェクトは、mwings::MWings クラスのインスタンスです。

通常、mwings::MWings クラスをスケッチ内でインスタンス化する必要はありません。自動的に初期化される Twelite オブジェクトを使用してください。

コンストラクタ

`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,
                   const uint32_t encryptKey = 0,
                   HardwareSerial* debugSerial = nullptr);

MWings.cpp

引数

型	名称	内容	省略	備考
`HardwareSerial&`	`serial`	TWELITE と通信するポート
`int`	`indicatorPin`	ステータスLEDを接続したピン	🆗	`-1`で省略可
`int`	`resetPin`	TWELITE の RST ピン	🆗	`-1`で省略可
`int`	`programPin`	TWELITE の PRGピン	🆗	`-1`で省略可
`uint8_t`	`channel`	周波数チャネル	🆗	省略時は`0x67720102`
`uint32_t`	`appId`	アプリケーション ID	🆗	省略時は`18`
`uint8_t`	`retryCount`	再送回数	🆗	0-9
`uint8_t`	`txPower`	送信出力	🆗	0-3
`int`	`rxBufferSize`	パケット受信バッファのサイズ	🆗	バイナリベース
`int`	`timeout`	各パケットのタイムアウト時間	🆗	受信完了まで
`uint32_t`	`encryptKey`	暗号化鍵	🆗	`0`で無効，v1.2.3+
`HardwareSerial*`	`debugSerial`	デバッグ出力ポート	🆗

戻り値

型	値	内容	備考
`bool`	`true`	成功
	`false`	エラー

`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

引数

型	名称	内容	省略	備考
`void (*)(BarePacket&)`	`callback`	イベントハンドラ

BarePacket の詳細はデータと手続きをご覧ください。

戻り値

なし

`on()` <`ParsedAppTwelitePacket`>

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

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

MWings.h

引数

型	名称	内容	省略	備考
`void (*)(ParsedAppTwelitePacket&)`	`callback`	イベントハンドラ

ParsedAppTwelitePacket の詳細はデータと手続きをご覧ください。

戻り値

なし

`on()` <`ParsedAppIoPacket`>

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

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

MWings.h

引数

型	名称	内容	省略	備考
`void (*)(ParsedAppIoPacket&)`	`callback`	イベントハンドラ

ParsedAppIoPacket の詳細はデータと手続きをご覧ください。

戻り値

なし

`on()` <`ParsedAppAriaPacket`>

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

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

MWings.h

引数

型	名称	内容	省略	備考
`void (*)(ParsedAppAriaPacket&)`	`callback`	イベントハンドラ

ParsedAppAriaPacket の詳細はデータと手続きをご覧ください。

戻り値

なし

`on()` <`ParsedAppCuePacket`>

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

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

MWings.h

引数

型	名称	内容	省略	備考
`void (*)(ParsedAppCuePacket&)`	`callback`	イベントハンドラ

ParsedAppCuePacket の詳細はデータと手続きをご覧ください。

戻り値

なし

`on()` <`ParsedAppPalOpenClosePacket`>

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

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

MWings.h

引数

型	名称	内容	省略	備考
`void (*)(ParsedAppPalOpenClosePacket&)`	`callback`	イベントハンドラ

ParsedAppPalOpenClosePacket の詳細はデータと手続きをご覧ください。

戻り値

なし

`on()` <`ParsedAppPalAmbPacket`>

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

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

MWings.h

引数

型	名称	内容	省略	備考
`void (*)(ParsedAppPalAmbPacket&)`	`callback`	イベントハンドラ

ParsedAppPalAmbPacket の詳細はデータと手続きをご覧ください。

戻り値

なし

`on()` <`ParsedAppPalMotPacket`>

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

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

MWings.h

引数

型	名称	内容	省略	備考
`void (*)(ParsedAppPalMotPacket&)`	`callback`	イベントハンドラ

ParsedAppPalMotPacket の詳細はデータと手続きをご覧ください。

戻り値

なし

`on()` <`ParsedAppUartAsciiPacket`>

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

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

MWings.h

引数

型	名称	内容	省略	備考
`void (*)(ParsedAppUartAsciiPacket&)`	`callback`	イベントハンドラ

ParsedAppUartAsciiPacket の詳細はデータと手続きをご覧ください。

戻り値

なし

`on()` <`ParsedAppUartAsciiExtendedPacket`>

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

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

MWings.h

引数

型	名称	内容	省略	備考
`void (*)(ParsedAppUartAsciiExtendedPacket&)`	`callback`	イベントハンドラ

ParsedAppUartAsciiExtendedPacket の詳細はデータと手続きをご覧ください。

戻り値

なし

`on()` <`ParsedActPacket`>

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

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

MWings.h

引数

型	名称	内容	省略	備考
`void (*)(ParsedActPacket&)`	`callback`	イベントハンドラ

ParsedActPacket の詳細はデータと手続きをご覧ください。

戻り値

なし

`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

引数

型	名称	内容	備考
`uint8_t*`	`payload`	ペイロード	`:`と LRC の間
`int`	`payloadSize`	ペイロードのサイズ
`uint8_t`	`checksum`	チェックサム	ペイロードの LRC

戻り値

型	値	内容	備考
`bool`	`true`	成功
	`false`	エラー

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

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

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

MWings.h

引数

型	名称	内容	省略	備考
`uint8_t*`	`payload`	ペイロード		`:`と LRC の間
`int`	`payloadSize`	ペイロードのサイズ

戻り値

型	値	内容	備考
`bool`	`true`	成功
	`false`	エラー

`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

引数

型	名称	内容	備考
`uint8_t`	`logicalId`	宛先の論理デバイス ID
`uint8_t`	`commandId`	コマンド種別
`uint8_t*`	`payload`	ペイロード	`:`と LRC の間
`int`	`payloadSize`	ペイロードのサイズ
`uint8_t`	`checksum`	チェックサム	ペイロードの LRC

戻り値

型	値	内容	備考
`bool`	`true`	成功
	`false`	エラー

`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

引数

型	名称	内容	備考
`uint8_t`	`logicalId`	宛先の論理デバイス ID
`uint8_t`	`commandId`	コマンド種別
`uint8_t*`	`payload`	ペイロード	`:`と LRC の間
`int`	`payloadSize`	ペイロードのサイズ

戻り値

型	値	内容	備考
`bool`	`true`	成功
	`false`	エラー

`send()` <`AppTweliteCommand`>

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

inline bool send(AppTweliteCommand& command)

MWings.h

引数

型	名称	内容	省略	備考
`AppTweliteCommand`	`command`	コマンドデータ

AppTweliteCommand の詳細はデータと手続きをご覧ください。

戻り値

型	値	内容	備考
`bool`	`true`	成功
	`false`	エラー

`send()` <`AppIoCommand`>

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

inline bool send(AppIoCommand& command)

MWings.h

引数

型	名称	内容	省略	備考
`AppIoCommand`	`command`	コマンドデータ

AppIoCommand の詳細はデータと手続きをご覧ください。

戻り値

型	値	内容	備考
`bool`	`true`	成功
	`false`	エラー

`send()` <`AppPalNoticeCommand`>

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

inline bool send(AppPalNoticeCommand& command)

MWings.h

引数

型	名称	内容	省略	備考
`AppPalNoticeCommand`	`command`	コマンドデータ

AppPalNoticeCommand の詳細はデータと手続きをご覧ください。

戻り値

型	値	内容	備考
`bool`	`true`	成功
	`false`	エラー

`send()` <`AppPalNoticeDetailedCommand`>

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

inline bool send(AppPalNoticeDetailedCommand& command)

MWings.h

引数

型	名称	内容	省略	備考
`AppPalNoticeDetailedCommand`	`command`	コマンドデータ

AppPalNoticeDetailedCommand の詳細はデータと手続きをご覧ください。

戻り値

型	値	内容	備考
`bool`	`true`	成功
	`false`	エラー

`send()` <`AppPalNoticeEventCommand`>

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

inline bool send(AppPalNoticeEventCommand& command)

MWings.h

引数

型	名称	内容	省略	備考
`AppPalNoticeEventCommand`	`command`	コマンドデータ

AppPalNoticeEventCommand の詳細はデータと手続きをご覧ください。

戻り値

型	値	内容	備考
`bool`	`true`	成功
	`false`	エラー

`send()` <`AppPalUartAsciiCommand`>

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

inline bool send(AppPalUartAsciiCommand& command)

MWings.h

引数

型	名称	内容	省略	備考
`AppPalUartAsciiCommand`	`command`	コマンドデータ

AppPalUartAsciiCommand の詳細はデータと手続きをご覧ください。

戻り値

型	値	内容	備考
`bool`	`true`	成功
	`false`	エラー

mwings::MWings クラス

コンストラクタ

MWings()

引数

デストラクタ

~MWings()

公開メンバ関数

begin()

引数

戻り値

end()

引数

戻り値

update()

引数

戻り値

on() <BarePacket>

引数

戻り値

on() <ParsedAppTwelitePacket>

引数

戻り値

on() <ParsedAppIoPacket>

引数

戻り値

on() <ParsedAppAriaPacket>

引数

戻り値

on() <ParsedAppCuePacket>

引数

戻り値

on() <ParsedAppPalOpenClosePacket>

引数

戻り値

on() <ParsedAppPalAmbPacket>

引数

戻り値

on() <ParsedAppPalMotPacket>

引数

戻り値

on() <ParsedAppUartAsciiPacket>

引数

戻り値

on() <ParsedAppUartAsciiExtendedPacket>

引数

戻り値

on() <ParsedActPacket>

引数

戻り値

send() <uint8_t*, int, uint8_t>

引数

戻り値

send() <uint8_t*, int>

引数

戻り値

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

引数

戻り値

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

引数

戻り値

send() <AppTweliteCommand>

引数

戻り値

send() <AppIoCommand>

引数

戻り値

send() <AppPalNoticeCommand>

引数

戻り値

send() <AppPalNoticeDetailedCommand>

引数

戻り値

send() <AppPalNoticeEventCommand>

引数

戻り値

send() <AppPalUartAsciiCommand>

引数

戻り値

`MWings()`

`~MWings()`

`begin()`

`end()`

`update()`

`on()` <`BarePacket`>

`on()` <`ParsedAppTwelitePacket`>

`on()` <`ParsedAppIoPacket`>

`on()` <`ParsedAppAriaPacket`>

`on()` <`ParsedAppCuePacket`>

`on()` <`ParsedAppPalOpenClosePacket`>

`on()` <`ParsedAppPalAmbPacket`>

`on()` <`ParsedAppPalMotPacket`>

`on()` <`ParsedAppUartAsciiPacket`>

`on()` <`ParsedAppUartAsciiExtendedPacket`>

`on()` <`ParsedActPacket`>

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

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

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

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

`send()` <`AppTweliteCommand`>

`send()` <`AppIoCommand`>

`send()` <`AppPalNoticeCommand`>

`send()` <`AppPalNoticeDetailedCommand`>

`send()` <`AppPalNoticeEventCommand`>

`send()` <`AppPalUartAsciiCommand`>