nwp500-python 1.0.0

Add a short description here!

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. This library provides comprehensive access to device status, temperature control, operation mode management, and real-time monitoring capabilities.

Features

• Device Monitoring: Access real-time status information including temperatures, power consumption, and tank charge level

• Temperature Control: Set target water temperature (100-140°F)

• Operation Mode Control: Switch between Heat Pump, Energy Saver, High Demand, Electric, and Vacation modes

• Comprehensive Status Data: Access to 70+ device status fields including compressor status, heater status, flow rates, and more

• MQTT Protocol Support: Low-level MQTT communication with Navien devices

• Automatic Reconnection: Reconnects automatically with exponential backoff during network interruptions

• Command Queuing: Commands sent while disconnected are queued and sent automatically when reconnected

• Data Models: Type-safe data classes with automatic unit conversions

Quick Start

Installation

pip install nwp500-python

Basic Usage

from nwp500 import NavienAuthClient, NavienAPIClient

# Authentication happens automatically when entering the context
async with NavienAuthClient("[e-mail]", "your_password") as auth_client:
    # Create API client
    api_client = NavienAPIClient(auth_client=auth_client)

    # Get device data
    devices = await api_client.list_devices()
    device = devices[0] if devices else None

    if device:
        # Access status information
        status = device.status
        print(f"Water Temperature: {status.dhwTemperature}°F")
        print(f"Tank Charge: {status.dhwChargePer}%")
        print(f"Power Consumption: {status.currentInstPower}W")

        # Set temperature
        await api_client.set_device_temperature(device, 130)

        # Change operation mode
        await api_client.set_device_mode(device, "heat_pump")

Device Status Fields

The library provides access to comprehensive device status information:

Temperature Sensors

• Water temperature (current and target)

• Tank upper/lower temperatures

• Ambient temperature

• Discharge, suction, and evaporator temperatures

• Inlet temperature

System Status

• Operation mode (Heat Pump, Energy Saver, High Demand, Electric, Vacation)

• Compressor status

• Heat pump and electric heater status

• Evaporator fan status

• Tank charge percentage

Power & Energy

• Current power consumption (Watts)

• Total energy capacity (Wh)

• Available energy capacity (Wh)

Diagnostics

• WiFi signal strength

• Error codes

• Fault status

• Cumulative operation time

• Flow rates

Operation Modes

Operation Modes

Mode	ID	Description
Heat Pump Mode	1	Most energy-efficient mode using only the heat pump. Longest recovery time.
Energy Saver Mode	2	Default mode. Balances efficiency and recovery time using both heat pump and electric heater.
High Demand Mode	3	Uses electric heater more frequently for faster recovery time.
Electric Mode	4	Fastest recovery using only electric heaters. Least energy-efficient.
Vacation Mode	5	Suspends heating to save energy during extended absences.

MQTT Protocol

The library supports low-level MQTT communication with Navien devices:

Control Topics

• cmd/{deviceType}/{deviceId}/ctrl - Send control commands

• cmd/{deviceType}/{deviceId}/st - Request status updates

Control Commands

• Power control (on/off)

• DHW mode changes

• Temperature settings

• Reservation management

Status Requests

• Device information

• General device status

• Energy usage queries

• Reservation information

See the full MQTT Protocol Documentation for detailed message formats.

Documentation

Comprehensive documentation is available in the docs/ directory:

• Device Status Fields - Complete field reference with units and conversions

• MQTT Messages - MQTT protocol documentation

• MQTT Client - MQTT client usage guide

• Authentication - Authentication module documentation

Data Models

The library includes type-safe data models with automatic unit conversions:

• DeviceStatus: Complete device status with 70+ fields

• OperationMode: Enumeration of available operation modes

• TemperatureUnit: Celsius/Fahrenheit handling

• MqttRequest/MqttCommand: MQTT message structures

Temperature conversions are handled automatically:

• DHW temperatures: raw_value + 20 (°F)

• Heat pump temperatures: raw_value / 10.0 (°F)

• Ambient temperature: (raw_value * 9/5) + 32 (°F)

Requirements

• Python 3.9+

• aiohttp >= 3.8.0

• websockets >= 10.0

• cryptography >= 3.4.0

• pydantic >= 2.0.0

• awsiotsdk >= 1.21.0

Development

To set up a development environment, clone the repository and install the required dependencies:

# Clone the repository
git clone https://github.com/eman/nwp500-python.git
cd nwp500-python

# Install in development mode
pip install -e .

# Run tests
pytest

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.

Author

Emmanuel Levijarvi <[e-mail]>

Acknowledgments

This project has been set up using PyScaffold 4.6. For details and usage information on PyScaffold see https://pyscaffold.org/.