maemo.org - Talk - [SailfishOS] [WIP] Phonebot: a mix between profilematic, IFTTT and on{X} to schedule actions on your phone

maemo.org - Talk (https://talk.maemo.org/index.php)

- Applications (https://talk.maemo.org/forumdisplay.php?f=41)

[WIP] Phonebot: a mix between profilematic, IFTTT and on{X} to schedule actions on your phone

Hi everybody,

After some discussions on TJC and some brainstorm, I'm proud to introduce phonebot, a scheduling daemon that takes inspiration from profilematic, IFTTT and on{X}

It has the following features

React to phone events, just like profilematic
If {events occurs} then {do something}, a bit like IFTTT (and profilematic too)
Scriptable using JS, just like on{X}, and QML

Architecture

phonebot isn't trying to reinvent the wheel. Since we are with Qt, we can take advantage of QML and JS to write rules. Actually phonebot is just reading QML files that contains rules. It uses the powerful QQmlEngine to do all the hard work of parsing, interpreting etc.

A Rule in phonebot is a QML component that have 3 properties

trigger: something that triggers the rule
condition: a condition (or conditions) to respect for the rule to be active
actions: a series of actions to execute when the rule is triggered, and when conditions are respected

The Trigger is in charge of emitting signals to run the Rule. Triggers could be: when it's 10pm, when you enter in the home wifi zone, when Battery reached a certain level etc.

The Condition do not provide any signal, and represent more a state. A Condition could be "when driving", "when at home" etc. (even if implementing this kind of condition is rather tricky).

An Action is what to run: execute a program, turn on / off some settings, change an ambience, or use DBus to do stuff.

Here is an example of scripted rule. You will also be able to configure rule with a friendly UI (using default Triggers, Conditions and Actions).

Code:

import org.SfietKonstantin.phonebot 1.0

import org.SfietKonstantin.phonebot.debug 1.0



Rule {

    name: "SimpleRule"

    trigger: DebugTrigger { path: "/test" }

    actions: LoggerAction {}

}

Rules are stored inside ~/.config/harbour-phonebot/<rule-folder>/rule.qml, you can add your own rule or take a look at rules generated by the client.

How to use

If you are running the harbour version (that is the only version being released), you should keep the application always on to have rules working.

To add a rule, use the pull down menu on the main page, you will then have to

Give a name (optionnal)
Configure a trigger
Configure a condition (optionnal)
Add some actions

Configure a component (Trigger, Condition or Action)

First, select the component you want to configure. A dialog will appear, asking you to select a component type. By clicking on this entry, you will be shown a list of components. Select the one you want.

Then, you will come back to the previous dialog. You will see that the selected component is shown in the component type, and you will be able to configure it.

Configure it, and accept to have the component configured. Remember that you need at least a trigger, to trigger an action, and an action to be triggered.

Download

harbour-phonebot 0.1.1: OBS
phonebot source code: GitHub

Of course, this post will be updated when new features comes.