Rule Machine API

[bravenel]

Perhaps in the future. Not easy to do for now.

[Linvale]

@bravenel

Rule Machine maintains a list of available Rules, Triggers, Triggered Rules, and Actions. This list can be obtained with this method call:

 def rules = RMUtils.getRuleList()

The resulting list, in this example in the variable "rules", can be used as an input to an "enum", as the options.

When I access this list via an HTTP request I get a JSON response of the list of RM rule ids and their names, but don't seem to be able to access either the triggers or the actions of each of the rules.:

[
{
"939": "Bathroom Outlet Auto Off "
},
.........
{
"903": "Track Music Room Dimmers "
}
]

Is this correct? Is it possible to access the triggers and actions in a similar way via an HTTP request? Is it possible to access these for Simple and Motion lighting?

I am trying to create a "performance" monitor that follows the timing of trigger/app/action cycle and being able to access this information would be really helpful .

[bravenel]

They all come in that one list. getRuleList is not limited to "Rules", but grabs all child apps of RM.

[Linvale]

Thanks Bruce . I must be even dimmer than usual as all I seem to get is a listing of the rules from RM:

Here's the get request and response I see (minus my authentication token) .

Am I missing something in the rule definition that creates the local endpoint?

[bravenel]

From the OP above. You get the endpoint by creating a Trigger in RM.

@bravenel

It is also possible to cause Rule Machine to perform these same actions from an HTTP request. To do this one would create a Trigger or a Triggered Rule with either a Local End Point or Cloud End Point. The endpoint URL given by Rule Machine has this form:

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

To run rule actions this URL must be modified to include the list of rules and the action. The modification takes this form:

/action=rule1&rule2&rule3

Where action is the action from the list above and rule1&rule2&rule3 are the appIds of the rules to run separated by ampersands.

This parameter is inserted in the endpoint URL just before the ? that precedes the access_token, like this:

http://192.168.0.36/apps/api/10249/trigger/stopRuleAct=943&956&10217?access_token=ecd95469-bbcd-4889-a694-9b05ef80f4db

This example would do the same thing as the code example above, where 943&956&10217 are the appIds that were selected by consequence of the input for theseRules, and stopRuleAct is the action to perform.

[bravenel]

@Linvale

don't seem to be able to access either the triggers or the actions of each of the rules.

What does this mean? What are you trying to do? This API is for causing RM to run a rule, or other actions on rules from this list:

@bravenel

Set Private Boolean True :
action "setRuleBooleanTrue"

Set Private Boolean False :
action "setRuleBooleanFalse"

Evaluate Rule :
action "runRule"

Run Rule Actions :
action "runRuleAct"

Stop Rule Actions :
action "stopRuleAct"

Pause Rule :
action "pauseRule"

Resume Rule :
action "resumeRule"

[Linvale]

Ok that's my misunderstanding of what would be returned when accessing this.

"Rule Machine maintains a list of available Rules, Triggers, Triggered Rules, and Actions."

I am trying to access a list each of the triggers and actions for the rules that have been set up so I can identify the ""trigger(s) - rule - action(s)" sequence in the logs and track times for these responses in an effort to tweak the system performance by identifying slow responses, recording how often and when and when they occur.

Not what the API is intended to do - but would be really helpful as, at present, I'm identifying the sequences from the available socket streams, which is less than ideal.

[bravenel]

@Linvale

I am trying to access a list each of the triggers and actions for the rules that have been set up

There is no such facility.

[Linvale]

Thanks, as always, for the responses.

[bangali]

@bravenel couple of questions:

1. when "runRule" action is triggered does it evaluate any rules specified and then perform the true or false action based on result of rules evaluation?
2. when "runRuleAct" action is triggered does it always run the true action?

thank you.

[cwwilson08]

@Keo

Does RM accept JSON with the http request? I'd like to use information passed to the rule.

@bravenel

How would you use information passed to a rule? I'm not seeing how this fits the general model of RM.

Hi @bravenel I was wondering if something along these lines was possible. I would like to be able to pass in information from an outside call and either set a GV with the value or pass the attribute directly to a device driver.

Curious what your thoughts are. Thanks in advance.

[bravenel]

@bangali

when "runRuleAct" action is triggered does it always run the true action?

Yes, it runs the true actions of a rule or triggered rule.

[bravenel]

@cwwilson08

I would like to be able to pass in information from an outside call and either set a GV with the value or pass the attribute directly to a device driver.

I think this can be added to set a GV from an endpoint call. The value passed would be a string, and only a GV of type string would make sense. The string would be URL encoded, and then URL decoded into the GV. The GV could be passed as a string parameter to a driver using a custom action.

Would that work for you?

[cwwilson08]

@bravenel

hink this can be added to set a GV from an endpoint call. The value passed would be a string, and only a GV of type string would make sense. The string would be URL encoded, and then URL decoded into the GV. The GV could be passed as a string parameter to a driver using a custom action.

This sounds about perfect. Thanks for the consideration!

[bravenel]

This feature is now available in Rule 3.0, now released.

See [Released] Rule Machine 3.0 and the top post of this topic Rule Machine API

[cwwilson08]

@bravenel

This feature is now available in Rule 3.0, now released.

See [Released] Rule Machine 3.0 and the top post of this topic Rule Machine API

Wow now that is super fast service thanks as always @bravenel and hubitat team!!!

[cwwilson08]

@bravenel

This feature is now available in Rule 3.0, now released.

See [Released] Rule Machine 3.0 and the top post of this topic Rule Machine API

Trying to select cloud endpoint as a trigger gives me this error..

[bravenel]

OK, we messed up and didn't turn on OAuth. Will get it fixed.

[mik3]

I just updated he but it looks like it’s rule machine 2.5

[bravenel]

They look the same until you set up Actions.