Skip to main content

Openhab python rule engine

Project description

OpenHAB python rule engine

A python 3.x rule engine for OpenHAB. This rule engine allows defining rule by using python 3.x.

Please consider that the OpenHAB username/password auhentication (basic authentication) needs to be enabled. To do this, open API security settings and activate advanced setting Allow Basic Authentication.

To run this software you may use Docker or PIP package manager such as shown below

Docker approach

sudo docker run -e openhab_uri=http://192.168.1.17:8080 -e user=me -e pwd=secret -v /etc/openhab2/automation/rules/python:/rules grro/pythonrule_engine 

PIP approach

sudo pip install openhab-pythonrule-engine

After this installation you may start the rule engine inside your python code or via command line using

sudo pyrule --command listen --openhab_uri http://localhost:8080 --python_rule_directory /etc/openhab2/automation/rules/python --user me --pwd secret

Here, the rule engine will connect the openhab instance running on the local machine on port 8080. Furthermore, the directory /etc/openhab2/automation/rules/python will be used to scan for python-based rules

By running a systemd-based Linux distribution you may use the register command to register and start the rule engine as systemd unit. By doing this the rule engine will be started automatically on boot. Starting the rule engine manually using the listen command is no longer necessary.

sudo pyrule --command register --openhab_uri http://localhost:8080 --python_rule_directory /etc/openhab2/automation/rules/python --user me --pwd secret

Rules

To trigger a rule methode the @when decorator has to be used. Currently, the conditions listed below are supported

condition example description
cron @when('Time cron */1 * * * *') fires based on cron expression
item state change @when('Item PhoneLisaLastSeen changed') fires when the specified Item's State changes
item command @when('Item SelectDoorCam received command ON')
@when('Item SelectDoorCam received command OFF')
fires when the specified Item receives a Command

Example: my_rule.py (located within /etc/openhab2/automation/rules/python)

from openhab_pythonrule_engine.condition import when
from openhab_pythonrule_engine.item_registry import ItemRegistry



@when("Time cron */1 * * * *") # each minute
@when("Item PhoneLisaLastSeen changed")
@when("Item PhoneTimLastSeen changed")
def update_presence_based_on_phone_seen(item_registry: ItemRegistry):
    last_time_present = item_registry.get_state_as_datetime('LastDateTimePresence')
    for phone_name in item_registry.get_group_membernames('Phones'):
        last_seen = item_registry.get_state_as_datetime(phone_name)
        print(last_seen)
        if last_seen > last_time_present:
            last_time_present = last_seen
    item_registry.set_state('LastDateTimePresence', last_time_present)

If the rule method defines a (single!) argument, the item_registry object will be injected automatically. The item_registry provides methods to get and set the item state. By setting the state the data value will be auto converted into the item specific data type

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

openhab_pythonrule_engine-1.1.0.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

openhab_pythonrule_engine-1.1.0-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

Details for the file openhab_pythonrule_engine-1.1.0.tar.gz.

File metadata

  • Download URL: openhab_pythonrule_engine-1.1.0.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for openhab_pythonrule_engine-1.1.0.tar.gz
Algorithm Hash digest
SHA256 7bec35da055d366b7972cc3b8ac54b85f12e61741a7169adde0bdfc14bbe4fb6
MD5 0cf26aec1a4c890e37e2675f3634cf67
BLAKE2b-256 87de79a97146dfd0effab2d155d32267a4226c84a2af9dd2ba8fba1ae2b64127

See more details on using hashes here.

File details

Details for the file openhab_pythonrule_engine-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: openhab_pythonrule_engine-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for openhab_pythonrule_engine-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 73997864ae56f4fcd670ebb42e6bd25a7520b12e37a08ad3692b9c064dd25552
MD5 093e3f0ac64bd27fd9a036eee4af74e2
BLAKE2b-256 d53f0fe3fe36ac7475ea066931f52ae76c5d352796aa5b1afbb468a098ec1860

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page