Metadata-Version: 2.1
Name: solmate-sdk
Version: 0.1.2
Summary: Software Development Kit for the EET SolMate
License: MIT
Author: EET
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: websockets (>=10.3,<11.0)
Description-Content-Type: text/markdown

# EET SolMate SDK

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

This python based SDK provides a class based API Client which let you:

1. Login to your SolMate with serial number and password which returns an authentification token.
2. Connect to your SolMate with the authentification 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.apiclient import SolMateAPIClient

client = SolMateAPIClient("serial_num")
client.connect()
print(f"Your SolMate online status is: {client.check_online()}")

# or for the protected API:
client.quickstart()
print(client.get_live_values())
```

## Implementation Details

The SolMate SDK communicate over the SolMate Websocket API with your SolMate.

## 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/)

