This is the multi-page printable view of this section. Click here to print...

For suitable output, we recommend to use Google Chrome (15+) or Microsoft Edge (79+).

As of 2025-07-24

TWELITE Wings API / MWings for 32-bit Arduinos

MWings for 32-bit Arduino boards

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

1.1: List of Data Types and Procedures

1.2: Class List

1.2.1: mwings::MWings Class

TWELITE Wings API for 32-bit Arduino boards.

The MWings library enables easy communication with all TWELITE series products such as TWELITE CUE / TWELITE ARIA, TWELITE PAL, TWELITE DIP, and TWELITE UART.

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

Latest Version

TWELITE Wings API for 32-bit Arduino boards.

The MWings library makes it easy to communicate with all TWELITE series products such as TWELITE CUE / TWELITE ARIA, TWELITE PAL, TWELITE DIP, and TWELITE UART.

GitHub: monowireless/mwings_arduino

1.1 - List of Data Types and Procedures

List of MWings-specific data types and procedures for 32-bit Arduino boards

This is a list of MWings-specific data types and procedures. Click here for a list of classes.

Structures

`BarePacket`

Stores raw data extracted from the packet received by the parent device from a child device.

MWings_Common.h

Data

Type	Name	Description
`uint8_t*`	`u8Payload`	Payload data converted to binary (excluding `:`, checksum, and `CRLF`)
`uint16_t`	`u16PayloadSize`	Byte size of the above data
`uint8_t`	`u8Checksum`	Checksum of the above data

Procedures

Type and Name	Description
`uint8_t* u8From(int)`	Gets payload data from the specified position onward
`uint8_t u8At(int)`	Gets the payload data at the specified position as an 8-bit unsigned integer
`int8_t i8At(int)`	Gets the payload data at the specified position as an 8-bit signed integer
`uint16_t u16At(int)`	Gets the payload data at the specified position as a 16-bit unsigned integer
`int16_t i16At(int)`	Gets the payload data at the specified position as a 16-bit signed integer
`uint32_t u32At(int)`	Gets the payload data at the specified position as a 32-bit unsigned integer
`int32_t i32At(int)`	Gets the payload data at the specified position as a 32-bit signed integer

`mwings::ParsedPacketBase`

Abstract structure that stores parsed data received by the parent device from a child device.

MWings_Common.h

Data

Type	Name	Description
`uint32_t`	`u32SourceSerialId`	Serial ID of the sender
`uint8_t`	`u8SourceLogicalId`	Logical device ID of the sender
`uint16_t`	`u16SequenceNumber`	Sequence number
`uint8_t`	`u8Lqi`	LQI
`uint16_t`	`u16SupplyVoltage`	Supply voltage (mV)

This abstract structure defines data that is commonly used.

Structures derived from this abstract type (e.g., ParsedAppTwelitePacket) can access the data defined here.

`ParsedAppTwelitePacket`

Derived from mwings::ParsedPacketBase

Structure that stores data received by the parent device from a child device running the “Super Easy! Standard App”.

AppTwelitePacketParser.h

Data

Type	Name	Description
`uint8_t`	`u8DestinationLogicalId`	Logical device ID of the recipient
`uint8_t`	`u8RelayCount`	Number of relays
`bool`	`bPeriodic`	`true` if the packet is a periodic transmission
`bool[4]`	`bDiChanged`	`true` if DI1–4 changed
`bool[4]`	`bDiState`	`true` if DI1–4 are in Low state
`uint16_t[4]`	`u16AiVoltage`	Input voltage of AI1–4 (mV)

Please also refer to the manual of the parent/relay app.

`ParsedAppIoPacket`

Derived from mwings::ParsedPacketBase

Structure that stores data received by the parent device from a child device running the Remote App.

AppIoPacketParser.h

Data

Type	Name	Description
`uint8_t`	`u8RelayCount`	Number of relays
`bool[12]`	`bDiState`	`true` if each DI is in Low state
`bool[12]`	`bDiValid`	`true` if each DI is valid
`bool[12]`	`bDiInterrupt`	`true` if each DI has changed by interrupt

Please also refer to the manual of the parent/relay app.

`ParsedAppAriaPacket`

Derived from mwings::ParsedPacketBase

