Initial core lib working.

Author: monkey-jsun

examples/esp8266_lib_test/esp8266_lib_test.ino

@@ -0,0 +1,192 @@
+#define ESP8266_SW_RX   9 
+#define ESP8266_SW_TX   8 
+
+#include "esp8266_lib.h"
+
+SoftwareSerial swSerial(8,9);
+Esp8266 esp8266(&swSerial);
+
+const char mySSID[] = "tzuming";
+const char myPSK[] = "5102991912";
+
+const char server[] = "example.com";
+const char httpRequest[] = "GET / HTTP/1.1\r\n"
+                           "Host: example.com\r\n"
+                           "Connection: close\r\n\r\n";
+const char httpRequest2[] = "GET /hello.html HTTP/1.1\r\n"
+                           "Host: junsun.net\r\n"
+                           "Connection: close\r\n\r\n";
+
+#define TEST(x,y) do { \
+    Serial.print(F("test ")); \
+    Serial.print(#x); \
+    Serial.print(F(" .... ")); \
+    if (x y) Serial.println(F("pass")); \
+    else { Serial.println(F("fail")); for(;;); } \
+} while (0)
+
+char buf[64];
+void setup() {
+  
+  Serial.begin(115200);
+
+  TEST(esp8266.begin(), >= 0);
+  
+  // raw_test();
+  
+  general_test();
+
+  server_test();
+
+  client_test();
+
+  Serial.println(F("All done! Entering loop ..."));
+}
+
+void loop() {
+  // Serial.println(F("We are in loop"));
+  delay(2000);
+}
+
+void raw_test() {
+  esp8266.rawTest("AT+CIPSTART=0,\"TCP\",\"example.com\",80,60", 5000);  
+  Serial.println(strlen(httpRequest));
+  esp8266.rawTest("AT+CIPSENDEX=0,56", 5000);
+  esp8266.rawTest(httpRequest, 5000);
+}
+
+void general_test() {
+  serialTrigger(F("Press any key to begin general test."));
+
+  TEST(esp8266.getVersion(buf,NULL,NULL), >= 0);
+  Serial.print(F("AT version is ")); Serial.println(buf);
+  
+  TEST(esp8266.getVersion(NULL, buf,NULL), >= 0);
+  Serial.print(F("SDK version is ")); Serial.println(buf);
+  
+  TEST(esp8266.getVersion(NULL, NULL, buf), >= 0);
+  Serial.print(F("Compile time is ")); Serial.println(buf);
+  
+  TEST(esp8266.connectAP(mySSID, myPSK), >0);
+
+  TEST(esp8266.getAP(buf), >=0);
+  Serial.print(F("getAP()=")); Serial.println(buf);
+  TEST(strcmp(buf, mySSID), == 0);
+
+  TEST(esp8266.getLocalMAC(buf), >=0);
+  Serial.print(F("getLocalMAC()=")); Serial.println(buf);
+
+  IPAddress ip;
+  TEST(esp8266.getLocalIP(ip), >=0);
+  Serial.print(F("getLocalIP()=")); Serial.println(ip);
+
+  Serial.println(F("disconnecting AP ..."));
+  TEST(esp8266.disconnectAP(), >=0);
+    
+  delay(5000);
+
+  TEST(esp8266.getAP(buf), >=0);
+  TEST(strcmp(buf, ""), == 0);
+}
+
+void server_test()
+{
+    serialTrigger(F("Press any key to begin TCP SERVER test."));
+
+    TEST(esp8266.connectAP(mySSID, myPSK), >0);
+    IPAddress ip;
+    TEST(esp8266.getLocalIP(ip), >=0);
+    Serial.print(F("getLocalIP()=")); Serial.println(ip);
+
+    TEST(esp8266.tcpServerStart(80), >= 0);
+
+    Serial.println(F("Open browser at server ... waiting for client"));
+    for (;;) {
+        if (esp8266.tcpConnected()) break;
+    }
+    Serial.println(F("client connected!"));
+    
+    // read data
+    Serial.println(F("Now dump received data:"));
+    while(!esp8266.tcpAvailable());
+    while(esp8266.tcpAvailable())
+      Serial.write(esp8266.tcpRead());
+    Serial.println(F("\n===END OF TCP DATA===\n"));
+
+    // send something back
+    TEST(esp8266.tcpWrite("<h1>Hello, there</h1>"), >= 0);
+
+    TEST(esp8266.tcpClose(), >=0);
+
+    // chrome browser sends two requests
+    while(!esp8266.tcpConnected());
+    Serial.println(F("Now dump received data:"));
+    while(!esp8266.tcpAvailable());
+    while(esp8266.tcpAvailable())
+      Serial.write(esp8266.tcpRead());
+    Serial.println(F("\n===END OF TCP DATA===\n"));
+
+    // send something back
+    TEST(esp8266.tcpWrite("<h1>Hello, there</h1>"), >= 0);
+
+    TEST(esp8266.tcpClose(), >=0);
+
+    // stop server
+    TEST(esp8266.tcpServerStop(), >= 0);
+
+    /*
+    Serial.println(F("Restart server and re-stop it ..."));
+    TEST(esp8266.tcpServerStart(80), >= 0);
+    TEST(esp8266.tcpServerStop(), >= 0);
+    */
+}
+
+void client_test()
+{
+    serialTrigger(F("Press any key to begin TCP client test."));
+
+    // TEST(esp8266.connectAP(mySSID, myPSK), >0);
+
+    TEST(esp8266.tcpConnect(server, 80, 30000), >=0);
+
+    while (!esp8266.tcpConnected()) ;
+    TEST(esp8266.tcpWrite(httpRequest), >=0);
+
+    Serial.println(F("Now dump received data:"));
+    while(!esp8266.tcpAvailable());
+    while(esp8266.tcpAvailable())
+      Serial.write(esp8266.tcpRead());
+    Serial.println(F("\n===END OF TCP DATA===\n"));
+
+    // server disconnects
+    delay(1000);
+    TEST(esp8266.tcpConnected(), ==false);
+
+    // now open a second session
+    TEST(esp8266.tcpConnect("junsun.net", 80, 30000), >=0);
+    while (!esp8266.tcpConnected()) ;
+    TEST(esp8266.tcpWrite(httpRequest2), >=0);
+
+    Serial.println(F("Now dump received data:"));
+    while(!esp8266.tcpAvailable());
+    while(esp8266.tcpAvailable())
+      Serial.write(esp8266.tcpRead());
+    Serial.println(F("\n===END OF TCP DATA===\n"));
+
+    // server disconnects
+    delay(1000);
+    TEST(esp8266.tcpConnected(), ==false);
+}
+
+void serialTrigger(String message)
+{
+  Serial.println();
+  Serial.println(message);
+  Serial.println();
+  while (!Serial.available())
+    ;
+  while (Serial.available()) {
+    Serial.read();
+    delay(2);  // deal with slow serial case, 2ms is good to cover 9600
+  }
+}

