Tasker Plugin #1435

christian-n · 2019-02-17T18:47:03Z

Tasker Plugin

Features

Tasks over Intents
Task Service for scheduling
Event based tasks with threshold
Full-fledged user settings
Easy to implement

Implemeted devices

XWatch

Quickstart

To implement a device add a TaskerDevice like

    XWATCH(DeviceType.XWATCH, new XWatchTaskerSpec(DeviceType.XWATCH));

all you need is a DeviceType and a TaskerSpec. Last thing is to add the TaskerBleProfile to your AbstractBTLEDeviceSupport like

    addSupportedProfile(new TaskerBleProfile<>(this, TaskerDevice.XWATCH));

Note
If you want generic user settings you MUST extend AbstractTaskerSpec or atleast use PreferenceTaskerSettings as TaskerSettings.

Tasker Hook

Tasker hook is done with TaskerBleProfile as an AbstractBleProfile (correct me if this is not the best way).

Tasker Service

The AbstractTaskerService is used to schedule TaskerTask's. The threshold is used to cumulate calls. The TaskerEvent is then send with the specific amount of calls within that threshold.
The default service for the hook is SpecTaskerService.

It uses the TaskerSpec's TaskerSettings as configuration. There is a TaskerService implementation for programmatic use.

Tasker Event

The default TaskerEventType's are

Button: For button related events.
Connection: For bluetooth connection related events.
Data: For data receiving related events.
No_op: For non operational events.

You can easly add more types via TaskerEventType class. It does not effect the already implemented devices.
Don't forget to add your type to

    public static List<TaskerEventType> getTypes() {
        return Arrays.asList(BUTTON, CONNECTION, DATA);
    }

And for device support add it to the device's TaskerSpec

    List<TaskerEventType> getSupportedTypes();

Tasker Settings

Tasker user settings are implemented via

TaskerActivity

As main entry point from SettingsActivity. It lists TaskerDevice's and has a enabled preference for overall tasker support.
Forwards to TaskerEventsActivity.

TaskerEventsActivity

Scoped with TaskerDevice

Lists all event types from TaskerSpec's getSupportedTypes() method.
Forwards to TaskerEventActivity.

TaskerEventActivity

Scoped by TaskerDevice and TaskerEventType

Has preferences for

Enabling the events
Enabled the threshold
Setting the threshold
Setting a task name
Adding/Removing more tasks for threshold calls (like double button press)

ToDo

More devices should be implemented.
Only EN and DE is currently translated.

Commit Information

Includes JavaDoc

…ill need to implement dynamic event activity.

…ope.

cpfeiffer · 2019-02-21T22:55:23Z

Wow, that's very nice! I will review this (and some other PRs) tomorrow.

IzzySoft · 2019-02-22T09:50:47Z

Though this might bring us the NonFreeAdd AntiFeature ("promoting" a non free app) at F-Droid, I can't wait to see this 😃

cpfeiffer

I made it through the review 😄, looks great, thanks again 👌

Since I don't have an XWatch, I'll adapt it to the Bip to try it out. AFAICS it's just a few lines of code.

cpfeiffer · 2019-02-24T09:54:04Z

app/src/main/java/nodomain/freeyourgadget/gadgetbridge/tasker/event/TaskerEventType.java

+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;


Nit: usually one uses instanceof instead of comparing the classes by identity. Otherwise it would be impossible for (technical) subclasses to be equal to the superclass. One example would be subclassing for testcases.

cpfeiffer · 2019-02-24T10:17:07Z

app/src/main/java/nodomain/freeyourgadget/gadgetbridge/tasker/plugin/TaskerBleProfile.java