Structure that stores data received by the parent device from a child device running the Aria App (TWELITE ARIA mode).

AppAriaPacketParser.h

Data

Type	Name	Description
`uint32_t`	`u32RouterSerialId`	Serial ID of the first relay device `0x80000000` if not relayed (v1.2.2+)
`int16_t`	`i16Temp100x`	Temperature ×100 (Celsius)
`uint16_t`	`u16Humid100x`	Relative humidity ×100 (%)
`uint8_t`	`u8MagnetState`	Magnet Event ID
`bool`	`bMagnetStateChanged`	`true` if magnet sensor state changed

Magnet Event ID

ID	Description
`0x00`	No magnet nearby
`0x01`	North pole is nearby
`0x02`	South pole is nearby

Please also refer to the manual of the parent/relay app.

`ParsedAppCuePacket`

Derived from mwings::ParsedPacketBase

Structure that stores data received by the parent device from a child device running the Cue App (TWELITE CUE mode).

AppCuePacketParser.h

Data

Type	Name	Description
`uint32_t`	`u32RouterSerialId`	Serial ID of the first relay device `0x80000000` if not relayed (v1.2.2+)
`int16_t[10]`	`i16SamplesX`	X-axis acceleration samples (mG)
`int16_t[10]`	`i16SamplesY`	Y-axis acceleration samples (mG)
`int16_t[10]`	`i16SamplesZ`	Z-axis acceleration samples (mG)
`uint8_t`	`u8SampleCount`	Number of samples
`bool`	`bHasAccelEvent`	`true` if there is an acceleration event
`uint8_t`	`u8AccelEvent`	Acceleration Event ID
`uint8_t`	`u8MagnetState`	Magnet Event ID
`bool`	`bMagnetStateChanged`	`true` if magnet sensor state changed

Acceleration Event ID

ID	Description
`0x01`~`0x06`	Dice
`0x08`	Shake
`0x10`	Move

Magnet Event ID

ID	Description
`0x00`	No magnet nearby
`0x01`	North pole is nearby
`0x02`	South pole is nearby

Please also refer to the manual of the parent/relay app.

`ParsedAppPalAmbPacket`

Derived from mwings::ParsedPacketBase

Structure that stores data received by the parent device from a child device running the Pal App (environment sensor Pal).

AppPalAmbPacketParser.h

Data

Type	Name	Description
`uint32_t`	`u32RouterSerialId`	Serial ID of the first relay device `0x80000000` if not relayed (v1.2.2+)
`uint16_t`	`u16Ai1Voltage`	AI1 input voltage (mV)
`int16_t`	`i16Temp100x`	Temperature ×100 (Celsius)
`uint16_t`	`u16Humid100x`	Relative humidity ×100 (%)
`uint32_t`	`u32Illuminance`	Illuminance (lux)

Please also refer to the manual of the parent/relay app.

`ParsedAppPalMotPacket`

Derived from mwings::ParsedPacketBase

Structure that stores data received by the parent device from a child device running the Pal App (motion sensor Pal).

AppPalMotPacketParser.h

Data

Type	Name	Description
`uint32_t`	`u32RouterSerialId`	Serial ID of the first relay device `0x80000000` if not relayed (v1.2.2+)
`uint16_t`	`u16Ai1Voltage`	AI1 input voltage (mV)
`int16_t[16]`	`i16SamplesX`	X-axis acceleration samples (mG)
`int16_t[16]`	`i16SamplesY`	Y-axis acceleration samples (mG)
`int16_t[16]`	`i16SamplesZ`	Z-axis acceleration samples (mG)
`uint8_t`	`u8SampleCount`	Number of samples
`uint16_t`	`u16SamplingFrequency`	Sampling frequency (Hz)

Please also refer to the manual of the parent/relay app.

`ParsedAppPalOpenClosePacket`

Derived from mwings::ParsedPacketBase

Structure that stores data received by the parent device from a child device running the Pal App (open/close sensor Pal).

AppPalOpenClosePacketParser.h

Data

Type	Name	Description
`uint32_t`	`u32RouterSerialId`	Serial ID of the first relay device `0x80000000` if not relayed (v1.2.2+)
`uint16_t`	`u16Ai1Voltage`	AI1 input voltage (mV)
`uint8_t`	`u8MagnetState`	Magnet Event ID
`bool`	`bMagnetStateChanged`	`true` if magnet sensor state changed

