https://github.com/alttch/eva-telegram
Telegram extension for EVA ICS LM PLC
https://github.com/alttch/eva-telegram
eva-ics extension iiot industrial-automation iot messenger module smarthome telegram
Last synced: 7 months ago
JSON representation
Telegram extension for EVA ICS LM PLC
- Host: GitHub
- URL: https://github.com/alttch/eva-telegram
- Owner: alttch
- License: apache-2.0
- Created: 2020-01-21T21:01:20.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-01-22T02:49:01.000Z (over 5 years ago)
- Last Synced: 2025-01-10T02:32:30.596Z (9 months ago)
- Topics: eva-ics, extension, iiot, industrial-automation, iot, messenger, module, smarthome, telegram
- Language: Python
- Size: 30.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# eva-telegram
Telegram bot extension for [EVA ICS](https://www.eva-ics.com/) LM PLC
Requires EVA ICS 3.3 or newer.
## Install
* install [tebot](https://pypi.org/project/tebot/) module
* put *telegram.py* to */opt/eva/xc/extensions/*
* put sample configuration file *telegram.yml* to */opt/eva/etc/*
* modify sample configuration
* load extension:
```shell
eva lm ext load tbot telegram -y
```
## Macro execution
Start chat with your bot and follow the instructions.
* if macros is started as "/macro some args", args are added to macro arguments.
* current *chat_id* is passed into macro kwargs and may be used later.
## Sending messages from macros
When loaded, e.g. as *tbot*, extension provides functions:
* tbot_send
* tbot_send_photo
* tbot_send_video
* tbot_send_audio
* tbot_send_document
Function arguments are the same as for https://pypi.org/project/tebot/, refer
to module documentation for more info, except first argument should be either
API key ID or list of API key IDs. If "\*" is specified, broadcast message is
sent.
### Examples
Send a message only to user who called macro
```python
# chat_id variable is available in macro, as it was sent in kwargs
tbot_send(None, 'this is a reply', chat_id=chat_id)
```
Send broadcast message to all
```python
tbot_send('*', 'this is a test')
```
Send image to users with API key IDs "operator" and "operator2":
```python
with open('image.jpg', 'rb') as fh:
tbot_send(['operator', 'operator2'], media=fh.read())
```
## Command autocomplete
After log in, use */getcommands* command, go to [Telegram
BotFather](https://telegram.me/BotFather), enter */setcommands* and paste it
as-is.
## Exclude command from the keyboard
To exclude command from the inline keyboard, put dot before macro in
"inline-keyboard" section of the configuration.
## Security
* using master key is not recommended
* write dedicated macros
* if possible - use dedicated instance of LM PLC