runRule equivalent in Python scripting

pap166 · June 4, 2026, 5:48pm

The rules.runRule() function is part of the openHAB JavaScript Scripting library, used to programmatically trigger another rule from within a script or rule.

I am wondering If there ist a similar function in Python Scripting. Any modules to be imported?

Searching the docs and the web was not helpful so far. Thanks.

holger_hees · June 5, 2026, 2:44pm

At the end, all languages are using the java api. I just checked the js source code

github.com/openhab/openhab-js

src/rules/rules.js

04efe5b8d


      
          /**
            * Runs the rule with the given UID. Throws errors when the rule doesn't exist
            * or is unable to run (e.g. it's disabled).
            *
            * @memberof rules
            * @param {string} uid the UID of the rule to run
            * @param {Record<string, unknown>} [args={}] args optional dict of data to pass to the called rule
            * @param {boolean} [conditions=true] when true, the called rule will only run if it's conditions are met
            * @throws {Error} throws an error if the rule does not exist or is not initialized.
            */
          function runRule (uid, args = {}, conditions = true) {
            const status = ruleManager.getStatus(uid);
            if (!status) {
              throw Error('There is no rule with UID ' + uid);
            }
            if (status.toString() === 'UNINITIALIZED') {
              throw Error('Rule ' + uid + ' is UNINITIALIZED');
            }
          
            ruleManager.runNow(uid, conditions, new HashMap(args));
          }

Just port this to python and it should work.

If you are not successful, I can provide a more detailed example. Currently I’m afk.

pap166 · June 5, 2026, 3:48pm

Hi Holger,
thanks a lot. Your feedback was leading me to the following description:

from core import osgi
ruleEngine = osgi.get_service("org.openhab.core.automation.RuleManager")
ruleEngine.runNow(ruleFunction.UID)

In my case the import of osgi fails. I get this error:

ModuleNotFoundError, No module named 'core'
Please, advice. Thanks.

holger_hees · June 5, 2026, 4:45pm

following the javascript example, you must do the following things

Get the rule service
Check the rule
call runNow on the rule manager

from openhab.services import getService

ruleManager = getService('org.openhab.core.automation.RuleManager')

status = ruleManager.getStatus("<myruleid>")

if not status:
     print("your rule does not exists")

if status == "UNINITIALIZED":
     print("your rule is not initialized")

ruleManager.runNow("<myruleid>", True, {});

btw. the example on openhab scripters are outdatet since years and not maintained by any openhab dev.

pap166 · June 10, 2026, 3:42pm

Thanks a lot. Your example is working as expected and is solving my problem.
Where do I find related information in the docs? I don’t want to bother you in the future.

holger_hees · June 11, 2026, 12:42pm

I improved the documentation