Metadata-Version: 2.3
Name: huum
Version: 0.8.2
Summary: Python library for Huum saunas
License: MIT
Author: Frank Wickström
Author-email: frwickst@gmail.com
Requires-Python: >3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: aiohttp
Requires-Dist: aiohttp[speedups] (>=3.12.12,<4.0.0) ; extra == "aiohttp"
Requires-Dist: mashumaro (>=3.16,<4.0)
Project-URL: Repository, https://github.com/frwickst/pyhuum
Description-Content-Type: text/markdown

# huum - A python library for controlling [Huum](https://huum.eu/) saunas

This library was created primarily to be used together with Home Assistant, but
can be used as a stand-alone library as well. The API used by this library is sanctioned
by Huum to be used by third parties. At least to the extent that they happily provided
documentation for the API when asked about it.

This library has been tested against a [Huum Drop](https://huum.eu/products/drop-electric-sauna-heater/) sauna
using the [UKU Wi-Fi](https://huum.eu/products/uku-wi-fi-sauna-controller/) control unit.

No guarantees are given when using this library. You are using it at your own risk.
Saunas can be dangerous if used without care or without the right security measures.

## Installation

### PIP

`pip install huum`

### Poetry

`poetry add huum`

## Quick guide

```python
import asyncio

from huum.huum import Huum

async def turn_on_sauna():
    huum = Huum(username="foo", password="bar")

    # If you don't have an existing aiohttp session
    # then run `open_session()` after initilizing
    await huum.open_session()

    # Turn on the sauna
    await huum.turn_on(80)

asyncio.run(turn_on_the_sauna())
```

## Usage

The `huum` package is fully asynchronous.

Supported Python versions:

| Python | Supported |
| ------ | --------- |
| <= 3.8 | ❌        |
| 3.9    | 🤷        |
| 3.10   | 🤷        |
| 3.11   | ✅        |
| 3.12   | ✅        |
| 3.13   | ✅        |

### Authentication

Authentication uses username + password. The same credentials that you use for logging into the Huum application.

**Passing credentials to constructor**

```python
huum = Huum(username=<username>, password=<password>)
```

### Sessions

You can use the library either with an already existing session or create one yourself. This design decision
was created mainly to support Home Assistants (HA) existing sessions and complying with their guidelines. In
most cases you will want to create your own session if you are using this outside of HA.

If you already have an existing session you can pass it to the constructor using the `session` argument.

```python
huum = Huum(session=<session>)
```

If you want the library to create a new session, run `open_session()` after creating a `Huum` instance.
You must do this before running any commands. You can close the session using `close_session()`.

```
huum = Huum()
huum.open_session()
...
huum.close_session()
```

### Controlling the sauna

#### Getting sauna status

The Huum API exposes a status endpoint for getting the current status of the sauna.

```python
huum.status()
```

#### Turning on and setting temperature

The Huum API does not have a specific endpoint for turning on a setting the temperature.
The same endpoint does both. This library has two functions for turning on and settings the
temperature, mainly for exposing a nicer interface to the developer.

```python
# Turns on the sauna and sets its temperature to 80
huum.turn_on(temperature=80)

# Identical the the above
huum.set_temperature(temperature=80)
```

##### Security concerns

Huums API does not check if the sauna door is open or not when turning it on. It will happily
turn on the sauna while the door is open. The sauna itself will most likely still not heat as
it has a security guard in the sauna, but it will turn it on and will start heating if the door
is closed. The Huum mobile application however checks if the sauna door is open or closed before
turning on the sauna.

To mimic the security guards of the mobile application the library, by default, checks the status
of the sauna before it turns it on. If you do not want to have this check, then you can pass the
argument `safety_override=True` to either `turn_on()` or `set_temperature`.

```python
huum.set_temperature(temperature=80, safety_override=True)
```

#### Turning off the sauna

The sauna can be turned off by calling `turn_off()`.

```python
huum.turn_off()
```

## Response objects

This library uses Pydantic schemas for all method responses.
I recommend checking the /huum/schemas.py for checking responses.

## Handling exceptions

This library implements custom exceptions for most of its calls. You can find them in the exceptions.py
file. But in short these are the exceptions triggered:

| HTTP Status        | Exception          |
| ------------------ | ------------------ |
| 400                | `BadRequest`       |
| 401                | `NotAuthenticated` |
| 403                | `Forbidden`        |
| Any other over 400 | `RequestError`     |

All of exceptions triggered by the library inherit from `HuumError`.

If the door is open and the sauna is turned on, and the client is not told to explicitly bypass security
measures (see "Security concerns" above), then `huum.exceptions.SafetyException` will be raised.