Magnet Event ID

ID	Description
`0x00`	No magnet nearby
`0x01`	North pole is nearby
`0x02`	South pole is nearby

Please also refer to the manual of the parent/relay app.

`ParsedAppUartAsciiPacket`

Derived from mwings::ParsedPacketBase

Structure that stores data received by the parent device from a child device running the serial communication app (A mode, simple format).

AppUartAsciiPacketParser.h

Data

Type	Name	Description
`uint8_t`	`u8CommandId`	Command type (response ID)
`uint8_t*`	`u8Data`	Data
`uint16_t`	`u16DataSize`	Data length

Please also refer to the manual of the parent/relay app.

`ParsedAppUartAsciiExtendedPacket`

Derived from mwings::ParsedPacketBase

Structure that stores data received by the parent device from a child device running the serial communication app (A mode, extended format).

AppUartAsciiExtendedPacketParser.h

Data

Type	Name	Description
`uint32_t`	`u32DestinationSerialId`	Destination serial ID
`uint8_t`	`u8CommandId`	Command type (response ID)
`uint8_t*`	`u8Data`	Data
`uint16_t`	`u16DataSize`	Data length

Please also refer to the manual of the parent/relay app.

`ParsedActPacket`

Derived from mwings::ParsedPacketBase

Structure that stores data received by the parent device from a child device running the act app.

ActPacketParser.h

Data

Type	Name	Description
`uint8_t`	`u8CommandId`	Command type (response ID)
`uint8_t*`	`u8Data`	Data
`uint16_t`	`u16DataSize`	Data length

Please also refer to the manual of the parent/relay app.

`mwings::CommandBase`

Abstract structure that stores command data sent from the parent device to a child device.

MWings_Common.h

Data

Type	Name	Description
`uint8_t`	`u8DestinationLogicalId`	Destination logical device ID

Procedures

Type and Name	Description
`bool isValid()`	Returns `true` if the data is valid (pure virtual function)

This abstract structure defines data and procedures that are commonly used.

Structures derived from this abstract type (e.g., AppTweliteCommand) can access the data and procedures defined here.

`AppTweliteCommand`

Derived from mwings::CommandBase

Structure that stores command data sent from the parent device to a child device running the “Super Easy! Standard App”.

AppTweliteCommandSerializer.h

Data

Type	Name	Description
`bool[4]`	`bDiToChange`	`true` to change the state of each DO1-4
`bool[4]`	`bDiState`	`true` to set each DO1-4 to Low state
`bool[4]`	`bPwmToChange`	`true` to change the state of each PWM1-4
`uint16_t[4]`	`u16PwmDuty`	Duty ratio of each PWM1-4 (0-1024)

Please also refer to the manual of the “Super Easy! Standard App”.

`AppIoCommand`

Derived from mwings::CommandBase

Structure that stores command data sent from the parent device to a child device running the Remote App.

AppIoCommandSerializer.h

Data

Type	Name	Description
`bool[12]`	`bDiToChange`	`true` to change the state of each O1-12
`bool[12]`	`bDiState`	`true` to set each O1-12 to Low state

`AppPalNoticeCommand`

Derived from mwings::CommandBase

Structure that stores command data sent from the parent device to a child device running the Pal App (Notifier Pal).

AppPalNoticeCommandSerializer.h

Data

Type	Name	Description
`AppPalNoticeColor`	`eColor`	Lighting color
`AppPalNoticeBlinkSpeed`	`eBlinkSpeed`	Blinking speed
`uint8_t`	`u8Brightness`	Brightness (0-15)
`uint16_t`	`u16DurationInSec`	Lighting duration (seconds)

Please also refer to the manual of the parent/relay app.

`AppPalNoticeDetailedCommand`

Derived from mwings::CommandBase

Structure that stores command data sent from the parent device to a child device running the Pal App (Notifier Pal) — detailed format.

AppPalNoticeDetailedCommandSerializer.h

Data

Type	Name	Description
`AppPalNoticeRGBWColor`	`sRGBWColor`	Lighting color (RGBW)
`uint8_t`	`u8BlinkDutyPercentage`	Lighting time ratio (%)
`float`	`fBlinkPeriodInSec`	Blinking period (seconds)
`uint16_t`	`u16DurationInSec`	Lighting duration (seconds)

