dual band devices and different SSIDs

README.md

@@ -1,44 +1,127 @@
-ssid-changer.sh
-===============
+gluon-ssid-changer
+==================
 
-This script changes the SSID when there is no connection to the selected Gateway.
+_This branch of the script contains the ssid-changer version for the gluon 
+2017.1.x branch. For other release of Gluon use the branches "2018.1.x" and
+"2016.2.x"._
 
-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.
+This package adds a script to change the SSID to an Offline-SSID when there is
+no connection to any gateway.
+This SSID can be generated from the nodes hostname with the first
+and last part of the nodename or the mac address, to allow observers to 
+recognise which node is down. The script is called once a minute by micron.d
+and it will change from online to offline-SSID maximum once every (definable)
+timeframe.
 
-*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*
+You can enable/disable it in the config mode.
 
-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:
+Once every timeframe it checks if there's still a gateway reachable. There can be
+selected two algorithms to analyze if a gateway is reacheable:
 
- - 3 min offline - call `wifi`
- - 5 min offline - restart fastd
- - 7 min offline - restart networking
+- `tq_limit` enabled: define an upper and lower limit to turn the offline_ssid 
+  on and off in-between these two values the SSID will never be changed to
+  prevent it from toggeling every minute.
+- `tq_limit` disabled: there will be only checked, if the gateway is reachable
+  with:
 
-If no countermeasure works bringing the node online again, the router will be enforced
-to reboot after 10 minutes.
+        batctl gwl -H
+
+Depending on the connectivity, it will be decided if a change of the SSID is 
+necessary: There is a variable `switch_timeframe` (for ex.  1440 = 24h) that 
+defines a time interval after which a successful check that detects an offline
+state will result in a single change of the SSID to "FF_Offline_$node_hostname".
+Only the first few minutes (also definable in a variable `first`) the 
+OFFLINE_SSID may also be set. All other minutes a checks will just be counted
+and reported in the log and whenever an online state is detected the SSID will
+be set back immediately back to normal. when the timeframe is reached, there
+will be checked if the node was offline at least half the timeframe, only then
+the SSID will be changed.
+
+site.conf
+=========
+
+Adapt and add this block to your site.conf: 
+
+```
+ssid_changer = {
+  enabled = true,
+  switch_timeframe = 30,    -- only once every timeframe (in minutes) the SSID will change to the Offline-SSID 
+                            -- set to 1440 to change once a day
+                            -- set to 1 minute to change every time the router gets offline
+  first = 5,                -- the first few minutes directly after reboot within which an Offline-SSID always may be activated (must be <= switch_timeframe)
+  prefix = 'FF_Offline_',   -- use something short to leave space for the nodename (no '~' allowed!)
+  suffix = 'nodename',      -- generate the SSID with either 'nodename', 'mac' or to use only the prefix: 'none'
+
+  tq_limit_enabled = false, -- if false, the offline SSID will only be set if there is no gateway reacheable
+                            -- upper and lower limit to turn the offline_ssid on and off
+                            -- in-between these two values the SSID will never be changed to prevent it from toggeling every minute.
+  tq_limit_max = 45,        -- upper limit, above that the online SSID will be used
+  tq_limit_min = 35         -- lower limit, below that the offline SSID will be used
+},
+```
+
+Commandline options
+===================
+
+You can configure the ssid-changer on the commandline with `uci`, for example 
+disable it with:
+
+    uci set ssid-changer.settings.enabled='0'
+
+Or set the timeframe to every three minutes with
+
+    uci set ssid-changer.settings.switch_timeframe='3'
+    uci set ssid-changer.settings.first='3'
+
+Manual installation
+===================
+
+If you don't have ssid-changer in your firmware, you can still install it
+manually on a node and set the desired settings that should differ from default:
+
+```
+ROUTER_IP='your:node::ip6'
+LOGIN="root@[$ROUTER_IP]"
+git clone https://github.com/Freifunk-Nord/gluon-ssid-changer.git ssid-changer
+cd ssid-changer/gluon-ssid-changer/
+git checkout lede
+scp -r files/* $LOGIN:/
+scp luasrc/lib/gluon/upgrade/500-ssid-changer $LOGIN:/lib/gluon/upgrade/
+ssh $ROUTER_IP "/lib/gluon/upgrade/500-ssid-changer;" \
+  "uci set ssid-changer.settings.switch_timeframe='3';" \
+  "uci set ssid-changer.settings.first='3';" \
+  "uci commit ssid-changer;" \
+  "uci show ssid-changer;" \
+  "/etc/init.d/micrond reload;"
+```
+
+Alternative: gluon-ssid-notifier
+================================
+If you just need the Offline-SSID for administrative purposes, there is a better solution,
+that will just add an extra SSID if a node is offline:
+https://github.com/freifunk-kiel/gluon-ssid-notifier/
 
