Skip to content

Commit

Permalink
Deploying to gh-pages from @ smarthomeNG/plugins@3f251f0 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@msinn
msinn committed Dec 16, 2023
1 parent f8fed62 commit 588aa47
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 10 deletions.
8 changes: 6 additions & 2 deletions _sources/plugins/pushover/README.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ Pushover is one out of many push services, which is compatible with Android, IOS

---
## Changelog
__2023-11-22__:
* add ttl parameter

__2018-10-04__:

* Use new lib.network
Expand Down Expand Up @@ -40,7 +43,7 @@ Description of the attributes:
---
## Usage:

### sh.po(title, message [, priority] [, retry] [, expire] [, sound] [, url] [, url_title] [, device] [, userKey] [, apiKey])
### sh.po(title, message [, priority] [, retry] [, expire] [, ttl] [, sound] [, url] [, url_title] [, device] [, userKey] [, apiKey])
Send a message to your device.

#### Parameters
Expand All @@ -49,6 +52,7 @@ Send a message to your device.
* __priority__: Priority of the message - read https://pushover.net/api#priority
* __retry__: when Emergency priority set, this specifies how often (in seconds) the Pushover servers will send the same notification to the user - read https://pushover.net/api#priority
* __expire__: when Emergency priority set, this specifies how many seconds your notification will continue to be retried for (every retry seconds) - read https://pushover.net/api#priority
* __ttl__: specifies the time to live in seconds (ignored for priority 2 messages) - read https://pushover.net/api#ttl
* __sound__: override a user's default tone choice on a per-notification basis - read https://pushover.net/api#sounds
* __url__: adds a supplementary URL that is not included in the message text, but available for the user to click on - read https://pushover.net/api#urls
* __url_title__: the title for the a supplementary URL - read https://pushover.net/api#urls
Expand All @@ -72,7 +76,7 @@ sh.po("Simple Test", "This is my test message.")
sh.po("Warning", "Your door is not locked!", 1)

# send simple message to device with id: e6653
sh.po("Simple Test", "This is my test message", None, None, None, None, None, None, "e6653")
sh.po("Simple Test", "This is my test message", device="e6653")

