Skip to main content

Python client for the Frisquet API

Project description

Frisquet API

Python client for the Frisquet API that features:

  • Complete control of your Frisquet Connect boiler
  • Async/await support for modern Python applications
  • Type hints for better IDE integration
  • Comprehensive error handling

Usage

from frisquet_api.client import FrisquetClient, Zone, Mode, ModeChange

client = FrisquetClient(email="your@email.com", password="your-password")

Get site data

site_data = await client.get_site_data("your-site-id")

Set mode

await client.set_mode("your-site-id", Zone.ZONE_1, Mode.COMFORT, ModeChange.PERMANENT)

Set temperature

await client.set_temperature("your-site-id", Zone.ZONE_1, HeatingMode.FROST_PROTECTION, 8.0)

Set water mode

await client.set_water_mode("your-site-id", WaterMode.ECO_TIMER)

Development

Install uv and setup your python environment with the following commands:

uv sync

Setup the pre-commit hooks:

uvx pre-commit install

Run the tests:

uv run pytest .

Inspiration

This project is inspired by the Frisquet-connect-for-home-assistant project.

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

frisquet_api-0.1.2.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

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

frisquet_api-0.1.2-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file frisquet_api-0.1.2.tar.gz.

File metadata

  • Download URL: frisquet_api-0.1.2.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for frisquet_api-0.1.2.tar.gz
Algorithm Hash digest
SHA256 b77ec66af2d59d900c8f7c8846276b6bd54eeb8a74c0df8b244a17d7252a98a2
MD5 8bb101b30ac46bb56e29744c055e1977
BLAKE2b-256 b1bb898413e7e6fb51259f9e479091d961b4fd734e9ef59e5e3cbe08b130cbd1

See more details on using hashes here.

Provenance

The following attestation bundles were made for frisquet_api-0.1.2.tar.gz:

Publisher: publish.yml on markkvdb/frisquet-api

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

File details

Details for the file frisquet_api-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: frisquet_api-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for frisquet_api-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8b07867a2e0b29037281b0a47d795674a68d24e6fb82bd234258762b738cb9f7
MD5 b2e029f948bd6944f5bf9290c17a8f07
BLAKE2b-256 9e99ea88f0fc2c1206d67b152334356060dba77087a89e10be6f161e648b7664

See more details on using hashes here.

Provenance

The following attestation bundles were made for frisquet_api-0.1.2-py3-none-any.whl:

Publisher: publish.yml on markkvdb/frisquet-api

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