Skip to main content

nwp500-python

PyPI-v Python-versions CI-status Docs-status Code-style License

Python library for Navien NWP500 Heat Pump Water Heater

A Python library for monitoring and controlling the Navien NWP500 Heat Pump Water Heater through the Navilink cloud service.

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.

  • Simulator (optional): nwp500.sim, a physics model of the heater. It estimates recovery time and available hot water, projects the effect of a change to the schedule or settings, and calibrates against a heater’s own history. nwp-cli simulate runs it against the live heater or a scenario file. Install with pip install nwp500-python[sim].

Getting Started

pip install nwp500-python

Quick 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.

Metadata

Release files for nwp500-python 9.12.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 nwp500-python 9.12.2
File Size Uploaded Provenance Actions
nwp500_python-9.12.2.tar.gz 1.3 MB With provenance Details for nwp500_python-9.12.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nwp500-python 9.12.2
File Interpreter ABI Platform Actions
nwp500_python-9.12.2-py3-none-any.whl Python 3 none any Details for nwp500_python-9.12.2-py3-none-any.whl

Total release size: 1.9 MB

Release files / nwp500_python-9.12.2.tar.gz

Download URL nwp500_python-9.12.2.tar.gz
Size 1.3 MB
Tags Source
SHA-256 checksum
How to use checksums
891f46ac78c00d4970b24bc9e0d5107617d76edbe725b01e48028ae9e038d71a
BLAKE2b-256 checksum
How to use checksums
b9a68cab16284b3e7c0a22d0eb9661bce1453f2a0e27bf7a0610904e6a28748d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 25, 2026.

Transparency log

Release files / nwp500_python-9.12.2-py3-none-any.whl

Download URL nwp500_python-9.12.2-py3-none-any.whl
Size 592.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1cf31d9f3ebeb74cca055ca1742c016f2b4e2f90c3a555b59df47b060d1a5cc5
BLAKE2b-256 checksum
How to use checksums
0a8ddfd4894d9094d5759610b9c00774108c61a27883172ff553f21d946361cf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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 25, 2026.

Transparency log

Security for nwp500-python 9.12.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 nwp500_python-9.12.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 Oct 25, 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.

Release history Release notifications | RSS feed

This release

9.12.2 This release

2 release files Full provenance

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