Metadata-Version: 2.4
Name: frisquet-api
Version: 0.1.2
Summary: Python client for the Frisquet API
Project-URL: Homepage, https://github.com/markkvdb/frisquet-api
Project-URL: Documentation, https://github.com/markkvdb/frisquet-api#readme
Project-URL: Repository, https://github.com/markkvdb/frisquet-api.git
Project-URL: Bug Tracker, https://github.com/markkvdb/frisquet-api/issues
Author-email: markkvdb <github@mvanderbroek.com>
License: MIT
Keywords: boiler,frisquet,heating,iot,smart home
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Home Automation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Requires-Dist: httpx>=0.26.0
Requires-Dist: pydantic>=2.5.0
Description-Content-Type: text/markdown

# 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

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

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

### Get site data

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

### Set mode

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

### Set temperature

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

### Set water mode

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

## Development

Install [uv](https://astral.sh/uv/) and setup your python environment with the following commands:

```bash
uv sync
```

Setup the pre-commit hooks:

```bash
uvx pre-commit install
```

Run the tests:

```bash
uv run pytest .
```

## Inspiration

This project is inspired by the [Frisquet-connect-for-home-assistant](https://github.com/TheGui01/Frisquet-connect-for-home-assistant) project.
