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.28.tar.gz (24.5 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.28-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: uns_kit-0.0.28.tar.gz
  • Upload date:
  • Size: 24.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.11.5 Windows/10

File hashes

Hashes for uns_kit-0.0.28.tar.gz
Algorithm Hash digest
SHA256 863e6907178d8b9fc2518200410d16325a9c1192021ba7e7ea745174751b8ea0
MD5 821a8d0764da91176a0e664198930eb3
BLAKE2b-256 97a50cecf117bc57f478b36f6aa7c6519658b964a52a1f1b8c492e8c15faa0ab

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uns_kit-0.0.28-py3-none-any.whl
  • Upload date:
  • Size: 32.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.11.5 Windows/10

File hashes

Hashes for uns_kit-0.0.28-py3-none-any.whl
Algorithm Hash digest
SHA256 c12dcba55bfdf7f19d3ffdd24da194c70a82cf993bc3e8e011970259d818d15f
MD5 d0f6d908b8a42dd1bb776a7b2648fba0
BLAKE2b-256 613c8ab8eaf2d3d21c41e4593648cd054aa9e976097243059f1dc4e4d72eef9d

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