README.rst

aprsd-telegram-plugin

Features

• Have a 2 way chat with users of Telegram messenger http://telegram.org

Requirements

• You have to create a telegram bot and start the bot
• Telegram users have to add that bot and then /start
• Telegram user can then message the bot
• Only after a telegram user has successfully completed the above can you then message a telegram user from an APRS enabled HAM Radio.

Installation

You can install aprsd-telegram-plugin via pip from PyPI:

$ pip install aprsd-telegram-plugin

Now edit your aprsd.conf config file and add the plugin

[DEFAULT]
enabled_plugins = aprsd_telegram_plugin.telegram.TelegramChatPlugin

[aprsd_telegram_plugin]

#
# From aprsd_telegram_plugin.conf
#

# Callsign allowed to use Telegram! For example, if you set this to
# WB4BOR then anycallsign starting with WB4BOR will be allowed to use
# this.This way WB4BOR-1 can use this instance. (string value)
#callsign = <None>

# Your telegram apiKeyInformation for creating your api keys is here:
# https://core.telegram.org/api/obtaining_api_id (string value)
#apiKey = <None>

# List of shortcuts for sending telegram messages For Example:
# wb=hemna6969,cl=craigerl
# Means use 'wb' to send a telegram message to hemna6969 (list value)
#shortcuts = <None>

Usage

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, aprsd-telegram-plugin is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @hemna's APRSD Plugin Python Cookiecutter template.