Merge pull request #459 from Stefal/detect_rtkbase

Detect rtkbase

Author: Stefal

CHANGELOG.md

@@ -2,7 +2,10 @@
 
 ## [2.6.3] - not released
 ### Added
+- New Linux/Windows Gui to detect online Station (https://github.com/Stefal/rtkbase/tree/master/tools/find_rtkbase)
 - Add Unicore UM980/UM982 support (rtcm3 mode). [#351](https://github.com/Stefal/rtkbase/issues/351)
+- Add api to get basics informations about the base station (/api/v1/infos)
+- Add Zeroconf/Avahi service definition to get a fast online Rtkbase station detection.
 - Detect Gnss receiver firmware version during receiver detection. [#428](https://github.com/Stefal/rtkbase/issues/428)
 - GUI -> Logs: Non-zipped files can be convert to rinex. [#348](https://github.com/Stefal/rtkbase/issues/348)
 - GUI -> Settings: Display network informations.

README.md

@@ -9,7 +9,7 @@ Frontend's main features are:
 
 + View the satellites signal levels
 + View the base location on a map
-+ Detect and configure the Gnss receiver (Ublox F9P or Septentrio Mosaic-X5)
++ Detect and configure the Gnss receiver (Ublox F9P, Septentrio Mosaic-X5, Unicore UM980 / UM982)
 + Start/stop various services (Sending data to a Ntrip caster, internal Ntrip caster, Rtcm server, Sending Rtcm stream on a radio link, Log raw data to files)
 + Edit the services settings
 + Convert raw data to Rinex
@@ -43,7 +43,7 @@ If you use a Raspberry Pi, thanks to [jancelin](https://github.com/jancelin), yo
   sudo ./install.sh --all release
   ```
 
-+ Go grab a coffee, it's gonna take a while. The script will install the needed software, and if you use a Usb-connected U-Blox ZED-F9P receiver, it'll be detected and set to work as a base station. If you don't use a F9P, you will have to configure your receiver manually (see step 7 in manual installation), and choose the correct port from the settings page.
++ Go grab a coffee, it's gonna take a while. The script will install the needed software, and if you use a supported receiver (U-Blox ZED-F9P, Septentrio Mosaic-X5, Unicore UM980/UM982), it'll be detected and set to work as a base station. If you don't use a supported recevier, you will have to configure your receiver manually (see step 7 in manual installation), and choose the correct port from the settings page.
 
 + Open a web browser to `http://ip_of_your_sbc` (the script will try to show you this ip address). Default password is `admin`. The settings page allows you to enter your own settings for the base coordinates, ntrip credentials and so on...
 
@@ -54,6 +54,12 @@ If you use a Raspberry Pi, thanks to [jancelin](https://github.com/jancelin), yo
    - [rtklibexplorer - PPP - for dual frequency receivers](https://rtklibexplorer.wordpress.com/2017/11/23/ppp-solutions-with-the-swiftnav-piksi-multi/)
    - [Centipede documentation (in french)](https://docs.centipede.fr/docs/base/positionnement.html)
 
++ To help you find your base ip address, you can use the simple `find_rtkase` gui tool. It is available for Gnu/Linux and Windows in [./tools/find_rtkbase/dist](./tools/find_rtkbase/dist/).
+  
+   - Click on the "Find" button, wait, then click on the "Open" button. It will open the RTKBase GUI in your web browser.
+
+     <img src="./tools/find_rtkbase/find_rtkbase_screenshot.png" alt="screenshot of find_rtkbase tool" width="300" />
+
 ## Manual installation: 
 The `install.sh` script can be used without the `--all` option to split the installation process into several different steps:
 ```
@@ -87,8 +93,8 @@ The `install.sh` script can be used without the `--all` option to split the inst
                              Install all dependencies like git build-essential python3-pip ...
     
             -r | --rtklib
-                             Get RTKlib 2.4.3b34g from github and compile it.
-                             https://github.com/rtklibexplorer/RTKLIB/tree/b34g
+                             Get RTKlib 2.4.3b34j from github and compile it.
+                             https://github.com/rtklibexplorer/RTKLIB/tree/b34j
     
             -b | --rtkbase-release
                              Get last release of RTKBase:
@@ -111,7 +117,7 @@ The `install.sh` script can be used without the `--all` option to split the inst
                              from the gnss receiver.
     
             -e | --detect-gnss
-                             Detect your GNSS receiver. It works only with receiver like ZED-F9P.
+                             Detect your GNSS receiver.
     
             -n | --no-write-port
                              Doesn'\''t write the detected port inside settings.conf.
@@ -218,11 +224,15 @@ So, if you really want it, let's go for a manual installation with some explanat
       sudo systemctl enable gpsd
    ```
 
+1. Install the avahi service definition with `sudo ./install.sh --zeroconf`, or:
+   + Copy the `rtkbase_web.service` file from `rtkbase/tools/zeroconf/` directory to `/etc/avahi/services/`
+   + Replace `{port}` with the port number used by the web server (e.g. 80).  
+
 1. Connect your gnss receiver to raspberry pi/orange pi/.... with usb or uart, and check which com port it uses (ttyS1, ttyAMA0, something else...). If it's a U-Blox F9P receiver (usb or uart) or a Septentrio Mosaic-X5 (usb), you can use `sudo ./install.sh --detect-gnss`. Write down the result, you may need it later.
 
-1. If you didn't have already configure your gnss receiver, you must set it to output raw data:
+1. If you didn't have already configure your gnss receiver, you must set it to output raw or rtcm3 data:
 
-   If it's a U-Blox ZED-F9P (usb or uart), or a Septentrio Mosaic-X5 (usb) you can use 
+   If it's a U-Blox ZED-F9P (usb or uart), or a Septentrio Mosaic-X5 (usb), or a Unicore UM980/UM982 you can use 
    ```bash
    sudo ./install.sh --detect-gnss --configure-gnss
    ```

tools/find_rtkbase/scan_network.py

@@ -1,9 +1,10 @@
-import scapy.all as scapy
-scapy.load_layer("http")
+#! /usr/bin/env python3
 import json
 import time
 import logging
 import argparse
+import scapy.all as scapy
+scapy.load_layer("http")
 from zeroconf import Zeroconf
 from zeroconf import ServiceBrowser
 logging.basicConfig(format='%(levelname)s: %(message)s')
@@ -22,12 +23,12 @@ def add_service(self, zeroconf, type, name):
     def update_service(self, *args, **kwargs):
         pass
 
-def zeroconf_scan(name, type, timeout=5):
+def zeroconf_scan(name, prot_type, timeout=5):
     log.debug("Scanning with zeroconf")
     service_list = []
     zeroconf = Zeroconf()
     listener = MyZeroConfListener()
-    browser = ServiceBrowser(zeroconf, type, listener)
+    browser = ServiceBrowser(zeroconf, prot_type, listener)
     time.sleep(timeout)
     for service in listener.services:
         if name.lower() in service.name.lower():
@@ -170,8 +171,8 @@ def arg_parse():
     parser.add_argument("-i", "--iprange", help="ip range to scan eg 192.168.1.0/24", type=str)
     parser.add_argument("-d", "--debug", action='store_true')
     parser.add_argument("--version", action="version", version="%(prog)s 1.0")
-    args = parser.parse_args()
-    return args
+    arguments = parser.parse_args()
+    return arguments
 
 
 def main(ports, allscan=False, iprange=None):

tools/install.sh

@@ -828,8 +828,8 @@ main() {
   [ $ARG_DETECT_GNSS -eq 1 ] &&  { detect_gnss "${ARG_NO_WRITE_PORT}" ; ((cumulative_exit+=$?)) ;}
   [ $ARG_CONFIGURE_GNSS -eq 1 ] && { configure_gnss ; ((cumulative_exit+=$?)) ;}
   [ $ARG_DETECT_MODEM -eq 1 ] && { detect_usb_modem && _add_modem_port && _configure_modem ; ((cumulative_exit+=$?)) ;}
-  [ $ARG_START_SERVICES -eq 1 ] && { start_services ; ((cumulative_exit+=$?)) ;}
   [ $ARG_ZEROCONF -eq 1 ] && { install_zeroconf_service; ((cumulative_exit+=$?)) ;}
+  [ $ARG_START_SERVICES -eq 1 ] && { start_services ; ((cumulative_exit+=$?)) ;}
 }
 
 main "$@"