Skip to main content

Lightweight Python UNS MQTT client (pub/sub + infra topics)

Project description

uns-kit (Python)

Lightweight UNS MQTT client for Python. Provides:

  • Topic builder compatible with UNS infra topics (uns-infra/<package>/<version>/<process>/).
  • Async publish/subscribe via MQTT (using aiomqtt).
  • Process + instance status topics (active/heap/uptime/alive + stats).
  • Minimal UNS packet builder/parser (data/table) aligned with TS core.

Install (editable)

cd packages/uns-py
poetry install

CLI

After poetry install, an uns-kit-py command is available (renamed to avoid clashing with the Node CLI):

poetry run uns-kit-py publish --host localhost:1883 --topic raw/data/ --value 1
poetry run uns-kit-py subscribe --host localhost:1883 --topic 'uns-infra/#'

Quick start

import asyncio
from pathlib import Path
from uns_kit import UnsConfig, UnsPacket, UnsProxyProcess

async def main():
    config = UnsConfig.load(Path("config.json"))
    process = UnsProxyProcess(config.infra_host, config=config)
    await process.start()
    mqtt = await process.create_mqtt_proxy("py")

    # Subscribe
    async with mqtt.client.messages("uns-infra/#") as messages:
        await mqtt.publish_packet("raw/data/", UnsPacket.data(value=1, uom="count"))
        msg = await messages.__anext__()
        print(msg.topic, msg.payload.decode())

    await mqtt.close()
    await process.stop()

asyncio.run(main())

Resilient subscriber

async for msg in client.resilient_messages("uns-infra/#"):
    print(msg.topic, msg.payload.decode())

Examples

  • examples/publish.py — publish 5 data packets.
  • examples/subscribe.py — resilient subscription with auto-reconnect.
  • examples/load_test.py — interactive publish burst.

Create a new project

uns-kit-py create my-uns-py-app
cd my-uns-py-app
poetry install
poetry run python src/main.py

Create a sandbox app in this repo

From the monorepo root:

pnpm run py:sandbox

This creates sandbox-app-py/ using the default Python template.

Notes

  • Default QoS is 0.
  • Instance status topics are published every 10 seconds; stats every 60 seconds.
  • Packet shape mirrors the TypeScript core: {"version":"1.3.0","message":{"data":{...}},"sequenceId":0}.
  • Windows: the library sets WindowsSelectorEventLoopPolicy() to avoid add_reader/add_writer NotImplementedError.

TODO (parity with TS core)

  • Handover manager (cross-version active detection + handover_* messages).
  • Publish throttling/queue.
  • Status parity (publisher/subscriber active flags everywhere, richer metrics).
  • API endpoints registry (to mirror @uns-kit/api produced endpoints).
  • Optional: dictionary/measurement helpers + CLI wrapper.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uns_kit-0.0.27.tar.gz (24.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uns_kit-0.0.27-py3-none-any.whl (32.2 kB view details)

Uploaded Python 3

File details

Details for the file uns_kit-0.0.27.tar.gz.

File metadata

  • Download URL: uns_kit-0.0.27.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.1 CPython/3.14.2 Darwin/25.3.0

File hashes

Hashes for uns_kit-0.0.27.tar.gz
Algorithm Hash digest
SHA256 4b19a7691cad0c0275a324daa4a4a38154d925a456573a6b28087b2f3a6939a6
MD5 41695b5bf05e3241852230f0dc39a029
BLAKE2b-256 4d986a320620b943efd5283b5fffd3b0ea59138d61d76ccf1e4d5c87e9efafb2

See more details on using hashes here.

File details

Details for the file uns_kit-0.0.27-py3-none-any.whl.

File metadata

  • Download URL: uns_kit-0.0.27-py3-none-any.whl
  • Upload date:
  • Size: 32.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.1 CPython/3.14.2 Darwin/25.3.0

File hashes

Hashes for uns_kit-0.0.27-py3-none-any.whl
Algorithm Hash digest
SHA256 f2a2f3228d0c29538a1d5050cc3955b52320079e2a0a1498ea0b0a05f3297f41
MD5 0b62a7da11f1c35bfbd73f27c5d9a774
BLAKE2b-256 2270940a0989c3b7616c5386932db1ee2b1d6955339973586bcfa55d1c21f319

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page