Edilkamin Stove Python client
Project description
Edilkamin.py
This is a library for the Reverse Engineered "The Mind" Edilkamin API. The Mind offers an app/API to remote control the Edilkamin pellet stoves.
Install
pip install edilkamin[ble]
Usage
Both async and sync are supported seamlessly, simply use the await keyword for the async version.
import edilkamin
token = edilkamin.sign_in(username, password)
mac_address = edilkamin.discover_devices()[0]
info = edilkamin.device_info(token, mac_address)
# or async via
# info = await edilkamin.device_info(token, mac_address)
edilkamin.set_power_off(token, mac_address)
# or async
# await edilkamin.set_power_off(token, mac_address)
For more advanced usage read the documentation.
Command Line Interface
After installation, you can control your stove directly from the terminal:
# Discover nearby Edilkamin devices via Bluetooth
edilkamin discover
# Get device information
edilkamin info --username USERNAME --password PASSWORD --mac-address MAC
# Turn the stove on
edilkamin power-on --username USERNAME --password PASSWORD --mac-address MAC
# Turn the stove off
edilkamin power-off --username USERNAME --password PASSWORD --mac-address MAC
You can also run via Python module:
python -m edilkamin info --username USERNAME --password PASSWORD --mac-address MAC
Environment Variables
Instead of passing credentials on every command, set environment variables:
export EDILKAMIN_USERNAME="your_username"
export EDILKAMIN_PASSWORD="your_password"
export EDILKAMIN_MAC_ADDRESS="AA:BB:CC:DD:EE:FF"
# Then simply run:
edilkamin info
edilkamin power-on
edilkamin power-off
Command Options
| Option | Short | Environment Variable | Description |
|---|---|---|---|
--username |
-u |
EDILKAMIN_USERNAME |
Account username |
--password |
-p |
EDILKAMIN_PASSWORD |
Account password |
--mac-address |
-m |
EDILKAMIN_MAC_ADDRESS |
Device MAC address |
--legacy |
EDILKAMIN_USE_LEGACY_API |
Use legacy API (deprecated) |
Use edilkamin --help or edilkamin <command> --help for more details.
Tests
make test
Motivations
- providing an open source web alternative to the proprietary mobile app
- improving the interoperability (Nest, HomeAssistant...)
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file edilkamin-1.6.0.tar.gz.
File metadata
- Download URL: edilkamin-1.6.0.tar.gz
- Upload date:
- Size: 21.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7634184499eb3a8a96fffa6dcc42f2b86a6edcda00a77c00e20b3e8b51d0aaf6
|
|
| MD5 |
f21074624c11416a85e15076c5e8edf8
|
|
| BLAKE2b-256 |
da03841a9c297f2f70fc6424e6c23df75344f675e74a2865ec934a858614bee4
|
File details
Details for the file edilkamin-1.6.0-py3-none-any.whl.
File metadata
- Download URL: edilkamin-1.6.0-py3-none-any.whl
- Upload date:
- Size: 14.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
763709d3213f39282204b29a5b696f9f4ca87a84fb1505e06d9ab95b1d1eb0c6
|
|
| MD5 |
3bd8dd727c189346af0bf94ba06a4e47
|
|
| BLAKE2b-256 |
1f92af71558d88efa50d2d2a31885344a1041d7c391d281117e21c302c2b902c
|