extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-13 10:21:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Notify_enigma2 (markdown)

Chris Caron 2023-06-17 15:42:12 -04:00
parent 2e556a2f2d
commit 085446456b
1 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Notify_enigma2.md

@ -11,19 +11,31 @@ Once [OpenWebif](https://github.com/E2OpenPlugins/e2openplugin-OpenWebif) is ins
Installation instructions on how to install OpenWebif onto your Engima2 device can be found on it's [GitHub Page](https://github.com/E2OpenPlugins/e2openplugin-OpenWebif). Installation instructions on how to install OpenWebif onto your Engima2 device can be found on it's [GitHub Page](https://github.com/E2OpenPlugins/e2openplugin-OpenWebif).
### Syntax ### Syntax
Valid syntaxes are as follows: Valid syntax is as follows:
* `enigma2://{host}` * `enigma2://{host}`
* `enigma2://{host}/{fullpath}`
* `enigma2://{host}:{port}` * `enigma2://{host}:{port}`
* `enigma2://{host}:{port}/{fullpath}`
* `enigma2://{user}@{host}` * `enigma2://{user}@{host}`
* `enigma2://{user}@{host}/{fullpath}`
* `enigma2://{user}@{host}:{port}` * `enigma2://{user}@{host}:{port}`
* `enigma2://{user}@{host}:{port}/{fullpath}`
* `enigma2://{user}:{password}@{host}` * `enigma2://{user}:{password}@{host}`
* `enigma2://{user}:{password}@{host}/{fullpath}`
* `enigma2://{user}:{password}@{host}:{port}` * `enigma2://{user}:{password}@{host}:{port}`
* `enigma2://{user}:{password}@{host}:{port}/{fullpath}`
* `enigma2s://{host}` * `enigma2s://{host}`
* `enigma2s://{host}/{fullpath}`
* `enigma2s://{host}:{port}` * `enigma2s://{host}:{port}`
* `enigma2s://{host}:{port}/{fullpath}`
* `enigma2s://{user}@{host}` * `enigma2s://{user}@{host}`
* `enigma2s://{user}@{host}/{fullpath}`
* `enigma2s://{user}@{host}:{port}` * `enigma2s://{user}@{host}:{port}`
* `enigma2s://{user}@{host}:{port}/{fullpath}`
* `enigma2s://{user}:{password}@{host}` * `enigma2s://{user}:{password}@{host}`
* `enigma2s://{user}:{password}@{host}/{fullpath}`
* `enigma2s://{user}:{password}@{host}:{port}` * `enigma2s://{user}:{password}@{host}:{port}`
* `enigma2s://{user}:{password}@{host}:{port}/{fullpath}`
### Parameter Breakdown ### Parameter Breakdown
| Variable | Required | Description | Variable | Required | Description
@ -33,6 +45,7 @@ Valid syntaxes are as follows:
| user | No | If you're system is set up to use HTTP-AUTH, you can provide _username_ for authentication to it. | user | No | If you're system is set up to use HTTP-AUTH, you can provide _username_ for authentication to it.
| password | No | If you're system is set up to use HTTP-AUTH, you can provide _password_ for authentication to it. | password | No | If you're system is set up to use HTTP-AUTH, you can provide _password_ for authentication to it.
| timeout | No | The number of seconds delivered notification stay on the screen for. The default value is 13. | timeout | No | The number of seconds delivered notification stay on the screen for. The default value is 13.
| fullpath | No | Those hosting this internally may wish to specify the (prefix) path their service is listening on.
#### Example #### Example
Send an notification to our Enigma2 Device: Send an notification to our Enigma2 Device:
@ -40,7 +53,16 @@ Send an notification to our Enigma2 Device:
# Assuming our {hostname} is dreambox # Assuming our {hostname} is dreambox
apprise -vv -t "Test Message Title" -b "Test Message Body" \ apprise -vv -t "Test Message Title" -b "Test Message Body" \
enigma2://dreambox enigma2://dreambox
# Hosting your service at /enigma2, the following can be handle this:
# Assuming our {hostname} is dreambox
# Assuming our {fullpath} is /enigma2
apprise -vv -t "Test Message Title" -b "Test Message Body" \
"enigma2://dreambox/enigma2"
``` ```
### Header Manipulation ### Header Manipulation
Some users may require special HTTP headers to be present when they post their data to their server. This can be accomplished by just sticking a hyphen (**-**) in front of any parameter you specify on your URL string. Some users may require special HTTP headers to be present when they post their data to their server. This can be accomplished by just sticking a hyphen (**-**) in front of any parameter you specify on your URL string.
```bash ```bash