# send a message with an attached image (camera snapshot for example)
sh.po(title="Simple Test", message="This is my test message", attachment="/tmp/snapshot.jpg")
Expand Down
2 changes: 1 addition & 1 deletion _sources/plugins_doc/plugins_all.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -856,7 +856,7 @@
| | | | | |
| | | Plugin Typ: **web** | | |
+-------------------------------------------------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------+
| :doc:`pushover <config/pushover>` | v1.6.1 | Anbindung des Pushover Dienstes | Thomas Creutz | None |
| :doc:`pushover <config/pushover>` | v1.6.2 | Anbindung des Pushover Dienstes | Thomas Creutz | None |
| | | | | |
| | | | | |
| | | . | | |
Expand Down
2 changes: 1 addition & 1 deletion _sources/plugins_doc/plugins_web.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@
| | | - `pushbullet zusätzliche Infos <https://www.smarthomeng.de/developer/plugins/pushbullet/README.html>`_ | | |
| | | - `pushbullet Unterstützung <https://knx-user-forum.de/forum/supportforen/smarthome-py/36001-neues-plugin-pushbullet>`_ | | |
+-------------------------------------------------------------------+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------+-----------------+
| :doc:`pushover <config/pushover>` | v1.6.1 | Anbindung des Pushover Dienstes | Thomas Creutz | None |
| :doc:`pushover <config/pushover>` | v1.6.2 | Anbindung des Pushover Dienstes | Thomas Creutz | None |
| | | | | |
| | | | | |
| | | . | | |
Expand Down
11 changes: 8 additions & 3 deletions plugins/pushover/README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5394,6 +5394,10 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to t
<hr class="docutils" />
<section id="changelog">
<h2>Changelog<a class="headerlink" href="#changelog" title="Permalink to this heading"></a></h2>
<p><strong>2023-11-22</strong>:</p>
<ul class="simple">
<li><p>add ttl parameter</p></li>
</ul>
<p><strong>2018-10-04</strong>:</p>
<ul class="simple">
<li><p>Use new lib.network</p></li>
Expand Down Expand Up @@ -5428,8 +5432,8 @@ <h3>plugin.yaml<a class="headerlink" href="#plugin-yaml" title="Permalink to thi
<hr class="docutils" />
<section id="usage">
<h2>Usage:<a class="headerlink" href="#usage" title="Permalink to this heading"></a></h2>
<section id="sh-po-title-message-priority-retry-expire-sound-url-url-title-device-userkey-apikey">
<h3>sh.po(title, message [, priority] [, retry] [, expire] [, sound] [, url] [, url_title] [, device] [, userKey] [, apiKey])<a class="headerlink" href="#sh-po-title-message-priority-retry-expire-sound-url-url-title-device-userkey-apikey" title="Permalink to this heading"></a></h3>
<section id="sh-po-title-message-priority-retry-expire-ttl-sound-url-url-title-device-userkey-apikey">
<h3>sh.po(title, message [, priority] [, retry] [, expire] [, ttl] [, sound] [, url] [, url_title] [, device] [, userKey] [, apiKey])<a class="headerlink" href="#sh-po-title-message-priority-retry-expire-ttl-sound-url-url-title-device-userkey-apikey" title="Permalink to this heading"></a></h3>
<p>Send a message to your device.</p>
<section id="parameters">
<h4>Parameters<a class="headerlink" href="#parameters" title="Permalink to this heading"></a></h4>
Expand All @@ -5439,6 +5443,7 @@ <h4>Parameters<a class="headerlink" href="#parameters" title="Permalink to this
<li><p><strong>priority</strong>: Priority of the message - read https://pushover.net/api#priority</p></li>
<li><p><strong>retry</strong>: when Emergency priority set, this specifies how often (in seconds) the Pushover servers will send the same notification to the user - read https://pushover.net/api#priority</p></li>
<li><p><strong>expire</strong>: when Emergency priority set, this specifies how many seconds your notification will continue to be retried for (every retry seconds) - read https://pushover.net/api#priority</p></li>
<li><p><strong>ttl</strong>: specifies the time to live in seconds (ignored for priority 2 messages) - read https://pushover.net/api#ttl</p></li>
<li><p><strong>sound</strong>: override a user’s default tone choice on a per-notification basis - read https://pushover.net/api#sounds</p></li>
<li><p><strong>url</strong>: adds a supplementary URL that is not included in the message text, but available for the user to click on - read https://pushover.net/api#urls</p></li>
<li><p><strong>url_title</strong>: the title for the a supplementary URL - read https://pushover.net/api#urls</p></li>
Expand All @@ -5462,7 +5467,7 @@ <h4>Example<a class="headerlink" href="#example" title="Permalink to this headin
<span class="n">sh</span><span class="o">.</span><span class="n">po</span><span class="p">(</span><span class="s2">&quot;Warning&quot;</span><span class="p">,</span> <span class="s2">&quot;Your door is not locked!&quot;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>

<span class="c1"># send simple message to device with id: e6653</span>
<span class="n">sh</span><span class="o">.</span><span class="n">po</span><span class="p">(</span><span class="s2">&quot;Simple Test&quot;</span><span class="p">,</span> <span class="s2">&quot;This is my test message&quot;</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="s2">&quot;e6653&quot;</span><span class="p">)</span>
<span class="n">sh</span><span class="o">.</span><span class="n">po</span><span class="p">(</span><span class="s2">&quot;Simple Test&quot;</span><span class="p">,</span> <span class="s2">&quot;This is my test message&quot;</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="s2">&quot;e6653&quot;</span><span class="p">)</span>

<span class="c1"># send a message with an attached image (camera snapshot for example)</span>
<span class="n">sh</span><span class="o">.</span><span class="n">po</span><span class="p">(</span><span class="n">title</span><span class="o">=</span><span class="s2">&quot;Simple Test&quot;</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="s2">&quot;This is my test message&quot;</span><span class="p">,</span> <span class="n">attachment</span><span class="o">=</span><span class="s2">&quot;/tmp/snapshot.jpg&quot;</span><span class="p">)</span>
Expand Down
2 changes: 1 addition & 1 deletion plugins_doc/plugins_all.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6543,7 +6543,7 @@
Sandman60</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="config/pushover.html"><span class="doc">pushover</span></a></p></td>
<td><p>v1.6.1</p></td>
<td><p>v1.6.2</p></td>
<td><p>Anbindung des Pushover Dienstes</p>
<p>.</p>
<p>Plugin Typ: <strong>web</strong></p>
Expand Down
2 changes: 1 addition & 1 deletion plugins_doc/plugins_web.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5620,7 +5620,7 @@
Sandman60</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="config/pushover.html"><span class="doc">pushover</span></a></p></td>
<td><p>v1.6.1</p></td>
<td><p>v1.6.2</p></td>
<td><p>Anbindung des Pushover Dienstes</p>
<p>.</p>
</td>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 588aa47

Please sign in to comment.