Skip to main content

Superwatt Python Client

Python client and CLI for SuperWatt / Voltronic-compatible inverters over serial.

Install

uv sync

Set the serial port with --port or SUPERWATT_PORT.

Examples:

$env:SUPERWATT_PORT = "COM3"
uv run superwatt query protocol-id
uv run superwatt --port COM3 query protocol-id
export SUPERWATT_PORT=/dev/ttyUSB0
uv run superwatt query protocol-id
uv run superwatt --port /dev/ttyUSB0 query protocol-id

CLI

Read a typed query:

uv run superwatt query protocol-id
uv run superwatt query general-status
uv run superwatt query device-flags

Send a raw protocol query:

uv run superwatt rawquery QPI
uv run superwatt rawquery QPIGS
uv run superwatt rawquery QFOO --allow-unknown

Build a parameter command without sending it:

uv run superwatt parameter disable buzzer
uv run superwatt parameter disable lcd-backlight

Execute a parameter command:

uv run superwatt parameter disable buzzer --execute
uv run superwatt parameter enable lcd-backlight --execute

Supported parameters:

buzzer
bypass-to-utility-on-overload
fault-code-recording
lcd-backlight
lcd-timeout-escape-to-default-page
over-temperature-restart
overload-restart
power-saving
primary-source-interrupt-alarm

Python

from superwatt import SuperWattClient

client = SuperWattClient(port="/dev/ttyUSB0")

protocol = client.get_protocol_id()
status = client.get_general_status()
flags = client.get_device_flags()

dry_run = client.build_set_parameter_command("buzzer", False)
result = client.set_parameter_value("buzzer", False)

Errors

NegativeAcknowledgementError is raised when the inverter returns NAK.

UnknownQuery is raised when an unknown query sent with allow_unknown=True returns NAK.

Metadata

Release files for superwatt 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for superwatt 0.1.2
File Size Uploaded Provenance Actions
superwatt-0.1.2.tar.gz 23.5 kB With provenance Details for superwatt-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for superwatt 0.1.2
File Interpreter ABI Platform Actions
superwatt-0.1.2-py3-none-any.whl Python 3 none any Details for superwatt-0.1.2-py3-none-any.whl

Total release size: 38.1 kB

Release files / superwatt-0.1.2.tar.gz

Download URL superwatt-0.1.2.tar.gz
Size 23.5 kB
Tags Source
SHA-256 checksum
How to use checksums
feeb59336be6ec3cbd85a5be602f943734459f375c89c74009c07a4cacab4848
BLAKE2b-256 checksum
How to use checksums
651659e4d86dcdbef2b45c99c662788a33217877f27e9f98cdfe361cea80739a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 5, 2026.

Transparency log

Release files / superwatt-0.1.2-py3-none-any.whl

Download URL superwatt-0.1.2-py3-none-any.whl
Size 14.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4b44b3f63b8590f44ef83df9b6150b71d6d538403db3a1d3c9a1f9670d4a4364
BLAKE2b-256 checksum
How to use checksums
8007e0e66e5465d79fdee0f560000ab83123726e97dd20c1db358b861aa4f48c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 5, 2026.

Transparency log

Security for superwatt 0.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for superwatt-0.1.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 5, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page