Merge pull request #298 from Stefal/dev

Merge dev 2.4.0 to master

Author: Stefal

CHANGELOG.md

@@ -1,8 +1,49 @@
 # Changelog
+
+## [2.4.0] - 2023-02-20
+### Added
+- GUI -> Settings: Added a 2nd NTRIP output. #240
+- GUI -> Settings: Added features to backup, restore and reset RTKBase settings.
+- GUI -> Settings: Added a button to detect and/or configure the gnss receiver. #70
+- GUI -> Settings: Added a button to show/hide the Ntrip passwords. Thanks to @GwnDaan #208 
+- GUI -> Settings: Added Gnss receiver informations (Model and firmware release).
+- GUI -> Settings: Added Operating system informations.
+- GUI -> Settings: Alert when user wants to leave the page with unsaved settings. #235
+- GUI -> Status: Added tooltip on the blue pin to explain that it's a coarse location. #247
+- GUI -> Status: Added an alert if the main service isn't active.
+- GUI -> Logs: Added 3 more Rinex presets, and modified rinex window layout. #43 #134 #190 #200
+- Bidirectionnal communication with the gnss receiver is enabled. #277
+- More informations are available in the local caster source table. #183
+- Port number for the web server is configurable in settings.conf
+### Changed
+- RTKLib upgraded to release b34g from rtklibexplorer. #222
+- RTKLib binaries are bundled for armv6l, armv7l, aarch64, x86. Compilation from source isn't needed anymore for these platforms.
+- Command line: Many changes on install.sh arguments/options. See `install.sh --help`
+- Flask upgraded to v2.2.2 and other dependencies upgraded too.
+- SocketIO upgraded to v4.4.1
+- Bootstrap upgraded to v4.6.1
+- Bootstrap-table upgraded to v1.21.1
+- Password for local caster isn't mandatory anymore. Thanks to @GwnDaan #210
+- Change socketio connection method. Thanks to @jaapvandenhandel
+- Change 127.0.0.1 to localhost for better ipv6 support. Thanks to @by
+### Fixed
+- GUI -> Status: Sat. levels and coordinates are set to zero in case of a signal interruption. #164
+- GUI -> Status: Sat. levels are left align. Thanks to @GwnDaan #72
+- GUI -> Status: New provider for OpenStreetMap HOT tiles.
+- GUI: After a RTKBase update, the browser won't use the old javascript files anymore (cache busting). #217
+- Remaining space check could not work with non english shell. Thanks to @GwnDaan #213
+- GUI -> Settings: No more "bounce" issues with the switches. Thanks to @GwnDaan
+- Max Cpu temp was not updated when no user were connected. Thanks to @GwnDaan
+- GUI -> Settings: Check update now display an error in case of a connection error. Thanks to @GwnDaan #221
+- GUI -> Logs: Better logs table behaviour on mobile devices.
+- Grep pattern fixed on PPS example. Thanks to @by.
+
+### Security
+
 ## [2.3.4] - 2022-04-01
 ### Fixed 
- - Failure with some python dependancies. #215
- - More fixes with Gpsd service restart. #94
+- Failure with some python dependancies. #215
+- More fixes with Gpsd service restart. #94
 
 ## [2.3.3] - 2022-02-28
 ### Fixed

README.md

@@ -9,8 +9,10 @@ Frontend's main features are:
 
 + View the satellites signal levels
 + View the base location on a map
-+ Start/stop various services (Sending data to a Ntrip caster, Ntrip caster, Rtcm server, Sending Rtcm stream on a radio link, Log raw data to files)
++ Detect and configure the Gnss receiver (F9P)
++ 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
 + Download/delete raw data
 
 ## Base example:
