Skip to content

Latest commit

 

History

History
100 lines (88 loc) · 6.48 KB

ConfigureNotificationsForArchive.md

File metadata and controls

100 lines (88 loc) · 6.48 KB
Raw

OPTIONAL: You can choose to integrate with Pushover, Gotify, IFTTT, Telegram and/or AWS SNS to get a push/email notification to your phone when the copy process is done. Depending on your wireless network speed/connection, copying files may take some time, so a push notification can help confirm that the process finished. If no files were copied (i.e. all manually saved dashcam files were already copied, no notification will be sent.).

Pushover

The Pushover service is free for up to 7,500 messages per month, but the iOS/Android apps do have a one time cost, after a free trial period. This also assumes your Pi is connected to a network with internet access.

  1. Create a free account at Pushover.net, and install and log into the mobile Pushover app.
  2. On the Pushover dashboard on the web, copy your User key.
  3. Create a new Application at Pushover.net. The description and icon don't matter, choose what you prefer.
  4. Copy the Application Key for the application you just created. The User key + Application Key are basically a username/password combination to needed to send the push.
  5. Run these commands, substituting your user key and app key in the appropriate places. No " are needed. 
    export pushover_enabled=true
export pushover_user_key=put_your_userkey_here
export pushover_app_key=put_your_appkey_here

Gotify

Gotify is a self-hosted notification service. The android client is available on Google Play, F-Droid, or a standalone APK.

  1. Install server by following instructions
  2. Create a new Application
  3. Copy the app's token
  4. Run these commands, substituting your domain and app token in the appropriate places. 
    export gotify_enabled=true
export gotify_domain=https://gotify.domain.com
export gotify_app_token=put_your_token_here
export gotify_priority=5

IFTTT

IFTTT is a completely free alternative that can be configured to send notifications. It requires an account and the IFTTT app to be installed but is available for both iOS and Android.

  1. Connect the Webhooks service
  2. Create a new applet
    1. Choose "Webhooks" as the service
    2. Choose "Receive a web request" as the trigger
    3. Provide a unique Event Name to create the trigger and note this down
    4. Choose "Notifications" as the action service
    5. Choose "Send a notification from the IFTTT app" as the action
    6. Customize the message to be something like 
      {{Value1}} {{Value2}} {{Value3}} ({{OccurredAt}})
      • Value3 will not be used by teslausb
      • Feel free to modify this later to your liking.
    7. Name and save the applet. You can modify the name, event name, and message by clicking on the Gear icon.
  3. Test the applet out by going back to the Webhooks service page and clicking on "Documentation".
  4. Note down the key.
  5. Trigger the test by providing the event name and optional values 1-3.
  6. If it's not working, you can try to run the curl command manually via your command line and it should return a more informative error message. You can also try to generate a new key by going to the Webhooks settings page, and clicking "Edit Connection".
  7. You should receive a notification within a few seconds. :)
  8. Run these commands, substituting your event name and key in the appropriate places. 
    export ifttt_enabled=true
export ifttt_event_name=put_your_event_name_here
export ifttt_key=put_your_key_here

AWS SNS

You can also choose to send notification through AWS SNS. You can create a free AWS account and the free tier enables you to receive notifications via SNS for free.

  1. Create a free account at AWS.
  2. Create a user in IAM and give it the rights to SNS.
  3. Create a new SNS topic.
  4. Create the notification end point (email or other)
  5. Run these commands, substituting your user key and app key in the appropriate places. Use of " is required for aws_sns_topic_arn. 
    export sns_enabled=true
export aws_region=us-east-1
export aws_access_key_id=put_your_accesskeyid_here
export aws_secret_key=put_your_secretkey_here
export aws_sns_topic_arn=put_your_sns_topicarn_here

Webhook

Generic Webhook call can be used with Node-Red, Home-Assistant, and other self hosted automation systems.

  1. Setup webhook url with your provider
  2. Run these commands, substituting your url. 
    export WEBHOOK_ENABLED=true
export WEBHOOK_URL=http://domain/path

Telegram

You can choose to send notifications via Telegram. This is a completely free alternative, but you need Telegram app (also free) on your device. It is available for iOS as well as Android and other platforms. See the complete list here

  1. If you don't already have it, download the Telegram Client for your device here and go through the sign up process.
  2. Once sign-up is complete, you can add this bot to your telegram client.
  3. Send any message (e.g. "Hi") to the bot and it will respond with your id. This identifies the recipient and is the value you will use for TELEGRAM_CHAT_ID
  4. You will need to create a new bot that acts as a sender. Follow the instructions here to get your bot token.
  5. If the API key does not have the "bot" prefix. Make sure you include it when entering TELEGRAM_BOT_TOKEN.
  6. Remove the comments and update the following values in the teslausb_setup_variables.conf file. 
    export TELEGRAM_ENABLED=true
export TELEGRAM_CHAT_ID=123456789
export TELEGRAM_BOT_TOKEN=bot123456789:abcdefghijklmnopqrstuvqxyz987654321
export TELEGRAM_SILENT_NOTIFY=false