Pushover image support

andre77 · April 3, 2018, 9:02am

its actually a pain point with so many methods, currently we have 23 of them
its due to different parameters, which are optional. see my last comment on the PR

simple example, curently we have this two methods among others:

pushover(String message, String device)
sendPushoverImage(String message, String attachment)

you see the difference

andre77 · April 3, 2018, 11:03pm

a big refactoring is finished, the builder pattern is in place, feel free to try
readme
snapshot jar is updated
feedback is very appreciated

sihui · April 4, 2018, 6:45am

I like breaking changes

I tried

sendPushoverMessage(pushoverBuilder("test message"))
sendPushoverMessage(pushoverBuilder("test message").withAttachment("/path/to/file.jpeg"))
sendPushoverMessage(pushoverBuilder("test message").withDevice("DEVICE"))

on a #1246 openHAB snapshot without any issues.

THANKS!

andre77 · April 4, 2018, 6:56am

compared to the latest stable version of the binding we do not have breaking changes, since all older methods are still supported, they are deprecated though

sihui · April 4, 2018, 7:21am

Thx for clarifying.

kintrupf · April 10, 2018, 8:46pm

Either I’m to stupid or it does not work any more
I got the supposedly latest snapshot jar from here:

http://areiter.net/org.openhab.action.pushover-1.12.0-SNAPSHOT.jar

I replaced my former snapshot.jar (1.12.0.201803261500) with this version (1.12.0.201804032255, dated 04.04.2018). It resides in my addons folder with an updated ZWAVE binding (which works fine, so this addon folder is used) and the pushover action is NOT installed via Paper UI. Naturally, I restarted openHAB

I still get this warning in my log file:

Going to buffer response body of large or unknown size. Using getResponseBodyAsStream instead is recommended.

I can use the standard pushover action, but get an ‘?’ instead of an umlaut character on my phone.

If I try to use the new sendPushoverMessage instead I’ll get this error in my log:

The name 'sendPushoverMessage' cannot be resolved to an item or type; line 107, column 5, length 95

What may be wrong?

kintrupf · April 11, 2018, 12:17pm

Solved! It looks like the older snapshot jar still lived somewhere in a cache or tmp folder of openHAB and was preferred by openHAB, maybe because the filename of the .jar-file did not change between versions?
After clearing those folders and restarting openHAB all problems are solved

cweitkamp · April 17, 2018, 3:36pm

Hi Hartmut,

Assuming you are using the snapshot version of OH2 have a look at the snapshot documentation:

github.com

openhab/openhab1-addons/blob/master/bundles/action/org.openhab.action.pushover/README.md

# Pushover Actions

The Pushover action service allows you to notify mobile devices of a message using the Pushover API web service.

## Configuration

You may define default values for parameters to action calls in the file `services/pushover.cfg`.
None of the configuration parameters are required as you can specify required configuration items in the action call, but you must at least provide an *API Token*, *User/Group Key* and a *Message* in some manner before a message can be pushed.

