## Main Features
* STA interfaces operating in an "always off" mode, to make sure that the AP is always accessible
* easy setup within normal OpenWrt/LEDE environment
-* strong LuCI-Support with builtin interface wizard and a wireless station manager
* fast uplink connections
-* 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
-* support of devices with multiple radios
-* procd init and hotplug support
-* runtime information available via LuCI & via 'status' init command
+* procd init system support
+* procd based hotplug support, the travelmate start will be triggered by interface triggers
* status & debug logging to syslog
## Prerequisites
-* [LEDE](https://www.lede-project.org) 17.01 or latest snapshot
-* iwinfo for wlan scanning
+* [OpenWrt](https://openwrt.org) or [LEDE](https://www.lede-project.org) trunk
+* iw (default) or iwinfo for wlan scanning
-## LEDE trunk Installation & Usage
+## OpenWrt / LEDE trunk Installation & Usage
* download the package [here](https://downloads.lede-project.org/snapshots/packages/x86_64/packages)
* install 'travelmate' (_opkg install travelmate_)
-* configure your network:
- * recommended: use the LuCI frontend with builtin interface wizard and a wireless station manager
- * manual: see detailed configure steps below
- * at least you need one configured AP and one STA interface
+* configure your network to support (multiple) wlan uplinks and set travelmate config options (details see below)
+* set 'trm\_enabled' option in travelmate config to '1'
+* travelmate starts automatically during boot and will be triggered by procd interface triggers
## LuCI travelmate companion package
* download the package [here](https://downloads.lede-project.org/snapshots/packages/x86_64/luci)
* install 'luci-app-travelmate' (_opkg install luci-app-travelmate_)
* the application is located in LuCI under 'Services' menu
+* _Thanks to Hannu Nyman for this great LuCI frontend!_
+
+## Chaos Calmer installation notes
+* 'travelmate' and 'luci-app-travelmate' are _not_ available as ipk packages in the Chaos Calmer download repository
+* download the packages from a development snapshot directory (see download links above)
+* manually transfer the packages to your routers temp directory (with tools like _sshfs_ or _winscp_)
+* install the packages as described above
## Travelmate config options
-* usually the pre-configured travelmate setup works quite well and no manual config overrides are needed, all listed options apply to the 'global' config section:
+* travelmate config options:
* trm\_enabled => main switch to enable/disable the travelmate service (default: '0', disabled)
* trm\_debug => enable/disable debug logging (default: '0', disabled)
- * trm\_automatic => keep travelmate in an active state (default: '1', enabled)
- * trm\_maxwait => how long (in seconds) should travelmate wait for a successful wlan interface reload action (default: '30')
- * trm\_maxretry => how many times should travelmate try to connect to an uplink, '0' means unlimited retries. (default: '3')
- * trm\_timeout => timeout in seconds for "automatic mode" (default: '60')
- * trm\_radio => limit travelmate to a dedicated radio, e.g. 'radio0' (default: not set, use all radios)
- * trm\_iface => main uplink / procd trigger network interface (default: trm_wwan)
- * trm\_triggerdelay => additional trigger delay in seconds before travelmate processing starts (default: '2')
-
-## Runtime information
+ * trm\_maxwait => how long (in seconds) should travelmate wait for wlan interface reload action (default: '20')
+ * trm\_maxretry => how many times should travelmate try to find an uplink after a trigger event (default: '3')
+ * trm\_iw => set this option to '0' to use iwinfo for wlan scanning (default: '1', use iw)
+ * trm\_iface => restrict the procd interface trigger to a (list of) certain wan interface(s) or disable it at all (default: not set, disabled)
-**receive travelmate runtime information:**
-<pre><code>
-::: travelmate runtime information
- travelmate_version : 1.0.0
- station_connection : true
- station_id : blackhole/04:F0:21:2F:B7:64
- station_interface : trm_wwan
- station_radio : radio1
- last_rundate : 15.12.2017 13:51:30
- system : TP-LINK RE450, OpenWrt SNAPSHOT r5422+84-9fe59abef8
-</code></pre>
-
-## Manual Setup
-**1. configure the travelmate wwan interface in /etc/config/network:**
+## Setup
+**1. configure a wwan interface in /etc/config/network:**
<pre><code>
[...]
-config interface 'trm_wwan'
+config interface 'wwan'
option proto 'dhcp'
[...]
</code></pre>
[...]
config zone
option name 'wan'
- option network 'wan wan6 trm_wwan'
+ option input 'REJECT'
+ option output 'ACCEPT'
+ option forward 'REJECT'
+ option masq '1'
+ option mtu_fix '1'
+ option network 'wan wan6 wwan'
[...]
</code></pre>
-**3. at least add one ap and (multiple) wwan stations to your wireless configuration in etc/config/wireless:**
+**3. add required ap and wwan stations to your wireless configuration in etc/config/wireless:**
<pre><code>
[...]
config wifi-iface
option device 'radio0'
option network 'lan'
+ option ifname 'wlan0'
option mode 'ap'
option ssid 'example_ap'
option encryption 'psk2+ccmp'
[...]
config wifi-iface
option device 'radio0'
- option network 'trm_wwan'
+ option network 'wwan'
option mode 'sta'
option ssid 'example_01'
+ option ifname 'wwan01'
option encryption 'psk2+ccmp'
option key 'abc'
option disabled '1'
-[...]
config wifi-iface
option device 'radio0'
- option network 'trm_wwan'
+ option network 'wwan'
option mode 'sta'
option ssid 'example_02'
+ option ifname 'wwan02'
option encryption 'psk2+ccmp'
option key 'xyz'
option disabled '1'
+config wifi-iface
+ option device 'radio0'
+ option network 'wwan'
+ option mode 'sta'
+ option ssid 'example_03'
+ option ifname 'wwan03'
+ option encryption 'none'
+ option disabled '1'
[...]
</code></pre>
-**4. start travelmate:**
+**4. reload network configuration & start travelmate:**
<pre><code>
-edit /etc/config/travelmate and set 'trm_enabled' to '1'
-/etc/init.d/travelmate restart
+/etc/init.d/network reload
+/etc/init.d/travelmate start
</code></pre>
-## 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?
-**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. To disable this functionality at all set the Connection Limit ('trm\_maxretry') to '0', which means unlimited retries.
-
-**Q:** Is travelmate compatible with CC/Openwrt?
-**A:** Travelmate was never tested with an ancient CC/OpenWrt release ... it should still work, but no promises.
-
-[...] to be continued [...]
## 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.openwrt.org/viewtopic.php?id=67697) or contact me by [mail](mailto:dev@brenken.org)
## Removal
* stop the travelmate daemon with _/etc/init.d/travelmate stop_
projects / librecmc / package-feed.git / blobdiff