Skip to content

Latest commit

 

History

History
156 lines (103 loc) · 4.6 KB

README.md

File metadata and controls

156 lines (103 loc) · 4.6 KB
Raw

Pushbullet Tasker JS

Send notes, links and/or local files to Pushbullet from Tasker.

Requirements

  • A Pushbullet account (a free one should suffice).

  • An Android device with Tasker installed in.

How to use it

  1. Get a Pushbullet API key from Settings > Account > Access Tokens > Create Access Token.

  2. In Tasker, create and assign the API key to the pb_token variable (see: Parameters).

  3. Load the library (locally or externally):

    • Local: Create new JavaScript action with the following parameter:

      • Path: /sdcard/pushbullet-tasker.js

    • External: Create a new JavaScriptlet action with the following parameters:

      • Code: // pushbullet-tasker-js/1.0.4

      • Libraries: https://cdn.jsdelivr.net/pushbullet-tasker-js/1.0.4/pushbullet-tasker.min.js

Parameters

The push parameters must be set before calling the JS library. They can be set in two interchangeable ways: locally (e.g., pb_token) and/or globally (e.g., PB_TOKEN).

  • PB_TOKEN: (required) Must contain your Pushbullet API Key.

  • PB_DEBUG: Enable debug (shows toast messages).

  • PB_TYPE: If set, the push will be automatically sent after loading the library. Value must be one of note, file or link.

  • PB_TITLE: The push title (e.g., My Push Title).

  • PB_BODY: The push body (e.g., My push content.).

  • PB_DEVICE_IDEN*: Device ID of the target device, if sending to a single device. (see: How to get the Device ID).

  • PB_EMAIL*: Email address to send the push to. If there is a pushbullet user with this address, they get a push, otherwise they get an email.

  • PB_URL: The URL to send (e.g., https://www.example.com). Used for link pushes.

  • PB_FILE_NAME: The name of the file you want to upload (e.g., cat.jpg). Used for file pushes.

  • PB_FILE_TYPE: The MIME type of the file (e.g., image/jpeg). Used for file pushes.

  • PB_FILE_PATH: Absolute path where the file is stored (e.g., /sdcard/DCIM/Tasker/cat.jpg). Used for file pushes.

* Both parameters, PB_DEVICE_IDEN and PB_EMAIL, are mutually exclusive. If they are omitted, the push will be sent to all devices.

How to get the Device ID

Manual/multiple pushes

NOTE: Ensure that the parameter PB_TYPE is not set, otherwise the library will try to send the push automatically

You can call the push methods manually in a JavaScriptlet. The parameters are similar but in lowercase and dropping the PB_ prefix. Not given parameters will be read from the environment, as usual.

try {
    var pb_title = 'Shared title';
    PB.pushNote({body: "My note content"});
    PB.pushNote({title: 'Overriding the shared title', body: "My content"});
    PB.pushLink({url: "https://example.com"});
    PB.pushFile({
        file_name: "cat.jpg",
        file_type: "image/jpeg",
        file_path: "/sdcard/cat.jpg"
    });
    // In Tasker: pb_file_path = "/sdcard/DCIM/Tasker/photo.jpg"
    PB.pushFile({
        file_name: "photo.jpg",
        file_type: "image/jpeg",
    });
} catch (e) {
    flashLong("Err: " + e.message);
}

Examples

Push note using external library

Push Note (ext. lib.) (1)
A1: Variable Set [ Name:%pb_token To:<insert-your-token> Do Maths:Off Append:Off ]
A2: Variable Set [ Name:%pb_type To:note Do Maths:Off Append:Off ]
A3: JavaScriptlet [ Code:// Libraries:https://cdn.jsdelivr.net/pushbullet-tasker-js/1.0.4/pushbullet-tasker.min.js Auto Exit:On Timeout (Seconds):45 ]

Take and push a photo

(TODO)

Useful links

Todo

  • Select target devices.

Changelog

1.0.4 (2016-07-24)

  • Simplified API parameters object building.

  • Added the ability to select the push target with the parameters PB_DEVICE_IDEN and PB_EMAIL.

1.0.2 (2016-07-23)

  • JSLint improvements.

  • Retrieved non-defined Tasker variables with tk.local/tk.global could potentially return as "undefined" (string) instead of undefined (value).

1.0.0 (2016-07-22)

  • First release