Skip to main content

PyOkofen

Python interface for Okofen (oekofen) JSON API

import pyokofen
import time

boiler = pyokofen.Okofen()
# Set here you ip:port/password/ - eg. 1.1.1.1:4321/XXXX/
try boiler.credentials("1.1.1.1", "4321", "XXXX"):
    print("It works!")
    print("Current temperature: " + boiler.get("hk0", "L_roomtemp_act"))
    print("Target temperature: " + boiler.get("hk0", "L_roomtemp_set"))
    time.sleep(30)
    boiler.update()
    print("Current temperature: " + boiler.get("hk0", "L_roomtemp_act"))
except:
    print('Oh no!')

Notice! Beside the class init, every other function are async functions.
Notice! Okofen have a soft limitation of 1 request per 10 seconds, regardless of the origin nor if it's to get or set something.

Todo

  • Document actual okofen API
  • Implement value modification (eg. GET /ww1.heat_once=1 to enable domestic hot water force heating)\ beware 1x request per 10 seconds regardless of the source. Maybe implement a queue?
  • Missing Power, Stirling, Thirdparty, Pu (accu), Se (Solar), Circ (circulation pump), St5k (5kw stirling) datas, as I do not own them, I don't know their format. Lack of documentation on Okofen side.

Release files for PyOkofen 1.0.1

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

Source distribution (sdist)

Source distribution for PyOkofen 1.0.1
File Size Uploaded
PyOkofen-1.0.1.tar.gz 7.6 kB Details

Built distribution (wheel)

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

Total release size: 15.9 kB

Release files / PyOkofen-1.0.1.tar.gz

Download URL PyOkofen-1.0.1.tar.gz
Size 7.6 kB
Tags Source
SHA-256 checksum
How to use checksums
2b12569ce26986d1a7f1f4f99ef5c816cac04cf8200de93a343272054a873345
BLAKE2b-256 checksum
How to use checksums
939c032adc6288529081694394b6e5113066d3a3950ba5514111267c48009153
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

Release files / PyOkofen-1.0.1-py3-none-any.whl

Download URL PyOkofen-1.0.1-py3-none-any.whl
Size 8.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
03b5e2f137b83cd1ac0634c4738170440dcd8f77f54e2f1b42170852924d149d
BLAKE2b-256 checksum
How to use checksums
1fb55cdd1037a9d9d62660bd906d9df460ea4e00da323a049dcc02fde8fd743f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

Release history Release notifications | RSS feed

This release

1.0.1 This release

2 release files

1.0.0

2 release files

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