ankohanse / hass-dab-pumps

Home Assistant Custom Integration for DAB Pumps via the DAB Live or DConnect service
MIT License
14 stars 2 forks source link
custom-integration dab-live dab-pumps dconnect esybox hacs home-assistant integration

version hacs_badge maintained
license buy_me_a_coffee

Hass-DAB-Pumps

Home Assistant custom component for retrieving sensor information from DAB Pumps devices. This component uses webservices to connect to the DAB Pumps DConnect website and automatically determines which installations and devices are available there.

The custom component was tested with a ESybox 1.5kw combined with a DConnect Box 2. It has also been reported to function correctly for ESybox Mini and ESybox Diver.

Prerequisites

This device depends on the backend servers for the DAB Pumps DAB Live app and DConnect app to retrieve the device information from.

DAB Live

If you have a pump that is supported for DAB Live then:

DConnect

If you have a device that is supported for DConnect then:

DConnect Account

The DAB Pumps DConnect website and app seem to have a problem with multiple logins from the same account. I.e. when already logged into the app or website, then a subsequent login via this integration may fail.

Therefore it is recommended to create a separate account within DAB Pumps DConnect that is specific for this HA integration.

Installation

HACS

This custom integration is avalable via HACS (Home Assistant Community Store).

  1. In the HACS page, search for 'DAB Pumps'.
  2. Click on the found item to display its readMe (this page).
  3. At the bottom of the page press 'Download'
  4. Restart Home Assistant.
  5. Follow the UI based Configuration

Manual install

  1. Under the <config directory>/custom_components/ directory create a directory called dabpumps. Copying all files in /custom_components/dabpumps/ folder from this repo into the new <config directory>/custom_components/dabpumps/ directory you just created.

    This is how your custom_components directory should look like:

    custom_components
    ├── dabpumps
    │   ├── translations
    │   │   └── en.json
    │   ├── __init__.py
    │   ├── api.py
    │   ├── binary_sensor.py
    │   ├── config_flow.py
    │   ├── const.py
    │   ├── coordinator.py
    │   ├── diagnostics.py
    │   ├── entity_base.py
    │   ├── manifest.json
    │   ├── number.py
    │   ├── select.py
    │   ├── sensor.py
    │   ├── strings.json
    │   └── switch.py  
  2. Restart Home Assistant.

  3. Follow the UI based Configuration

Configuration

To start the setup of this custom integration:

Step 1 - Connection details

The following properties are required to connect to the DAB Live or DConnect service:

setup_step_1

Step 2 - Installations

If your account is only assiciated with one DAB Pumps installation then this step is automatically skipped. Otherwise, select the DAB Pumps installation to use in Home Assistant. The other DAB Pumps installations can be added to the integration later on.

Devices

After succcessful setup, all devices from the DAB Pumps installation should show up in a list.

controller_list

On the individual device pages, the hardware related device information is displayed, together with sensors typically grouped into main entity sensors, controls and diagnostics.

Any sensors that you do not need can be manually disabled using the HASS GUI.

controller_detail

Sensors

Sensors are registered to each device as sensor.{device_name}_{sensor_name} with an easy to read friendly name of sensor_name.

sensor

Troubleshooting

Please set your logging for the this custom component to debug during initial setup phase. If everything works well, you are safe to remove the debug logging:

logger:
  default: warn
  logs:
    custom_components.dabpumps: info

Credits

Special thanks to the following people for their testing and feedback on the first versions of this custom integration: