nwp500-python
Features
REST and MQTT: The REST API and real-time MQTT (AWS IoT).
Monitoring: Real-time tracking of temperature, power usage, tank charge, and component status.
Control: Remote control of target temperatures, operation modes, and vacation settings.
Scheduling: Reservations, time-of-use (TOU) schedules and anti-legionella cycles.
Typed models: Pydantic models with validation and unit handling.
Async: Built on asyncio.
Simulator (optional): A physics model of the heater, nwp500.sim, that answers “when will the tank be hot?”, “how much hot water is there?” and “what would this change do?”, and calibrates from a heater’s own history. nwp-cli simulate runs it on the heater as it is now or on a scenario file. Install it with pip install nwp500-python[sim].
Getting Started
pip install nwp500-pythonQuick Example
import asyncio
from nwp500 import NavienAPIClient, NavienAuthClient, NavienMqttClient
async def main():
async with NavienAuthClient("email@example.com", "password") as auth:
api = NavienAPIClient(auth)
device = await api.get_first_device()
# Status and control go over MQTT.
mqtt = NavienMqttClient(auth)
await mqtt.connect()
try:
got = asyncio.Event()
def on_status(status):
print(f"Tank: {status.dhw_temperature}°F, "
f"setpoint {status.dhw_target_temperature_setting}°F")
got.set()
await mqtt.subscribe_device_status(device, on_status)
await mqtt.request_device_status(device)
await asyncio.wait_for(got.wait(), timeout=20)
await mqtt.set_dhw_temperature(device, 130)
finally:
await mqtt.disconnect()
asyncio.run(main())Documentation
Tutorials: Start here if you’re new to the library.
How-to Guides: Practical step-by-step recipes for specific tasks.
Reference: Technical descriptions of the API, models, and protocol.
Explanation: How the library and the device work.
Contributing
We welcome contributions! Please see our Contributing Guide for more details.
License
This project is licensed under the MIT License. See the LICENSE.txt file for details.
1 maintainer
Metadata
1 maintainer
Release files for nwp500-python 9.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| nwp500_python-9.5.0.tar.gz | 1.2 MB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| nwp500_python-9.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.7 MB
Release files / nwp500_python-9.5.0.tar.gz
| Download URL | nwp500_python-9.5.0.tar.gz |
|---|---|
| Size | 1.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
be67312f06b82101fd483d9b1b394556b4bee66e517ea5646530c157a828b54a
|
|
BLAKE2b-256 checksum How to use checksums |
dea56369bcc57130af8059ad0086a4c92212bbeeb15b8a541852f87f4350e94e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Oct 20, 2026.
Transparency logRelease files / nwp500_python-9.5.0-py3-none-any.whl
| Download URL | nwp500_python-9.5.0-py3-none-any.whl |
|---|---|
| Size | 550.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cf671f6c5271c97eea90ba4db4150ba67885de97267d86efadd0d8d466167219
|
|
BLAKE2b-256 checksum How to use checksums |
6fccad56e73d848a980ccf5a64e0612ca222ed9a26f73d1762b016d03087243c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Oct 20, 2026.
Transparency logSecurity for nwp500-python 9.5.0
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
All 2 files in this release have been uploaded with provenance metadata.
Attestation for nwp500_python-9.5.0.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 Oct 20, 2026.
Transparency logA 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.
