Skip to main content

Pure-Python OPC UA servers from quasar Design files — the quasarnova family's no-codegen engine

Project description

kilonova

CI

What is this?

kilonova serves a quasar Design.xml + config.xml as a live OPC UA server in pure Python — no code generation, no C++. It produces the same address space as a quasar-generated server (same ns=2 string NodeIds, same dotted parent.child addressing), so quasar ecosystem tools — Cacophony/WinCC OA, UaoForQuasar clients, plain OPC UA clients — work against it unmodified.

A kilonova is the luminous flash of a neutron-star merger — a lighter, faster transient in the nova family. This kilonova is the pure-Python engine of the quasarnova family: successor of MilkyWay (Piotr Nikiel's 2021 prototype, and briefly named microquasar), rebuilt from scratch on asyncua 2.x.

Basic usage mode

  1. Install (Python ≥ 3.10): pip install . (from this repository, for now)
  2. Run your existing quasar server's design, unchanged: kilonova run --design Design/Design.xml --config bin/config.xml
  3. Point any OPC UA client at opc.tcp://host:4841 — the address space is quasar's.
  4. Dump a running server's address space (uasak_dump-style NodeSet2): kilonova dump --endpoint opc.tcp://127.0.0.1:4841 --output dump.xml

Device logic is plain Python (see doc/DeviceLogic.md):

from kilonova import Server

server = Server("Design.xml", config_path="config.xml")

@server.read("sca1.adc")                 # source variable: runs inside the client read
async def read_adc(obj):
    return await hardware.read_adc()

@server.method("sca1.reset")             # method handler
async def reset(obj):
    await obj.setOnline(0)               # generated setter, quasar naming

async with server:
    ...

What works

All 12 cases of quasar's own CI test suite pass against the reference nodesets (cache/source/calculated variables, methods incl. arguments, config entries and restrictions, singleVariableNode, design/config instantiation, StandardMetaData). Production designs (ATLAS ATCA, CAEN, CanOpen) were probed at structural parity against live C++ servers of both backends. Details: doc/Parity.md.

Limitations

  • Device logic is registered per address at runtime — there is no generated D<Class> skeleton (that is the point).
  • Design-mandated children are instantiated unconditionally; C++ device logic may create some conditionally.
  • No server-side security policies yet (NoSecurity endpoint only).
  • Values live in asyncua's address space; extreme write rates were not a design goal.

Documentation

Credits

  • Paris Moschovakos (paris@moschovakos.com) — kilonova
  • Piotr Nikiel — quasar concept and architecture; MilkyWay, the predecessor

License: BSD-2-Clause.

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

kilonova-0.1.0.tar.gz (44.0 kB view details)

Uploaded Source

Built Distribution

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

kilonova-0.1.0-py3-none-any.whl (32.0 kB view details)

Uploaded Python 3

File details

Details for the file kilonova-0.1.0.tar.gz.

File metadata

  • Download URL: kilonova-0.1.0.tar.gz
  • Upload date:
  • Size: 44.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kilonova-0.1.0.tar.gz
Algorithm Hash digest
SHA256 1af831b805ea8c08cb83f62938d6ba90dee7793808b453de85a5a0f34e487393
MD5 4a7a8864c03ee4ed9227b8fa8eb53770
BLAKE2b-256 24048080cb3907ea16984152e99060bc9b44d64ef21cedab21b902cccf95244d

See more details on using hashes here.

Provenance

The following attestation bundles were made for kilonova-0.1.0.tar.gz:

Publisher: release.yml on quasarnova-team/kilonova

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kilonova-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: kilonova-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 32.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kilonova-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae69748b57182438d445917b19929202bd84a36bc4dbd78af29a9bf938103fe3
MD5 2a04a35a08c402854e8d6f425dbd7eb3
BLAKE2b-256 23503be56268f45a16122565ab05c03b40e8d6089b2f6ad3467ec2d96608e890

See more details on using hashes here.

Provenance

The following attestation bundles were made for kilonova-0.1.0-py3-none-any.whl:

Publisher: release.yml on quasarnova-team/kilonova

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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