summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEvgeny Zinoviev <me@ch1p.io>2022-06-14 02:44:43 +0300
committerEvgeny Zinoviev <me@ch1p.io>2022-06-14 22:56:46 +0300
commite3d3d6b76010a6dd5c417f017339bec17fb07887 (patch)
tree42cb6194504ae863db2bf7d21ef9e2acd41d0fd2 /doc
parent600fdf99ffd893857c9cdb9e68140766a963bd17 (diff)
media: refactor sound_node, introduce camera_node
Diffstat (limited to 'doc')
-rw-r--r--doc/camera_node.md5
-rw-r--r--doc/sensors_bot.md6
-rw-r--r--doc/sound_bot.md86
-rw-r--r--doc/sound_sensor_server.md33
4 files changed, 106 insertions, 24 deletions
diff --git a/doc/camera_node.md b/doc/camera_node.md
new file mode 100644
index 0000000..5f2d8d8
--- /dev/null
+++ b/doc/camera_node.md
@@ -0,0 +1,5 @@
+## Configuration
+
+```
+
+``` \ No newline at end of file
diff --git a/doc/sensors_bot.md b/doc/sensors_bot.md
index 9f1c008..c6dba42 100644
--- a/doc/sensors_bot.md
+++ b/doc/sensors_bot.md
@@ -30,4 +30,10 @@ label_en = "There"
[logging]
verbose = false
+```
+
+## Dependencies
+
+```
+apt install python3-matplotlib
``` \ No newline at end of file
diff --git a/doc/sound_bot.md b/doc/sound_bot.md
index f273e7c..93241be 100644
--- a/doc/sound_bot.md
+++ b/doc/sound_bot.md
@@ -2,35 +2,73 @@
## Configuration example
-```toml
-[bot]
-token = "..."
-users = [1, 2]
-manual_record_allowlist = [ 1 ]
-notify_users = [ 1, 2 ]
+```yaml
+bot:
+ token: "..."
+ users: [1, 2]
+ manual_record_allowlist: [ 1 ]
+ notify_users: [ 1, 2 ]
+
+ record_intervals: [15, 30, 60, 180, 300, 600]
+ guard_server: "1.2.3.4:8311"
+
+api:
+ token: "..."
+ host: "..."
-record_intervals = [15, 30, 60, 180, 300, 600]
-guard_server = "1.2.3.4:8311"
+nodes:
+ name1:
+ addr: "1.2.3.4:8313"
+ label:
+ ru: "название 1"
+ en: "name 1"
+ name2:
+ addr: "1.2.3.5:8313"
+ label:
+ ru: "название2"
+ en: "name 2"
-[api]
-token = "..."
-host = "..."
+sound_sensors:
+ name1:
+ ru: "название 1"
+ en: "name 1"
+ name2:
+ ru: "название 2"
+ en: "name 2"
-[nodes]
-name1.addr = '1.2.3.4:8313'
-name1.label = { ru="название 1", en="name 1" }
+cameras:
+ cam1:
+ label:
+ ru: "название 1"
+ en: "name 1"
+ type: esp32
+ addr: "1.2.3.4:80"
+ settings:
+ framesize: 9
+ vflip: true
+ hmirror: true
+ lenc: true
+ wpc: true
+ bpc: false
+ raw_gma: false
+ agc: true
+ gainceiling: 5
+ quality: 10
+ awb_gain: false
+ awb: true
+ aec_dsp: true
+ aec: true
+ flash: true
-name2.addr = '1.2.3.5:8313'
-name2.label = { ru="название2", en="name 2" }
+logging:
+ verbose: false
+ default_fmt: true
-[sound_sensors]
-name1 = { ru="название 1", en="name 1" }
-name2 = { ru="название 2", en="name 2" }
+```
-[cameras]
-name1 = { ru="название 1", en="name 1", type="esp32", addr="1.2.3.4:80", settings = {framesize=9, vflip=true, hmirror=true, lenc=true, wpc=true, bpc=false, raw_gma=false, agc=true, gainceiling=5, quality=10, awb_gain=false, awb=true, aec_dsp=true, aec=true} }
-[logging]
-verbose = false
-default_fmt = true
+## Dependencies
+
+```
+apt install python3-pil
``` \ No newline at end of file
diff --git a/doc/sound_sensor_server.md b/doc/sound_sensor_server.md
new file mode 100644
index 0000000..9543562
--- /dev/null
+++ b/doc/sound_sensor_server.md
@@ -0,0 +1,33 @@
+## Configuration
+
+```
+[server]
+listen = "0.0.0.0:8311"
+guard_control = true
+guard_recording_default = false
+
+[sensor_to_sound_nodes_relations]
+big_house = ['bh1', 'bh2']
+john = ['john']
+
+[sensor_to_camera_nodes_relations]
+big_house = ['bh']
+john = ['john']
+
+[sound_nodes]
+bh1 = { addr = '192.168.1.2:8313', durations = [7, 30] }
+bh2 = { addr = '192.168.1.3:8313', durations = [10, 60] }
+john = { addr = '192.168.1.4:8313', durations = [10, 60] }
+
+[camera_nodes]
+bh = { addr = '192.168.1.2:8314', durations = [7, 30] }
+john = { addr = '192.168.1.4:8314', durations = [10, 60] }
+
+[api]
+token = "..."
+host = "..."
+
+[logging]
+verbose = false
+default_fmt = true
+``` \ No newline at end of file