Updated external content (Jenkins build 841)
parent
e3b26350dc
commit
009a53581d
File diff suppressed because one or more lines are too long
|
@ -0,0 +1,57 @@
|
|||
---
|
||||
id: prowl
|
||||
label: Prowl
|
||||
title: Prowl - Bindings
|
||||
type: binding
|
||||
description: "This is the binding for the [Prowl](https://www.prowlapp.com) iOS push service."
|
||||
since: 3x
|
||||
install: manual
|
||||
---
|
||||
|
||||
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
|
||||
|
||||
{% include base.html %}
|
||||
|
||||
# Prowl Binding
|
||||
|
||||
This is the binding for the [Prowl](https://www.prowlapp.com) iOS push service.
|
||||
It has been written from scratch and therefore it is not based on the original 1.x Prowl binding.
|
||||
It has no other purpose than sending push messages to iOS devices.
|
||||
|
||||
## Binding Configuration
|
||||
|
||||
The binding does not require any manual configuration on the binding level.
|
||||
|
||||
## Thing Configuration
|
||||
|
||||
This binding has only one thing called _Broker_. If you want to use this binding, just add a broker instance and configure the API key, which you can generate on the Prowl website.
|
||||
You can also modify the _application_ property, which identifies the originator of these push messages.
|
||||
If you want to have specific refresh time for the remaining free push messages channel, you can edit the _refresh_ property.
|
||||
Anyway beware - every check consumes one free push message you can send in an hour.
|
||||
|
||||
## Channels
|
||||
|
||||
The broker thing has only one channel keeping the number of free push messages, which can be sent.
|
||||
|
||||
| channel | type | description |
|
||||
|------------|--------|--------------------------------------------------------|
|
||||
| remaining | Number | This channel provides the number of free push messages |
|
||||
|
||||
## Example
|
||||
|
||||
_*.things_
|
||||
|
||||
```
|
||||
Thing prowl:broker:mybroker "Prowl Broker" [ apiKey="0000000000000000000000000000000000000000" ]
|
||||
```
|
||||
|
||||
_*.rules_
|
||||
|
||||
Once you have created the broker thing with a valid API key, you can use the Prowl service in your rules.
|
||||
First you need to create an instance of the broker just before any call or on the top rules level. (replace the _mybroker_ with the right name of your instance).
|
||||
Then you can call method _pushNotification_, which requires two parameters - _event_ and _description_.
|
||||
|
||||
```
|
||||
val prowl = getActions("prowl","prowl:broker:mybroker")
|
||||
prowl.pushNotification("Event", "This is the description of the event")
|
||||
```
|
|
@ -0,0 +1,42 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<thing:thing-descriptions bindingId="prowl"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
|
||||
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
|
||||
|
||||
<!-- Prowl Thing Type -->
|
||||
<thing-type id="broker">
|
||||
<label>Broker</label>
|
||||
<description>A broker thing for the Prowl Binding</description>
|
||||
|
||||
<channels>
|
||||
<channel id="remaining" typeId="remaining"/>
|
||||
</channels>
|
||||
|
||||
<config-description>
|
||||
<parameter name="application" type="text" required="false">
|
||||
<label>Application name</label>
|
||||
<description>Application name used in every push message</description>
|
||||
<default>openHAB</default>
|
||||
</parameter>
|
||||
<parameter name="apiKey" type="text" required="true">
|
||||
<label>API key</label>
|
||||
<description>API key created in the ProwlApp</description>
|
||||
</parameter>
|
||||
<parameter name="refresh" type="integer" required="false" min="1">
|
||||
<label>Refresh</label>
|
||||
<description>Specifies the refresh time in minutes for checking for remaining free messages</description>
|
||||
<default>30</default>
|
||||
</parameter>
|
||||
|
||||
</config-description>
|
||||
</thing-type>
|
||||
|
||||
<!-- remaining messages -->
|
||||
<channel-type id="remaining">
|
||||
<item-type>Number</item-type>
|
||||
<label>Remaining Messages</label>
|
||||
<description>Remaining free push messages for Prowl Binding</description>
|
||||
<state pattern="%d" readOnly="true"/>
|
||||
</channel-type>
|
||||
</thing:thing-descriptions>
|
Loading…
Reference in New Issue