nwp500-python 1.1.2__tar.gz → 1.1.3__tar.gz

{nwp500_python-1.1.2/src/nwp500_python.egg-info → nwp500_python-1.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nwp500-python
-Version: 1.1.2
+Version: 1.1.3
 Summary: Add a short description here!
 Home-page: https://github.com/pyscaffold/pyscaffold/
 Author: Emmanuel Levijarvi

{nwp500_python-1.1.2 → nwp500_python-1.1.3}/docs/DEVICE_STATUS_FIELDS.rst

@@ -29,10 +29,10 @@ This document lists the fields found in the ``status`` object of device status m
      - Status of special functions (e.g., freeze protection, anti-seize operations).
      - None
    * - ``didReload``
-     - integer
+     - bool
      - None
      - Indicates if the device has recently reloaded or restarted.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``errorCode``
      - integer
      - None
@@ -49,25 +49,25 @@ This document lists the fields found in the ``status`` object of device status m
      - The current **actual operational state** of the device (what it's doing RIGHT NOW). Reports status values: 0=Standby, 32=Heat Pump active, 64=Energy Saver active, 96=High Demand active. See Operation Modes section below for the critical distinction between this and ``dhwOperationSetting``.
      - None
    * - ``operationBusy``
-     - integer
-     - None
-     - Indicates if the device is currently performing heating operations (1=busy, 0=idle).
+     - bool
      - None
+     - Indicates if the device is currently performing heating operations (True=busy, False=idle).
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``freezeProtectionUse``
-     - integer
+     - bool
      - None
      - Whether freeze protection is active. When tank water temperature falls below 43°F (6°C), the electric heater activates to prevent freezing.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``dhwUse``
-     - integer
+     - bool
      - None
      - Domestic Hot Water (DHW) usage status - indicates if hot water is currently being drawn from the tank.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``dhwUseSustained``
-     - integer
+     - bool
      - None
      - Sustained DHW usage status - indicates prolonged hot water usage.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``dhwTemperature``
      - integer
      - °F
@@ -79,10 +79,10 @@ This document lists the fields found in the ``status`` object of device status m
      - Target DHW temperature setting. Range: 95°F (35°C) to 150°F (65.5°C). Default: 120°F (49°C).
      - ``raw + 20``
    * - ``programReservationUse``
-     - integer
+     - bool
      - None
      - Whether a program reservation (scheduled operation) is in use.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``smartDiagnostic``
      - integer
      - None
@@ -104,10 +104,10 @@ This document lists the fields found in the ``status`` object of device status m
      - WiFi signal strength in dBm (decibel-milliwatts). Typical values: -30 (excellent) to -90 (poor).
      - None
    * - ``ecoUse``
-     - integer
+     - bool
      - None
      - Whether ECO (Energy Cut Off) safety feature has been triggered. The ECO switch is a high-temperature safety limit.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``dhwTargetTemperatureSetting``
      - integer
      - °F
@@ -127,62 +127,62 @@ This document lists the fields found in the ``status`` object of device status m
      - integer
      - °F
      - Compressor discharge temperature - temperature of refrigerant leaving the compressor.
-     - ``raw / 10.0``
+     - ``(raw / 10) * 9/5 + 32`` (decicelsius to Fahrenheit)
    * - ``suctionTemperature``
      - integer
      - °F
      - Compressor suction temperature - temperature of refrigerant entering the compressor.
-     - ``raw / 10.0``
+     - ``(raw / 10) * 9/5 + 32`` (decicelsius to Fahrenheit)
    * - ``evaporatorTemperature``
      - integer
      - °F
      - Evaporator temperature - temperature where heat is absorbed from ambient air.
-     - ``raw / 10.0``
+     - ``(raw / 10) * 9/5 + 32`` (decicelsius to Fahrenheit)
    * - ``ambientTemperature``
      - integer
      - °F
      - Ambient air temperature measured at the heat pump air intake.
-     - ``(raw / 22.4) * 9/5 + 32``
+     - ``(raw / 10) * 9/5 + 32`` (decicelsius to Fahrenheit)
    * - ``targetSuperHeat``
      - integer
      - °F
      - Target superheat value - the desired temperature difference ensuring complete refrigerant vaporization.
      - ``raw / 10.0``
    * - ``compUse``
-     - integer
-     - None
-     - Compressor usage status (1=On, 0=Off). The compressor is the main component of the heat pump.
+     - bool
      - None
+     - Compressor usage status (True=On, False=Off). The compressor is the main component of the heat pump.
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``eevUse``
-     - integer
-     - None
-     - Electronic Expansion Valve (EEV) usage status (1=active, 0=inactive). The EEV controls refrigerant flow.
+     - bool
      - None
+     - Electronic Expansion Valve (EEV) usage status (True=active, False=inactive). The EEV controls refrigerant flow.
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``evaFanUse``
-     - integer
-     - None
-     - Evaporator fan usage status (1=On, 0=Off). The fan pulls ambient air through the evaporator coil.
+     - bool
      - None
+     - Evaporator fan usage status (True=On, False=Off). The fan pulls ambient air through the evaporator coil.
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``currentInstPower``
      - integer
      - W
      - Current instantaneous power consumption in Watts. Does not include heating element power when active.
      - None
    * - ``shutOffValveUse``
-     - integer
+     - bool
      - None
      - Shut-off valve usage status. The valve controls refrigerant flow in the system.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``conOvrSensorUse``
-     - integer
+     - bool
      - None
      - Condensate overflow sensor usage status.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``wtrOvrSensorUse``
-     - integer
+     - bool
      - None
      - Water overflow/leak sensor usage status. Triggers error E799 if leak detected.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``dhwChargePer``
      - integer
      - %
@@ -209,20 +209,20 @@ This document lists the fields found in the ``status`` object of device status m
      - Freeze protection temperature setting.
      - ``raw + 20``
    * - ``antiLegionellaUse``
-     - integer
+     - bool
      - None
      - Whether anti-legionella function is enabled.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``antiLegionellaPeriod``
      - integer
      - days
      - Anti-legionella function period.
      - None
    * - ``antiLegionellaOperationBusy``
-     - integer
+     - bool
      - None
      - Whether the anti-legionella function is busy.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``programReservationType``
      - integer
      - None
@@ -244,15 +244,15 @@ This document lists the fields found in the ``status`` object of device status m
      - Temperature formula type.
      - None
    * - ``errorBuzzerUse``
-     - integer
+     - bool
      - None
      - Whether the error buzzer is enabled.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``currentHeatUse``
-     - integer
+     - bool
      - None
      - Current heat usage.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``currentInletTemperature``
      - float
      - °F
@@ -302,27 +302,27 @@ This document lists the fields found in the ``status`` object of device status m
      - integer
      - °F
      - Current superheat value - actual temperature difference between suction and evaporator temperatures.
-     - ``raw / 10.0``
+     - ``(raw / 10) * 9/5 + 32`` (decicelsius to Fahrenheit)
    * - ``heatUpperUse``
-     - integer
-     - None
-     - Upper electric heating element usage status (1=On, 0=Off). Power: 3,755W @ 208V or 5,000W @ 240V.
+     - bool
      - None
+     - Upper electric heating element usage status (True=On, False=Off). Power: 3,755W @ 208V or 5,000W @ 240V.
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``heatLowerUse``
-     - integer
-     - None
-     - Lower electric heating element usage status (1=On, 0=Off). Power: 3,755W @ 208V or 5,000W @ 240V.
+     - bool
      - None
+     - Lower electric heating element usage status (True=On, False=Off). Power: 3,755W @ 208V or 5,000W @ 240V.
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``scaldUse``
-     - integer
+     - bool
      - None
      - Scald protection active status. Displays warning when water temperature reaches levels that could cause scalding.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``airFilterAlarmUse``
-     - integer
+     - bool
      - None
      - Air filter alarm usage - indicates if air filter maintenance reminder is enabled.
-     - None
+     - Converted from integer (1=OFF, 2=ON) to bool
    * - ``airFilterAlarmPeriod``
      - integer
      - hours

{nwp500_python-1.1.2 → nwp500_python-1.1.3}/src/nwp500/cli.py

@@ -205,6 +205,37 @@ async def handle_status_request(mqtt: NavienMqttClient, device: Device):
         _logger.error("Timed out waiting for device status response.")
 
 
+async def handle_status_raw_request(mqtt: NavienMqttClient, device: Device):
+    """Request device status once and print raw MQTT data (no conversions)."""
+    future = asyncio.get_running_loop().create_future()
+
+    # Subscribe to the raw MQTT topic to capture data before conversion
+    def raw_callback(topic: str, message: dict):
+        if not future.done():
+            # Extract and print the raw status portion
+            if "response" in message and "status" in message["response"]:
+                print(
+                    json.dumps(
+                        message["response"]["status"], indent=2, default=_json_default_serializer
+                    )
+                )
+                future.set_result(None)
+            elif "status" in message:
+                print(json.dumps(message["status"], indent=2, default=_json_default_serializer))
+                future.set_result(None)
+
+    # Subscribe to all device messages
+    await mqtt.subscribe_device(device, raw_callback)
+
+    _logger.info("Requesting device status (raw)...")
+    await mqtt.request_device_status(device)
+
+    try:
+        await asyncio.wait_for(future, timeout=10)
+    except asyncio.TimeoutError:
+        _logger.error("Timed out waiting for device status response.")
+
+
 async def handle_device_info_request(mqtt: NavienMqttClient, device: Device):
     """
     Request comprehensive device information via MQTT and print it.
@@ -504,6 +535,9 @@ async def async_main(args: argparse.Namespace):
                 _logger.info("Getting updated status after temperature change...")
                 await asyncio.sleep(2)  # Brief pause for device to process
                 await handle_status_request(mqtt, device)
+        elif args.status_raw:
+            # Raw status request (no conversions)
+            await handle_status_raw_request(mqtt, device)
         elif args.status:
             # Status-only request
             await handle_status_request(mqtt, device)
@@ -549,6 +583,12 @@ def parse_args(args):
         action="store_true",
         help="Fetch and print the current device status. Can be combined with control commands.",
     )
+    parser.add_argument(
+        "--status-raw",
+        action="store_true",
+        help="Fetch and print the raw device status as received from MQTT "
+        "(no conversions applied).",
+    )
 
     # Primary action modes (mutually exclusive)
     group = parser.add_mutually_exclusive_group()
@@ -635,6 +675,12 @@ def setup_logging(loglevel):
 def main(args):
     """Wrapper for the asynchronous main function."""
     args = parse_args(args)
+
+    # Validate that --status and --status-raw are not used together
+    if args.status and args.status_raw:
+        print("Error: --status and --status-raw cannot be used together.", file=sys.stderr)
+        return 1
+
     # Set default log level for libraries
     setup_logging(logging.WARNING)
     # Set user-defined log level for this script

{nwp500_python-1.1.2 → nwp500_python-1.1.3}/src/nwp500/models.py

@@ -13,6 +13,24 @@ from typing import Any, Optional, Union
 _logger = logging.getLogger(__name__)
 
 
+def _decicelsius_to_fahrenheit(raw_value: float) -> float:
+    """
+    Convert a raw decicelsius value to Fahrenheit.
+
+    Args:
+        raw_value: Raw value in decicelsius (tenths of degrees Celsius)
+
+    Returns:
+        Temperature in Fahrenheit
+
+    Example:
+        >>> _decicelsius_to_fahrenheit(250)  # 25.0°C
+        77.0
+    """
+    celsius = raw_value / 10.0
+    return (celsius * 9 / 5) + 32
+
+
 class OperationMode(Enum):
     """Enumeration for the operation modes of the device.
 
@@ -306,6 +324,11 @@ class DeviceStatus:
             )
 
         # Convert integer-based booleans
+        # The device uses a non-standard encoding for boolean values:
+        #   0 = Not applicable/disabled (rarely used)
+        #   1 = OFF/Inactive/False
+        #   2 = ON/Active/True
+        # This applies to ALL boolean fields in the device status
         bool_fields = [
             "didReload",
             "operationBusy",
@@ -329,9 +352,11 @@ class DeviceStatus:
             "scaldUse",
             "airFilterAlarmUse",
         ]
+
+        # Convert using the device's encoding: 0 or 1=false, 2=true
         for field_name in bool_fields:
             if field_name in converted_data:
-                converted_data[field_name] = bool(converted_data[field_name])
+                converted_data[field_name] = converted_data[field_name] == 2
 
         # Convert temperatures with 'raw + 20' formula
         add_20_fields = [
@@ -353,15 +378,11 @@ class DeviceStatus:
             if field_name in converted_data:
                 converted_data[field_name] += 20
 
-        # Convert fields with 'raw / 10.0' formula
+        # Convert fields with 'raw / 10.0' formula (non-temperature fields)
         div_10_fields = [
-            "dischargeTemperature",
-            "suctionTemperature",
-            "evaporatorTemperature",
             "targetSuperHeat",
             "currentInletTemperature",
             "currentDhwFlowRate",
-            "currentSuperHeat",
             "hpUpperOnDiffTempSetting",
             "hpUpperOffDiffTempSetting",
             "hpLowerOnDiffTempSetting",
@@ -375,23 +396,28 @@ class DeviceStatus:
             if field_name in converted_data:
                 converted_data[field_name] /= 10.0
 
-        # Special conversion for ambientTemperature
-        if "ambientTemperature" in converted_data:
-            raw_temp = converted_data["ambientTemperature"]
-            # Based on observed data: raw 503.6 corresponds to 72.5°F
-            # Convert raw value to Celsius first (raw / 22.4 ≈ Celsius)
-            # Then convert Celsius to Fahrenheit
-            celsius = raw_temp / 22.4
-            converted_data["ambientTemperature"] = (celsius * 9 / 5) + 32
-
         # Special conversion for tank temperatures (decicelsius to Fahrenheit)
         tank_temp_fields = ["tankUpperTemperature", "tankLowerTemperature"]
         for field_name in tank_temp_fields:
             if field_name in converted_data:
-                raw_temp = converted_data[field_name]
-                # Convert from decicelsius (raw / 10.0) to Celsius, then to Fahrenheit
-                celsius = raw_temp / 10.0
-                converted_data[field_name] = (celsius * 9 / 5) + 32
+                converted_data[field_name] = _decicelsius_to_fahrenheit(converted_data[field_name])
+
+        # Special conversion for dischargeTemperature (decicelsius to Fahrenheit)
+        if "dischargeTemperature" in converted_data:
+            converted_data["dischargeTemperature"] = _decicelsius_to_fahrenheit(
+                converted_data["dischargeTemperature"]
+            )
+
+        # Special conversion for heat pump temperatures (decicelsius to Fahrenheit)
+        heat_pump_temp_fields = [
+            "suctionTemperature",
+            "evaporatorTemperature",
+            "ambientTemperature",
+            "currentSuperHeat",
+        ]
+        for field_name in heat_pump_temp_fields:
+            if field_name in converted_data:
+                converted_data[field_name] = _decicelsius_to_fahrenheit(converted_data[field_name])
 
         # Convert enum fields with error handling for unknown values
         if "operationMode" in converted_data:

{nwp500_python-1.1.2 → nwp500_python-1.1.3/src/nwp500_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nwp500-python
-Version: 1.1.2
+Version: 1.1.3
 Summary: Add a short description here!
 Home-page: https://github.com/pyscaffold/pyscaffold/
 Author: Emmanuel Levijarvi