Update Readme: add detailed description of the scripts

README.md

-ssid-changer
+ssid-changer.sh
+===============
+
+This script changes the SSID when there is no connection to the selected Gateway.
+
+Once a minute it checks if there is a gateway reacheable with `batctl gwl -H` and
+decides if a change of the SSID is necessary.
+
+*It is a simplified rewrite of https://github.com/ffac/gluon-ssid-changer that doesn't check
+the tx value any more. It is in use in Freifunk Freiburg*
+
+emergency.sh
 ============
+this repository also includes an emergency script which checks for a working batman-adv
+gateway connection. If no Gateway connection exists some countermeasures are started:
 
-Script to change the SSID when there is no suffic sufficient connection to the selected Gateway.
+ - 3 min offline - call `wifi`
+ - 5 min offline - restart fastd
+ - 7 min offline - restart networking
 
-It is quite basic, it just checks the Quality of the Connection and decides if a change of the SSID is necessary.
+If no countermeasure works bringing the node online again, the router will be enforced
+to reboot after 10 minutes.
 
-Create a file "modules" with the following content in your <a href="https://github.com/ffac/site/tree/offline-ssid"> site directory:</a>
+*Note: this script may cause a problem for users, that use the node on purposes intended
+to work without functioning gateway connectivity, for example as a switch (disable
+the cronjob there).*
+
+Gluon versions
+==============
+This branch of the skript contains the the ssid-changer version for the gluon 2016.1.x
+based on openwrt `chaos-calmer`. There is also a pre 2016.1 (barrier braker based)
+version in the branch `master`. It will probably not work in 2016.2 yet.
+
+Implement this package in your firmware
+=======================================
+Create a file "modules" with the following content in your
+<a href="https://github.com/ffac/site/tree/offline-ssid"> site directory:</a>
 
 GLUON_SITE_FEEDS="ssidchanger"<br>
 PACKAGES_SSIDCHANGER_REPO=https://github.com/ffac/gluon-ssid-changer.git<br>
@@ -13,5 +42,3 @@ PACKAGES_SSIDCHANGER_COMMIT=1146ff354ff0bb99a100d6b067fc410068e7521d<br>
 PACKAGES_SSIDCHANGER_BRANCH=chaos-calmer<br>
 
 With this done you can add the package gluon-ssid-changer to your site.mk
-
-This branch of the skript contains the the ssid-changer version for the current master based on openwrt chaos-calmer (upcoming 2016.1)

files/lib/gluon/ssid-changer/emergency.sh

@@ -36,7 +36,7 @@ if [ $counter -lt 10 ]
 		echo $counter > /tmp/emergency
 		if [ $counter -eq 3 ]; then echo "$0 - 3 min offline - try wifi"|logger; wifi ; fi
 		if [ $counter -eq 5 ]; then echo "$0 - 5 min offline - try restart fastd"|logger; /etc/init.d/fastd restart ; fi
-		if [ $counter -eq 7 ]; then echo "$0 - 5 min offline - try restart network"|logger; /etc/init.d/network restart ; fi
+		if [ $counter -eq 7 ]; then echo "$0 - 7 min offline - try restart network"|logger; /etc/init.d/network restart ; fi
         else reboot
 fi
 echo $counter