Rule Machine API

[cwwilson08]

@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

I am having some difficulty figuring this out. I am not sure If I have the url correct. I do seem to get a 200 response though the global variable never changes.

Here is the url

http://192.168.1.129/apps/api/2832/trigger/setGlobalVariable=test2:abcdefgh?access_token=461f117c-95ad-4d52-8136-asdfadefdasdf

I changed up the access token but otherwise that is what I am trying to use.

and here is the response my node server gets.

Status: 200
Headers: {"connection":"close","date":"Thu, 02 May 2019 03:58:45 GMT","content-type":"text/html;charset=utf-8","server":"Jetty(9.4.z-SNAPSHOT)"}

Using the getRuleList example does work with this same url.

[bravenel]

Hmmm, that worked for me. Let me check.

Update: I found something amiss, and have a fix for it. Look at your logs and see if there is an error thrown.

[cwwilson08]

app:28322019-05-01 09:33:04.624 pm errorjava.lang.NullPointerException: Cannot invoke method getAt() on null object (endpointHandler)

guess i should have looked there too....

[cwwilson08]

@bravenel

ate: I found something amiss, and have a fix for it. Look at your logs and see if there is an error thrown

Looks like this is working now @bravenel. Many thanks.

[nh.schottfam]

Is there an event one can subscribe to know if a rule executed?

[bravenel]

Not directly, no. Rules can throw events, but there is no subscription mechanism for those (haven't thought about this much -- perhaps it should be possible to subscribe to such events). This could be done indirectly of course using a virtual device set by the rule and whose events are subscribed to. The limitation at the moment are the available subscribe() methods, limited to device and location events.

Makes me also wonder whether these app events might not possibly be done as location events instead, thus allowing subscription to them.

So, the ability to subscribe to app events would be an addition to the hub core, while the latter would be a change to apps. Will look into this...

Lots of hair on this one: You'd want a way to subscribe to a specific rule (or app). As you know, internally apps have an appId that is used to reference them. So there would be the hurdle of getting an appId from a rule name or app name. RM has this very issue in offering things like Run Actions or Set Private Boolean of another rule, and so it handles this stuff in the parent.

As it stands right now, Rules do not in general tell the parent they have run.

[xbohdpukc]

I re-read the first post at least 3 times and miserably failed to see clear instructions as to how to get the access point to use with HTTP requests. Please help.

[bravenel]

Set up a trigger event, either Cloud End Point or Local End Point, as appropriate to your use case. That will give you the link that you can right-click-copy.

@bravenel

Using Rule Machine from HTTP requests

It is also possible to cause Rule Machine to perform these same actions from an HTTP GET request. To do this one would create a Trigger Event 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

[xbohdpukc]

Thanks for that, I completely misunderstood that sentence.
So now I guess I misunderstand the rest. I construct a url as follows,

http://192.168.1.113/apps/api/AAA/trigger/action=BBB?access_token=XXX
where AAA is the Local End Point event id, BBB - another rule id I want to run and access_token is the AT I got from Local End Point event.

When executing in the browser I get this JSON,

http://192.168.1.113/apps/api/849/trigger/action=417?access_token=9d1fb079-7eb9-45ad-b724-af448b0e08d4

"status": "success",
"country": "United States",
"countryCode": "US",
"region": "TX",
"regionName": "Texas",
"city": "xx",
"zip": "xx",
"lat": xx,
"lon": xx,
"timezone": "America/Chicago",
"isp": "xx",
"org": "xx",
"as": "xx,
"query": "my public ip"

}

Is that what I am expecting to see? I did not see any effect of executing that rule, i.e. no lights changed.

[bravenel]

@bravenel

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

This one is too complex. A simple variant:

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

That's going to do a stopRuleAct against rule with appId 943. And that is triggering a rule with appId of 10249.

@xbohdpukc

http://192.168.1.113/apps/api/849/trigger/action=417?access_token=9d1fb079-7eb9-45ad-b724-af448b0e08d4

What action are you trying to do? "action=417" isn't right. It has to be one of these:

@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"

[xbohdpukc]

@bravenel

runRuleAct

Ah, that's much clearer. In the initial post since these all are over the post I didn't connect the dots that /action=XXX where action should be replaced with one of those. Okay, fair enough.

Ok so I have the following Rule with a trigger (850)

Then I have a rule to run (436)

So I construct this URL

http://192.168.1.113/apps/api/850/trigger/runRuleAct=436?access_token=xxx

and get this response
{

• error: true,
• type: "java.lang.Exception",
• message: "An unexpected error occurred."
  }

In the hub logs there's this msg,

app:8502020-10-17 07:46:38.062 pm errorjava.lang.NullPointerException: Cannot invoke method getAt() on null object on line 7182 (endpointHandler)

[bravenel]

OK, Hard to tell what caused that. Had you hit Done in both rules?

Separate question: Why are you trying to do this from an end point in the first place. Why not just have the rule with the End Point trigger run the action of the other rule?

[xbohdpukc]

Yes, both are done rules.
What I am trying to do is to replace my webCore pistons with Rules. For webCore pistons I have endpoints exposed, so that I can trigger them from my phone using Tasker. So that's exactly what I am trying to replicate with the Rule Machine. Are there better ways to achieve that?

[bravenel]

@xbohdpukc

Are there better ways to achieve that?

You can just trigger a rule with an end point. You don't need the rest of this.

[BorrisTheCat]

@xbohdpukc

so that I can trigger them from my phone using Tasker

I do this, using this

@bravenel

You can just trigger a rule with an end point.

You just copy the end point from the rule once it's creates one and paste it to taskers as a task event.

[xbohdpukc]

Okay, I just wanna make sure I understand what you both are saying... Here's a Rule that I want to trigger from Tasker. Where is its endpoint and how do I retrieve it?

[bravenel]

Create a Trigger Event for Cloud End Point. I showed that above in a screenshot.

[stephen_nutt]

Since you are doing this for a Tasker Profile, I recommend creating rule on phone instead of computer. Then you can right click on End Point in Trigger, Copy, the Paste into Tasker without having to type out the End Point.

[xbohdpukc]

So every Rule that I want to call remotely needs a cloud and/or local endpoint? Is that how they get exposed?

[bravenel]

Yes. They can have other Trigger Events also.