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.26.tar.gz (24.2 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.26-py3-none-any.whl (32.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: uns_kit-0.0.26.tar.gz
  • Upload date:
  • Size: 24.2 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.26.tar.gz
Algorithm Hash digest
SHA256 a6fdef18a402035a34af6e5baefd23e6c33fcbbc17ee89a94d169e6530f04288
MD5 b9abb9765b7fb241f4a909a43e00c84d
BLAKE2b-256 cc210533ed17326608ede12bb1fb6f6fa6b7d161622501f538645a9ab357392d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uns_kit-0.0.26-py3-none-any.whl
  • Upload date:
  • Size: 32.0 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.26-py3-none-any.whl
Algorithm Hash digest
SHA256 29740ea99691ca9d4db2cc47b7617b39b155e4876b08c73e8975ce8c6a1baa45
MD5 4d658bbac807250f465383cf7cb134c9
BLAKE2b-256 a3a49ac073c46dec08529fd3ac4cece41000910bce1f555f8e2fe0f728eb37a5

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