Skip to main content

Ondilo ICO

PyPi PyPi

A simple client used to access Ondilo ICO APIs.
Implemented to be used in Home Assistant, but can be used anywhere else.

Install

To install ondilo, run:

pip install ondilo

Example usage

Ondilo is using the Authorization Code Grant flow, so each user must be individually authenticated.
The client_id and client_secret are always the same, there is no need to create a specific app on Ondilo side. So they are hard coded. However, if needed, they can also be passed during initialization.

A very basic implementation could look like:

from ondilo import Ondilo

client = Ondilo(redirect_uri="https://example.com/api")
print('Please go here and authorize,', client.get_authurl())

redirect_response = input('Paste the full redirect URL here:')
client.request_token(authorization_response=redirect_response)

print("Found all those pools: ", client.get_pools())

If the Oauth2 flow is handled externally and a token is already available, one can also use the package this way:

from ondilo import Ondilo

client = Ondilo(token)
print("Found all those pools: ", client.get_pools())

Available APIs

More information about the returned objects can be found here: https://interop.ondilo.com/docs/api/customer/v1/

  • get_pools: Get list of available pools / spa
  • get_ICO_details: Get details of a pool/spa
  • get_last_pool_measures: Get the last measures from an ICO
  • get_pool_recommendations: Get the list of recommendations from an ICO
  • validate_pool_recommendation: Acknowledge a recommendation
  • get_user_units: Get user units
  • get_user_info: Get user infos
  • get_pool_config: Get pool/spa ranges for temperature, pH, ORP, salt and TDS
  • get_pool_shares: Get list of users with whom the pool/spa is shared
  • get_pool_histo: Get measurements historical data

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ondilo-0.5.0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

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

ondilo-0.5.0-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file ondilo-0.5.0.tar.gz.

File metadata

  • Download URL: ondilo-0.5.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.18

File hashes

Hashes for ondilo-0.5.0.tar.gz
Algorithm Hash digest
SHA256 5cad5db8a1bfc80d4d312aad5e66e677f7c6c43a1e353320e0a5d018e333d3a1
MD5 1bc9b45783b219e2cbbcf4e8945bf832
BLAKE2b-256 02e1889f515f8833a1113455feee5953b9069a2882fbd53d857a52437f131dcf

See more details on using hashes here.

File details

Details for the file ondilo-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: ondilo-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.8.18

File hashes

Hashes for ondilo-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb8d6e777230bd3db1dcec674ebfdcc29e173922f2b7cf446408d0b95a7f4219
MD5 68cce3e268cf4202705b19272ab101a6
BLAKE2b-256 ac6c681bcdff23e558bf5c7edb07599f2ba94a2ae05734e7e7cec5488a35865d

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.5.0 This release

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page