Please also refer to the manual of the parent/relay app.

`AppPalNoticeEventCommand`

Derived from mwings::CommandBase

Structure that stores command data (detailed format) sent from the parent device to a child device running the Pal App (Notifier Pal).

AppPalNoticeEventCommandSerializer.h

Data

Type	Name	Description
`uint8_t`	`u8EventId`	Event ID (0x00-0x10)

Please also refer to the manual of the parent/relay app.

`AppUartAsciiCommand`

Derived from mwings::CommandBase

Structure that stores command data (simple format) sent from the parent device to a child device running the serial communication app (A mode).

AppUartAsciiCommand.h

Data

Type	Name	Description
`uint8_t`	`u8CommandId`	Command type (response ID)
`uint8_t*`	`u8Data`	Data
`uint16_t`	`u16DataSize`	Data length

Command data represented by AppUartAsciiCommand does not require serialization.

Call Twelite.send() directly as shown below:

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

Please also refer to the manual of the parent/relay app.

`AppPalNoticeRGBWColor`

Structure that defines the lighting color (RGBW) used in AppPalNoticeDetailedCommand.

AppPalNoticeDetailedCommandSerializer.h

Data

Type	Name	Description
`uint8_t`	`red`	R (0-15)
`uint8_t`	`green`	G (0-15)
`uint8_t`	`blue`	B (0-15)
`uint8_t`	`white`	W (0-15)

Procedures

Type and Name	Description
`bool isValid()`	Returns `true` if the data is valid
`uint16_t u16()`	Returns a 16-bit unsigned integer with RGBW packed in order from LSB, 4 bits each

Enumerations

`AppPalNoticeColor`

enum class based on uint8_t ?

Enumeration that defines the lighting color used in AppPalNoticeCommand.

AppPalNoticeCommandSerializer.h

Identifier	Value	Description
`AppPalNoticeColor::RED`	`0`	Red
`AppPalNoticeColor::GREEN`	`1`	Green
`AppPalNoticeColor::BLUE`	`2`	Blue
`AppPalNoticeColor::YELLOW`	`3`	Yellow
`AppPalNoticeColor::PURPLE`	`4`	Purple
`AppPalNoticeColor::LIGHT_BLUE`	`5`	Light blue
`AppPalNoticeColor::WHITE`	`6`	White
`AppPalNoticeColor::WARM_WHITE`	`7`	Warm white

`AppPalNoticeBlinkSpeed`

enum class based on uint8_t

Enumeration that defines the blinking speed used in AppPalNoticeCommand.

AppPalNoticeCommandSerializer.h

Identifier	Value	Description
`AppPalNoticeBlinkSpeed::ALWAYS_ON`	`0`	Always on
`AppPalNoticeBlinkSpeed::SLOW`	`1`	Slow blinking
`AppPalNoticeBlinkSpeed::MEDIUM`	`2`	Medium blinking
`AppPalNoticeBlinkSpeed::FAST`	`3`	Fast blinking

Other Data Types

Procedures

`GetAppTweliteSerializedCommandPayloadSize()`

constexpr function ?

Returns the payload size (in bytes) of the serialized fixed-length data for AppTweliteCommand.

AppTweliteCommandSerializer.h

Type and Name	Description
`int GetAppTweliteSerializedCommandPayloadSize()`	Returns the number of bytes

`GetAppAppPalNoticeSerializedCommandPayloadSize()`

constexpr function

Returns the payload size (in bytes) of the serialized fixed-length data for AppPalNoticeCommand.

AppPalNoticeCommandSerializer.h

Type and Name	Description
`int GetAppPalNoticeSerializedCommandPayloadSize()`	Returns the number of bytes

`GetAppAppPalNoticeDetailedSerializedCommandPayloadSize()`

constexpr function

Returns the payload size (in bytes) of the serialized fixed-length data for AppPalNoticeDetailedCommand.

AppPalNoticeDetailedCommandSerializer.h

Type and Name	Description
`int GetAppPalNoticeDetailedSerializedCommandPayloadSize()`	Returns the number of bytes

`GetAppAppPalNoticeEventSerializedCommandPayloadSize()`

constexpr function

