Skip to main content

IPS Controllers API Client

Python client library for the IPS Controllers pool monitoring system.

Installation

pip install ips-api-client

Usage

import asyncio
from ips_api import IPSClient

async def main():
    async with IPSClient("your_email@example.com", "your_password") as client:
        # Get all controllers
        controllers = await client.get_controllers()

        for controller in controllers:
            print(f"Controller: {controller.name}")
            print(f"  pH: {controller.current_reading.ph}")
            print(f"  ORP: {controller.current_reading.orp} mV")
            print(f"  Status: {controller.status}")

            # Get detailed reading
            detail = await client.get_controller_detail(controller.controller_id)
            print(f"  pH Setpoint: {detail.ph_setpoint}")
            print(f"  ORP Setpoint: {detail.orp_setpoint}")
            print(f"  pH State: {detail.ph_state}")

asyncio.run(main())

Features

  • Async/await support
  • Automatic session management
  • Support for multiple controllers
  • Detailed pool chemistry readings (pH, ORP, temperature, chlorine)
  • Controller status monitoring

Data Available

  • pH level
  • ORP (Oxidation-Reduction Potential) in mV
  • Water temperature (when available)
  • Chlorine PPM (when available)
  • Controller status
  • Last reading timestamp
  • pH setpoint and state
  • ORP setpoint

License

MIT

Metadata

Release files for ips-api-client 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ips-api-client 0.2.0
File Size Uploaded Provenance
ips_api_client-0.2.0.tar.gz 11.6 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for ips-api-client 0.2.0
File Interpreter ABI Platform
ips_api_client-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 21.3 kB

Release files / ips_api_client-0.2.0.tar.gz

Download URL ips_api_client-0.2.0.tar.gz
Size 11.6 kB
Tags Source
SHA-256 checksum
How to use checksums
39cdf579932b6f9a9a9eb082ae7849c521f6379f114a1d1fa168daf14857b71c
BLAKE2b-256 checksum
How to use checksums
f0d08e621bc8cba4922a127c7002515318753a4a3990b586164f82c3f2fe5aa7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release files / ips_api_client-0.2.0-py3-none-any.whl

Download URL ips_api_client-0.2.0-py3-none-any.whl
Size 9.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6e44912b6ba109da3fef7a64b1659a40608f9b2e5d1e4c7edd566bf713c9fe63
BLAKE2b-256 checksum
How to use checksums
ec91414f529d495a554f63a9cea78e04462cff0da76171bb4812683d395427d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Security for ips-api-client 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page