extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-04 05:54:35 +01:00
Code Issues Packages Projects Releases Wiki Activity
Page: Notify_enigma2
Pages
CLI_Usage DemoPlugin_Basic DemoPlugin_WebRequest Development_API Development_Apprise_Details Development_Contribution Development_LogCapture Home Notification_Graveyard Notify_Custom_Form Notify_Custom_JSON Notify_Custom_XML Notify_Revolt Notify_africas_talking Notify_apprise_api Notify_aprs Notify_bark Notify_boxcar Notify_bulksms Notify_bulkvs Notify_burst_sms Notify_chantify Notify_clicksend Notify_d7networks Notify_dapnet Notify_dbus Notify_dingtalk Notify_discord Notify_email Fastmail Notify_email Notify_emby Notify_enigma2 Notify_faast Notify_fcm Notify_feishu Notify_flock Notify_freemobile Notify_gitter Notify_gnome Notify_googlechat Notify_gotify Notify_growl Notify_guilded Notify_homeassistant Notify_httpsms Notify_ifttt Notify_join Notify_kavenegar Notify_kodi Notify_kumulos Notify_lametric Notify_line Notify_lunasea Notify_macosx Notify_mailgun Notify_mastodon Notify_matrix Notify_mattermost Notify_messagebird Notify_misskey Notify_mqtt Notify_msg91 Notify_msteams Notify_nexmo Notify_nextcloud Notify_nextcloudtalk Notify_notica Notify_notifiarr Notify_notifico Notify_ntfy Notify_office365 Notify_onesignal Notify_opsgenie Notify_pagerduty Notify_pagertree Notify_parseplatform Notify_plivo Notify_popcornnotify Notify_prowl Notify_pushalot Notify_pushbullet Notify_pushdeer Notify_pushed Notify_pushjet Notify_pushme Notify_pushover Notify_pushsafer Notify_pushy Notify_reddit Notify_rocketchat Notify_rsyslog Notify_ryver Notify_sendgrid Notify_serverchan Notify_ses Notify_seven Notify_sfr Notify_signal Notify_simplepush Notify_sinch Notify_slack Notify_sms_manager Notify_smseagle Notify_smtp2go Notify_sns Notify_sparkpost Notify_splunk Notify_spontit Notify_streamlabs Notify_stride Notify_synology_chat Notify_syslog Notify_techulus Notify_telegram Notify_threema Notify_toasty Notify_twilio Notify_twist Notify_twitter Notify_voipms Notify_wecombot Notify_whatsapp Notify_windows Notify_workflows Notify_wxpusher Notify_wxteams Notify_xbmc Notify_xmpp Notify_zulip Sponsors Troubleshooting URLBasics config config_text config_yaml decorator_notify persistent_storage showcase
4 Notify_enigma2
Chris Caron edited this page 2023-06-17 15:42:12 -04:00
Table of Contents

Enimga2 Device Notifications

  • Source: n/a
  • Icon Support: No
  • Message Format: XML
  • Message Limit: 1000 Characters per message

A E2OpenPlugin called OpenWebif can allow you to communicate with your Enigma2 devices (such as Dreambox, Vu+, etc.) using a API.

Once OpenWebif is installed, Apprise can utilize it's API to send notifications to your Enigma2 device.

Installation instructions on how to install OpenWebif onto your Engima2 device can be found on it's GitHub Page.

Syntax

Valid syntax is as follows:

  • enigma2://{host}
  • enigma2://{host}/{fullpath}
  • enigma2://{host}:{port}
  • enigma2://{host}:{port}/{fullpath}
  • enigma2://{user}@{host}
  • enigma2://{user}@{host}/{fullpath}
  • enigma2://{user}@{host}:{port}
  • enigma2://{user}@{host}:{port}/{fullpath}
  • enigma2://{user}:{password}@{host}
  • enigma2://{user}:{password}@{host}/{fullpath}
  • enigma2://{user}:{password}@{host}:{port}
  • enigma2://{user}:{password}@{host}:{port}/{fullpath}
  • enigma2s://{host}
  • enigma2s://{host}/{fullpath}
  • enigma2s://{host}:{port}
  • enigma2s://{host}:{port}/{fullpath}
  • enigma2s://{user}@{host}
  • enigma2s://{user}@{host}/{fullpath}
  • enigma2s://{user}@{host}:{port}
  • enigma2s://{user}@{host}:{port}/{fullpath}
  • enigma2s://{user}:{password}@{host}
  • enigma2s://{user}:{password}@{host}/{fullpath}
  • enigma2s://{user}:{password}@{host}:{port}
  • enigma2s://{user}:{password}@{host}:{port}/{fullpath}

Parameter Breakdown

Variable Required Description
hostname Yes The Enigma2 devices IP/hostname
port No The port our Web server is listening on. By default the port is 80 for enigma2s:// and 443 for all enigma2:// references.
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.
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

Send an notification to our Enigma2 Device:

# Assuming our {hostname} is dreambox
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   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

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.

# Below would set the header:
#    X-Token: abcdefg
#
# Assuming our {hostname} is vu-device
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "enigma2://localhost/?-X-Token=abcdefg"

# Multiple headers just require more entries defined with a hyphen in front:
# Below would set the headers:
#    X-Token: abcdefg
#    X-Apprise: is great
#
# Assuming our {hostname} is localhost
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   "enigma2://localhost/path/?-X-Token=abcdefg&-X-Apprise=is%20great"

Quick Links: