semvec/pypi-packages huggingface dataset:
solmate-sdk 0.1.11
Software Development Kit for the EET SolMate
License: MIT
Requires Python: <4.0,>=3.8

# EET SolMate SDK

All you need to integrate your [EET SolMate](https://www.eet.energy) into your home automation system - or really any Python-based system!
Keep in mind that this is **work in progress**.

This Python SDK provides a class-based API Client which lets you:

1. Login to your SolMate with serial number and password which returns an authentication token.
2. Connect to your SolMate with the authentication token.
3. Get live values of your SolMate.
4. Check if your SolMate is online.

For any inquiries about, or problems with, the usage of this API endpoint, please create an issue in this repository.

## How to use

Install the package via:

`pip install solmate-sdk`

Import the `SolMateAPIClient` class and connect to your SolMate:

```python
from solmate_sdk import SolMateAPIClient

client = SolMateAPIClient("<YOUR SOLMATE SERIAL NUMBER>")
client.connect()
print(f"Your SolMate online status is: {client.check_online()}")

# or for the protected API:
client.quickstart() # or client.quickstart(password="<YOUR_SOLMATE_PASSWORD>")
print(client.get_live_values())
```

The SolMate SDK communicates via a Websocket API with your SolMate.

## Roadmap

- Quickstart supports multiple serial numbers (and multiple device ids?)
- More Examples
- Full Unit Testing
- Car Charger Example

## Links

- Our Homepage: [www.eet.energy](https://www.eet.energy)
- The project on PyPi: [pypi.org/project/solmate-sdk](https://pypi.org/project/solmate-sdk/)
- Read the docs page: https://solmate-sdk.readthedocs.io/en/latest/

## Changelog

### Version 0.1.11

- Added async methods and made them public
- Added possibility to provide password to quickstart
- Added possibility to initialize api client with async parameter