doc

README.md

@@ -38,7 +38,16 @@ git clone https://git.hs42.de/hs/sumsel.git
 cd /sumsel
 cp sumsel.conf.dist sumsel.conf
 ```
-Anschliessend Variablen in ./sumsel.conf setzen.
+Anschliessend Variablen in ./sumsel.conf setzen:
+| Variable                 | Optional/Required | Bedeutung                                       | Default                                   |
+| ------------------------ | ----------------- | ----------------------------------------------- | ----------------------------------------- |
+| REC_DEVICE               | required          | Adresse der USB Soundkarte                      | plughw:1,0                                |
+| REMOTE_DIR               | required          | Zielordner auf dem entfernten Server            | <remote_user>@<remote_host>:<remote_path> |
+| REF_FILE_TIME            | optional          | Laenge einer WAV Datei in Sekunden              | 360                                       |
+| REC_DIR                  | optional          | Ordner, ind dem die WAV Dateien abgelegt werden | ./recordings                              |
+| REC_PREFIX               | optional          | Prefix Dateiname WAV Dateien                    | sums                                      |
+| UPL_DIR                  | optional          | Ordner in dem die MP3 Dateien abgelegt werden   | ./upqueue                                 |
+| UPL_SUFFIX               | optional          | Ordner in dem die MP3 Dateien abgelegt werden   | sumsi                                     |
 
 ## Betrieb
 
@@ -61,3 +70,9 @@ Einplanung über crond
 ```
 pi@raspi:~> ./convert.sh
 ```
+
+### GIT commands
+* git status
+* git add ...
+* git commit -m "..."
+* git push origin master

convert.sh

@@ -1,5 +1,6 @@
 #!/bin/bash
 
+. ./sumsel.defaults
 . ./sumsel.conf
 . ./sumsel_functions.incl
 

record.sh

@@ -1,5 +1,6 @@
 #!/bin/bash
 
+. ./sumsel.defaults
 . ./sumsel.conf
 . ./sumsel_functions.incl
 

simulate.sh

@@ -1,5 +1,6 @@
 #!/bin/bash
 
+. ./sumsel.defaults
 . ./sumsel.conf
 . ./sumsel_functions.incl
 

sumsel.conf.dist

@@ -1,27 +1,24 @@
-LOCK_DIR=/var/lock
-
-SIM_EXAMPLE_FILE=./res/test.wav
 
 REC_DEVICE=plughw:1,0
 
 #Laenge der WAV Dateien in Sekunden
-REC_FILE_TIME=360
+#REC_FILE_TIME=360
 
 #Ordner, ind dem die WAV Dateien abgelegt werden
 #wenn der Ordner nicht existiert, wird er angelegt
-REC_DIR=./recordings
+#REC_DIR=./recordings
 
 #Dateiname der WAV Dateien
 # sums-01.wav, sums-02.wav, ...
-REC_PREFIX=sums
+#REC_PREFIX=sums
 
 #Ordner in dem die MP3 Dateien abgelegt werden
 #wenn der Ordner nicht existiert, wird er angelegt
-UPL_DIR=./upqueue
+#UPL_DIR=./upqueue
 
 #Dateiname der MP3 Dateien
 # 20210130101112-sumsi.mp3, 20210130101120-sumsi.mp3, ...
-UPL_SUFFIX=sumsi
+#UPL_SUFFIX=sumsi
 
 #Rsync Zielordner
 REMOTE_DIR=<remote_user>@<remote_host>:<remote_path>

sumsel.defaults

@@ -0,0 +1,23 @@
+LOCK_DIR=/var/lock
+
+SIM_EXAMPLE_FILE=./res/test.wav
+
+#Laenge der WAV Dateien in Sekunden
+REC_FILE_TIME=360
+
+#Ordner, ind dem die WAV Dateien abgelegt werden
+#wenn der Ordner nicht existiert, wird er angelegt
+REC_DIR=./recordings
+
+#Dateiname der WAV Dateien
+# sums-01.wav, sums-02.wav, ...
+REC_PREFIX=sums
+
+#Ordner in dem die MP3 Dateien abgelegt werden
+#wenn der Ordner nicht existiert, wird er angelegt
+UPL_DIR=./upqueue
+
+#Dateiname der MP3 Dateien
+# 20210130101112-sumsi.mp3, 20210130101120-sumsi.mp3, ...
+UPL_SUFFIX=sumsi
+