JSON to python API for Okofen boilers
Project description
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.
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
PyOkofen-1.0.1.tar.gz
(7.6 kB
view details)
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 PyOkofen-1.0.1.tar.gz.
File metadata
- Download URL: PyOkofen-1.0.1.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2b12569ce26986d1a7f1f4f99ef5c816cac04cf8200de93a343272054a873345
|
|
| MD5 |
41e928b1159a9c69d30fb7672bff0500
|
|
| BLAKE2b-256 |
939c032adc6288529081694394b6e5113066d3a3950ba5514111267c48009153
|
File details
Details for the file PyOkofen-1.0.1-py3-none-any.whl.
File metadata
- Download URL: PyOkofen-1.0.1-py3-none-any.whl
- Upload date:
- Size: 8.2 kB
- Tags: Python 3
- Uploaded using 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
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
03b5e2f137b83cd1ac0634c4738170440dcd8f77f54e2f1b42170852924d149d
|
|
| MD5 |
c570fe6d8c013b42ca377c7e8b997eb0
|
|
| BLAKE2b-256 |
1fb55cdd1037a9d9d62660bd906d9df460ea4e00da323a049dcc02fde8fd743f
|