32ビット Arduino ボードのための TWELITE Wings API です。
MWings ライブラリは、TWELITE CUE / TWELITE ARIA、TWELITE PAL、TWELITE DIP、TWELITE UART など、あらゆる TWELITE シリーズ製品との通信を簡単に実現します。
セクションの複数ページをまとめています。 印刷またはPDF形式で保存...
最適な出力のために、Google Chrome（15以降）または Microsoft Edge（79以降）を推奨いたします。
TWELITE Wings API / MWings for 32-bit Arduinos
32ビット Arduino ボードのための MWings
- 1: TWELITE Wings API / MWings for 32-bit Arduinos
- 1.1: データ型と手続きの一覧
- 1.2: クラスの一覧
- 1.2.1: mwings::MWings クラス
1 - TWELITE Wings API / MWings for 32-bit Arduinos
最新版
32ビット Arduino ボードのための TWELITE Wings API です。
MWings ライブラリは、TWELITE CUE / TWELITE ARIA、TWELITE PAL、TWELITE DIP、TWELITE UART など、あらゆる TWELITE シリーズ製品との通信を簡単に実現します。
GitHub: monowireless/mwings_arduino
1.1 - データ型と手続きの一覧
32ビット Arduino ボードのための MWings 個別のデータ型と手続きの一覧
個別のデータ型と手続きの一覧です。クラスの一覧はこちら
構造体
BarePacket
親機が子機から受信したパケットの電文情報から得た素のデータを格納します。
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint8_t* | u8Payload | バイナリ変換したペイロードデータ（:とチェックサム、CRLFを除く） |
uint16_t | u16PayloadSize | 上記データのバイト数 |
uint8_t | u8Checksum | 上記データのチェックサム |
手続き
| 型と名称 | 内容 |
|---|---|
uint8_t* u8From(int) | 指定位置以降のペイロードデータを取得する |
uint8_t u8At(int) | 指定位置のペイロードデータを8ビット非不整数として取得する |
int8_t i8At(int) | 指定位置のペイロードデータを8ビット整数として取得する |
uint16_t u16At(int) | 指定位置のペイロードデータを16ビット非不整数として取得する |
int16_t i16At(int) | 指定位置のペイロードデータを16ビット整数として取得する |
uint32_t u32At(int) | 指定位置のペイロードデータを32ビット非不整数として取得する |
int32_t i32At(int) | 指定位置のペイロードデータを32ビット整数として取得する |
mwings::ParsedPacketBase
親機が子機から受信したパース済みデータを格納する構造体の抽象型です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint32_t | u32SourceSerialId | 送信元のシリアルID |
uint8_t | u8SourceLogicalId | 送信元の論理デバイスID |
uint16_t | u16SequenceNumber | シーケンス番号 |
uint8_t | u8Lqi | LQI |
uint16_t | u16SupplyVoltage | 電源電圧 (mV) |
この抽象型には、共通して利用されるデータを記述しています。
この抽象型から派生した構造体（例：ParsedAppTwelitePacket）では、この抽象型のデータを併せて利用できます。
ParsedAppTwelitePacket
親機が超簡単！標準アプリの子機から受信したデータを格納する構造体です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint8_t | u8DestinationLogicalId | 送信先の論理デバイスID |
uint8_t | u8RelayCount | 中継回数 |
bool | bPeriodic | 定期送信パケットならtrue |
bool[4] | bDiChanged | 各 DI1-4 が変化したならtrue |
bool[4] | bDiState | 各 DI1-4 が Low 状態ならtrue |
uint16_t[4] | u16AiVoltage | 各 AI1-4 の入力電圧 (mV) |
親機・中継機アプリのマニュアルも併せてご覧ください。
ParsedAppIoPacket
親機がリモコンアプリの子機から受信したデータを格納する構造体です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint8_t | u8RelayCount | 中継回数 |
bool[12] | bDiState | 各 DI が Low 状態ならtrue |
bool[12] | bDiValid | 各 DI が有効ならtrue |
bool[12] | bDiInterrupt | 各 DI が割り込みにより変化したならtrue |
親機・中継機アプリのマニュアルも併せてご覧ください。
ParsedAppAriaPacket
親機がアリアアプリの子機（TWELITE ARIA モード）から受信したデータを格納する構造体です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
int16_t | i16Temp100x | 100倍された温度（摂氏） |
uint16_t | u16Humid100x | 100倍された相対湿度 (%) |
uint8_t | u8MagnetState | 磁気イベントID |
bool | bMagnetStateChanged | 磁気センサの状態が変化したならtrue |
磁気イベントID
| ID | 内容 |
|---|---|
0x00 | 近くに磁石がない |
0x01 | N極が近くにある |
0x02 | S極が近くにある |
親機・中継機アプリのマニュアルも併せてご覧ください。
ParsedAppCuePacket
親機がキューアプリの子機（TWELITE CUE モード）から受信したデータを格納する構造体です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
int16_t[10] | i16SamplesX | 各サンプルの X 軸加速度 (mG) |
int16_t[10] | i16SamplesY | 各サンプルの Y 軸加速度 (mG) |
int16_t[10] | i16SamplesZ | 各サンプルの Z 軸加速度 (mG) |
uint8_t | u8SampleCount | サンプル数 |
bool | bHasAccelEvent | 加速度イベントがあるならtrue |
uint8_t | u8AccelEvent | 加速度イベントID |
uint8_t | u8MagnetState | 磁気イベントID |
bool | bMagnetStateChanged | 磁気センサの状態が変化したならtrue |
加速度イベントID
| ID | 内容 |
|---|---|
0x01~0x06 | サイコロ |
0x08 | シェイク |
0x10 | ムーブ |
磁気イベントID
| ID | 内容 |
|---|---|
0x00 | 近くに磁石がない |
0x01 | N極が近くにある |
0x02 | S極が近くにある |
親機・中継機アプリのマニュアルも併せてご覧ください。
ParsedAppPalAmbPacket
親機がパルアプリの子機（環境センサーパル）から受信したデータを格納する構造体です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint16_t | u16Ai1Voltage | AI1 の入力電圧 (mV) |
int16_t | i16Temp100x | 100倍された温度（摂氏） |
uint16_t | u16Humid100x | 100倍された相対湿度 (%) |
uint32_t | u32Illuminance | 照度（ルクス） |
親機・中継機アプリのマニュアルも併せてご覧ください。
ParsedAppPalMotPacket
親機がパルアプリの子機（動作センサーパル）から受信したデータを格納する構造体です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint16_t | u16Ai1Voltage | AI1 の入力電圧 (mV) |
int16_t[16] | i16SamplesX | 各サンプルの X 軸加速度 (mG) |
int16_t[16] | i16SamplesY | 各サンプルの Y 軸加速度 (mG) |
int16_t[16] | i16SamplesZ | 各サンプルの Z 軸加速度 (mG) |
uint8_t | u8SampleCount | サンプル数 |
uint16_t | u16SamplingFrequency | サンプリング周波数 (Hz) |
親機・中継機アプリのマニュアルも併せてご覧ください。
ParsedAppPalOpenClosePacket
親機がパルアプリの子機（開閉センサーパル）から受信したデータを格納する構造体です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint16_t | u16Ai1Voltage | AI1 の入力電圧 (mV) |
uint8_t | u8MagnetState | 磁気イベントID |
bool | bMagnetStateChanged | 磁気センサの状態が変化したならtrue |
磁気イベントID
| ID | 内容 |
|---|---|
0x00 | 近くに磁石がない |
0x01 | N極が近くにある |
0x02 | S極が近くにある |
親機・中継機アプリのマニュアルも併せてご覧ください。
ParsedAppUartAsciiPacket
親機がシリアル通信アプリの子機（Aモード）から受信したデータ（簡易形式）を格納する構造体です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint8_t | u8CommandId | コマンド種別（応答ID） |
uint8_t* | u8Data | データ |
uint16_t | u16DataSize | データ長 |
親機・中継機アプリのマニュアルも併せてご覧ください。
ParsedAppUartAsciiExtendedPacket
親機がシリアル通信アプリの子機（Aモード）から受信したデータ（拡張形式）を格納する構造体です。
AppUartAsciiExtendedPacketParser.h
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint32_t | u32DestinationSerialId | 送信先のシリアルID |
uint8_t | u8CommandId | コマンド種別（応答ID） |
uint8_t* | u8Data | データ |
uint16_t | u16DataSize | データ長 |
親機・中継機アプリのマニュアルも併せてご覧ください。
ParsedActPacket
親機がactの子機から受信したデータを格納する構造体です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint8_t | u8CommandId | コマンド種別（応答ID） |
uint8_t* | u8Data | データ |
uint16_t | u16DataSize | データ長 |
親機・中継機アプリのマニュアルも併せてご覧ください。
mwings::CommandBase
親機から子機に送信するコマンドデータを格納する構造体の抽象型です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint8_t | u8DestinationLogicalId | 送信先の論理デバイスID |
手続き
| 型と名称 | 内容 |
|---|---|
bool isValid() | データが正常ならtrueを返す（純粋仮想関数） |
この抽象型には、共通して利用されるデータや手続きを記述しています。
この抽象型から派生した構造体（例：AppTweliteCommand）では、この抽象型のデータや手続きを併せて利用できます。
AppTweliteCommand
mwings::CommandBase から派生
親機から超簡単！標準アプリの子機へ送信するコマンドデータを格納する構造体です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
bool[4] | bDiToChange | 各 DO1-4 の状態を変更する場合はtrue |
bool[4] | bDiState | 各 DO1-4 を Low 状態にする場合はtrue |
bool[4] | bPwmToChange | 各 PWM1-4 の状態を変更する場合はtrue |
uint16_t[4] | u16PwmDuty | 各 PWM1-4 のデューティ比 (0-1024) |
超簡単！標準アプリのマニュアルも併せてご覧ください。
AppIoCommand
mwings::CommandBase から派生
親機から超簡単！標準アプリの子機へ送信するコマンドデータを格納する構造体です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
bool[12] | bDiToChange | 各 O1-12 の状態を変更する場合はtrue |
bool[12] | bDiState | 各 O1-12 を Low 状態にする場合はtrue |
AppPalNoticeCommand
mwings::CommandBase から派生
親機からパルアプリ（通知パル）の子機へ送信するコマンドデータを格納する構造体です。
AppPalNoticeCommandSerializer.h
データ
| 型 | 名称 | 内容 |
|---|---|---|
AppPalNoticeColor | eColor | 点灯色 |
AppPalNoticeBlinkSpeed | eBlinkSpeed | 点滅速度 |
uint8_t | u8Brightness | 明るさ (0-15) |
uint16_t | u16DurationInSec | 点灯時間（秒） |
親機・中継機アプリのマニュアルも併せてご覧ください。
AppPalNoticeDetailedCommand
mwings::CommandBase から派生
親機からパルアプリ（通知パル）の子機へ送信するコマンドデータを格納する構造体です（詳細形式）。
AppPalNoticeDetailedCommandSerializer.h
データ
| 型 | 名称 | 内容 |
|---|---|---|
AppPalNoticeRGBWColor | sRGBWColor | 点灯色 (RGBW) |
uint8_t | u8BlinkDutyPercentage | 点灯時間の割合 (%) |
float | fBlinkPeriodInSec | 点滅周期（秒） |
uint16_t | u16DurationInSec | 点灯時間（秒） |
親機・中継機アプリのマニュアルも併せてご覧ください。
AppPalNoticeEventCommand
mwings::CommandBase から派生
親機からパルアプリ（通知パル）の子機へ送信するコマンドデータ（詳細形式）を格納する構造体です。
AppPalNoticeEventCommandSerializer.h
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint8_t | u8EventId | イベントID (0x00-0x10) |
親機・中継機アプリのマニュアルも併せてご覧ください。
AppUartAsciiCommand
mwings::CommandBase から派生
親機からシリアル通信アプリ（Aモード）の子機へ送信するコマンドデータ（簡易形式）を格納する構造体です。
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint8_t | u8CommandId | コマンド種別（応答ID） |
uint8_t* | u8Data | データ |
uint16_t | u16DataSize | データ長 |
AppUartAsciiCommand で表される簡易形式のコマンドデータは、シリアライズする必要がありません。
下記のようにして、Twelite.send() を直接呼び出してください。
Twelite.send(command.u8DestinationLogicalId, command.u8CommandId,
command.u8Data, command.u16DataSize);
親機・中継機アプリのマニュアルも併せてご覧ください。
AppPalNoticeRGBWColor
AppPalNoticeDetailedCommand で使用する点灯色（RGBW）を定義した構造体です。
AppPalNoticeDetailedCommandSerializer.h
データ
| 型 | 名称 | 内容 |
|---|---|---|
uint8_t | red | R (0-15) |
uint8_t | green | G (0-15) |
uint8_t | blue | B (0-15) |
uint8_t | white | W (0-15) |
手続き
| 型と名称 | 内容 |
|---|---|
bool isValid() | データが正常ならtrueを返す |
uint16_t u16() | LSB から RGBW の順に4ビットずつ並べた16ビット非不整数を返す |
列挙型
AppPalNoticeColor
uint8_t ベースの enum class ?
AppPalNoticeCommand で使用する点灯色を定義した列挙型です。
AppPalNoticeCommandSerializer.h
| 識別子 | 値 | 内容 |
|---|---|---|
AppPalNoticeColor::RED | 0 | 赤 |
AppPalNoticeColor::GREEN | 1 | 緑 |
AppPalNoticeColor::BLUE | 2 | 青 |
AppPalNoticeColor::YELLOW | 3 | 黄色 |
AppPalNoticeColor::PURPLE | 4 | 紫 |
AppPalNoticeColor::LIGHT_BLUE | 5 | 水色 |
AppPalNoticeColor::WHITE | 6 | 白 |
AppPalNoticeColor::WARM_WHITE | 7 | 暖かい白 |
AppPalNoticeBlinkSpeed
uint8_t ベースの enum class
AppPalNoticeCommand で使用する点滅速度を定義した列挙型です。
AppPalNoticeCommandSerializer.h
| 識別子 | 値 | 内容 |
|---|---|---|
AppPalNoticeBlinkSpeed::ALWAYS_ON | 0 | 常時点灯 |
AppPalNoticeBlinkSpeed::SLOW | 1 | おちついた点滅 |
AppPalNoticeBlinkSpeed::MEDIUM | 2 | ほどほどの点滅 |
AppPalNoticeBlinkSpeed::FAST | 3 | せわしない点滅 |
その他のデータ型
手続き
GetAppTweliteSerializedCommandPayloadSize()
constexpr 関数 ?
AppTweliteCommand をシリアライズしたあとの固定長データのペイロードサイズを返す関数です。
| 型と名称 | 内容 |
|---|---|
int GetAppTweliteSerializedCommandPayloadSize() | バイト数を返します |
GetAppAppPalNoticeSerializedCommandPayloadSize()
constexpr 関数
AppPalNoticeCommand をシリアライズしたあとの固定長データのペイロードサイズを返す関数です。
AppPalNoticeCommandSerializer.h
| 型と名称 | 内容 |
|---|---|
int GetAppPalNoticeSerializedCommandPayloadSize() | バイト数を返します |
GetAppAppPalNoticeDetailedSerializedCommandPayloadSize()
constexpr 関数
AppPalNoticeDetailedCommand をシリアライズしたあとの固定長データのペイロードサイズを返す関数です。
AppPalNoticeDetailedCommandSerializer.h
| 型と名称 | 内容 |
|---|---|
int GetAppPalNoticeDetailedSerializedCommandPayloadSize() | バイト数を返します |
GetAppAppPalNoticeEventSerializedCommandPayloadSize()
constexpr 関数
AppPalNoticeEventCommand をシリアライズしたあとの固定長データのペイロードサイズを返す関数です。
AppPalNoticeEventCommandSerializer.h
| 型と名称 | 内容 |
|---|---|
int GetAppPalNoticeEventSerializedCommandPayloadSize() | バイト数を返します |
1.2 - クラスの一覧
32ビット Arduino ボードのための MWings クラスの一覧
クラスの一覧です。
1.2.1 - mwings::MWings クラス
32ビット Arduino ボードのための MWings メインクラス
mwings::MWings クラスの解説です。スケッチで利用する
Twelite オブジェクトは、mwings::MWings クラスのインスタンスです。通常、
mwings::MWings クラスをスケッチ内でインスタンス化する必要はありません。自動的に初期化される Twelite オブジェクトを使用してください。コンストラクタ
MWings()
コンストラクタです。内部変数を初期化します。
MWings()
引数
なし
デストラクタ
~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);
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
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 | 各パケットのタイムアウト時間 | 🆗 | 受信完了まで |
HardwareSerial* | debugSerial | デバッグ出力ポート | 🆗 |
戻り値
| 型 | 値 | 内容 | 備考 |
|---|---|---|---|
bool | true | 成功 | |
false | エラー |
end()
すべての内部変数を初期化します。
inline void end()
引数
なし
戻り値
なし
update()
シリアル受信バッファを読み出し、親機から送られた ModBus ASCII 形式のデータをパースします。
void update();
引数
なし
戻り値
なし
on() <BarePacket>
すべての子機から送られたデータに対して行う処理を登録します。
inline void on(void (*callback)(const BarePacket& packet))
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
void (*)(BarePacket&) | callback | イベントハンドラ |
BarePacket の詳細は データと手続き をご覧ください。戻り値
なし
on() <ParsedAppTwelitePacket>
超簡単！標準アプリの子機から送られたデータに対して行う処理を登録します。
inline void on(void (*callback)(const ParsedAppTwelitePacket& packet))
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
void (*)(ParsedAppTwelitePacket&) | callback | イベントハンドラ |
ParsedAppTwelitePacket の詳細は データと手続き をご覧ください。戻り値
なし
on() <ParsedAppIoPacket>
リモコンアプリの子機から送られたデータに対して行う処理を登録します。
inline void on(void (*callback)(const ParsedAppIoPacket& packet))
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
void (*)(ParsedAppIoPacket&) | callback | イベントハンドラ |
ParsedAppIoPacket の詳細は データと手続き をご覧ください。戻り値
なし
on() <ParsedAppAriaPacket>
アリアアプリ（TWELITE ARIA モード）の子機から送られたデータに対して行う処理を登録します。
inline void on(void (*callback)(const ParsedAppAriaPacket& packet))
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
void (*)(ParsedAppAriaPacket&) | callback | イベントハンドラ |
ParsedAppAriaPacket の詳細は データと手続き をご覧ください。戻り値
なし
on() <ParsedAppCuePacket>
キューアプリ（TWELITE CUE モード）の子機から送られたデータに対して行う処理を登録します。
inline void on(void (*callback)(const ParsedAppCuePacket& packet))
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
void (*)(ParsedAppCuePacket&) | callback | イベントハンドラ |
ParsedAppCuePacket の詳細は データと手続き をご覧ください。戻り値
なし
on() <ParsedAppPalOpenClosePacket>
パルアプリ（開閉センサーパル）の子機から送られたデータに対して行う処理を登録します。
inline void on(void (*callback)(const ParsedAppPalOpenClosePacket& packet))
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
void (*)(ParsedAppPalOpenClosePacket&) | callback | イベントハンドラ |
ParsedAppPalOpenClosePacket の詳細は データと手続き をご覧ください。戻り値
なし
on() <ParsedAppPalAmbPacket>
パルアプリ（環境センサーパル）の子機から送られたデータに対して行う処理を登録します。
inline void on(void (*callback)(const ParsedAppPalAmbPacket& packet))
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
void (*)(ParsedAppPalAmbPacket&) | callback | イベントハンドラ |
ParsedAppPalAmbPacket の詳細は データと手続き をご覧ください。戻り値
なし
on() <ParsedAppPalMotPacket>
パルアプリ（動作センサーパル）の子機から送られたデータに対して行う処理を登録します。
inline void on(void (*callback)(const ParsedAppPalMotPacket& packet))
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
void (*)(ParsedAppPalMotPacket&) | callback | イベントハンドラ |
ParsedAppPalMotPacket の詳細は データと手続き をご覧ください。戻り値
なし
on() <ParsedAppUartAsciiPacket>
シリアル通信アプリ（Aモード）の子機から送られたデータ（簡易形式）に対して行う処理を登録します。
inline void on(void (*callback)(const ParsedAppUartAsciiPacket& packet))
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
void (*)(ParsedAppUartAsciiPacket&) | callback | イベントハンドラ |
ParsedAppUartAsciiPacket の詳細は データと手続き をご覧ください。戻り値
なし
on() <ParsedAppUartAsciiExtendedPacket>
シリアル通信アプリ（Aモード）の子機から送られたデータ（拡張形式）に対して行う処理を登録します。
inline void on(void (*callback)(const ParsedAppUartAsciiExtendedPacket& packet))
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
void (*)(ParsedAppUartAsciiExtendedPacket&) | callback | イベントハンドラ |
ParsedAppUartAsciiExtendedPacket の詳細は データと手続き をご覧ください。戻り値
なし
on() <ParsedActPacket>
act の子機から送られたデータに対して行う処理を登録します。
inline void on(void (*callback)(const ParsedActPacket& packet))
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
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)
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
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)
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
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)
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
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)
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
uint8_t | logicalId | 宛先の論理デバイス ID | ||
uint8_t | commandId | コマンド種別 | ||
uint8_t* | payload | ペイロード | :と LRC の間 | |
int | payloadSize | ペイロードのサイズ |
戻り値
| 型 | 値 | 内容 | 備考 |
|---|---|---|---|
bool | true | 成功 | |
false | エラー |
send() <AppTweliteCommand>
超簡単！標準アプリの端末を操作するためのコマンドを親機に送信します。
inline bool send(AppTweliteCommand& command)
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
AppTweliteCommand | command | コマンドデータ |
AppTweliteCommand の詳細は データと手続き をご覧ください。戻り値
| 型 | 値 | 内容 | 備考 |
|---|---|---|---|
bool | true | 成功 | |
false | エラー |
send() <AppIoCommand>
リモコンアプリの端末を操作するためのコマンドを親機に送信します。
inline bool send(AppIoCommand& command)
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
AppIoCommand | command | コマンドデータ |
AppIoCommand の詳細は データと手続き をご覧ください。戻り値
| 型 | 値 | 内容 | 備考 |
|---|---|---|---|
bool | true | 成功 | |
false | エラー |
send() <AppPalNoticeCommand>
パルアプリ（通知パル）の端末を操作するためのコマンドを親機に送信します。
inline bool send(AppPalNoticeCommand& command)
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
AppPalNoticeCommand | command | コマンドデータ |
AppPalNoticeCommand の詳細は データと手続き をご覧ください。戻り値
| 型 | 値 | 内容 | 備考 |
|---|---|---|---|
bool | true | 成功 | |
false | エラー |
send() <AppPalNoticeDetailedCommand>
パルアプリ（通知パル）の端末を操作するためのコマンド（詳細形式）を親機に送信します。
inline bool send(AppPalNoticeDetailedCommand& command)
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
AppPalNoticeDetailedCommand | command | コマンドデータ |
AppPalNoticeDetailedCommand の詳細は データと手続き をご覧ください。戻り値
| 型 | 値 | 内容 | 備考 |
|---|---|---|---|
bool | true | 成功 | |
false | エラー |
send() <AppPalNoticeEventCommand>
パルアプリ（通知パル）の端末を操作するためのコマンド（イベント）を親機に送信します。
inline bool send(AppPalNoticeEventCommand& command)
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
AppPalNoticeEventCommand | command | コマンドデータ |
AppPalNoticeEventCommand の詳細は データと手続き をご覧ください。戻り値
| 型 | 値 | 内容 | 備考 |
|---|---|---|---|
bool | true | 成功 | |
false | エラー |
send() <AppPalUartAsciiCommand>
シリアル通信アプリ（Aモード）の端末を操作するためのコマンド（簡易形式）を親機に送信します。
inline bool send(AppPalUartAsciiCommand& command)
引数
| 型 | 名称 | 内容 | 省略 | 備考 |
|---|---|---|---|---|
AppPalUartAsciiCommand | command | コマンドデータ |
AppPalUartAsciiCommand の詳細は データと手続き をご覧ください。戻り値
| 型 | 値 | 内容 | 備考 |
|---|---|---|---|
bool | true | 成功 | |
false | エラー |