Returns the payload size (in bytes) of the serialized fixed-length data for AppPalNoticeEventCommand.

AppPalNoticeEventCommandSerializer.h

Type and Name	Description
`int GetAppPalNoticeEventSerializedCommandPayloadSize()`	Returns the number of bytes

1.2 - Class List

List of MWings classes for 32-bit Arduino boards

This is a list of classes.

1.2.1 - mwings::MWings Class

The main MWings class for 32-bit Arduino boards

This is an explanation of the mwings::MWings class.

The Twelite object used in sketches is an instance of the mwings::MWings class.

Normally, you do not need to instantiate the mwings::MWings class in your sketch. Please use the automatically initialized Twelite object.

Constructor

`MWings()`

Constructor. Initializes internal variables.

MWings()

MWings.h

Arguments

None

Destructor

`~MWings()`

Destructor. Releases allocated buffers.

~MWings()

Public Member Functions

`begin()`

Initializes TWELITE and starts it with the specified settings.

    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

Arguments

Type	Name	Description	Optional	Remarks
`HardwareSerial&`	`serial`	Port communicating with TWELITE
`int`	`indicatorPin`	Pin connected to status LED	🆗	Can be omitted with `-1`
`int`	`resetPin`	TWELITE’s RST pin	🆗	Can be omitted with `-1`
`int`	`programPin`	TWELITE’s PRG pin	🆗	Can be omitted with `-1`
`uint8_t`	`channel`	Frequency channel	🆗	Default is `18`
`uint32_t`	`appId`	Application ID	🆗	Default is `0x67720102`
`uint8_t`	`retryCount`	Number of retries	🆗	0-9
`uint8_t`	`txPower`	Transmission power	🆗	0-3
`int`	`rxBufferSize`	Size of packet reception buffer	🆗	Binary-based
`int`	`timeout`	Timeout for each packet	🆗	Until reception completion
`uint32_t`	`encryptKey`	Encryption key	🆗	Disabled if `0`, available from v1.2.3+
`HardwareSerial*`	`debugSerial`	Debug output port	🆗

Return Value

Type	Value	Description	Remarks
`bool`	`true`	Success
	`false`	Error

`end()`

Initializes all internal variables.

inline void end()

MWings.h

Arguments

None

Return Value

None

`update()`

Reads the serial receive buffer and parses the ModBus ASCII format data sent from the parent device.

void update();

MWings.h

Arguments

None

Return Value

None

`on()` <`BarePacket`>

Registers a handler to process data sent from all child devices.

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

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`void (*)(BarePacket&)`	`callback`	Event handler

For details on BarePacket, see Data and Procedures.

Return Value

None

`on()` <`ParsedAppTwelitePacket`>

Super easy! Registers a handler to process data sent from standard app child devices.

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

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`void (*)(ParsedAppTwelitePacket&)`	`callback`	Event handler

For details on ParsedAppTwelitePacket, see Data and Procedures.

Return Value

None

`on()` <`ParsedAppIoPacket`>

Registers a handler to process data sent from remote control app child devices.

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

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`void (*)(ParsedAppIoPacket&)`	`callback`	Event handler

For details on ParsedAppIoPacket, see Data and Procedures.

Return Value

None

`on()` <`ParsedAppAriaPacket`>

Registers a handler to process data sent from ARIA app (TWELITE ARIA mode) child devices.

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

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`void (*)(ParsedAppAriaPacket&)`	`callback`	Event handler

For details on ParsedAppAriaPacket, see Data and Procedures.

Return Value

None

`on()` <`ParsedAppCuePacket`>

Registers a handler to process data sent from CUE app (TWELITE CUE mode) child devices.

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

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`void (*)(ParsedAppCuePacket&)`	`callback`	Event handler

For details on ParsedAppCuePacket, see Data and Procedures.

Return Value

None

`on()` <`ParsedAppPalOpenClosePacket`>

Registers a handler to process data sent from PAL app (open/close sensor PAL) child devices.

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

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`void (*)(ParsedAppPalOpenClosePacket&)`	`callback`	Event handler

For details on ParsedAppPalOpenClosePacket, see Data and Procedures.

Return Value

None

`on()` <`ParsedAppPalAmbPacket`>

