Skip to main content

Python library for communicating with IDM Navigator heat pumps via Modbus TCP. Used by the official Home Assistant integration.

Project description

IDM Heatpump API

Official Python library for communicating with IDM Navigator heat pumps (2.0, Pro, and Navigator 10) over Modbus TCP.

This package is published on PyPI as idm-heatpump and is the core dependency for the Home Assistant integration.

pip install idm-heatpump

Documentation

The docs/ directory is the single source of truth:

  • GitHub Pages is deployed automatically from docs/.
  • GitHub Wiki is synchronized automatically from docs/.

Supported Devices (Current Status)

Device Firmware Heating Circuits Zone Modules Status
IDM Navigator 10 NAV10_20.23+ (2025) up to 7 (A-G) up to 10 (6 rooms each) Confirmed
IDM Navigator 2.0 all versions up to 7 (A-G) no Confirmed
IDM Navigator Pro all versions up to 7 (A-G) up to 10 (6 rooms each) Confirmed

Note: Zone modules on current hardware (including Navigator 10) support 6 rooms per module. Older documentation sometimes mentioned 8; the library defaults to 6 for accuracy.

Requirements

  • Modbus TCP must be enabled in the IDM controller (Settings → Building Management → Modbus TCP = On).
  • Default port: 502
  • Default slave ID: 1

New in Navigator 10 Support

The library now fully covers the official 2025 Navigator 10 Modbus TCP specification, including:

  • Heat sink / plate heat exchanger sensors (flow rate in l/min at 1072 — excellent for filter monitoring)
  • Power limitation registers (4108 / 4112) for demand response / peak shaving
  • Complete Booster A + B (second heat generator) monitoring
  • Additional source pump faults and external pump demand control
  • Groundwater temperatures and more cascade bivalence points
  • All zone module rooms (6 rooms per module on current hardware)

Installation

pip install idm-heatpump

Contributing

Please open an issue or pull request for bug reports, improvements, and documentation updates.

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

idm_heatpump-0.2.0.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

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

idm_heatpump-0.2.0-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file idm_heatpump-0.2.0.tar.gz.

File metadata

  • Download URL: idm_heatpump-0.2.0.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for idm_heatpump-0.2.0.tar.gz
Algorithm Hash digest
SHA256 7f45e1766f63dc867ceb9dfa450021bd06cf1482385cf86891c0c6de0c8b569a
MD5 f0c7830797b67fe7084908c7b6363aa4
BLAKE2b-256 5ab716eca359df23a48a5e0c8f76ed37ef953f858fadecc32a482bd37abd8a25

See more details on using hashes here.

File details

Details for the file idm_heatpump-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: idm_heatpump-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for idm_heatpump-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 83e57d70c037d585a83c90419a9d8763873e3567e2dcf458afedcfc6a9ce4a1b
MD5 80a126cb1920bd93a176bd67d54fbd7d
BLAKE2b-256 4402fe7ac21fa56e29e9236f1f31dfd0358d4db45f0b0ccb264beab624fefbb4

See more details on using hashes here.

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