mwings 1.0.4

Communicate with TWELITE wireless modules

MWings

A library that communicate with TWELITE wireless modules.

Overview

Receive packets from and send commands to TWELITE child devices through the connected TWELITE parent device.

The App_Wings firmware must be written to the TWELITE parent device connected to the host.

Built for Python 3.12+.

Receive packets from

• App_Twelite
• App_IO
• App_ARIA
  • ARIA mode
• App_CUE
  • CUE mode
  • PAL Event (Move/Dice) mode
• App_PAL
  • AMBIENT
  • OPENCLOSE (CUE/ARIA OPENCLOSE mode)
  • MOTION
• App_Uart (Mode A)
  • Simple
  • Extended
• act

Send commands to

• App_Twelite (Signals)
• App_PAL (NOTICE)
  • Simple
  • Detailed
  • Event
• App_Uart (Mode A)
  • Simple

Installation

The package is available from PyPI.

Use pip

pip install mwings

Or poetry

poetry add mwings

Features

Written with modern python

Modules of the modern python, by the modern python, for the modern python.

• Fully typed; passes mypy --strict
• PEP8 compliance; formatted with black and passes ruff check
• Built with poetry and pyproject.toml
• numpy-style docstring, everywhere

Great data portability

Received data can be exported easily.

• to_dict() for dictionary
• to_json() for JSON string
• to_df() for Dataframe (requires pandas)
  • to_csv() for CSV file (with pandas)
  • to_excel() for Xlsx file (with pandas)

Data classes are derived from pydantic.BaseModel.

Examples

Receive App_Twelite packets

Using Twelite.receive()

Simplest way to receive some parsed packets.

Below script shows how to receive App_Twelite packets in blocking operations.

import mwings as mw


def main() -> None:
    # Create twelite object
    twelite = mw.Twelite(mw.utils.ask_user_for_port())

    # Attach handlers
    @twelite.on(mw.Twelite.Packet.APP_TWELITE)
    def on_app_twelite(packet: mw.parsers.app_twelite.ParsedPacket) -> None:
        print(packet.to_json())

    # Receive packets
    while True:
        print(twelite.receive())


if __name__ == "__main__":
    try:
        main()
    except KeyboardInterrupt:
        print("...Aborting")

Using Twelite.start()

Practical way to receive some parsed packets.

The Twelite class is a subclass of the threading.Thread.

Below script shows how to receive packets in another thread.

import mwings as mw


def main() -> None:
    # Create twelite object
    twelite = mw.Twelite(mw.utils.ask_user_for_port())

    # Attach handlers
    @twelite.on(mw.Twelite.Packet.APP_TWELITE)
    def on_app_twelite(packet: mw.parsers.app_twelite.ParsedPacket) -> None:
        print(packet.to_json())

    # Start receiving
    try:
        twelite.daemon = True
        twelite.start()
        print("Started receiving")
        while True:
            twelite.join(0.5)
    except KeyboardInterrupt:
        print("...Stopping")
        twelite.stop()
        print("Stopped")


if __name__ == "__main__":
    main()

Note that event handlers are not called from the main thread. When you have to use parsed data from the main thread, data should be passed by queue or something.

Send App_Twelite packets

To send packets, just create a command and send it.

Below script shows how to blink an LED on the DO1 port.

from time import sleep
from typing import Any

import mwings as mw


def main() -> None:
    # Create twelite objec
    twelite = mw.Twelite(mw.utils.ask_user_for_port())

    # Create command (initialize in pydantic style)
    initial: dict[str, Any] = {
        "destination_logical_id": 0x78,
        "di_to_change": [True, False, False, False],
        "di_state": [False, False, False, False],
    }
    command = mw.serializers.app_twelite.Command(**initial)

    # Blinking
    while True:
        command.di_state[0] = not command.di_state[0]
        twelite.send(command)
        print(f"Flip DO1: {command.di_state[0]}")
        sleep(1)


if __name__ == "__main__":
    try:
        main()
    except KeyboardInterrupt:
        print("...Aborting")

Note that command data classes (such as mw.serializers.app_twelite.Command) are derived from [pydantic.BaseModel](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.

See more advanced examples at mwings_python/examples at main.

LICENSE

MW-OSSLA