Registers a handler to process data sent from PAL app (environment sensor PAL) child devices.

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

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`void (*)(ParsedAppPalAmbPacket&)`	`callback`	Event handler

For details on ParsedAppPalAmbPacket, see Data and Procedures.

Return Value

None

`on()` <`ParsedAppPalMotPacket`>

Registers a handler to process data sent from PAL app (motion sensor PAL) child devices.

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

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`void (*)(ParsedAppPalMotPacket&)`	`callback`	Event handler

For details on ParsedAppPalMotPacket, see Data and Procedures.

Return Value

None

`on()` <`ParsedAppUartAsciiPacket`>

Registers a handler to process data (simple format) sent from serial communication app (A mode) child devices.

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

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`void (*)(ParsedAppUartAsciiPacket&)`	`callback`	Event handler

For details on ParsedAppUartAsciiPacket, see Data and Procedures.

Return Value

None

`on()` <`ParsedAppUartAsciiExtendedPacket`>

Registers a handler to process data (extended format) sent from serial communication app (A mode) child devices.

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

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`void (*)(ParsedAppUartAsciiExtendedPacket&)`	`callback`	Event handler

For details on ParsedAppUartAsciiExtendedPacket, see Data and Procedures.

Return Value

None

`on()` <`ParsedActPacket`>

Registers a handler to process data sent from act child devices.

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

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`void (*)(ParsedActPacket&)`	`callback`	Event handler

For details on ParsedActPacket, see Data and Procedures.

Return Value

None

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

Sends an arbitrary command (ModBus ASCII format) to the parent device.

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

MWings.h

Arguments

Type	Name	Description	Remarks
`uint8_t*`	`payload`	Payload	Between `:` and LRC
`int`	`payloadSize`	Payload size
`uint8_t`	`checksum`	Checksum	LRC of the payload

Return Value

Type	Value	Description	Remarks
`bool`	`true`	Success
	`false`	Error

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

Sends an arbitrary command (ModBus ASCII format) to the parent device (checksum automatically added).

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

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`uint8_t*`	`payload`	Payload		Between `:` and LRC
`int`	`payloadSize`	Payload size

Return Value

Type	Value	Description	Remarks
`bool`	`true`	Success
	`false`	Error

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

Sends an arbitrary command (ModBus ASCII format) to the parent device.

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

Arguments

Type	Name	Description	Remarks
`uint8_t`	`logicalId`	Destination logical device ID
`uint8_t`	`commandId`	Command type
`uint8_t*`	`payload`	Payload	Between `:` and LRC
`int`	`payloadSize`	Payload size
`uint8_t`	`checksum`	Checksum	LRC of the payload

Return Value

Type	Value	Description	Remarks
`bool`	`true`	Success
	`false`	Error

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

Sends an arbitrary command (ModBus ASCII format) to the parent device (checksum automatically added).

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

MWings.h

Arguments

Type	Name	Description	Remarks
`uint8_t`	`logicalId`	Destination logical device ID
`uint8_t`	`commandId`	Command type
`uint8_t*`	`payload`	Payload	Between `:` and LRC
`int`	`payloadSize`	Payload size

Return Value

Type	Value	Description	Remarks
`bool`	`true`	Success
	`false`	Error

`send()` <`AppTweliteCommand`>

Super easy! Sends a command to operate standard app terminals to the parent device.

inline bool send(AppTweliteCommand& command)

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`AppTweliteCommand`	`command`	Command data

For details on AppTweliteCommand, see Data and Procedures.

Return Value

Type	Value	Description	Remarks
`bool`	`true`	Success
	`false`	Error

`send()` <`AppIoCommand`>

Sends a command to operate remote control app terminals to the parent device.

inline bool send(AppIoCommand& command)

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`AppIoCommand`	`command`	Command data

For details on AppIoCommand, see Data and Procedures.

Return Value

Type	Value	Description	Remarks
`bool`	`true`	Success
	`false`	Error

`send()` <`AppPalNoticeCommand`>

Sends a command to operate PAL app (notification PAL) terminals to the parent device.

inline bool send(AppPalNoticeCommand& command)

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`AppPalNoticeCommand`	`command`	Command data

For details on AppPalNoticeCommand, see Data and Procedures.

Return Value

Type	Value	Description	Remarks
`bool`	`true`	Success
	`false`	Error

