* union 'automatic' and 'trigger' mode, now much more responsive
if an uplink suddenly disappears
* tidy up (disable) travelmate related uplink connections
if you disable the service
* change default config ('trm_automatic' removal)
* documentation update
* LuCI: remove needless 'automatic' and 'trigger' options
plus small fixes
Signed-off-by: Dirk Brenken <dev@brenken.org>
@ -11,24 +11,25 @@ To avoid these kind of deadlocks, travelmate set all station interfaces in an "a
* strong LuCI-Support with builtin interface wizard and a wireless station manager
* strong LuCI-Support with builtin interface wizard and a wireless station manager
* fast uplink connections
* fast uplink connections
* support all kinds of uplinks, incl. hidden and enterprise uplinks
* support all kinds of uplinks, incl. hidden and enterprise uplinks
* trigger- or automatic-mode support, the latter one is the default and checks the existing uplink connection regardless of ifdown event trigger actions every n seconds
* checks continuously the signal quality for conditional uplink (dis-) connections
* continuously checks the existing uplink connection (quality), e.g. for conditional uplink (dis-) connections
* captive portal detection with internet online check and a 'heartbeat' function to keep the uplink connection up & running
* captive portal detection with internet online check and a 'heartbeat' function to keep the uplink connection up & running
* support of devices with multiple radios
* support of devices with multiple radios
* procd init and hotplug support
* procd init and hotplug support
* runtime information available via LuCI & via 'status' init command
* runtime information available via LuCI & via 'status' init command
* status & debug logging to syslog
* status & debug logging to syslog
* optional: the LuCI frontend shows the WiFi QR codes from all configured Access Points. It allows you to connect your Android or iOS devices to your router’s WiFi using the QR code
## Prerequisites
## Prerequisites
* [OpenWrt](https://openwrt.org), tested with the stable release series (17.01.x) and with the latest OpenWrt snapshot
* [OpenWrt](https://openwrt.org), tested with the stable release series (17.01.x) and with the latest OpenWrt snapshot
* iwinfo for wlan scanning, uclient-fetch for captive portal detection
* iwinfo for wlan scanning, uclient-fetch for captive portal detection
* optional: qrencode 4.x for QR code support
## Installation & Usage
## Installation & Usage
* download the package [here](https://downloads.openwrt.org/snapshots/packages/x86_64/packages)
* download the package [here](https://downloads.openwrt.org/snapshots/packages/x86_64/packages)
* recommended: use the LuCI frontend with builtin interface wizard and a wireless station manager
* recommended: use the LuCI frontend with builtin interface wizard and a wireless station manager
* manual: see detailed configure steps below
* manual: see detailed configuration steps below
* at least you need one configured AP and one STA interface
* at least you need one configured AP and one STA interface
## LuCI travelmate companion package
## LuCI travelmate companion package
@ -40,28 +41,28 @@ To avoid these kind of deadlocks, travelmate set all station interfaces in an "a
* usually the pre-configured travelmate setup works quite well and no manual config overrides are needed, all listed options apply to the 'global' section:
* usually the pre-configured travelmate setup works quite well and no manual config overrides are needed, all listed options apply to the 'global' section:
* trm\_enabled => main switch to enable/disable the travelmate service (bool/default: '0', disabled)
* trm\_enabled => main switch to enable/disable the travelmate service (bool/default: '0', disabled)
* trm\_triggerdelay => additional trigger delay in seconds before travelmate processing starts (int/default: '2')
* trm\_triggerdelay => additional trigger delay in seconds before travelmate processing begins (int/default: '2')
## Runtime information
## Runtime information
**receive travelmate runtime information:**
**receive travelmate runtime information:**
<pre><code>
<pre><code>
~# /etc/init.d/travelmate status
::: travelmate runtime information
::: travelmate runtime information
+ travelmate_status : connected (net ok/55)
+ travelmate_version : 1.1.0
+ station_id : Turris/-
+ travelmate_status : connected (net ok/37)
+ travelmate_version : 1.2.0
+ station_id : blackhole/01:02:03:04:05:06
+ station_interface : trm_wwan
+ station_interface : trm_wwan
+ station_radio : radio1
+ last_rundate : 19.02.2018 17:02:25
+ system : GL.iNet GL-AR750, OpenWrt SNAPSHOT r5988+25-60e07ffec5
+ station_radio : radio0
+ last_rundate : 04.04.2018 13:00:24
+ system : GL.iNet GL-AR750, OpenWrt SNAPSHOT r6588-16efb0c1c6
</code></pre>
</code></pre>
## Manual Setup
## Manual Setup
@ -98,7 +99,7 @@ config wifi-iface
option device 'radio0'
option device 'radio0'
option network 'trm_wwan'
option network 'trm_wwan'
option mode 'sta'
option mode 'sta'
option ssid 'example_01'
option ssid 'example_usual'
option encryption 'psk2+ccmp'
option encryption 'psk2+ccmp'
option key 'abc'
option key 'abc'
option disabled '1'
option disabled '1'
@ -107,7 +108,8 @@ config wifi-iface
option device 'radio0'
option device 'radio0'
option network 'trm_wwan'
option network 'trm_wwan'
option mode 'sta'
option mode 'sta'
option ssid 'example_02'
option ssid 'example_hidden'
option bssid '00:11:22:33:44:55'
option encryption 'psk2+ccmp'
option encryption 'psk2+ccmp'
option key 'xyz'
option key 'xyz'
option disabled '1'
option disabled '1'
@ -121,11 +123,10 @@ edit /etc/config/travelmate and set 'trm_enabled' to '1'
</code></pre>
</code></pre>
## FAQ
## FAQ
**Q:** What's about 'trigger' and 'automatic' mode?
**A:** In "trigger" mode travelmate will be triggered solely by procd interface down events, whenever an uplink disappears travelmate tries n times (default 3) to find a new uplink or reconnect to the old one. The 'automatic' mode keeps travelmate in an active state and checks every n seconds the connection status / the uplink availability regardless of procd event trigger.
**Q:** What happen with misconfigured uplinks, e.g. due to outdated wlan passwords?
**Q:** What happen with misconfigured uplinks, e.g. due to outdated wlan passwords?
**A:** Travelmate tries n times (default 3) to connect, then the respective uplink SSID will be marked / renamed to '_SSID_\_err'. In this case use the builtin wireless station manager to update your wireless credentials.
**A:** Travelmate tries n times (default 3) to connect, then the respective uplink SSID will be marked / renamed to '_SSID_\_err' and travelmate no longer attends this uplink. In this case use the builtin wireless station manager to update your wireless credentials.
**Q:** How to connect to hidden uplinks?
**A:** See 'example\_hidden' STA configuration above, option 'SSID' and 'BSSID' must be specified for successful connections.
## Support
## Support
Please join the travelmate discussion in this [forum thread](https://forum.lede-project.org/t/travelmate-support-thread/5155) or contact me by [mail](mailto:dev@brenken.org)
Please join the travelmate discussion in this [forum thread](https://forum.lede-project.org/t/travelmate-support-thread/5155) or contact me by [mail](mailto:dev@brenken.org)