Rule Machine API

[stephen_nutt]

You can create both cloud and local endpoint as OR triggers in same rule. Then in Tasker, setup a variable that is set to "X" when connected to your home WiFi and "Y" when not. Then in Tasker, your task checks the value of that variable and sends appropriate HTTP Request.

[Angus_M]

Great thread. I didn't even realise we could trigger a rule from an endpoint. Today I learnt something once again Schweet.

[xbohdpukc]

Yep, thanks all for your help, I think I got it.
I don't use these endpoints in Tasker directly, I create a "web service" using AutoWeb - basically a collection of endpoints so that I can abstract tasker from direct calls.
Next step for me will be to figure out under which conditions to call the local endpoint, and under which a cloud one.

Again thanks all for your help, it took some time for me to wrap my head around this concept, but I guess I at last got it working

[stephen_nutt]

@xbohdpukc

I don't use these endpoints in Tasker directly, I create a "web service" using AutoWeb - basically a collection of endpoints so that I can abstract tasker from direct calls.

I don't have that piece of Tasker installed. I will have to give it a test.

[dcaton1220]

@bravenel

Get Rule List

To get the list of rules as is returned from getRuleList() use this insert for the URL:

/getRuleList

for full URL like this:

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

I assume the appiid is the appid of Rule Machine, as seen in http://10.0.0.102/installedapp/configure/6/mainPage.

But this: 10.0.0.102/apps/api/6/trigger/getRuleList?access_token=xxx

returns

<oauth>
<error_description>xxx</error_description>
<error>invalid_token</error>
</oauth>

What token do I use? The only places I can see to get a token is in the Maker API app, or in an individual rule if I create a local end point trigger. None of those tokens work. What am I missing here?

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

/setGlobalVariable=varName:varString

Is there an equivalent "get" global var? I know I can create a RM connector and enable it in the maker api and then query the device, but that's clumsy and clutters up the devices list.

Thanks.

[bravenel]

@dcaton1220

What token do I use?

Create an endpoint URL in a Rule (local or cloud as you may need), and that will have the access token in it. This is described in the original post above:

@bravenel

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

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

[bravenel]

@bravenel

/getRuleList

Hmmm, it does seem to be broken. Will investigate...

[dcaton1220]

@bravenel

Create an endpoint URL in a Rule (local or cloud as you may need), and that will have the access token in it. This is described in the original post above:

I assume then that what you mean by the above is "Create an endpoint URL in ANY rule, it doesn't matter which one, and that will have an access token you can use for getRuleList and setGlobalVariable". Is that correct?

Since getRuleList and setGlobalVariable have nothing to do with a specific rule, do you use the appid of the rule you got the token from, or the app id of Rule Manager itself for these two commands?

[bravenel]

The rule with the endpoint has to exist. The API access is via that rule.

[bravenel]

@bravenel

/setGlobalVariable=varName:varString

I just confirmed that setting a GV with this works.

[dcaton1220]

@bravenel

@bravenel

/setGlobalVariable=varName:varString

I just confirmed that setting a GV with this works.

Yes it does, but it also runs the rule. Is that intentional?

Is there a complimentary /getGlobalVariable? If not, can it be added?

If I try /getGlobalVariable I don't get an error but the rule runs.

[bptworld]

@bravenel

def rules = RMUtils.getRuleList()

Is there an update to this to pickup up the new RM 5.0 rules?

[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.

[bptworld]

Thank you!

[bcp123ez]

Thanks,

[stephack]

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

Happy New Year Bruce. I'm adding RM5 support to my ABC app. Can you tell me what the minimum HE firmware version is needed for RMUtils to support version 5? I want to include this info in my changelog.

[bravenel]

I don't know. That would take a lot of digging to find out.

[bertabcd1234]

@stephack

minimum HE firmware version

If you want to play it safe, it was probably somewhere in 2.2.8, so maybe the latest in that series, 2.2.8.156, would be something to specify (it was definitely there before 2.2.9, given that the post was made on August 21 and 2.2.9 was released on October 7).

[stephack]

Thanks...I'll put 2.2.9 as the minimum.

[putudhony88]

Can we do this as save rules?