Skip to main content

API client for IPS Controllers pool monitoring system

Project description

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

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

ips_api_client-0.1.1.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

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

ips_api_client-0.1.1-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file ips_api_client-0.1.1.tar.gz.

File metadata

  • Download URL: ips_api_client-0.1.1.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for ips_api_client-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0de58f30bf96cf103f9f4ff5c0c84c96f700256b16cc363b9a7aa77165cc4054
MD5 0b6a9f56a9e2e3d2eb8ca121fb94653c
BLAKE2b-256 88d81c5b31455790dd5977aa23f04045f2c8c28aeeed92fe7aea5e35d66a9231

See more details on using hashes here.

File details

Details for the file ips_api_client-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: ips_api_client-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for ips_api_client-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b0979212f1437f1a43673a733ddef9ce0170403ef72add994a8c0b895127ee31
MD5 df053514417089dbe671ad9a99c1f69b
BLAKE2b-256 11e92917c5315ef6d2ccf005271e254203639e6d1885e13373b2272e6999c898

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