[ul]Current Version : 0.98
If you are a Push Over user, upgrade to this version and use your Own Application Key.
Hi, All
A plugin for sending notification using the following Push Services
[list]
[li]Prowl (IOS) [/li]
[li]PushOver (IOS and Android)[/li]
[li]Toasty (Windows Phone)[/li]
[li]XendApp (IOS, Android, Windows RT, Windows Phone )/li]
[/list]
Notes about service limitations:
Prowl : Have a limit of 1000 messages per hour
PushOver : Messages limit per Month (Use Custom Application key to allow 7500 messages Per User/Per Month) , Messages are currently limited to 512 characters, including a title. Supplementary URLs are limited to 500 characters, and URL titles to 50 characters.
Toasty : Image file must be in .png format and no larger than 128x128 pixels.
XendApp : No restriction founds on provider Web Site.
General Functions
[list]
[li]Summary Tab[/li]
[li]Tab for Each Service Parameters[/li]
[li]Last Error/Succes repport on Dashborad[/li]
[li]Ability to reset number of sent message for each service[/li]
[li]Ability to send test message for each service from the setup tab[/li]
[/list]
Prowl Functions
[list]
[li]HTTPS connexion to server to preserve your ID[/li]
[li]Add serial of sending Unit to subject[/li]
[li]Use priority in notification[/li]
[li]Ability to Add URL in notification[/li]
[/list]
PushOver Functions
[list]
[li]Allow custom application key (Allow 7500 Messages per User/per Month)[/li]
[li]HTTPS connexion to server to preserve your ID[/li]
[li]Add serial of sending Unit to subject[/li]
[li]Use priority in notification[/li]
[li]Ability to Add URL in notification[/li]
[li]Ability to Add URL Title in notification[/li]
[li]Ability to change notification sound[/li]
[/list]
Toasty Functions
[list]
[li]Add serial of sending Unit to subject[/li]
[li]Add your own image in notification[/li]
[/list]
XendApp Functions
[list]
[li]Add serial of sending Unit to subject[/li]
[li]Use multiple channels for notification[/li]
[/list]
Tested only with UI5 on Vera Lite (1.5.408)
VERSION HISTORY
[list]
[li]0.5 Initial public release[/li]
[li]0.6 Add priority, and URL parameters[/li]
[li]0.7 Add PushOver support, Change summary Tab, Add Tabs for service setup, Prowl remaining messages and reset date are now moved on Prowl Tab[/li]
[li]0.8 Add URL, URL Title Priority to PushOver service, GUI modification, Bug Fixes, Rename to Push Notification[/li]
[li]0.9 Change PushOver service usage, Bug Fixes, New Icon[/li]
[li]0.91 Add new PushOver Quiet priority[/li]
[li]0.92 Add new PushOver Per-notification Sounds function (Require Version 1.5+ of Mobile Application), and Ability to send Test message from Setup Tab.[/li]
[li]0.93 Add toasty Service Support, Move test message to specific tab, Improve PushOver code.[/li]
[li]0.94 Add toasty image notification.[/li]
[li]0.95 Extend PushOver API Usage.[/li]
[li]0.98 Add XendApp Notification, Remove PushOver Limits by using your Own application Key.[/li]
[/list]
INSTALLATION
Automatic Installation version may be older due to validation Delay
Automatic
https://apps.mios.com/plugin.php?id=2508
Manual
Upload the plugin files :
- In the Toolbox section open MiOS Developers >> Luup Files and upload all the files you downloaded. check the Restart Luup after upload checkbox and click GO.
Create the IOS Notification Device:
- Open Create Device.
- In the UpnpDevFilename input box enter D_IosPush.xml
- In the Upnp Implementation Filename input box enter I_IosPush.xml
- In the Description input box enter a name for the panel device, e.g. My Push Notification.
- Click Create device.
- Close this window and Save.
Configuration
Go to the corresponding service Tab and Fill the required parameters
Advanced Configuration
- In the device advanced control tab, you can find the following parameters (See screenshot)
[list]
[li]Plugin Version[/li]
[li]Plugin ID (Internal Usage)[/li]
[li]Status (Unused)[/li]
[li]Last Error message with readable time[/li]
[li]Message (Update notification … )[/li]
[li]Prowl API Key[/li]
[li]Prowl Application Name[/li]
[li]Add serial of sending Unit to Prowl notification[/li]
[li]Prowl Default Priority[/li]
[li]Number of successfull Prowl notification sent[/li]
[li]Number of remaining usable prowl message for the actual period[/li]
[li]Timestamp of prowl reset date[/li]
[li]PushOver User Key[/li]
[li]PushOver Custom Application Key (Details here) [/li]
[li]Activate Use of your Custom Application Key[/li]
[li]PushOver Application Name[/li]
[li]PushOver Default Sound[/li]
[li]PushOver Sounds List[/li]
[li]Add serial of sending Unit to PushOver notification[/li]
[li]PushOver Default Priority[/li]
[li]Number of successfull PushOver notification sent[/li]
[li]Timestamp of last Error[/li]
[li]Timestamp of last successful send[/li]
[li]Toasty Device ID[/li]
[li]Add serial of sending Unit to Toasty notification[/li]
[li]Toasty Application Name[/li]
[li]Number of successfull Toasty notification sent[/li]
[li]XendApp UserName[/li]
[li]XendApp Password[/li]
[li]XendApp Application Name[/li]
[li]XendApp channel Name List[/li]
[li]XendApp channel ID List[/li]
[li]XendApp Default Channel[/li]
[li]XendApp Message Encryption[/li]
[li]XendApp Content type Option ( Can be 1 or 2). 1 - PlainText, 2 - HTML.)[/li]
[li]Add serial of sending Unit to XendApp notification[/li]
[li]Number of successfull XendApp notification sent[/li]
[li]Prowl API message URL[/li]
[li]PushOver API message URL[/li]
[li]PushOver API Sound List URL[/li]
[li]Toasty API URL[/li]
[li]Toasty Image URL[/li]
[li]XendApp API URL[/li]
[li]Debug Flag[/li]
[/list]
[size=10pt]USAGE IN SCENE[/size]
You just have to fill informations in bold the other can be left blank if not used
SendProwlNotification action
Send a notification using Prowl service
[list]
[li]Event[/li]
[li]Description[/li]
[li]Priority[/li]
[li]URL[/li]
[/list]
The value for priority can be :
-2 Very Low
-1 Moderate
0 Normal
1 High
2 Emergency
SendPushOverNotification action
Send a notification using PushOver service
[list]
[li]Title[/li]
[li]Message[/li]
[li]Priority[/li]
[li]URL[/li]
[li]URL Title[/li]
[li]Sound[/li]
[/list]
The value for priority can be :
0 Normal
1 High
-1 Quiet
The value for sound can be :
bike
bugle
cash Register
classical
cosmic
falling
gamelan
incoming
intermission
magic
mechanical
piano Bar
siren
space Alarm
tug Boat
This list can change and is automaticaly updated from PushOver web site, so if you want the last updated list,
use pushoversoundlist field in the advanced tab.
SendToastyNotification action
Send a notification using toasty service
[list]
[li]Title[/li]
[li]Message[/li]
[li]ImageUrl[/li]
[/list]
SendXendAppNotification
[list]
[li]Title[/li]
[li]Message[/li]
[li]Channel[/li][/list] (Not mandatory if you specify a default channel)[/ul]
ResetProwlCount action
Reset Prowl count of sent message(s)
ResetPushOverCount action
Reset PushOver count of sent message(s)
ResetToastyCount action
Reset toasty count of sent message(s)
ResetXendAppCount action
Reset XendApp count of sent message(s)
[size=10pt]USAGE IN CODE[/size]
Assuming that the Plugin was installed as Device 99, the following tests should work. Your installation will have a different Device number, please adjust accordingly.
luup.call_action("urn:upnp-org:serviceId:IOSPush1", "SendProwlNotification",{ Event= "Title", Description="Message", Priority=2, URL=""}, 99)
luup.call_action("urn:upnp-org:serviceId:IOSPush1", "SendPushOverNotification",{ Title= "Title", Message="Message", Priority=1, URL="", URLTitle="", Sound="Siren"}, 99)
luup.call_action("urn:upnp-org:serviceId:IOSPush1", "SendToastyNotification",{ Title= "Title", Message="Message", ImageURL="" }, 99)
luup.call_action("urn:upnp-org:serviceId:IOSPush1", "SendXendAppNotification",{ Subject= "Subject", Message="Message", Channel="<ChannelID>" }, 99)