https://github.com/blt950/vPilot-Pushover
Plugin for vPilot to Pushover vPilot and Hoppie messages
https://github.com/blt950/vPilot-Pushover
acars hoppie plugin pushover vatsim vpilot
Last synced: about 1 year ago
JSON representation
Plugin for vPilot to Pushover vPilot and Hoppie messages
- Host: GitHub
- URL: https://github.com/blt950/vPilot-Pushover
- Owner: blt950
- License: gpl-3.0
- Created: 2023-07-26T09:47:37.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-05T18:39:19.000Z (over 1 year ago)
- Last Synced: 2025-03-05T19:34:33.801Z (over 1 year ago)
- Topics: acars, hoppie, plugin, pushover, vatsim, vpilot
- Language: C#
- Homepage:
- Size: 104 KB
- Stars: 20
- Watchers: 1
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vatsim - vPilot Pushover - Plugin for vPilot to notify you about vPilot and Hoppie messages on your mobile device (Others / VATSIM Connect)
README
# vPilot Pushover
[]()
Relay [vPilot](https://vpilot.rosscarlson.dev/) and [Hoppie](https://www.hoppie.nl/acars/) messages to your mobile device via [Pushover](https://pushover.net/), [Telegram](https://telegram.org/) or [Gotify](https://gotify.net/).\
Hoppie is integrated directly, meaning you can use any aircraft with this plugin.
Have also a look at my other projects at my homepage: [https://blt950.com](https://blt950.com)\
I won't make an X-Plane variant of this plugin, [see reasoning here](https://github.com/blt950/vPilot-Pushover/issues/14#issuecomment-1979402032).
## Prerequisites
You need [vPilot](https://vpilot.rosscarlson.dev/) that you use to connect to VATSIM. Then choose one of the following notifiers.
### Pushover
- [Create your own Pushover API key](https://pushover.net/apps/build) which is for your personal use
- Pushover has a 30-day trial you can try out before you pay the one-time $5 for a lifetime subscription. You can use Pushover to much more than this plugin, the subscription is in no way tied to this plugin
### Telegram
- [Create a Telegram bot](telegram.md) for credentials you need for the settings
### Gotify
- It's required to install gotify server beforehand. Check [Gotify Docs](https://gotify.net/docs/index) for more infomation
- Please note that only Android phone is officially supported by them. See [this](https://github.com/gotify/android)
## Installation
1. Make sure your vPilot is not running
2. Download the latest release `.zip` only from the [releases page](https://github.com/blt950/vPilot-Pushover/releases)
3. Extract the zip file and move both `vPilot-Pushover.dll` and `vPilot-Pushover.ini` to your vPilot plugin folder, usually `C:\Users\\AppData\Local\vPilot\Plugins`
4. Open `vPilot-Pushover.ini` in a text editor and configure your desired [settings](#settings)
5. When you start vPilot you should now get an "Connected. Running version x.x.x" push notification. If not, see [troubleshooting](#troubleshooting) below.
## Settings
In the `vPilot-Pushover.ini` file, you can configure the following settings:
### [General]
`Driver` = Choose your notifier method, write `pushover`, `telegram` or `gotify` in lowercase.
### [Pushover]
`UserKey` = Your Pushover user key. You can find this on the [Pushover dashboard](https://pushover.net/)\
`ApiKey` = Your Pushover API key. You need to [create this youself in Pushover](https://pushover.net/apps/build)\
`Device` = The device name to send the notifications to. If you leave this blank, it will send to all devices. If you want to specifify multiple devices, separate them with a comma, e.g. `iphone,nexus5`
### [Telegram]
`BotToken` = Your Telgram bot API key, see [this](telegram.md) for instructions\
`ChatId` = Your Telgram bots chat id key, see [this](telegram.md) for instructions
### [Gotify]
`Url` = Your Gotify server address. For example, `https://push.example.com`, `https://example.com/gotify`, depending on your server configuration.\
`Token` = Your Gotify application token. see [this](https://gotify.net/docs/pushmsg)
### [Hoppie]
`Enabled` = Whether or not to relay Hoppie messages. Set to `true` or `false`\
`LogonCode` = Your [Hoppie](https://hoppie.nl) logon code.
### [RelayPrivate]
`Enabled` = Whether or not to relay private messages. Set to `true` or `false`
### [RelayRadio]
`Enabled` = Whether or not to relay radio messages. Only sends radio messages meant for your callsign, e.g. ATC writing to you on text. Set to `true` or `false`
### [EnableSelcal]
`Enabled` = Whether or not to relay SELCAL messages. Set to `true` or `false`
### [Disconnect]
`Enabled`= Whether or not to send message when disconneted from network. Set to `true` or `false`
## Troubleshooting
### I don't receive any connected notification
- Make sure you have placed the plugin in the correct folder, usually like this `C:\Users\\AppData\Local\vPilot\Plugins\vPilot-Pushover.dll` and `.ini` in the same folder.
- Make sure you've configured both your Pushover user key and your Pushover API key and that they are each surrounded by quotation marks.
- Your Windows might have blocked the `.dll` file. This is because the `.dll` is not [code-signed](https://en.wikipedia.org/wiki/Code_signing) as it's a hobby project and I don't have $200/yearly to purchase a verification. Before you unblock the file, check it with your antivirus or upload it to [VirusTotal](https://www.virustotal.com/gui/home/upload). If you're comfortable to proceed, right click on the `vPilot-Pushover.dll`, open Properties, unblock and apply to allow vPilot to load the plugin.
- If you receive `Unable to cast object of type` error, [check out this issue](https://github.com/blt950/vPilot-Pushover/issues/23).
*Still having an issue? Make an issue request here on Github.*
## Contribution
Feel free to contribute by creating pull requests or issues in this Github!