Software Development Kit for the EET SolMate
Project description
EET SolMate SDK
All you need to integrate your EET SolMate 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:
- Login to your SolMate with serial number and password which returns an authentication token.
- Connect to your SolMate with the authentication token.
- Get live values of your SolMate.
- 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:
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
- The project on PyPi: 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file solmate_sdk-0.1.11.tar.gz
.
File metadata
- Download URL: solmate_sdk-0.1.11.tar.gz
- Upload date:
- Size: 8.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-45-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d2c9e721442c46f1172805f477fdf552640ef5b9955a988c3668186e7d330da1 |
|
MD5 | 48c2127c978d372b21c5ed7afdcfdf98 |
|
BLAKE2b-256 | 57fadef09630200d299bd2da5ac1fd65b69ee46c76490d34374d18e6e435a4b1 |
File details
Details for the file solmate_sdk-0.1.11-py3-none-any.whl
.
File metadata
- Download URL: solmate_sdk-0.1.11-py3-none-any.whl
- Upload date:
- Size: 9.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-45-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfc8e695cd907a9b954bf82dd6d38eadbe6672c7658b0a3cfdf4cc4825d32eee |
|
MD5 | d359240858dc65bfcf4c4eb3ae3dc677 |
|
BLAKE2b-256 | 08e349cd0d72ba9319872545fc408ff8b81ec89d8c5b52cf9b63396f79885566 |