| Property        | Default | Required                                          | method to set                       | Description                                                                                                            |
|-----------------|---------|:-------------------------------------------------:|-------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| defaultTimeout  | 10000   | No                                                | -                                   | Timeout in milliseconds for the connection to pushover.net                                                             |
| defaultToken    |         | if using action call without `apiToken` parameter | withApiKey(String apiKey)           | Pushover [API token](https://pushover.net/api) to send to devices                                                      |
| defaultUser     |         | if using action call without `userKey` parameter  | withUser(String user)               | Pushover User or Group key (not e-mail address) of your user (or you) to send to devices.                              |
| defaultTitle    | openHAB | No                                                | withTitle(String title)             | Application title for the notification                                                                                 |
| defaultPriority | 0       | No                                                | withPriority(int priority)          | Priority of the notification, from -2 (low priority) to 2 (high priority)                                              |
| defaultUrl      |         | No                                                | withUrl(String url)                 | URL to attach to the message if not specified in the command. This can be used to trigger actions on the device.       |
| defaultUrlTitle |         | No                                                | withUrlTitle(String urlTitle)       | URL title to attach to the message if not specified in the command. This can be used to trigger actions on the device. |
| defaultRetry    | 300     | No                                                | -                                   | When priority is 2 (high priority), how often (in seconds) should messages be resent                                   |
| defaultExpire   | 3600    | No                                                | -                                   | When priority is 2 (high priority), how long (in seconds) to continue resending messages until acknowledged            |

This file has been truncated. show original

lfs_alp5 · April 19, 2018, 12:33pm

Is this version added to the snapshot release(s) or do I have to manually download it?

sihui · April 19, 2018, 12:50pm

Yes.

Sim · April 23, 2018, 10:48am

Is it possible to use “URL” instead of “local file”?

This is my .sitemap

Text label="Garden" icon="garden" {
    Image url="http://192.168.1.123/channels/1/picture" refresh=3000
}

And I need to push that “Image” from “real-time”

Regards

Sim

andre77 · April 23, 2018, 11:04am

@Sim
yes, not directly though
this is, how i do it

val camURL = "http://user:pw@camera1/Streaming/channels/1/picture"
val file = now.toString.replaceAll("[:\\/ \\+]+", "_") +".jpg"
val outputFile = "/tmp/camera/" + file
var String curl_result = executeCommandLine("curl -m 10 -o " + outputFile + " " + camURL, 5000)
sendPushoverMessage(pushoverBuilder(msg).withAttachment(outputFile))
// delete the temp file after 60 seconds
createTimer(now.plusSeconds(60)) [|
    executeCommandLine("rm " + outputFile)
]

“curl” must be installed

waspie · April 23, 2018, 1:28pm

are there plans to support OH image items?

cweitkamp · April 23, 2018, 3:48pm

Hi scott,

let’s assume you have an Image item called Webcam_Image. You can adjust the above script in the first line:

val camURL = Webcam_Image.state.toFullString
val file = now.toString.replaceAll("[:\\/ \\+]+", "_") +".jpg"
...

// Edit: I filed an issue for it:

waspie · April 23, 2018, 6:22pm

even better would be
sendPushoverMessage(“message”,openHabImageItem)

FatherTime · May 5, 2018, 1:31am

With Openhab 2.2 I only have the option of getting version 1.11.0 which does not seem to have this support. Can anyone explain where to get a newer version?

Edit: Sorry, just figured that it would be available normally considering the new documentation is up. I understand now that it needs to be manually downloaded / installed for now.

Edit2: Doesn’t seem to be working?
19:54:53.426 [ERROR] [untime.internal.engine.RuleEngineImpl] - Rule ‘driveway_camera_alert_rule’: The name ‘sendPushoverImage’ cannot be resolved to an item or type; line 67, column 3, length 87

253 │ Active │ 80 │ 1.12.0.201804032255 │ openHAB Pushover Action

Edit3: What kintrupf said about the cache seems correct? I had to restart openhab to get the binding to load properly. Everything is working now. I found a link to the latest module I think here: https://openhab.jfrog.io/openhab/libs-pullrequest-local/org/openhab/action/org.openhab.action.pushover/1.12.0-SNAPSHOT/
It is what the latest documentation describes: https://docs.openhab.org/addons/actions/pushover/readme.html

Nice work guys! Pretty awesome!

ricadelic · May 5, 2018, 10:57pm

First of all, thanks for putting all your effort in this great binding!

I’m trying to get the new Pushover commands working in Jython. The following works in xTend:

sendPushoverMessage(pushoverBuilder(msg))

But this doesn’t work in Jython:

Pushover.sendPushoverMessage(pushoverBuilder(msg))

(The command pushover(msg) works, via Pushover.pushover(msg)

Does anyone has an idea what the Jython syntax should be?

cweitkamp · May 6, 2018, 3:47pm

Hi @ricadelic,

I am not familiar with Jython and do not know if I can help you very much. But if the Jython syntax requires to prepend the class name in front of a method name you maybe can try to use it like this:

Pushover.sendPushoverMessage(Pushover.pushoverBuilder(msg))

ricadelic · May 6, 2018, 5:10pm

That works! Thanks a million

cweitkamp · May 6, 2018, 6:28pm

Sounds good. You’re welcome.