net/travelmate/files/README.md

   1 # travelmate, a wlan connection manager for travel router
   2
   3 ## Description
   4 If you’re planning an upcoming vacation or a business trip, taking your laptop, tablet or smartphone give you the ability to connect with friends or complete work on the go. But many hotels don’t have a secure wireless network setup or you’re limited on using a single device at once. Investing in a portable, mini travel router is a great way to connect all of your devices at once while having total control over your own personalized wireless network.
   5 A logical combination of AP+STA mode on one physical radio allows most of OpenWrt/LEDE supported router devices to connect to a wireless hotspot/station (STA) and provide a wireless access point (AP) from that hotspot at the same time. Downside of this solution: whenever the STA interface looses the connection it will go into an active scan cycle which renders the radio unusable for AP mode operation, therefore the AP is taken down if the STA looses its association.
   6 To avoid these kind of deadlocks, travelmate set all station interfaces in an "always off" mode and connects automatically to available/configured hotspots.
   7
   8 ## Main Features
   9 * STA interfaces operating in an "always off" mode, to make sure that the AP is always accessible
  10 * easy setup within normal OpenWrt/LEDE environment
  11 * strong LuCI-Support to simplify the interface setup
  12 * fast uplink connections
  13 * manual / automatic mode support, the latter one checks the existing uplink connection regardless of ifdown event trigger actions every n seconds
  14 * support of devices with multiple radios
  15 * procd init and hotplug support
  16 * runtime information available via LuCI & via 'status' init command
  17 * status & debug logging to syslog
  18
  19 ## Prerequisites
  20 * [LEDE](https://www.lede-project.org) 17.01 or latest snapshot
  21 * iwinfo for wlan scanning
  22
  23 ## LEDE trunk Installation & Usage
  24 * download the package [here](https://downloads.lede-project.org/snapshots/packages/x86_64/packages)
  25 * install 'travelmate' (_opkg install travelmate_)
  26 * configure your network:
  27     * automatic: use the LuCI frontend with automatic STA interface setup, that's the recommended way
  28     * manual: see detailed configure steps below
  29     * at least you need one configured AP and one STA interface
  30
  31 ## LuCI travelmate companion package
  32 * download the package [here](https://downloads.lede-project.org/snapshots/packages/x86_64/luci)
  33 * install 'luci-app-travelmate' (_opkg install luci-app-travelmate_)
  34 * the application is located in LuCI under 'Services' menu
  35
  36 ## Travelmate config options
  37 * travelmate config options:
  38     * trm\_enabled => main switch to enable/disable the travelmate service (default: '0', disabled)
  39     * trm\_debug => enable/disable debug logging (default: '0', disabled)
  40     * trm\_automatic => keep travelmate in an active state (default: '1', enabled)
  41     * trm\_maxwait => how long (in seconds) should travelmate wait for a successful wlan interface reload action (default: '30')
  42     * trm\_maxretry => how many times should travelmate try to find an uplink after a trigger event (default: '3')
  43     * trm\_timeout => timeout in seconds for "automatic mode" (default: '60')
  44     * trm\_radio => limit travelmate to a dedicated radio, e.g. 'radio0' (default: not set, use all radios)
  45     * trm\_iface => restrict the procd interface trigger to a (list of) certain wan interface(s) or disable it at all (default: trm_wwan)
  46     * trm\_triggerdelay => additional trigger delay in seconds before travelmate processing starts (default: '1')
  47
  48 ## Runtime information
  49
  50 **receive travelmate runtime information:**
  51 <pre><code>
  52 root@adb2go:~# /etc/init.d/travelmate status
  53 ::: travelmate runtime information
  54  travelmate_version : 0.7.2
  55  station_connection : true
  56  station_ssid       : blackhole
  57  station_interface  : trm_wwan
  58  station_radio      : radio1
  59  last_rundate       : 06.05.2017 06:58:22
  60  system             : LEDE Reboot SNAPSHOT r4051-3ddc1914ba
  61 </code></pre>
  62
  63 ## Manual Setup
  64 **1. configure the travelmate wwan interface in /etc/config/network:**
  65 <pre><code>
  66 [...]
  67 config interface 'trm_wwan'
  68         option proto 'dhcp'
  69 [...]
  70 </code></pre>
  71
  72 **2. add this interface to your firewall configuration in /etc/config/firewall:**
  73 <pre><code>
  74 [...]
  75 config zone
  76         option name 'wan'
  77         option network 'wan wan6 trm_wwan'
  78 [...]
  79 </code></pre>
  80
  81 **3. at least add one ap and (multiple) wwan stations to your wireless configuration in etc/config/wireless:**
  82 <pre><code>
  83 [...]
  84 config wifi-iface
  85         option device 'radio0'
  86         option network 'lan'
  87         option mode 'ap'
  88         option ssid 'example_ap'
  89         option encryption 'psk2+ccmp'
  90         option key 'abc'
  91         option disabled '0'
  92 [...]
  93 config wifi-iface
  94         option device 'radio0'
  95         option network 'trm_wwan'
  96         option mode 'sta'
  97         option ssid 'example_01'
  98         option encryption 'psk2+ccmp'
  99         option key 'abc'
 100         option disabled '1'
 101 config wifi-iface
 102         option device 'radio0'
 103         option network 'trm_wwan'
 104         option mode 'sta'
 105         option ssid 'example_02'
 106         option encryption 'psk2+ccmp'
 107         option key 'xyz'
 108         option disabled '1'
 109 config wifi-iface
 110         option device 'radio0'
 111         option network 'trm_wwan'
 112         option mode 'sta'
 113         option ssid 'example_03'
 114         option encryption 'none'
 115         option disabled '1'
 116 [...]
 117 </code></pre>
 118
 119 **4. reload network configuration & start travelmate:**
 120 <pre><code>
 121 /etc/init.d/network reload
 122 /etc/init.d/travelmate start
 123 </code></pre>
 124
 125 ## Support
 126 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)
 127
 128 ## Removal
 129 * stop the travelmate daemon with _/etc/init.d/travelmate stop_
 130 * optional: remove the travelmate package (_opkg remove travelmate_)
 131
 132 Have fun!
 133 Dirk