Skip to main content

Edilkamin.py

Tests Coverage Status PyPI version Build Docs Documentation Status

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.

API Endpoints

The library supports two backend endpoints:

New API (Default)

import edilkamin

# Uses new API endpoint by default
token = edilkamin.sign_in(username, password)
info = edilkamin.device_info(token, mac_address)
edilkamin.set_power_on(token, mac_address)

Legacy API

import edilkamin

# Use legacy AWS endpoint
token = edilkamin.sign_in(username, password, use_legacy_api=True)
info = edilkamin.device_info(token, mac_address, use_legacy_api=True)
edilkamin.set_power_on(token, mac_address, use_legacy_api=True)

For CLI, use the --legacy flag:

edilkamin info --username USERNAME --password PASSWORD --mac-address MAC --legacy

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...)

Metadata

Release files for edilkamin 1.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for edilkamin 1.7.0
File Size Uploaded Provenance Actions
edilkamin-1.7.0.tar.gz 22.3 kB Without provenance Details for edilkamin-1.7.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for edilkamin 1.7.0
File Interpreter ABI Platform Actions
edilkamin-1.7.0-py3-none-any.whl Python 3 none any Details for edilkamin-1.7.0-py3-none-any.whl

Total release size: 37.2 kB

Release files / edilkamin-1.7.0.tar.gz

Download URL edilkamin-1.7.0.tar.gz
Size 22.3 kB
Tags Source
SHA-256 checksum
How to use checksums
c7bce991e58ccf21add364c5425d1f338321e3f14624489407a96a7a071b6c43
BLAKE2b-256 checksum
How to use checksums
aa2c7186fa59a4db42cd1fce101ffbb8adb254818586e2895605b66d5fa64892
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / edilkamin-1.7.0-py3-none-any.whl

Download URL edilkamin-1.7.0-py3-none-any.whl
Size 15.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
927164868b671d5a781aa4083abdc2951fb40bc6cb70b6d3a1efeb3e882d8d84
BLAKE2b-256 checksum
How to use checksums
1502154a27b33438947cfa26233ffa064cf61292fb291b2783f8d24ae8c41fdf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for edilkamin 1.7.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page