Skip to main content

Async python library to communicate with DAB Pumps servers for DConnect and DAB Live

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

license buy_me_a_coffee

aiodabpumps

Python library for retrieving sensor information from DAB Pumps devices. This component connects to the remote DAB Pumps servers 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.

Disclaimer: this library is NOT created by DAB Pumps

Prerequisites

This library depends on the backend servers for the DAB Pumps H2D app, DAB Live app or DConnect app to retrieve the device information from.

  • For most pumps:

    All DAB's new network-capable pumps will progressively be connected with H2D. At the moment, H2D is supported by Esybox Mini3, Esybox Max, NGPanel, NGDrive and the new EsyBox.

    Newer pump devices will have integrated connectivity (Esybox MAX and Esybox Mini), while older pumps might require a DConnect Box/Box2 device (Esybox and Esybox Diver).

    Using free functionalilty you will be able to check the system's basic parameters via the H2D app and this library. To allow to edit settings via the H2D app and this library you will need a Dab Pumps subscription to premium H2D. Follow the steps under H2D

  • For other pumps:

    The older Dab Live and DConnect apps are being replaced by H2D, but are still available.

    Esybox Mini3 pumps are supported on the DAB Live app with a free DAB Live account, or on the DConnect App with a paid account. Follow the steps under either DAB Live or DConnect.

    To see whether your pump device is supported via DConnect, browse to internetofpumps.com, select 'Professional Users' and scroll down to the operation diagram. A free trial period is available, after that there is a yearly subscription to DAB Pumps DConnect (US$ 20 in 2024). Follow the steps under DConnect.

H2D

If you have a pump that is supported by the H2D app then:

  • Download the H2D app on your phone or tablet
  • Setup an account to use with the app.
  • Follow the steps in the app to register your pump.
  • Create a separate account for use with this libary; follow the steps under Multiple Account Logins below.

DAB Live

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

  • Download the DAB Live app on your phone or tablet
  • Open the app and create a new account. When asked between 'Professional' or 'End User' either are good, this has no implications on the app or the use of this library.
  • Follow the steps in the app to register your pump.

DConnect

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

  • Enable your DAB Pumps devices to connect to DConnect. For more information on this, see the manual of your device.
  • Install the DConnect app, or open the DConnect website in a browser.
  • Setup an account for DConnect
  • Add your installation via the device serial number.
  • Setup a sepatate account for use with this library; follow the steps under Multiple Account Logins below.

Multiple Account Logins

The H2D app and the DConnect app and website 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 library may fail.

Therefore it is recommended to create a separate account within DAB Pumps H2D or DConnect that is specific for script use.

  • Create a fresh email address at gmail, outlook or another provider.

  • For H2D:

    • Login to the H2D app using your regular email address.
    • In the bottom of the H2D app select 'Installations'.
    • At the top of the page the owner is displayed. This is the name associated with your regular email address. Press the '>' next to it.
    • Click on '+ Invite another user'.
    • Fill in the email address you created specific for script use. Select user category 'Professional' to make use of all functionality of this library. Press 'Invite' and then 'Continue'.
    • Follow the steps as described in the invitation email to register the new email address. Note that this is handled via the DConnect website (which is expected to be renamed to H2D soon).
  • For DConnect:

    • Open the Dconnect app and logout from your normal account if needed.
    • Press 'Login' and then 'Register'. This will open the DConnect website.
    • Enter the email address you created for script use and choose a password. The choice between 'Professional' or 'End User' either are good as this is only used for marketing purposes; it has no implications on the website, app or this library.
    • Fill in all other details on the form and press 'Register'.
    • Go back to the DConnect app and login using your normal account.
    • Click on your installation and then at the bottom of the page on 'Installation Sharing'.
    • Click on 'Add an installer' to make use of all functionality of this library.
    • Fill in the email address you created specific for script use and click '+'.

Usage

The library is available from PyPi using: pip install aiodabpumps

See example_api_use.py for an example of usage.

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

aiodabpumps-1.0.7.tar.gz (40.0 kB view details)

Uploaded Source

Built Distribution

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

aiodabpumps-1.0.7-py3-none-any.whl (33.2 kB view details)

Uploaded Python 3

File details

Details for the file aiodabpumps-1.0.7.tar.gz.

File metadata

  • Download URL: aiodabpumps-1.0.7.tar.gz
  • Upload date:
  • Size: 40.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for aiodabpumps-1.0.7.tar.gz
Algorithm Hash digest
SHA256 acada8a43a7f7a7a3366173fc00dd15e15403e84516c90fa32042e8b94b7ffba
MD5 bbb20a88a2e61ba92516d923c410ddbf
BLAKE2b-256 7ffef18fa463c2e89a184fda9b60dcfb1d4b7374bf1650548cfe879103367234

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiodabpumps-1.0.7.tar.gz:

Publisher: publish.yml on ankohanse/aiodabpumps

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aiodabpumps-1.0.7-py3-none-any.whl.

File metadata

  • Download URL: aiodabpumps-1.0.7-py3-none-any.whl
  • Upload date:
  • Size: 33.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for aiodabpumps-1.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c9a3c4146b630b49597854f7c608244cbc576aaeca27b73536b0a7ff9177e972
MD5 c173306d78b4e3094b5fc0f856a49e86
BLAKE2b-256 23ba2b21aaf216cb3f889314f4cd475ea94106f4b534538c22ea2991c0192a0d

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiodabpumps-1.0.7-py3-none-any.whl:

Publisher: publish.yml on ankohanse/aiodabpumps

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