major overhaul to do serial reading and uploading in an asynchronous fashion. Moved concepts from gnssr4river to this repository

Author: strawpants

Diff for: .gitignore

@@ -0,0 +1 @@
+__pycache__

Diff for: README.md

@@ -1,7 +1,70 @@
-# Raspberry_Gnssr
+# Using a low-cost Raspberry pi enabled Gnss reflectometer to log and upload NMEA messages
 
+[Instructions for building together the casing](doc/README.md)
 
+# Raspberry Information
+---
 
-[Instructions for building together the casing](doc/README.md)
+### Install the python module
+```
+pip install .
+```
+
+### Copy and Change the yaml config file
+
+The file ``nmeaconfig.yml`` is the file used for configuration. Copy the file to the user's home and open it with a text editor and change the value.
+
+* ``file_base`` *ex: myfile*, the basename used for naming the  output (date and increment will be appended to this e.g. providing `testname` will result in `testname_2022-01-01_00.gz`
+* ``data_dir`` *ex: /home/user*, the path where the data logs will be stored
+* ``device`` *ex: /dev/ttyAMA0*, the linux serial device path which produces the nmea output   
+* ``baudrate`` *ex: 9600*, the baudrate of the serial port   
+* ``serialsleep`` *ex: 20*, set the amount of microseconds to sleep between serial reads (this time will be made available to do other tasks such as uploading)
+* ``webdav`` 
+	* ``url`` Webdav upload address
+	* ``user``
+	* ``password``
+
+### How to setup a service file
+
+If you want your raspberry to automatically launch the logger on boot, you need to create a service file (see the example file [nmealogger.service](nmealogger.service). This allows to simply plug your raspberry and directly execute a program without having to open a terminal. This is very useful for field survey where the raspberry boots and runs without interactive user input, or where a power failure will result in a reboot.
+
+
+Now to create the service, copy the modified [nmealogger.service file](nmealogger.service) into the right directory:  
+```
+sudo cp nmealogger.service /etc/systemd/system/nmealogger.service
+```
+
+Make sure to replace *User* with a user who can access the serial port and the *data_dir* provided in the [configuration file](nmeaconfig.yml)
+
+```
+Before starting the service, execute the following line. It reloads to take the change into account
+```
+sudo systemctl daemon-reload
+```
+You can then start the service, if the service file is installed in the right directory (``/etc/systemd/system/``)
+```
+sudo systemctl start nmealogger.service
+```
+You can see if your service file is properly running by executing
+```
+sudo systemctl status nmealogger.service
+```
+You can also of course stop the service
+```
+sudo systemctl stop nmealogger.service
+```
+Your service file is now running on your raspberry until the board is shutdown. If you want to start it on boot *enable* it:
+
+```
+sudo systemctl enable nmealogger.service
+```
+
+
+
+
+
+## Authors
+
+**Lubin Roineau, Roelof Rietbroek**
 
 

Diff for: ReadandWriteSerials.py

@@ -0,0 +1,14 @@
+# Yaml file for raspberry gnssr-r configuration
+# Copy this file and replace values with your own
+---
+file_base: gnssr0
+data_dir: /tmp/gnssr_nmea/
+device: /dev/ttyAMA0
+baudrate: 9600
+serialsleep: 20 #microsecond sleep in between getting nmea messages from the serial port to get other stuff done
+#Possibly upload to a webdav folder
+webdav:
+  url: "https://surfdrive.surf.nl/files/public.php/webdav"
+  user: Changeme
+  passw: Changemetoo
+

Diff for: UploadingfileWebdav.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+"""
+Main nmealogging command line daemon
+Authors: Roelof Rietbroek
+Nov 2022
+"""
+
+from raspberry_gnssr.gnssr import GNSSRconfig
+import asyncio
+import argparse
+import sys
+
+def main(argv):
+    usage="GNSSR nmea logging and upload daemon"
+    parser = argparse.ArgumentParser(description=usage)
+    
+    parser.add_argument('config',metavar="Configuration file",type=str,nargs="?",
+            help="Specify configuration file to use (default ${HOME}/nmeaconfig.yml)")
+
+    parser.add_argument('-s','--simulate',action='store_true',
+            help="Simulate some nmea messages on a fake serial port (allows testing on non gnss-enabled platforms)")
+    parser.add_argument('-n','--noupload',action='store_true',
+            help="Don't attempt to upload any logs")
+    args=parser.parse_args(argv[1:]) 
+    
+    gnssr=GNSSRconfig(args.config,args.simulate,args.noupload)
+    try:
+        asyncio.run(gnssr.startLoggingDaemon())
+    except KeyboardInterrupt:
+        gnssr.closeLog()
+
+
+if __name__ == "__main__":
+    main(sys.argv)

Diff for: nmeaconfig.yml

@@ -0,0 +1,13 @@
+[Unit]
+Description=NMEA message logging service
+After=multi-user.target
+
+[Service]
+Type=simple
+User=roelof
+Restart=on-abort
+ExecStart=nmealogger.py
+
+[Install]
+WantedBy=multi-user.target
+