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

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

on() <ParsedAppTwelitePacket>

Arguments

Return Value

on() <ParsedAppIoPacket>

Arguments

Return Value

on() <ParsedAppAriaPacket>

Arguments

Return Value

on() <ParsedAppCuePacket>

Arguments

Return Value

on() <ParsedAppPalOpenClosePacket>

Arguments

Return Value

on() <ParsedAppPalAmbPacket>

Arguments

Return Value

on() <ParsedAppPalMotPacket>

Arguments

Return Value

on() <ParsedAppUartAsciiPacket>

Arguments

Return Value

on() <ParsedAppUartAsciiExtendedPacket>

Arguments

Return Value

on() <ParsedActPacket>

Arguments

Return Value

send() <uint8_t*, int, uint8_t>

Arguments

Return Value

send() <uint8_t*, int>

Arguments

Return Value

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

Arguments

Return Value

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

Arguments

Return Value

send() <AppTweliteCommand>

Arguments

Return Value

send() <AppIoCommand>

Arguments

Return Value

send() <AppPalNoticeCommand>

Arguments

Return Value

send() <AppPalNoticeDetailedCommand>

Arguments

Return Value

send() <AppPalNoticeEventCommand>

Arguments

Return Value

send() <AppPalUartAsciiCommand>

Arguments

Return Value

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