+ *
+ * @param <T> Bluetooth LE support class extends {@link AbstractBTLEDeviceSupport}
+ */
+public class TaskerBleProfile<T extends AbstractBTLEDeviceSupport> extends AbstractBleProfile<T> {


That is a very creative idea to make tasker support pluggable and reusable 😄

Subclasses of AbstractBleProfile are reusable implementations of BLE profiles (e.g. for setting time, alarms, heart rate, etc.).

This is rather an event handler that does no further BLE communication. Need to think&check if we can add an interface for that, in addition to the profiles without duplicating code (just thinking loud for now, no action required).

cpfeiffer · 2019-02-24T10:22:39Z

app/src/main/java/nodomain/freeyourgadget/gadgetbridge/tasker/event/TaskerEventType.java

+    }
+
+    public TaskerEventType withIndex(int index) {
+        TaskerEventType taskerEventType = new TaskerEventType();


The builder-like approach (create().withIndex().withLocalization()) looks nice, but IMHO one or two constructors would be more sensible, since the events would be immutable then.

cpfeiffer · 2019-02-24T10:25:17Z

app/src/main/java/nodomain/freeyourgadget/gadgetbridge/tasker/service/TaskerUtil.java

+    /**
+     * Creates a {@link android.widget.Toast} for the user to show that Tasker is enabled but no task is defined.
+     */
+    public static void noTaskDefinedInformation() {


You can use GB.toast() that does all the event loop handling (and logging in addition) for you.

cpfeiffer · 2019-02-24T11:32:17Z

app/src/main/java/nodomain/freeyourgadget/gadgetbridge/devices/xwatch/XWatchTaskerSpec.java

+                return TaskerEventType.BUTTON;
+            }
+            if (data[0] == XWatchService.COMMAND_CONNECTED) {
+                return TaskerEventType.CONNECTION;


I think that such events would rather be handled generically via GBDevice#getState() changes (see GBDevice#sendDeviceUpdateEvent()).

The AbstractDeviceSupport#handleGBDeviceEvent() methods are probably also good candidates for a generic implementation.

Can you give me more info on that.

christian-n · 2019-02-24T15:06:57Z

I will be on it tomorrow. Thanks for the review!

…ntType.

christian-n · 2019-03-03T17:27:44Z

@cpfeiffer Ive done some of your fixes but i dont know what to do with getState.
Seems no one is using it. at least ive looked up the XWatchSupport and MiBandSupport.
And i could not find the method sendDeviceUpdateEvent()

cpfeiffer · 2019-03-03T19:11:37Z

Thanks for the updates!

GBDevice#getState() is used all over the place. It's the state describing whether a device is disconnected, connected, initializing, busy, etc. I thought that these state changes would be good candidates for tasker interaction, especially since they could be handled in a device independent way.

The *Support-classes usually only set the state, but don't react to any changes.

cpfeiffer · 2019-03-03T19:15:29Z

Please let me know if I should explain in more details.

christian-n added 17 commits December 28, 2018 21:45

First tasker draft.

e860d78

Added Tasker plugin with service and events.

be6a3e3

Fist draft for tasker settings.

26af4c4

Added tasker activities and dynamic building.

88c823d

Added tasker activities in draft state. Still buggy.

0ecff3f

Settings now complete.

9dee59f

TaskerSettings now binded to TaskerActivities.

c6b20ea

Finished activities. Fixed some bugs. Added scopes for preferences. S…

85c3d40

…ill need to implement dynamic event activity.

TaskerEventSettings are now fragment based and scoped.

20e14ec

Changed Settings to Fragment based perferences and implemented the sc…

a857be6

…ope.

Finished scope settings. Loading is still missing.

3fb1c70

Added all tasker plugin classes.

015898d

Started bug fixing.

b54b306

Added task removal.

82cec63

Fixed threshold values.

554a9a9

Merge branch 'master' of https://github.com/Freeyourgadget/Gadgetbridge

2aeb993

Merged origin.

4b9e9f0

cpfeiffer self-assigned this Feb 21, 2019

cpfeiffer reviewed Feb 24, 2019

View reviewed changes

christian-n added 2 commits March 3, 2019 17:41

Changed to GB.toast, fixed equals and added constructors to TaskerEve…

7e736a4

…ntType.

Merged with master.

14db704

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tasker Plugin #1435

Tasker Plugin #1435

christian-n commented Feb 17, 2019

cpfeiffer commented Feb 21, 2019

IzzySoft commented Feb 22, 2019

cpfeiffer left a comment

cpfeiffer Feb 24, 2019

cpfeiffer Feb 24, 2019

cpfeiffer Feb 24, 2019

cpfeiffer Feb 24, 2019

cpfeiffer Feb 24, 2019

cpfeiffer Feb 24, 2019

christian-n Mar 3, 2019

christian-n commented Feb 24, 2019

christian-n commented Mar 3, 2019 •

edited

cpfeiffer commented Mar 3, 2019

cpfeiffer commented Mar 3, 2019

Tasker Plugin #1435

Are you sure you want to change the base?

Tasker Plugin #1435

Conversation

christian-n commented Feb 17, 2019

Tasker Plugin

Features

Implemeted devices

Quickstart

Tasker Hook

Tasker Service

Tasker Event

Tasker Settings

TaskerActivity

TaskerEventsActivity

TaskerEventActivity

ToDo

Commit Information

cpfeiffer commented Feb 21, 2019

IzzySoft commented Feb 22, 2019

cpfeiffer left a comment

Choose a reason for hiding this comment

cpfeiffer Feb 24, 2019

Choose a reason for hiding this comment

cpfeiffer Feb 24, 2019

Choose a reason for hiding this comment

cpfeiffer Feb 24, 2019

Choose a reason for hiding this comment

cpfeiffer Feb 24, 2019

Choose a reason for hiding this comment

cpfeiffer Feb 24, 2019

Choose a reason for hiding this comment

cpfeiffer Feb 24, 2019

Choose a reason for hiding this comment

christian-n Mar 3, 2019

Choose a reason for hiding this comment

christian-n commented Feb 24, 2019

christian-n commented Mar 3, 2019 • edited

cpfeiffer commented Mar 3, 2019

cpfeiffer commented Mar 3, 2019

christian-n commented Mar 3, 2019 •

edited