-*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.
+This branch of the script contains the ssid-changer version for the gluon 
+master branch (lede).
 
 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>
+Create a file "modules" with the following content in your site directory:
+
+```
+GLUON_SITE_FEEDS="ssidchanger"
+PACKAGES_SSIDCHANGER_REPO=https://github.com/freifunk-nord/gluon-ssid-changer.git
+PACKAGES_SSIDCHANGER_COMMIT=cc16f488bd32f17da845279800e06f237884829e # <-- set the newest commit ID here
+PACKAGES_SSIDCHANGER_BRANCH=master
+```
 
-GLUON_SITE_FEEDS="ssidchanger"<br>
-PACKAGES_SSIDCHANGER_REPO=https://github.com/viisauksena/gluon-ssid-changer.git<br>
-PACKAGES_SSIDCHANGER_COMMIT=f135ba05913feb4451e4cf067b735b095a4ee243<br>
-PACKAGES_SSIDCHANGER_BRANCH=chaos-calmer<br>
+With this done you can add the package `gluon-ssid-changer` to your `site.mk`
 
-With this done you can add the package gluon-ssid-changer to your site.mk
+History
+=======
+*This is a merge of https://github.com/ffac/gluon-ssid-changer and
+https://github.com/viisauksena/gluon-ssid-changer that doesn't check
+the tx value any more. It is now in use in Freifunk Nord*

gluon-ssid-changer/Makefile

@@ -0,0 +1,53 @@
+include $(TOPDIR)/rules.mk
+
+PKG_NAME:=gluon-ssid-changer
+PKG_VERSION:=4
+
+PKG_BUILD_DIR := $(BUILD_DIR)/$(PKG_NAME)
+
+include $(TOPDIR)/../package/gluon.mk
+
+PKG_CONFIG_DEPENDS += $(GLUON_I18N_CONFIG)
+
+
+define Package/$(PKG_NAME)
+  SECTION:=gluon
+  CATEGORY:=Gluon
+  TITLE:=changes the SSID to an Offline-SSID so clients don't connect to an offline WiFi
+  DEPENDS:=+gluon-core +micrond
+endef
+
+define Package/$(PKG_NAME)/description
+  Script to change the SSID to an Offline-SSID when there is no connection to
+  any gateway. This SSID can be generated from the nodes hostname with the first
+  and last part of the nodename or the mac address, to allow observers to 
+  recognise which node is down. The script is called once a minute by micron.d
+  and it will change from online to offline-SSID maximum once every (definable)
+  timeframe.
+endef
+
+define Build/Prepare
+	mkdir -p $(PKG_BUILD_DIR)
+endef
+
+define Build/Configure
+endef
+
+define Build/Compile
+	$(call GluonBuildI18N,$(PKG_NAME),i18n)
+	$(call GluonSrcDiet,./luasrc,$(PKG_BUILD_DIR)/luadest/)
+endef
+
+define Package/$(PKG_NAME)/install
+	$(CP) ./files/* $(1)/
+	$(CP) $(PKG_BUILD_DIR)/luadest/* $(1)/
+	./gluonShellDiet.sh $(1)/lib/gluon/ssid-changer/ssid-changer.sh
+	$(call GluonInstallI18N,$(PKG_NAME),$(1))
+endef
+
+define Package/$(PKG_NAME)/postinst
+#!/bin/sh
+$(call GluonCheckSite,check_site.lua)
+endef
+
+$(eval $(call BuildPackage,$(PKG_NAME)))

gluon-ssid-changer/check_site.lua

@@ -0,0 +1,11 @@
+if need_table('ssid_changer', nil, false) then
+  need_boolean('ssid_changer.enabled', false)
+  need_number('ssid_changer.switch_timeframe', false)
+  need_number('ssid_changer.first', false)
+  need_string('ssid_changer.prefix', false)
+  need_string('ssid_changer.suffix', false)
+  if need_boolean('ssid_changer.tq_limit_enabled', false) then
+    need_number('ssid_changer.tq_limit_max', false)
+    need_number('ssid_changer.tq_limit_min', false)
+  end
+end

gluon-ssid-changer/files/etc/config/ssid-changer

@@ -0,0 +1,2 @@
+config settings 'settings'
+  option enabled '1'