library.properties

@@ -0,0 +1,9 @@
+name=ESP8266 AT CMD WI-FI Library
+version=1.0.0
+author=Jun Sun
+maintainer=Jun Sun <jsun@junsun.net>
+sentence=Driver library for SparkFun's ESP8266 WiFi Shield, Adafruit Huzzah and other ESP8266 breakout boards.
+paragraph=Simple API to connect to WiFi, TCP server or TCP client
+category=Communication
+url=http://github.com/sparkfun/SparkFun_ESP8266_AT_Arduino_Library
+architectures=*

src/esp8266_const.h

@@ -0,0 +1,69 @@
+/******************************************************************************
+******************************************************************************/
+
+#ifndef __esp8266_const_h__
+#define __esp8266_const_h__
+
+//////////////////////
+// Common Responses //
+//////////////////////
+const char RESPONSE_OK[] = "OK\r\n";
+const char RESPONSE_ERROR[] = "ERROR\r\n";
+const char RESPONSE_FAIL[] = "FAIL";
+const char RESPONSE_READY[] = "READY!";
+const char RESPONSE_IPD[] = "+IPD,";
+const char RESPONSE_CONNECT_0[] = "0,CONNECT\r\n";
+const char RESPONSE_CONNECT[]=",CONNECT\r\n";
+const char RESPONSE_CLOSED_0[] = "0,CLOSED\r\n";
+
+///////////////////////
+// Basic AT Commands //
+///////////////////////
+const char ESP8266_TEST[] = "";	// Test AT startup
+//const char ESP8266_RESET[] = "+RST"; // Restart module
+const char ESP8266_VERSION[] = "+GMR"; // View version info
+//!const char ESP8266_SLEEP[] = "+GSLP"; // Enter deep-sleep mode
+const char ESP8266_ECHO_ENABLE[] = "E1"; // AT commands echo
+const char ESP8266_ECHO_DISABLE[] = "E0"; // AT commands echo
+//!const char ESP8266_RESTORE[] = "+RESTORE"; // Factory reset
+//const char ESP8266_UART[] = "+UART"; // UART configuration
+
+////////////////////
+// WiFi Functions //
+////////////////////
+//const char ESP8266_WIFI_MODE[] = "+CWMODE"; // WiFi mode (sta/AP/sta+AP)
+const char ESP8266_CONNECT_AP[] = "+CWJAP"; // Connect to AP
+//!const char ESP8266_LIST_AP[] = "+CWLAP"; // List available AP's
+const char ESP8266_DISCONNECT[] = "+CWQAP"; // Disconnect from AP
+//!const char ESP8266_AP_CONFIG[] = "+CWSAP"; // Set softAP configuration
+//!const char ESP8266_STATION_IP[] = "+CWLIF"; // List station IP's connected to softAP
+//!const char ESP8266_DHCP_EN[] = "+CWDHCP"; // Enable/disable DHCP
+//!const char ESP8266_AUTO_CONNECT[] = "+CWAUTOCONN"; // Connect to AP automatically
+//!const char ESP8266_SET_STA_MAC[] = "+CIPSTAMAC"; // Set MAC address of station
+const char ESP8266_GET_STA_MAC[] = "+CIPSTAMAC"; // Get MAC address of station
+//!const char ESP8266_SET_AP_MAC[] = "+CIPAPMAC"; // Set MAC address of softAP
+//!const char ESP8266_SET_STA_IP[] = "+CIPSTA"; // Set IP address of ESP8266 station
+//!const char ESP8266_SET_AP_IP[] = "+CIPAP"; // Set IP address of ESP8266 softAP
+
+/////////////////////
+// TCP/IP Commands //
+/////////////////////
+const char ESP8266_TCP_STATUS[] = "+CIPSTATUS"; // Get connection status
+const char ESP8266_TCP_CONNECT[] = "+CIPSTART"; // Establish TCP connection or register UDP port
+const char ESP8266_TCP_SEND[] = "+CIPSEND"; // Send Data
+const char ESP8266_TCP_CLOSE[] = "+CIPCLOSE"; // Close TCP/UDP connection
+const char ESP8266_GET_LOCAL_IP[] = "+CIFSR"; // Get local IP address
+const char ESP8266_TCP_MULTIPLE[] = "+CIPMUX"; // Set multiple connections mode
+const char ESP8266_SERVER_CONFIG[] = "+CIPSERVER"; // Configure as server
+//const char ESP8266_TRANSMISSION_MODE[] = "+CIPMODE"; // Set transmission mode
+//!const char ESP8266_SET_SERVER_TIMEOUT[] = "+CIPSTO"; // Set timeout when ESP8266 runs as TCP server
+const char ESP8266_PING[] = "+PING"; // Function PING
+
+//////////////////////////
+// Custom GPIO Commands //
+//////////////////////////
+//const char ESP8266_PINMODE[] = "+PINMODE"; // Set GPIO mode (input/output)
+//const char ESP8266_PINWRITE[] = "+PINWRITE"; // Write GPIO (high/low)
+//const char ESP8266_PINREAD[] = "+PINREAD"; // Read GPIO digital value
+
+#endif /* __esp8266_const_h__ */

