Rule Machine API

[ritchierich]

@bravenel

The "appLabel" parameter is passed and will appear in the log entry that the rule makes when it performs the action commanded. Typically, simply pass app.label, for the name of the app that is causing the action. This has no other function than logging.

Example:

 def rules = RMUtils.getRuleList()
 input "theseRules", "enum", title: "Select which rules to stop", options: rules
 RMUtils.sendAction(theseRules, "stopRuleAct", app.label)

@bravenel

Set Hub Variable

A Hub Variable can be set by an endpoint trigger. The format for the parameter is this:

/setHubVariable=varName:varString

The varString portion is assumed to be URL encoded, and is URL decoded before being stored into the varName Hub Variable.

Set Global Variable

A Global Variable can be set by an endpoint trigger. The format for the parameter is this:

/setGlobalVariable=varName:varString

@bravenel does the RMUtils API allow the setting of hub or global variables? I see you can set them via endpoint trigger but hoping the RMUtils API allows this as well. If so what is the syntax to pass the variable name and variable value?

If I take your example above would expect something like the following:

def rules = RMUtils.getRuleList()
input "theseRules", "enum", title: "Select which rules to stop", options: rules
RMUtils.sendAction(theseRules, "setHubVariable", "varName:varString")
RMUtils.sendAction(theseRules, "setGlobalVariable", "varName:varString")

[bertabcd1234]

I'm not sure about "legacy" global variables, but hub variables have their own API (this is no longer an RM-specific feature), and documentation on them can be found here for the time being:

How to use Hub Variables in apps

This is a brief introduction to how to use Hub Variables in user apps. Please note: expect for Variable Connectors to be phased out in favor of direct access to Hub Variables. Existing connectors will, of course, continue to work. But, the ability to create new ones will be deprecated at some point. Hub Variables Methods GlobalVariable (Object) getGlobalVar(String name) GlobalVariable: [name: xx, type: xx, value: xx, deviceId: xx, attribute: xx] Note: value is already cast to created data…

[lairdknox]

@bravenel

Yes, sorry that I haven't caught up with the documentation yet.

def rules50 = RMUtils.getRuleList('5.0')

and for actions:

RMUtils.sendAction(rule50abc, 'pauseRule', app.label, '5.0')

Defaults to Rule-4.1 when omitted.

Would you kindly add this to the original post? I’ve been spinning my wheels on this for hours. It might help somebody else in the future.

Thank you.

[bertabcd1234]

I'd suggest just looking at the documentation (which has, indeed, since been updated) instead:

https://docs2.hubitat.com/apps/rule-machine#rule-machine-api

[lairdknox]

I had seen that at some point last night but wasn’t finding it again. At the time I didn’t note the differences.

A link in the OP would be helpful if not an update.

[DubbyDad]

Perhaps I'm mis-reading this aspect of the Rule Machine API docs, which explains how the following GET call can be invoked for triggering more than one RM rule at a time using HTTP:

http://[hub-IP]/apps/api/723/trigger/runRule=723&729?access_token=ca0199c9-618c-4203-9d9e-99xxxx

However, repeated attempts have only triggered the 1st rule (appid 723, which makes a lot of sense), but not the 2nd rule (appid 729). The response I get in the Web browser is:

{'result':'Triggered with runRule=723&729'}

...which, on its face, suggests that the intent was for both rules to be triggered. For the record, both rules include a Trigger of "Local Endpoint" and both work as expected when called with their respective RM URLs. Just not in tandem.

So I'm left with these questions, which I hope someone smarter than me can shed light on:

1. Must each Rule contain a Trigger of type Endpoint in order to be executed by the runRule URL?
2. Have I formed the multi-Rule calling URL correctly?
3. Am I missing some other crucial setup for this construct to work?
4. What is the format (if not JSON) of the response object? (I don't see a list of all possible Success and Error responses listed in the Docs, but didn't hunt far)

Appreciate any enlightenment on this obscure-but-powerful API.

[thebearmay]

Maybe:

http://[hub-IP]/apps/api/723/trigger/action=723&729?access_token=ca0199c9-618c-4203-9d9e-99xxxx 

action instead of runRule

[DubbyDad]

It's my understanding that action in this context is simply a placeholder word standing in for a list of potential actions, like runRule per the Docs. But I will try it ASAP, thanks!

RESULT: {'result':'Triggered with action=723&729'}
(and rule 723 ran while the other one did not, like before). Looks like the response( ) is just a recapitulation of the input string ingredients.

[BorrisTheCat]

@bravenel trying to set a HV Boolean to try from a local endpoint read the instructions but I must be missing something

http://192.168.1.81/apps/api/8938/setHubVariable=StevenInBed:True?access_token=(the access token)

Where the variable is StevenInBed. Is this correct/ what am I doing wrong?

[bravenel]

I will look into it...

[bravenel]

@BorrisTheCat

what am I doing wrong?

should be "true", not "True".

[BorrisTheCat]

Also tried that before I put True. Still didn't work.

However the key thing is I'm on the correct lines?

[bravenel]

No, your URL isn't right.

http://192.168.0.36/apps/api/10249/trigger/setHubVariable=StevenInBed:true?access_token=ecd95469-bbcd-4889-a694-9b05ef80f4db

[Slate]

If that is your actual access_token, you might want to delete it.

[bravenel]

@Slate

If that is your actual access_token, you might want to delete it.

Some access token from a few years ago and some other hub. At this point, a meaningless string.

[Slate]

I should have know.

[DrRomca]

Hello!

I've been searching for some time but never found a solution to my issue:

Is it possible to read a local variable from a Rule Machine Rule as a JSON somehow?
I need to read it with my PC dashboard web page.

Thank you!

[sburke781]

I'm not sure about with RM, but as an alternative, you could look at setting up a Hub Variable with a connector and adding the connector to the list of devices available via a Maker API instance.