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.0.0.tar.gz (457.2 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.0.0-py3-none-any.whl (158.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nwp500_python-9.0.0.tar.gz
  • Upload date:
  • Size: 457.2 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.0.0.tar.gz
Algorithm Hash digest
SHA256 2b1dad4594c5f50eb96cf9cfcac02998f6774c6a32f161675862e52b83f5355c
MD5 2f0e80a1a44d440bcfe496cbeb775be1
BLAKE2b-256 8a453749d251c8b174eda4f2d35a1aca330b30802cd695a129fe0a9f1f00fe01

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: nwp500_python-9.0.0-py3-none-any.whl
  • Upload date:
  • Size: 158.2 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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ada359b31f307309f746236d2ea412261b970e400910a02da83b41389b40a868
MD5 dc137c68f9d8ccb139d69daae07dc7d5
BLAKE2b-256 87fb8fc079bd56cb3cabf926f42cf7969c6d1e89f30f4812f680b5dee7db8917

See more details on using hashes here.

Provenance

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