travelmate: release 2.4.8-1

* distinguish an active run cycle from an idle daemon in the
  runtime status: 'processing' is now only reported while f_main
  is actually running, an idle daemon without uplink reports
  'not connected' instead
* settle the status file at the end of f_main, so a leftover
  'processing' does not survive into the sleep phase
* README: document the travelmate_status values and the LuCI
  button behaviour

Signed-off-by: Dirk Brenken <redacted>

diff --git a/net/travelmate/Makefile b/net/travelmate/Makefile
index 6eeba80b98dac7a18de59513c8258a144ed8e2a0..2a1574c1fda648eb9f8418037870e05ea42b1157 100644 (file)
--- a/net/travelmate/Makefile
+++ b/net/travelmate/Makefile
@@ -6,8 +6,8 @@
 include $(TOPDIR)/rules.mk
 
 PKG_NAME:=travelmate
-PKG_VERSION:=2.4.7
-PKG_RELEASE:=3
+PKG_VERSION:=2.4.8
+PKG_RELEASE:=1
 PKG_LICENSE:=GPL-3.0-or-later
 PKG_MAINTAINER:=Dirk Brenken <dev@brenken.org>
 

diff --git a/net/travelmate/files/README.md b/net/travelmate/files/README.md
index 20675dec7d95726bf5a9ecfada553ef0ac995427..e31ee1e950383a557700fc81d32a7823768b2795 100644 (file)
--- a/net/travelmate/files/README.md
+++ b/net/travelmate/files/README.md
@@ -89,6 +89,18 @@ For a typical setup these few steps are enough to get travelmate up and running
 * You may add additional uplinks for different locations by repeating the previous step
 * Happy traveling ...
 
+The buttons at the bottom of the LuCI overview page behave as follows:
+
+| Button               | Description                                                                                                        |
+| :------------------- | :----------------------------------------------------------------------------------------------------------------- |
+| **Stop**             | Stops the travelmate service. Greyed out while the service is not running                                            |
+| **Interface Wizard** | One-time setup of the uplink interface, firewall zone and metric                                                     |
+| **Interface Restart** | Restarts the travelmate uplink interface without touching the configuration                                         |
+| **AP QR-Codes**      | Displays a QR code per AP to transfer the wireless credentials to your mobile devices                                |
+| **Save & Restart**   | Applies pending configuration changes and restarts the service, this also brings a stopped service back up           |
+
+While a run cycle is in progress (status `processing`), all buttons except **Stop** are temporarily locked to avoid overlapping actions. **Stop** always stays available, so an unwanted or long running cycle can be interrupted at any time - e.g. right after the **Interface Wizard** on a fresh setup, when no uplink station has been configured yet.
+
 <a id="travelmate-cli-interface"></a>
 ## Travelmate CLI interface
 * All important travelmate functions are accessible via CLI, too. If you're going to configure travelmate via CLI, edit the config file `/etc/config/travelmate` and enable the service, see the options reference tables below.
@@ -132,6 +144,17 @@ The `status` sub-command prints the current runtime information:
   + system_info        : cores: 2, fetch: curl, Cudy TR3000 v1, mediatek/filogic, OpenWrt SNAPSHOT (r32287-1c7ec8ab19)
 ```
 
+The `travelmate_status` field reports one of the following states:
+
+| State           | Description                                                                                                     |
+| :-------------- | :-------------------------------------------------------------------------------------------------------------- |
+| `connected`     | An uplink is connected, followed by the connection details, e.g. `connected, net ok/100`                          |
+| `processing`    | A run cycle is currently in progress, e.g. scanning the radios or waiting for an uplink to come up                |
+| `not connected` | No uplink is connected and no run cycle is active, i.e. travelmate is idle and waiting for the next trigger       |
+| `program error` | A fatal error occurred, the daemon has stopped, please check the syslog                                           |
+
+A stopped service does not report a state at all, it truncates the runtime file instead - LuCI shows this as `stopped`.
+
 <a id="travelmate-config-options"></a>
 ## Travelmate config options
 * Usually the pre-configured travelmate setup works quite well and no manual config overrides are needed. All options listed below apply to the 'global' section:

diff --git a/net/travelmate/files/travelmate-functions.sh b/net/travelmate/files/travelmate-functions.sh
index 1aaab6788719acbfe6304bf1bf36dfba67f2884c..6b3b331a18d623677be9217f02203e9a8e395834 100644 (file)
--- a/net/travelmate/files/travelmate-functions.sh
+++ b/net/travelmate/files/travelmate-functions.sh
@@ -53,6 +53,7 @@ trm_captiveurl="http://detectportal.firefox.com"
 trm_useragent="Mozilla/5.0 (X11; Linux x86_64; rv:144.0) Gecko/20100101 Firefox/144.0"
 trm_action="${1}"
 trm_runmode=""
+trm_active="0"
 
 # ensure runtime directory exists
 #
@@ -1188,7 +1189,11 @@ f_genstatus() {
                status="program error"
        else
                trm_connection=""
-               status="processing"
+               if [ "${trm_active}" = "1" ]; then
+                       status="processing"
+               else
+                       status="not connected"
+               fi
                runtime="-"
        fi
 
@@ -1403,6 +1408,11 @@ f_main() {
        local radio cnt retrycnt scan_list scan_essid scan_bssid scan_rsn scan_wpa scan_quality scan_open station_id retry_display
        local section sta sta_essid sta_bssid sta_radio sta_mac open_sta open_essid config_radio config_essid config_bssid
 
+       # mark the run cycle as active, e.g. to distinguish 'processing' from an
+       # idle daemon in f_genstatus
+       #
+       trm_active="1"
+
        # initial check
        #
        f_check "initial" "false"
@@ -1580,6 +1590,14 @@ f_main() {
                        done
                done
        fi
+
+       # the run cycle is over, settle the status file for the idle phase, e.g.
+       # to turn a leftover 'processing' into 'not connected'
+       #
+       trm_active="0"
+       if [ "${trm_ifstatus}" != "true" ] && [ "${trm_ifstatus}" != "error" ]; then
+               f_genstatus
+       fi
 }
 
 # reference required system utilities