Skip to main content

Library built for Home Assistant to integrate with the City of Toronto MyWaterToronto service

Project description

🌤️ Python Wrapper for MyWaterToronto REST API

Latest PyPI version Supported Python

This module communicates with the City of Toronto MyWaterToronto service.

The module is primarily written for the purpose of being used in Home Assistant for the Custom Integration called mywatertoronto .

This API will read the account information and obtain a list of address(es) and meter(s).

Consumption data incude

Unfortunately, the City of Toronto only appears to be pulling meter data every 1-2 days.

Install

pymywatertoronto is available on PyPi:

pip install pymywatertoronto

Consumption Buckets

This library will provide the following consumption buckets

  • Total usage
  • Today usage
  • Week-to-date usage
  • Month-to-date usage
  • Year-to-date usage

Usage

This library is primarily designed to be used in Home Assistant.

The main interface for the library is the pymywatertoronto.MyWaterToronto. This interface takes 6 options:

  • session: (required) An existing aiohttp.ClientSession.
  • account_number: (required) Enter your Account No. found on the utility bill.
  • client_number: (required) Enter your Client No. found on the utility bill.
  • last_name: (required) Enter your Last Name - must match the first last name on the utility bill.
  • postal_code: (required) Enter your Postal Code - must match the postal code on the utility bill.
  • last_payment_method: (required) use the enumerations from const.LastPaymentMethod.

Copy the tests/template.env to tests/.env file and update the account information with your your City of Toronto account information:

ACCOUNT_NUMBER="000000000"
CLIENT_NUMBER="000000000-00"
LAST_NAME="lastname"
POSTAL_CODE="A1A 1A1"
LAST_PAYMENT_METHOD="4"

Use the enumerations from const.LastPaymentMethod.

Run the test file: python tests/test_mywatertoronto.py [-h or --dump]

--dump paramater will create two files containing data that is leveraged in the Home Assistant integration:

  • data_account_details.json
  • data_consumption.json

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

pymywatertoronto-1.4.2.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

pymywatertoronto-1.4.2-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file pymywatertoronto-1.4.2.tar.gz.

File metadata

  • Download URL: pymywatertoronto-1.4.2.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for pymywatertoronto-1.4.2.tar.gz
Algorithm Hash digest
SHA256 052df55df4ec3ef606cbd894a9ecaca7deef415a48cd0cb518eef4703602fc16
MD5 d6a0323948c7f3854e23c457d8321eec
BLAKE2b-256 1dcb64a6a4cb05e488dd675ec1de3d922593e827b1f66b83cccc8114f54044fa

See more details on using hashes here.

File details

Details for the file pymywatertoronto-1.4.2-py3-none-any.whl.

File metadata

File hashes

Hashes for pymywatertoronto-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f6e6d77b4c754d5594e01f18f8044c54c40e767466be246a03fc7d2219598f1f
MD5 2c24ee0ce7b7f55200bc967e2d513549
BLAKE2b-256 cdfe600f5f72bf54ae04ec2260dd412b4ca478609c95424b0661e1ec290174cd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page