Skip to content

Commit f9207eb

Browse files
committed
[Pushsafer] Update documentation about config layout modernization
1 parent fb10825 commit f9207eb

File tree

2 files changed

+46
-19
lines changed

2 files changed

+46
-19
lines changed

CHANGES.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ in progress
77
===========
88

99
- Pushsafer: Fix to prevent submitting empty parameters to upstream API.
10+
- Pushsafer: Modernize configuration layout for target addresses.
1011

1112

1213
2023-02-13 0.32.0

HANDBOOK.md

Lines changed: 45 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2449,38 +2449,64 @@ Requires:
24492449
24502450
### `pushsafer`
24512451
2452-
This service is for [Pushsafer](https://www.pushsafer.com), an app for iOS, Android and Windows 10.
2453-
In order to receive pushsafer notifications you need what is called a _private or alias key_:
2452+
[Pushsafer](https://www.pushsafer.com) is an app for iOS, Android and Windows 10.
2453+
You can define different notification targets, in turn dispatching to one or
2454+
multiple Pushsafer devices or groups.
2455+
For a list of available icons, sounds and other parameters, see the
2456+
[Pushsafer API](https://www.pushsafer.com/en/pushapi) documentation.
2457+
2458+
#### Requirements
2459+
In order to receive Pushsafer notifications, you need what is called a _private
2460+
or alias key_. To receive such a key, you will need to sign up for an account.
2461+
2462+
#### Configuration example
24542463
24552464
```ini
24562465
[config:pushsafer]
2457-
targets = {
2458-
'nagios' : ['privatekey', 'Device ID', 'Icon', 'Sound', 'Vibration', 'URL', 'Url Title', 'Time2Live', 'Priority', 'Retry', 'Expire', 'Answer'],
2459-
'tracking' : ['aliaskey1'],
2460-
'extraphone' : ['aliaskey2', '', '', '', '', '', '', '60', '2', '60', '600', '0'],
2461-
'warnme' : ['aliaskey3', '', '', '', '', '', '', '60', '1', '', '', '1']
2466+
; https://www.pushsafer.com/en/pushapi
2467+
; https://www.pushsafer.com/en/pushapi_ext
2468+
targets = {
2469+
'basic': { 'private_key': '3SAz1a2iTYsh19eXIMiO' },
2470+
'nagios': {
2471+
'private_key': '3SAz1a2iTYsh19eXIMiO',
2472+
'device': '52|65|78',
2473+
'icon': 64,
2474+
'sound': 2,
2475+
'vibration': 1,
2476+
'url': 'http://example.org',
2477+
'url_title': 'Example Org',
2478+
'time_to_live': 60,
2479+
'priority': 2,
2480+
'retry': 60,
2481+
'expire': 600,
2482+
'answer': 1,
2483+
},
2484+
'tracking': {
2485+
'private_key': '3SAz1a2iTYsh19eXIMiO',
2486+
'device': 'gs23',
2487+
'icon': 18,
2488+
},
2489+
'extraphone': { 'private_key': 'aliaskey2', 'time_to_live': 60, 'priority': 2, 'retry': 60, 'expire': 600, 'answer': 0 },
2490+
'warnme': { 'private_key': 'aliaskey3', 'time_to_live': 60, 'priority': 1, 'answer': 1 },
24622491
}
24632492
```
24642493
2465-
This defines targets (`nagios`, `alerts`, etc.) which are directed to the
2466-
configured _private or alias key_ combinations. This in turn enables you to
2467-
notify, say, one or more of your devices as well as one for your spouse.
2468-
For a list of available icons, sounds and other params see the
2469-
[Pushsafer API](https://www.pushsafer.com/en/pushapi).
2470-
2471-
Please note:
2472-
- [Retry](https://www.pushsafer.com/en/pushapi_ext#API-RE)
2473-
with [Expire](https://www.pushsafer.com/en/pushapi_ext#API-EX):
2474-
For configuring delivery retries, you must set both parameters.
2494+
#### MQTT topic options
24752495
24762496
| Topic option | M/O | Description |
24772497
| ------------- | :----: | -------------------------------------- |
24782498
| `title` | O | application title (dflt: pushsafer dflt) |
24792499
2500+
#### Notes
2501+
- [Retry](https://www.pushsafer.com/en/pushapi_ext#API-RE)
2502+
with [Expire](https://www.pushsafer.com/en/pushapi_ext#API-EX):
2503+
For configuring delivery retries, you must set both parameters.
2504+
- The legacy configuration layout, based on a list for the `addrs` slot,
2505+
is still supported.
2506+
2507+
#### Screenshot
24802508
![pushsafer on iOS](assets/pushsafer.jpg)
24812509
2482-
Requires:
2483-
* An account at [pushsafer.com](https://www.pushsafer.com/).
24842510
24852511
### `redispub`
24862512

0 commit comments

Comments
 (0)