Merge pull request #7 from Ddoiron-cidco/master

clean repo and update docs

Author: glabmoris

BOM.txt

@@ -1,8 +1,7 @@
 Raspberry pi 3B+
-https://canada.newark.com/raspberry-pi/rpi3-modbp/sbc-arm-cortex-a53-1gb-sdram/dp/49AC7637
-Environ 50$ CAD
+https://www.waveshare.com/product/raspberry-pi/boards-kits/raspberry-pi-3/raspberry-pi-3-model-b-plus.htm
+
+FT232RL USB TO RS232/485/TTL Interface Converter, Industrial Isolation
+https://www.waveshare.com/usb-to-rs232-485-ttl.htm?sku=15817
 
-RS422 / RS485 Shield for Raspberry Pi
-https://www.hwhardsoft.de/english/webshop/shields/#cc-m-product-11173736397
-Environ 60$ CAD
 

Makefile

@@ -1,28 +1,48 @@
 # README for nmeaSIMULATOR.py
 ## Sonar simulator NMEA-0183
 
-*implementation of PyPi : nmeasim https://pypi.org/project/nmeasim/#description*
+
 
 ### foncitonnalities :
 
 Generate nmea-0183 string of types  :  
-- Geospatial (GGA, GLL, RMC, VTG, ZDA) - simulated using a consistent location/velocity model, time using machine time (not NTP, unless the machine happens to be NTP synchronised).  
-- Satellites (GSA, GSV) - faked with random azimuth/elevation.
 - Depth of water (SDDPT)
 
 ### HOW TO MAKE IT WORK: 
 
 On a Raspberry pi : 
-First, setting the baud rate at 4800 : stty -F /dev/ttyUSB0 4800  
-Then, in /SonarSimulator/src python3 nmeaSIMULATOR.py 1    
 
+1. Install ubuntu server on as sdcard with the user ubuntu
+
+2. Connect the usb serial adapter on the Raspberry
+
+3. apply the power on the raspberry
+
+4. validate if the serial adapter is detected by the OS
+    ls /dev/ttyU*
+	  you should see ttyUSB0
+   
+5. clone the repository in /home/ubuntu
+
+6. Validate and modify the setting for the serial port and baudrate in the autolaunch.sh
+    nano /home/ubuntu/SonarSimulator/autolaunch.sh
+	  python /home/ubuntu/SonarSimulator/Script/sonar_simulator_DPT.py /dev/ttyUSB0 9600
+	  the 2 last argument are the serial port and the baudrate
+	  ex:
+	  python /home/ubuntu/SonarSimulator/Script/sonar_simulator_DPT.py /dev/ttyUSB1 9600
+	  python /home/ubuntu/SonarSimulator/Script/sonar_simulator_DPT.py /dev/ttyAMA0 115200
+
+7. go in the install directory and run the installation script
+    cd /home/ubuntu/SonarSimulator/Install
+    ./install.sh
 
-### install requirements for nmeaSim
-install_requires =
+The script is installed as a service. 
+If you do some modification in the autolaunch.sh file you have to relaunch the service. 
+sudo systemctl restart nmea
 
-    pyserial
+to show the status of the service : sudo systemctl status nmea
+to start the service : sudo systemctl start nmea
+to stop the service : sudo systemctl stop nmea
 
-    geographiclib
 
-    importlib.metadata; python_version<'3.8'