first full working version of WebSocketsServer

Author: Links2004

examples/WebSocketsServer/WebSocketsServer.ino

@@ -0,0 +1,78 @@
+/*
+ * WebSocketsServer.ino
+ *
+ * Created on: 22.05.2015
+ *
+ */
+
+#include <Arduino.h>
+
+#include <ESP8266WiFi.h>
+#include <ESP8266WiFiMulti.h>
+#include <WebSocketsServer.h>
+#include <hash.h>
+
+ESP8266WiFiMulti WiFiMulti;
+
+WebSocketsServer webSocket = WebSocketsServer(81);
+
+void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t lenght) {
+
+ switch(type) {
+ case WStype_DISCONNECTED:
+ Serial1.printf("[%d] Disconnected!\n", num);
+ break;
+ case WStype_CONNECTED:
+ Serial1.printf("[%d] Connected.\n", num);
+ break;
+ case WStype_TEXT:
+ Serial1.printf("[%d] get Text: %s\n", num, payload);
+
+ // echo data back to browser
+ webSocket.sendTXT(num, payload, lenght);
+
+ // send data to all connected clients
+ webSocket.broadcastTXT(payload, lenght);
+ break;
+ case WStype_BIN:
+ Serial1.printf("[%d] get binary.\n", num);
+ hexdump(payload, lenght);
+
+ // echo data back to browser
+ webSocket.sendBIN(num, payload, lenght);
+ break;
+ }
+
+}
+
+void setup() {
+ Serial.begin(921600);
+ Serial1.begin(921600);
+
+ //Serial.setDebugOutput(true);
+ Serial1.setDebugOutput(true);
+
+ Serial1.println();
+ Serial1.println();
+ Serial1.println();
+
+ for(uint8_t t = 4; t > 0; t--) {
+ Serial1.printf("[SETUP] BOOT WAIT %d...\n", t);
+ Serial1.flush();
+ delay(1000);
+ }
+
+ WiFiMulti.addAP("SSID", "passpasspass");
+
+ while(WiFiMulti.run() != WL_CONNECTED) {
+ delay(100);
+ }
+
+ webSocket.begin();
+ webSocket.onEvent(webSocketEvent);
+}
+
+void loop() {
+ webSocket.loop();
+}
+

src/WebSockets.cpp

@@ -27,19 +27,13 @@
 /**
  *
  * @param client WSclient_t * ptr to the client struct
- * @param code
+ * @param code uint16_t see RFC
  * @param reason
  * @param reasonLen
  */
 void WebSockets::clientDisconnect(WSclient_t * client, uint16_t code, char * reason, size_t reasonLen) {
  if(client->status == WSC_CONNECTED && code) {
- //todo send reason to client
-
- if(reasonLen > 0 && reason) {
-
- } else {
-
- }
+ sendFrame(client, WSop_close, (uint8_t *) reason, reasonLen);
  }
  clientDisconnect(client);
 }
