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-9.2.0.tar.gz (465.9 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-9.2.0-py3-none-any.whl (163.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nwp500_python-9.2.0.tar.gz
Algorithm Hash digest
SHA256 6290728750947d43e90fb0cb634ed600a3657752a06040015ae10f807e3dcc73
MD5 54a5a9d69ada087cff3718b0fa364b93
BLAKE2b-256 e1654bf3e9abf1b8489dbbafedc3472c52aa5f1941e36c36ec135e63d61ee562

See more details on using hashes here.

Provenance

The following attestation bundles were made for nwp500_python-9.2.0.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-9.2.0-py3-none-any.whl.

File metadata

  • Download URL: nwp500_python-9.2.0-py3-none-any.whl
  • Upload date:
  • Size: 163.8 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-9.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5ac21115027bb72b53f1520fc37d9008819c016523bb03337a8df33870876f03
MD5 7f19bdc76837da285fae1fbcc269a62c
BLAKE2b-256 0574f46b2c91f465509cba28e7d9052dc697e29ed077fb8289f031a16a6553a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for nwp500_python-9.2.0-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