`send()` <`AppPalNoticeDetailedCommand`>

Sends a command (detailed format) to operate PAL app (notification PAL) terminals to the parent device.

inline bool send(AppPalNoticeDetailedCommand& command)

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`AppPalNoticeDetailedCommand`	`command`	Command data

For details on AppPalNoticeDetailedCommand, see Data and Procedures.

Return Value

Type	Value	Description	Remarks
`bool`	`true`	Success
	`false`	Error

`send()` <`AppPalNoticeEventCommand`>

Sends a command (event) to operate PAL app (notification PAL) terminals to the parent device.

inline bool send(AppPalNoticeEventCommand& command)

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`AppPalNoticeEventCommand`	`command`	Command data

For details on AppPalNoticeEventCommand, see Data and Procedures.

Return Value

Type	Value	Description	Remarks
`bool`	`true`	Success
	`false`	Error

`send()` <`AppPalUartAsciiCommand`>

Sends a command (simple format) to operate serial communication app (A mode) terminals to the parent device.

inline bool send(AppPalUartAsciiCommand& command)

MWings.h

Arguments

Type	Name	Description	Optional	Remarks
`AppPalUartAsciiCommand`	`command`	Command data

For details on AppPalUartAsciiCommand, see Data and Procedures.

Return Value

Type	Value	Description	Remarks
`bool`	`true`	Success
	`false`	Error

TWELITE Wings API / MWings for 32-bit Arduinos

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

1.1 - List of Data Types and Procedures

Structures

BarePacket

Data

Procedures

mwings::ParsedPacketBase

Data

ParsedAppTwelitePacket

Data

ParsedAppIoPacket

Data

ParsedAppAriaPacket

Data

Magnet Event ID

ParsedAppCuePacket

Data

Acceleration Event ID

Magnet Event ID

ParsedAppPalAmbPacket

Data

ParsedAppPalMotPacket

Data

ParsedAppPalOpenClosePacket

Data

Magnet Event ID

ParsedAppUartAsciiPacket

Data

ParsedAppUartAsciiExtendedPacket

Data

ParsedActPacket

Data

mwings::CommandBase

Data

Procedures

AppTweliteCommand

Data

AppIoCommand

Data

AppPalNoticeCommand

Data

AppPalNoticeDetailedCommand

Data

AppPalNoticeEventCommand

Data

AppUartAsciiCommand

Data

AppPalNoticeRGBWColor

Data

Procedures

Enumerations

AppPalNoticeColor

AppPalNoticeBlinkSpeed

Other Data Types

Procedures

GetAppTweliteSerializedCommandPayloadSize()

GetAppAppPalNoticeSerializedCommandPayloadSize()

GetAppAppPalNoticeDetailedSerializedCommandPayloadSize()

GetAppAppPalNoticeEventSerializedCommandPayloadSize()

1.2 - Class List

1.2.1 - mwings::MWings Class

Constructor

MWings()

Arguments

Destructor

~MWings()

Public Member Functions

begin()

Arguments

Return Value

end()

Arguments

Return Value

update()

Arguments

Return Value

on() <BarePacket>

Arguments

Return Value

`BarePacket`

`mwings::ParsedPacketBase`

`ParsedAppTwelitePacket`

`ParsedAppIoPacket`

`ParsedAppAriaPacket`

`ParsedAppCuePacket`

`ParsedAppPalAmbPacket`

`ParsedAppPalMotPacket`

`ParsedAppPalOpenClosePacket`

`ParsedAppUartAsciiPacket`

`ParsedAppUartAsciiExtendedPacket`

`ParsedActPacket`

`mwings::CommandBase`

`AppTweliteCommand`

`AppIoCommand`

`AppPalNoticeCommand`

`AppPalNoticeDetailedCommand`

`AppPalNoticeEventCommand`

`AppUartAsciiCommand`

`AppPalNoticeRGBWColor`

`AppPalNoticeColor`

`AppPalNoticeBlinkSpeed`

`GetAppTweliteSerializedCommandPayloadSize()`

`GetAppAppPalNoticeSerializedCommandPayloadSize()`

`GetAppAppPalNoticeDetailedSerializedCommandPayloadSize()`

`GetAppAppPalNoticeEventSerializedCommandPayloadSize()`

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