update docs

UMONS-GFA · Jul 4, 2017 · 9704eeb · 9704eeb
1 parent 5ba6970
commit 9704eeb
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 2 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -12,7 +12,7 @@ Welcome to ardas's documentation!
 
    parse_and_push_to_db
    build_arduino_sketch
-
+   settings
 
 Indices and tables
 ==================

diff --git a/docs/source/parse_and_push_to_db.rst b/docs/source/parse_and_push_to_db.rst
@@ -9,5 +9,5 @@ Add a cron job::
    PYTHONPATH=/home/pi/ardas
 
    # m h  dom mon dow   command
-   @reboot /usr/bin/python3 /home/pi/ardas/ardas/raspardas.py debug on calibration /home/pi/ardas/ardas/calibrations/cal_0002.dat > /home/pi/cronlog.log 2>&1
+   @reboot /usr/bin/python3 /home/pi/ardas/ardas/raspardas.py debug on calibration /home/pi/ardas/ardas/calibrations/cal_0002.dat > /home/pi/ardas/cronlog.log 2>&1
 
diff --git a/docs/source/settings.rst b/docs/source/settings.rst
@@ -0,0 +1,42 @@
+Settings
+========
+
+
+``DATABASE``
+------------
+
+InfluxDB is used. ::
+
+    DATABASE = {
+        'HOST': '127.0.0.1',
+        'PORT': 8086,
+        'USER': 'mydatabaseuser',
+        'PASSWORD': 'mypassword',
+        'NAME': 'mydatabase'
+    }
+
+``ARDAS``
+---------
+
+::
+
+    ARDAS_CONFIG = {
+        'station': '0002',
+        'net_id': '001',
+        'integration_period': '0001'
+    }
+
+
+``SFTP``
+--------
+
+::
+
+    SFTP = {
+        'host': '127.0.0.1',
+        'username': 'pi',
+        'password': '',
+        'local_path':'/home/username/test.txt',
+        'remote_path': '/home/pi/remote/test.txt'
+    }
+