@@ -34,12 +36,12 @@ If you use a Raspberry Pi, thanks to [jancelin](https://github.com/jancelin), yo
 
 + Open a terminal and:
 
-   ```bash
-   $ cd ~
-   $ wget https://raw.githubusercontent.com/Stefal/rtkbase/master/tools/install.sh -O install.sh
-   $ chmod +x install.sh
-   $ sudo ./install.sh --all
-   ```
+  ```bash
+  cd ~
+  wget https://raw.githubusercontent.com/Stefal/rtkbase/master/tools/install.sh -O install.sh
+  chmod +x install.sh
+  sudo ./install.sh --all
+  ```
 
 + 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.
 
@@ -54,8 +56,8 @@ If you use a Raspberry Pi, thanks to [jancelin](https://github.com/jancelin), yo
 
 ## Manual installation: 
 The `install.sh` script can be used without the `--all` option to split the installation process into several different steps:
-```bash
-   $ ./install.sh --help
+```
+   ./install.sh --help
    ################################
    RTKBASE INSTALLATION HELP
    ################################
@@ -69,64 +71,81 @@ The `install.sh` script can be used without the `--all` option to split the inst
          sudo ./install.sh
 
    Options:
-        --all
-                         Install all dependencies, Rtklib, last release of Rtkbase, gpsd, chrony, services,
+        -a | --all
+                         Install all you need to run RTKBase : dependencies, RTKlib, last release of Rtkbase, services,
                          crontab jobs, detect your GNSS receiver and configure it.
 
-        --dependencies
+        -v | --alldev <branch>
+                         Install all as --all option, but use the rtkbase github repo instead of the release
+                         You have to select the git branch you want to install.
+
+        -u | --user
+                         Use this username as User= inside service unit and for path to rtkbase:
+                         --user=john will install rtkbase in /home/john/rtkbase
+
+        -d | --dependencies
                          Install all dependencies like git build-essential python3-pip ...
 
-        --rtklib
-                         Clone RTKlib 2.4.3 from github and compile it.
-                         https://github.com/tomojitakasu/RTKLIB/tree/rtklib_2.4.3
+        -r | --rtklib
+                         Get RTKlib 2.4.3b34g from github and compile it.
+                         https://github.com/rtklibexplorer/RTKLIB/tree/b34g
 
-        --rtkbase-release
-                         Get last release of RTKBASE:
+        -b | --rtkbase-release
+                         Get last release of RTKBase:
                          https://github.com/Stefal/rtkbase/releases
 
-        --rtkbase-repo
-                         Clone RTKBASE from github:
-                         https://github.com/Stefal/rtkbase/tree/web_gui
+        -i | --rtkbase-repo <branch>
+                         Clone RTKBASE from github with the <branch> parameter used to select the branch.
+
+        -f | --rtkbase-custom <source>
+                         Get RTKBASE from an url.
 
-        --unit-files
+        -t | --unit-files
                          Deploy services.
 
-        --gpsd-chrony
+        -g | --gpsd-chrony
                          Install gpsd and chrony to set date and time
                          from the gnss receiver.
 
-        --detect-usb-gnss
-                         Detect your GNSS receiver.
+        -e | --detect-usb-gnss
+                         Detect your GNSS receiver. It works only with usb-connected receiver like ZED-F9P.
 
-        --configure-gnss
+        -n | --no-write-port
+                         Doesn't write the detected port inside settings.conf.
+                         Only relevant with --detect-usb-gnss argument.
+
+        -c | --configure-gnss
                          Configure your GNSS receiver.
 
-        --start-services
+        -s | --start-services
                          Start services (rtkbase_web, str2str_tcp, gpsd, chrony)
 
+        -h | --help
+                          Display this help message.
+
    ```
 So, if you really want it, let's go for a manual installation with some explanations:
 1. Install dependencies with `sudo ./install.sh --dependencies`, or do it manually with:
    ```bash
-   $ sudo apt update
-   $ sudo apt install -y  git build-essential python3-pip python3-dev python3-setuptools python3-wheel libsystemd-dev bc dos2unix socat
+    sudo apt update
+    sudo apt install -y  git build-essential pps-tools python3-pip python3-dev python3-setuptools python3-wheel libsystemd-dev bc dos2unix socat zip unzip pkg-config psmisc
    ```
 
 1. Install RTKLIB with `sudo ./install.sh --rtklib`, or:
-   + clone [RTKlib](https://github.com/tomojitakasu/RTKLIB/tree/rtklib_2.4.3)
+   + get [RTKlib](https://github.com/rtklibexplorer/RTKLIB)
 
       ```bash
-      $ cd ~
-      $ git clone -b rtklib_2.4.3 --single-branch https://github.com/tomojitakasu/RTKLIB
+      cd ~
+      wget -qO - https://github.com/rtklibexplorer/RTKLIB/archive/refs/tags/b34g.tar.gz | tar -xvz
       ```
 
    + compile and install str2str:
 
       Optionally, you can edit the CTARGET line in makefile in RTKLIB/app/str2str/gcc
 
       ```bash
-      $ cd RTKLIB/app/str2str/gcc
-      $ nano makefile
+      cd RTKLIB/app/str2str/gcc
+      nano makefile
       ```
 
       For an Orange Pi Zero SBC, i use:
@@ -136,33 +155,33 @@ So, if you really want it, let's go for a manual installation with some explanat
       Then you can compile and install str2str:
 
       ```bash  
-      $ make
-      $ sudo make install
+      make
+      sudo make install
       ```
    + Compile/install `rtkrcv` and `convbin` the same way as `str2str`.
 
 1. Get latest rtkbase release `sudo ./install.sh --rtkbase-release`, or:
    ```bash
-   $ wget https://github.com/stefal/rtkbase/releases/latest/download/rtkbase.tar.gz -O rtkbase.tar.gz
-   $ tar -xvf rtkbase.tar.gz
+   wget https://github.com/stefal/rtkbase/releases/latest/download/rtkbase.tar.gz -O rtkbase.tar.gz
+   tar -xvf rtkbase.tar.gz
 
    ```
    If you prefer, you can clone this repository to get the latest code.
 
 1. Install the rtkbase requirements:
    ```bash
-   $ python3 -m pip install --upgrade pip setuptools wheel  --extra-index-url https://www.piwheels.org/simple
-   $ python3 -m pip install -r rtkbase/web_app/requirements.txt  --extra-index-url https://www.piwheels.org/simple
+   python3 -m pip install --upgrade pip setuptools wheel  --extra-index-url https://www.piwheels.org/simple
+   python3 -m pip install -r rtkbase/web_app/requirements.txt  --extra-index-url https://www.piwheels.org/simple
 
 1. Install the systemd services with `sudo ./install.sh --unit-files`, or do it manually with:
    + Edit them (`rtkbase/unit/`) to replace `{user}` with your username.
    + If you log the raw data inside the base station, you may want to compress these data and delete the too old archives. `archive_and_clean.sh` will do it for you. The default settings compress the previous day data and delete all archives older than 90 days. To automate these 2 tasks, enable the `rtkbase_archive.timer`. The default value runs the script every day at 04H00.
    + Copy these services to `/etc/systemd/system/` then enable the web server, str2str_tcp and rtkbase_archive.timer:
    ```bash
-   $ sudo systemctl daemon-reload
-   $ sudo systemctl enable rtkbase_web
-   $ sudo systemctl enable str2str_tcp
-   $ sudo systemctl enable rtkbase_archive.timer
+   sudo systemctl daemon-reload
+   sudo systemctl enable rtkbase_web
+   sudo systemctl enable str2str_tcp
+   sudo systemctl enable rtkbase_archive.timer
    ```
 1. Install and configure chrony and gpsd with `sudo ./install.sh --gpsd-chrony`, or:
    + Install chrony with `sudo apt install chrony` then add this parameter in the chrony conf file (/etc/chrony/chrony.conf):
@@ -174,7 +193,7 @@ So, if you really want it, let's go for a manual installation with some explanat
    ```
       # Devices gpsd should connect to at boot time.
       # They need to be read/writeable, either by user gpsd or the group dialout.
-      DEVICES="tcp://127.0.0.1:5015"
+      DEVICES="tcp://localhost:5015"
 
       # Other options you want to pass to gpsd
       GPSD_OPTIONS="-n -b"
@@ -190,9 +209,9 @@ So, if you really want it, let's go for a manual installation with some explanat
    ```
    + Reload the services and enable them:
    ```bash
-      $ sudo systemctl daemon-reload
-      $ sudo systemctl enable chrony
-      $ sudo systemctl enable gpsd
+      sudo systemctl daemon-reload
+      sudo systemctl enable chrony
+      sudo systemctl enable gpsd
    ```
 
 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 usb receiver, you can use `sudo ./install.sh --detect-usb-gnss`. Write down the result, you may need it later.
@@ -201,37 +220,38 @@ So, if you really want it, let's go for a manual installation with some explanat
 
    If it's a U-Blox ZED-F9P (usb), you can use 
    ```bash
-   $ sudo ./install.sh --detect-usb-gnss --configure-gnss
+   sudo ./install.sh --detect-usb-gnss --configure-gnss
    ```
 
    If it's a U-Blox ZED-F9P (uart), you can use this command (change the ttyS1 and 115200 value if needed)):
    ```bash
-   $ rtkbase/tools/set_zed-f9p.sh /dev/ttyS1 115200 rtkbase/receiver_cfg/U-Blox_ZED-F9P_rtkbase.cfg
+   rtkbase/tools/set_zed-f9p.sh /dev/ttyS1 115200 rtkbase/receiver_cfg/U-Blox_ZED-F9P_rtkbase.cfg
    ```
      
    If you need to use a config tool from another computer (like U-center), you can use `socat`:
 
    ```bash
-   $ sudo socat tcp-listen:128,reuseaddr /dev/ttyS1,b115200,raw,echo=0
+   sudo socat tcp-listen:128,reuseaddr /dev/ttyS1,b115200,raw,echo=0
    ```
 
    Change the ttyS1 and 115200 value if needed. Then you can use a network connection in U-center with the base station ip address and the port n°128.
 
 1. Now you can start the services with `sudo ./install.sh --start-services`, or:
    ```bash
-      $ sudo systemctl start rtkbase_web
-      $ sudo systemctl start str2str_tcp
-      $ sudo systemctl start gpsd
-      $ sudo systemctl start chrony
-      $ sudo systemctl start rtkbase_archive.timer
+   sudo systemctl start rtkbase_web
+   sudo systemctl start str2str_tcp
+   sudo systemctl start gpsd
+   sudo systemctl start chrony
+   sudo systemctl start rtkbase_archive.timer
    ```
 
    Everything should be ready, now you can open a web browser to your base station ip address.
 
 ## How it works:
 RTKBase use several RTKLIB `str2str` instances started with `run_cast.sh` as systemd services. `run_cast.sh` gets its settings from `settings.conf`
 + `str2str_tcp.service` is the main instance. It is connected to the gnss receiver and broadcast the raw data on TCP for all the others services.
-+ `str2str_ntrip.service` get the data from the main instance, convert the data to rtcm and stream them to a Ntrip caster.
++ `str2str_ntrip_A.service` get the data from the main instance, convert the data to rtcm and stream them to a Ntrip caster.
++ `str2str_ntrip_B.service` get the data from the main instance, convert the data to rtcm and stream them to another Ntrip caster.
 + `str2str_local_ntrip_caster.service` get the data from the main instance, convert the data to rtcm, and act as a local Ntrip caster.
 + `str2str_rtcm_svr.service` get the data from the main instance, convert the data to rtcm and stream them to clients
 + `str2str_rtcm_serial.service` get the data from the main instance, convert the data to rtcm and stream them to a serial port (radio link, or other peripherals)
@@ -251,10 +271,10 @@ The default map background is OpenStreetMap, but you can switch to a worldwide a
 ## Development release:
 If you want to install RTKBase from the dev branch, you can do it with these commands:
 ```bash
-   $ cd ~
-   $ wget https://raw.githubusercontent.com/Stefal/rtkbase/dev/tools/install.sh -O install.sh
-   $ chmod +x install.sh
-   $ sudo ./install.sh --alldev
+cd ~
+wget https://raw.githubusercontent.com/Stefal/rtkbase/dev/tools/install.sh -O install.sh
+chmod +x install.sh
+sudo ./install.sh --alldev dev
 ```
 
 ## Other usages:
@@ -321,4 +341,4 @@ RTKBase uses some parts of other software:
 + [pystemd](https://github.com/facebookincubator/pystemd) (L-GPL 2.1)
 + [gpsd](https://gitlab.com/gpsd/gpsd) (BSD-2-Clause)
 
-RTKBase uses [OpenStreetMap](https://www.openstreetmap.org) tiles, courtesy of [Empreinte digitale](https://cloud.empreintedigitale.fr).
+RTKBase uses [OpenStreetMap](https://www.openstreetmap.org) tiles. Thank you to all the contributors!