@@ -49,9 +43,9 @@ void WebSockets::clientDisconnect(WSclient_t * client, uint16_t code, char * rea
  * @param client WSclient_t * ptr to the client struct
  * @param opcode WSopcode_t
  * @param payload uint8_t *
- * @param lenght size_t
+ * @param length size_t
  */
-void WebSockets::sendFrame(WSclient_t * client, WSopcode_t opcode, uint8_t * payload, size_t lenght) {
+void WebSockets::sendFrame(WSclient_t * client, WSopcode_t opcode, uint8_t * payload, size_t length) {
 
  uint8_t buffer[16] = { 0 };
  uint8_t i = 0;
@@ -61,31 +55,32 @@ void WebSockets::sendFrame(WSclient_t * client, WSopcode_t opcode, uint8_t * pay
  buffer[i] = bit(7); // set Fin
  buffer[i++] |= opcode; // set opcode
 
- if(lenght < 126) {
- buffer[i++] = lenght;
+ if(length < 126) {
+ buffer[i++] = length;
 
- } else if(lenght < 0xFFFF) {
+ } else if(length < 0xFFFF) {
  buffer[i++] = 126;
- buffer[i++] = ((lenght >> 8) & 0xFF);
- buffer[i++] = (lenght & 0xFF);
+ buffer[i++] = ((length >> 8) & 0xFF);
+ buffer[i++] = (length & 0xFF);
  } else {
+ // normaly we never get here (to less memory)
  buffer[i++] = 127;
  buffer[i++] = 0x00;
  buffer[i++] = 0x00;
  buffer[i++] = 0x00;
  buffer[i++] = 0x00;
- buffer[i++] = ((lenght >> 24) & 0xFF);
- buffer[i++] = ((lenght >> 16) & 0xFF);
- buffer[i++] = ((lenght >> 8) & 0xFF);
- buffer[i++] = (lenght & 0xFF);
+ buffer[i++] = ((length >> 24) & 0xFF);
+ buffer[i++] = ((length >> 16) & 0xFF);
+ buffer[i++] = ((length >> 8) & 0xFF);
+ buffer[i++] = (length & 0xFF);
  }
 
  // send header
  client->tcp.write(&buffer[0], i);
 
- if(payload && lenght > 0) {
+ if(payload && length > 0) {
  // send payload
- client->tcp.write(&payload[0], lenght);
+ client->tcp.write(&payload[0], length);
  }
 
 }
@@ -136,7 +131,7 @@ void WebSockets::handleWebsocket(WSclient_t * client) {
  }
  payloadLen = buffer[0] << 8 | buffer[1];
  } else if(payloadLen == 127) {
- // read 64bit inteager as Lenght
+ // read 64bit inteager as length
  if(!readWait(client, buffer, 8)) {
  //timeout
  clientDisconnect(client, 1002);
@@ -191,32 +186,24 @@ void WebSockets::handleWebsocket(WSclient_t * client) {
 
  switch(opCode) {
  case WSop_text:
- DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] text: %s\n", client->num, payload)
- ;
- // todo API for user to get message may callback
-
- // send the frame back!
- sendFrame(client, WSop_text, payload, payloadLen);
-
- break;
+ DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] text: %s\n", client->num, payload);
+ // no break here!
  case WSop_binary:
- // todo API for user to get message may callback
+ messageRecived(client, opCode, payload, payloadLen);
  break;
  case WSop_ping:
- // todo send pong
+ // send pong back
+ sendFrame(client, WSop_pong, payload, payloadLen);
  break;
  case WSop_pong:
- DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] get pong from Client (%s)\n", client->num, payload)
- ;
+ DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] get pong from Client (%s)\n", client->num, payload);
  break;
- case WSop_close: {
- uint16_t reasonCode = buffer[0] << 8 | buffer[1];
-
- DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] client ask for close. Code: %d (%s)\n", client->num, reasonCode, (payload + 2));
-
- // todo send confimation to client
- clientDisconnect(client, 1000, (char *) (payload + 2), payloadLen - 2);
- }
+ case WSop_close:
+ {
+ uint16_t reasonCode = buffer[0] << 8 | buffer[1];
+ DEBUG_WEBSOCKETS("[WS-Server][%d][handleWebsocket] client ask for close. Code: %d (%s)\n", client->num, reasonCode, (payload + 2));
+ clientDisconnect(client, 1000);
+ }
  break;
  case WSop_continuation:
  // continuation is not supported

src/WebSockets.h

@@ -37,7 +37,7 @@
 #endif
 #endif
 
-#define DEBUG_WEBSOCKETS(...) Serial1.printf( __VA_ARGS__ ); Serial1.flush()
+//#define DEBUG_WEBSOCKETS(...) Serial1.printf( __VA_ARGS__ );
 
 #ifndef DEBUG_WEBSOCKETS
 #define DEBUG_WEBSOCKETS(...)
@@ -95,9 +95,10 @@ class WebSockets {
  virtual void clientDisconnect(WSclient_t * client);
  virtual bool clientIsConnected(WSclient_t * client);
 
+ virtual void messageRecived(WSclient_t * client, WSopcode_t opcode, uint8_t * payload, size_t length);
 
  void clientDisconnect(WSclient_t * client, uint16_t code, char * reason = NULL, size_t reasonLen = 0);
- void sendFrame(WSclient_t * client, WSopcode_t opcode, uint8_t * payload = NULL, size_t lenght = 0);
+ void sendFrame(WSclient_t * client, WSopcode_t opcode, uint8_t * payload = NULL, size_t length = 0);
 
 
  void handleWebsocket(WSclient_t * client);