Skip to main content

A library for controlling Navien NWP500 Water Heaters via NaviLink

Project description

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

Python library for Navien NWP500 Heat Pump Water Heater

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

Features

  • Complete Interface: Full support for both 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.

  • Advanced Features: Native support for reservations, time-of-use (TOU) optimization, and anti-legionella cycles.

  • Type-Safe: Built with Pydantic for robust data validation and unit handling.

  • Async/Await: Modern asyncio-based implementation for high-performance integration.

Getting Started

pip install nwp500-python

Quick Example

from nwp500 import NavienAuthClient, NavienAPIClient

async with NavienAuthClient("email@example.com", "password") as auth:
    api = NavienAPIClient(auth)
    devices = await api.list_devices()

    if devices:
        device = devices[0]
        print(f"Temperature: {device.status.dhw_temperature}°F")
        await api.set_device_temperature(device, 130)

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: Understanding-oriented deep dives into the library’s design and advanced features.

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.

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

nwp500_python-8.1.3.tar.gz (430.3 kB view details)

Uploaded Source

Built Distribution

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

nwp500_python-8.1.3-py3-none-any.whl (152.5 kB view details)

Uploaded Python 3

File details

Details for the file nwp500_python-8.1.3.tar.gz.

File metadata

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

File hashes

Hashes for nwp500_python-8.1.3.tar.gz
Algorithm Hash digest
SHA256 3850133e59ed7a81e3058231bba618ca6a41ebed4c21fb0a7703186fb564c179
MD5 d23a0cccac0a575d3a05d7227b4e8e5e
BLAKE2b-256 fb50e0ca0e8300de83bc23181aed105cf6648008ac6b01a973ab7c77b2424f53

See more details on using hashes here.

Provenance

The following attestation bundles were made for nwp500_python-8.1.3.tar.gz:

Publisher: release.yml on eman/nwp500-python

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

File details

Details for the file nwp500_python-8.1.3-py3-none-any.whl.

File metadata

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

File hashes

Hashes for nwp500_python-8.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 31f0a14dae9d2d6752de35ee206e73f553e510fe3f652727485e475ec34aa7ee
MD5 1e403a96de4a15d82d42e58981add05d
BLAKE2b-256 2b836d2ec4ceebe1d4c826991e7670caee4d199ee56e21ad3c4b02a20f938368

See more details on using hashes here.

Provenance

The following attestation bundles were made for nwp500_python-8.1.3-py3-none-any.whl:

Publisher: release.yml on eman/nwp500-python

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