summaryrefslogtreecommitdiff
path: root/doc/sensors_bot.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sensors_bot.md')
-rw-r--r--doc/sensors_bot.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/doc/sensors_bot.md b/doc/sensors_bot.md
new file mode 100644
index 0000000..9f1c008
--- /dev/null
+++ b/doc/sensors_bot.md
@@ -0,0 +1,33 @@
+# Sensors Bot
+
+Configuration is stored in **`~/.config/sensors_bot/config.toml`**.
+
+Example:
+
+```toml
+[bot]
+token = "..."
+users = [
+ 1, # user 1
+ 2, # user 2
+ 3, # user 3
+]
+
+[api]
+token = ..."
+
+[sensors.name1]
+ip = "192.168.0.2"
+port = 8306
+label_ru = "Тут"
+label_en = "Here"
+
+[sensors.name2]
+ip = "192.168.0.3"
+port = 8307
+label_ru = "Там"
+label_en = "There"
+
+[logging]
+verbose = false
+``` \ No newline at end of file