Switch to the new wifi library

This removes the old wifi code entirely and instead links to the new
library at https://github.com/Pinoccio/library-gainspan-s2w. To use this
library after this commit, you should include that library in the
IDE libraries path as well.

Additionally, this new library is initialized to use SPI to talk to the
backpacks (which requires the SPI version of the firmware on the
gainspan module). To use UART for modules that still have the UART
firmware, see the comments in WifiBackpack::setup().

This commit disabled the wifi verbose mode for now, since the new wifi
library only has some compile-time verbosity switches.

Furthermore, the new wifi library does not yet set the L4 (TCP) retry
count for the HQ connection and does not wait for the association to
complete at startup.

Author: matthijskooijman

ScoutHandler.cpp

@@ -15,13 +15,11 @@ PinoccioScoutHandler::~PinoccioScoutHandler() { }
 
 void PinoccioScoutHandler::setup() {
   if (Scout.isLeadScout()) {
-    Gainspan.connectEventHandler = hqConnectHandler;
-    Gainspan.disconnectEventHandler = hqDisconnectHandler;
 
     Scout.enableBackpackVcc();
     Serial.print("Wi-Fi backpack connecting...");
     Scout.wifi.setup();
-    Scout.wifi.init();
+    Scout.wifi.autoConnect();
     Serial.println("Done");
     RgbLed.blinkGreen();
 
@@ -49,14 +47,6 @@ void PinoccioScoutHandler::loop() {
   }
 }
 
-static void hqConnectHandler(uint8_t cid) {
-  leadHQConnect(cid);
-}
-
-static void hqDisconnectHandler(uint8_t cid) {
-  Serial.println("Disconnected from HQ");
-}
-
 static bool fieldCommands(NWK_DataInd_t *ind) {
   int total, ret;
   RgbLed.blinkGreen(200);
@@ -230,7 +220,7 @@ static void leadAnnouncementSend(int chan, int from, char *message) {
 ////////////////////
 // lead scout stuff
 
-void leadHQConnect(uint8_t cid) {
+void leadHQConnect() {
   char auth[256], token[33];
 
   if (Scout.wifi.client.connected()) {

ScoutHandler.h

@@ -63,7 +63,7 @@ static void leadAnnouncementSend(int chan, int from, char *message);
 static void leadHQ(void);
 static void leadSignal(char *json);
 static void leadIncoming(char *packet, unsigned short *index);
-static void leadHQConnect(uint8_t cid);
+void leadHQConnect();
 
 // this is called on the main loop to try to (re)connect to the HQ
 static void leadHQHandle(void);

Shell.cpp

@@ -592,58 +592,53 @@ static numvar setEventVerbose(void) {
 \****************************/
 static numvar wifiReport(void) {
   if (getarg(0) > 0 && getarg(1) == 1) {
-    Scout.wifi.printProfiles();
+    Scout.wifi.printProfiles(Serial);
   } else {
-    Serial.print("Wi-Fi App Version: ");
-    Serial.println(Gainspan.getAppVersion());
-    Serial.print("Wi-Fi GEPS Version: ");
-    Serial.println(Gainspan.getGepsVersion());
-    Serial.print("Wi-Fi Wlan Version: ");
-    Serial.println(Gainspan.getWlanVersion());
-    Scout.wifi.printCurrentNetworkStatus();
+    Serial.print("Wi-Fi Versions: ");
+    Scout.wifi.printFirmwareVersions(Serial);
+    Scout.wifi.printCurrentNetworkStatus(Serial);
   }
 }
 
 static numvar wifiList(void) {
-    Scout.wifi.printAPs();
+    Scout.wifi.printAPs(Serial);
 }
 
 static numvar wifiConfig(void) {
-  String port = String(getarg(4));
-  if (!Scout.wifi.apConfig((const char *)getstringarg(1), (const char *)getstringarg(2), (const char *)getstringarg(3), port)) {
+  if (!Scout.wifi.autoConfig((const char *)getstringarg(1), (const char *)getstringarg(2), (const char *)getstringarg(3), getarg(4))) {
     Serial.println("Error: saving Scout.wifi.configuration data failed");
   }
 }
 
 static numvar wifiConnect(void) {
   Serial.print("Wi-Fi backpack connecting...");
-  if (!Scout.wifi.apConnect()) {
+  if (!Scout.wifi.autoConnect()) {
     Serial.println("Error: unable to connect");
   } else {
     Serial.println("Done");
   }
 }
 
 static numvar wifiCommand(void) {
-  if (!Scout.wifi.runDirectCommand((const char *)getstringarg(1))) {
+  if (!Scout.wifi.runDirectCommand(Serial, (const char *)getstringarg(1))) {
      Serial.println("Error: Wi-Fi direct command failed");
   }
 }
 
 static numvar wifiPing(void) {
-  if (!Scout.wifi.ping((const char *)getstringarg(1))) {
+  if (!Scout.wifi.ping(Serial, (const char *)getstringarg(1))) {
      Serial.println("Error: Wi-Fi ping command failed");
   }
 }
 
 static numvar wifiDNSLookup(void) {
-  if (!Scout.wifi.dnsLookup((const char *)getstringarg(1))) {
+  if (!Scout.wifi.dnsLookup(Serial, (const char *)getstringarg(1))) {
      Serial.println("Error: Wi-Fi DNS lookup command failed");
   }
 }
 
 static numvar wifiGetTime(void) {
-  if (!Scout.wifi.getTime()) {
+  if (!Scout.wifi.printTime(Serial)) {
      Serial.println("Error: Wi-Fi NTP time lookup command failed");
   }
 }
@@ -661,7 +656,7 @@ static numvar wifiWakeup(void) {
 }
 
 static numvar wifiVerbose(void) {
-  Gainspan.debugAutoConnect = getarg(1);
+  // TODO
 }
 
 /****************************\

examples/Begin/Begin.ino

@@ -1,6 +1,7 @@
 #include <SPI.h>
 #include <Wire.h>
 #include <Scout.h>
+#include <GS.h>
 
 /* MANUAL PROVISIONING BITLASH COMMANDS
 mesh.config(<Scout ID>, <Troop ID>)

utility/WiFiBackpack.cpp

@@ -1,101 +1,111 @@
 #include <Arduino.h>
+#include <SPI.h>
 #include <utility/WiFiBackpack.h>
+#include "../ScoutHandler.h"
 
-//#define P_BACKPACK_WIFI_DEBUG
-#ifdef P_BACKPACK_WIFI_DEBUG
-#  define WD(x) x
-#else
-#  define WD(x)
-#endif
+static void print_line(const uint8_t *buf, uint16_t len, void *data) {
+  static_cast<Print*>(data)->write(buf, len);
+  static_cast<Print*>(data)->println();
+}
 
-WiFiBackpack::WiFiBackpack() { }
+WiFiBackpack::WiFiBackpack() : client(gs) { }
 
 WiFiBackpack::~WiFiBackpack() { }
 
 bool WiFiBackpack::setup() {
   Backpack::setup();
 
-  WD(Serial.println("WiFiBackpack::setup 1"));
-
-  if (!Gainspan.setup()) {
-     WD(Serial.println("FAIL: Setup failed"));
-     return 0;
-  }
-
-  WD(Serial.println("WiFiBackpack::setup 2"));
-  return 1;
-}
-
-bool WiFiBackpack::init() {
+  // Alternatively, use the UART for Wifi backpacks that still have the
+  // UART firmware running on them
+  // Serial1.begin(115200);
+  // return gs.begin(Serial1);
 
-  WD(Serial.println("WiFiBackpack::init 1"));
+  SPI.begin();
+  SPI.setClockDivider(SPI_CLOCK_DIV8);
 
-  if (!Gainspan.init()) {
-    WD(Serial.println("Error: no response from Wi-Fi backpack"));
-    return 0;
-  }
-  WD(Serial.println("WiFiBackpack::init 2"));
-  client.autoConnect();
-  WD(Serial.println("WiFiBackpack::init 3"));
-
-  return 1;
+  return gs.begin(7);
 }
 
 void WiFiBackpack::loop() {
   Backpack::loop();
-  Gainspan.process();
+  client = gs.getNcmCid();
+  if (!client.connected()) {
+    hqConnected = false;
+  } else if (!hqConnected) {
+    leadHQConnect();
+    hqConnected = true;
+  }
+  // TODO: Don't call leadHQConnect directly
+  // TODO: There is a race condition here: If a disconnect and connect
+  // happen quickly before we can notice the disconnect, leadHqConnect
+  // will not be called for the new connection.
 }
 
-bool WiFiBackpack::apConfig(const char *ssid, const char *passphrase, String host, String port) {
-  String ip;
-  if (client.connected()) {
-    ip = Gainspan.dnsLookup(host);
-  } else {
-    ip = host;
-  }
+bool WiFiBackpack::autoConfig(const char *ssid, const char *passphrase, const String& host, uint16_t port) {
+  bool ok = true;
+  ok = ok && gs.setSecurity(GSModule::GS_SECURITY_AUTO);
+  ok = ok && gs.setWpaPassphrase(passphrase);
+  ok = ok && gs.setAutoAssociate(ssid);
+  ok = ok && gs.setAutoConnectClient(host.c_str(), port);
+  // Remember these settings through a reboot
+  ok = ok && gs.saveProfile(0);
+  ok = ok && gs.setDefaultProfile(0);
+  return ok;
+}
 
-  Gainspan.autoConfigure(ssid, passphrase, ip, port);
+bool WiFiBackpack::autoConnect() {
+  // Try to disable the NCM in case it's already running
+  gs.setNcm(false);
+  return gs.setNcm(/* enable */ true, /* associate_only */ false, /* remember */ false);
 }
 
-bool WiFiBackpack::apConnect() {
-  Gainspan.autoConnect();
+void WiFiBackpack::printAPs(Print& p) {
+  runDirectCommand(p, "AT+WS");
 }
 
-void WiFiBackpack::printAPs() {
-  Gainspan.send_cmd_w_resp(CMD_LIST_SSIDS);
+void WiFiBackpack::printProfiles(Print& p) {
+  runDirectCommand(p, "AT&V");
 }
 
-void WiFiBackpack::printProfiles() {
-  Gainspan.send_cmd_w_resp(CMD_PROFILEGET);
+void WiFiBackpack::printCurrentNetworkStatus(Print& p) {
+  runDirectCommand(p, "AT+NSTAT=?");
+  runDirectCommand(p, "AT+CID=?");
 }
 
-void WiFiBackpack::printCurrentNetworkStatus() {
-  Gainspan.send_cmd_w_resp(CMD_NET_STATUS);
-  Gainspan.send_cmd_w_resp(CMD_CURCID);
+void WiFiBackpack::printFirmwareVersions(Print& p) {
+  runDirectCommand(p, "AT+VER=?");
 }
 
-bool WiFiBackpack::dnsLookup(const char *host) {
-  Serial.println(Gainspan.dnsLookup(host));
+
+bool WiFiBackpack::dnsLookup(Print& p, const char *host) {
+  // TODO
+  return false;
 }
 
-bool WiFiBackpack::ping(const char *host) {
-  Gainspan.ping(host);
+bool WiFiBackpack::ping(Print &p, const char *host) {
+  // TODO
+  return false;
 }
 
-bool WiFiBackpack::runDirectCommand(const char *command) {
-  Gainspan.send_raw_cmd_w_resp(command);
+bool WiFiBackpack::runDirectCommand(Print &p, const char *command) {
+  gs.writeCommand("%s", command);
+  return gs.readResponse(print_line, &p);
 }
 
 bool WiFiBackpack::goToSleep() {
-  Gainspan.send_cmd(CMD_PSDPSLEEP);
+  // TODO
+  //Gainspan.send_cmd(CMD_PSDPSLEEP);
+  return false;
 }
 
 bool WiFiBackpack::wakeUp() {
-  Gainspan.send_cmd_w_resp(CMD_AT);
+  // TODO
+  // Gainspan.send_cmd_w_resp(CMD_AT);
+  return false;
 }
 
-bool WiFiBackpack::getTime() {
-  Gainspan.send_cmd_w_resp(CMD_GETTIME);
+bool WiFiBackpack::printTime(Print &p) {
+  return runDirectCommand(p, "AT+GETTIME=?");
 }
 
 

utility/WiFiBackpack.h

@@ -3,12 +3,7 @@
 
 #include <Pinoccio.h>
 #include <utility/Backpack.h>
-
-#include "utility/webGainspan.h"
-#include "utility/webWifi.h"
-#include "utility/webWifiServer.h"
-#include "utility/webWifiClient.h"
-#include "utility/Flash.h"
+#include <GS.h>
 
 class WiFiBackpack : public Backpack {
 
@@ -20,25 +15,29 @@ class WiFiBackpack : public Backpack {
     bool init();
     void loop();
 
-    bool apConfig(const char *ssid, const char *passphrase, String ip, String port);
-    bool apConnect();
-    void printAPs();
-    void printProfiles();
-    void printCurrentNetworkStatus();
+    bool autoConfig(const char *ssid, const char *passphrase, const String &host, uint16_t port);
+    bool autoConnect();
+
+    void printAPs(Print& p);
+    void printProfiles(Print& p);
+    void printCurrentNetworkStatus(Print& p);
+    bool printTime(Print& p);
+    void printFirmwareVersions(Print& p);
 
-    bool dnsLookup(const char *host);
-    bool ping(const char *host);
+    bool dnsLookup(Print &p, const char *host);
+    bool ping(Print &p, const char *host);
 
-    bool runDirectCommand(const char *command);
+    /** Run a command and print the results */
+    bool runDirectCommand(Print& p, const char *command);
 
     bool goToSleep();
     bool wakeUp();
 
-    bool getTime();
-
-    PinoccioWifiClient client;
-
+    GSClient client;
   protected:
+    GSModule gs;
+    // Was leadHQConnect already called?
+    bool hqConnected = false;
 };
 
-#endif // LIB_PINOCCIO_WIFI_BACKPACK_H_
+#endif // LIB_PINOCCIO_WIFI_BACKPACK_H_