Skip to content

Commit 56d826d

Browse files
author
Sebastian
committed
update telegram docs
1 parent 9892a98 commit 56d826d

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

docs/TELEGRAM.rst

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,30 @@ Configure RTOC for Telegram
1919
+++++++++++++++++++++++++++++
2020
You can eather configure it in the settings of the RTOC GUI or edit the :ref:`config.json` file by yourself. Enter your Bot-Token there and activate it (``active=True``).
2121

22+
User permissions
23+
+++++++++++++++++++++++++++++
24+
By default any new client connected to this bot will have no permissions. You can change the default behavior in :ref:`config.json`.
25+
26+
The first client connected to the bot will automatically be admin. The admin has the permission to change the permissions of all users.
27+
28+
- **blocked**: No permissions at all
29+
- **read**: Can receive event-notifications and plot signals
30+
- **write**: Can create global Events/Actions, send Events/Signals, access devices
31+
- **admin**: Full permissions. Can delete signals, access settings menu
2232

2333
.. image:: ../screenshots/telegramBot.png
2434

2535
Mainmenu
2636
------------
2737

2838
- <USER_ACTIONS>
29-
- Set Event Notification
30-
- Latest values
31-
- Signals
32-
- Devices
33-
- Send event/signal
34-
- Automation
35-
- Settings (**only admin**)
39+
- Set Event Notification [**read**,**write**,**admin**]
40+
- Latest values [**read**,**write**,**admin**]
41+
- Signals [**read**,**write**,**admin**]
42+
- Devices [**write**,**admin**]
43+
- Send event/signal [**write**,**admin**]
44+
- Automation [**write**,**admin**]
45+
- Settings [**admin**]
3646

3747
Set Event Notification
3848
++++++++++++++++++++++++
@@ -51,9 +61,9 @@ Contains a list of all signals. Clicking on a signal will select this signal. Yo
5161

5262
``Show/Hide events`` will show/hide events in the plot. Events are displayed as vertical lines with the event-text
5363

54-
``Delete signals`` (**only admin**) will delete all selected data (signals and time-period).
64+
``Delete signals`` [**admin**] will delete all selected data (signals and time-period).
5565

56-
``Delete events`` (**only admin**) will delete all selected events (time-period).
66+
``Delete events`` [**admin**] will delete all selected events (time-period).
5767

5868
Devices
5969
+++++++++++++++++++++++

0 commit comments

Comments
 (0)