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

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.13.0
File Size Uploaded Provenance Actions
nwp500_python-9.13.0.tar.gz 1.5 MB With provenance Details for nwp500_python-9.13.0.tar.gz

Built distribution (wheel)

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

Total release size: 2.1 MB

Release files / nwp500_python-9.13.0.tar.gz

Download URL nwp500_python-9.13.0.tar.gz
Size 1.5 MB
Tags Source
SHA-256 checksum
How to use checksums
6a71a5804563d5281576f08f617ba98b892b00cd33dfd7fa8a36ba0069973195
BLAKE2b-256 checksum
How to use checksums
4cb89f2179aee98e50d729be0953a550b94d2c7a5e587adfc2a64139267d3146
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 Nov 7, 2026.

Transparency log

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

Download URL nwp500_python-9.13.0-py3-none-any.whl
Size 605.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
714d9eef62e42e6aa80dac9fbcb00706b2c0845348b2b36845d35b6d97388116
BLAKE2b-256 checksum
How to use checksums
b856e2adc2ddbf83b207389c99d4cac71b48f00b2f2055376a7dd02a8879fd39
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 Nov 7, 2026.

Transparency log

Security for nwp500-python 9.13.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

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

Select from 2 files

Attestation for nwp500_python-9.13.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 Nov 7, 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.13.0 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