src/esp8266_debug.h

@@ -0,0 +1,38 @@
+#ifndef __esp8266_debug_h__
+#define __esp8266_debug_h__
+
+#define ESP8266_DEBUG
+//#define ESP8266_DEBUG_VERBOSE
+
+#ifdef ESP8266_DEBUG
+
+	#define ASSERT(x) if (!(x)) { \
+		Serial.print(F("assert failed at ")); \
+		Serial.print(__func__); \
+		Serial.print(F("()@")); \
+		Serial.println(__LINE__); \
+		for(;;); }
+	#define WARN(x) if (!(x)) { \
+		Serial.print(F("warning at ")); \
+		Serial.print(__func__); \
+		Serial.print(F("()@")); \
+		Serial.println(__LINE__);}
+	#define VERIFY(x, y) ASSERT(x y)
+	#define DEBUG(x)  do { x; } while (0)
+	#ifdef ESP8266_DEBUG_VERBOSE
+		#define DEBUG_VERBOSE(x) DEBUG(x)
+	#else
+		#define DEBUG_VERBOSE(x)
+	#endif
+
+#else
+
+	#define ASSERT(x)
+	#define WARN(x)
+	#define VERIFY(x, y) x
+	#define DEBUG(x)
+	#define DEBUG_VERBOSE(x)
+
+#endif
+
+#endif  /* __esp8266_debug_h__ */