+license,style

Author: d-a-v

examples/esp8266-websocket/esp8266-websocket.ino renamed to examples/StandardFirmataWebSocket-esp8266/StandardFirmataWebSocket-esp8266.ino

@@ -1,17 +1,52 @@
+/*
+  Firmata is a generic protocol for communicating with microcontrollers
+  from software on a host computer. It is intended to work with
+  any host computer software package.
+
+  To download a host software package, please click on the following link
+  to open the list of Firmata client libraries in your default browser.
+
+  https://github.com/firmata/arduino#firmata-client-libraries
+
+  Copyright (C) 2006-2008 Hans-Christoph Steiner.  All rights reserved.
+  Copyright (C) 2010-2011 Paul Stoffregen.  All rights reserved.
+  Copyright (C) 2009 Shigeru Kobayashi.  All rights reserved.
+  Copyright (C) 2009-2016 Jeff Hoefs.  All rights reserved.
+  Copyright (C) 2015-2016 Jesse Frush. All rights reserved.
+  Copyright (C) 2016 Jens B. All rights reserved.
+  Copyright (C) 2020 david gauchard. All rights reserved (esp8266/websocket)
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+
+  See file LICENSE.txt for further informations on licensing terms.
+
+  Last updated June 1st, 2020
+*/
+
+#ifndef STASSID
+// WiFi credentials
+#define STASSID "your_network_name"
+#define STAPSK  "your_wpa_passphrase"
+#endif
+
+#define LOG_ENABLED     1       // 0 or 1
+#define DEBUG_ENABLED   0       // 0 or 1
+#define WS_PORT         3031    // websocket port
+#define SERIAL_BAUD     9600
 
 #include <Servo.h>
 #include <Wire.h>
 #include <Firmata.h>
 
-#include <ESP8266mDNS.h>        // esp8266 Arduino standard library
-#include <WebSocketsServer.h>   // https://github.com/Links2004/arduinoWebSockets
+#include <ESP8266mDNS.h>        // mDNS from esp8266 Arduino standard library
+#include <WebSocketsServer.h>   // https://github.com/Links2004/arduinoWebSockets 
 #include <PipedStream.h>        // https://github.com/paulo-raca/ArduinoBufferedStreams
 
 #include <utility/ExampleStandardFirmataCommon.h>
 
-#define LOG_ENABLED     1 // 0 or 1
-#define DEBUG_ENABLED   1 // 0 or 1
-
 #if LOG_ENABLED
 #define LOG(x...) do { x; } while (0)
 #define IS_IGNORE_PIN(i) ((i) == 1) // 1 == Serial TX
@@ -25,10 +60,15 @@
 #define DEBUG(x...) do { (void)0; } while (0)
 #endif
 
+// everything written to firmataStream will be readable from firmataInternalStream
+// everything written to firmataInternalStream will be readable from firmataStream
+// firmataInternalStream is the stream given to Firmata
+// websocket functions will read and write on firmataStream
 PipedStreamPair pipe; // streamify data coming from websocket
 PipedStream& firmataInternalStream = pipe.first;
 PipedStream& firmataStream = pipe.second;
-WebSocketsServer webSocket(3031);
+
+WebSocketsServer webSocket(WS_PORT);
 
 /*
  * StandardFirmataWiFi communicates with WiFi shields over SPI. Therefore all
@@ -49,16 +89,16 @@ void ignorePins()
 
 void initTransport()
 {
-    WiFi.persistent(false);
-    WiFi.mode(WIFI_STA);
-    WiFi.begin(STASSID, STAPSK);
-    LOG(Serial.printf("Connecting to SSID '%s'...\n", STASSID));
-    while (WiFi.status() != WL_CONNECTED)
-    {
-        delay(1000);
-        LOG(Serial.print('.'));
-    }    
-    LOG(Serial.printf("Connected, IP address: %s\n", WiFi.localIP().toString().c_str()));
+  WiFi.persistent(false);
+  WiFi.mode(WIFI_STA);
+  WiFi.begin(STASSID, STAPSK);
+  LOG(Serial.printf("Connecting to SSID '%s'...\n", STASSID));
+  while (WiFi.status() != WL_CONNECTED)
+  {
+    delay(1000);
+    LOG(Serial.print('.'));
+  }
+  LOG(Serial.printf("Connected, IP address: %s\n", WiFi.localIP().toString().c_str()));
 }
 
 int clients = 0;
@@ -81,15 +121,15 @@ void webSocketEvent(uint8_t num, WStype_t type, uint8_t * payload, size_t length
         clients++;
       }
       break;
-    
+
     case WStype_TEXT:
       DEBUG(Serial.printf("Informative Text from WebSocket: '%s'\n", (const char*)payload));
       break;
 
     case WStype_BIN:
       DEBUG(Serial.printf("binary from WebSocket\n"));
 #if 1
-      // !! there _is_StreamFirmataInternal a Print::write(ptr,size_t) !?
+      // !! there _is_  a Print::write(ptr,size_t) !?
       for (size_t i = 0; i < length; i++)
       {
         if (firmataStream.write(payload[i]) != 1) {
@@ -119,20 +159,18 @@ void initFirmata()
 {
   initFirmataCommonBegin();
   ignorePins();
-
   Firmata.begin(firmataInternalStream);
-
   initFirmataCommonEnd();
 }
 
 void setup()
 {
-  LOG(Serial.begin(115200));
+  LOG(Serial.begin(SERIAL_BAUD));
 
   initTransport();
   initWebSocket();
   initFirmata();
-  MDNS.begin("firmata"); // "firmata.local" will be the dns name in LAN
+  MDNS.begin("firmata"); // "firmata.local" will be the mDNS name in LAN
 }
 
 /*==============================================================================
@@ -144,34 +182,34 @@ void loop()
   webSocket.loop();
   MDNS.update();
 
-  size_t firmataStreamLen = firmataStream.available();
+  size_t firmata2WSLen = firmataStream.available();
 
-#if 0 && DEBUG_ENABLED
+#if DEBUG_ENABLED
   static unsigned long last = 0;
   if (millis() - last > 5000)
   {
     last += 1000;
     Serial.printf("Firmata to WS: available=%zd --- WS to Firmata: available=%zd\n",
-        firmataStreamLen, 
+        firmata2WSLen,
         firmataInternalStream.available());
   }
 #endif
 
-  if (clients && firmataStreamLen)
+  if (clients && firmata2WSLen)
   {
-    DEBUG(Serial.printf("Firmata -> WS: %zd bytes\n", firmataStreamLen));
+    DEBUG(Serial.printf("Firmata -> WS: %zd bytes\n", firmata2WSLen));
 
     static byte tempBuffer [MAX_DATA_BYTES];
-    if (firmataStreamLen > sizeof(tempBuffer))
-      firmataStreamLen = sizeof(tempBuffer);
-    if (   firmataStream.readBytes(tempBuffer, firmataStreamLen) == firmataStreamLen
-        && webSocket.broadcastBIN(tempBuffer, firmataStreamLen))
+    if (firmata2WSLen > sizeof(tempBuffer))
+      firmata2WSLen = sizeof(tempBuffer);
+    if (   firmataStream.readBytes(tempBuffer, firmata2WSLen) == firmata2WSLen
+        && webSocket.broadcastBIN(tempBuffer, firmata2WSLen))
     {
-      DEBUG(Serial.printf("Successfully broadcasted-to-websocket a binary message of %zd bytes\n", firmataStreamLen));
+      DEBUG(Serial.printf("Successfully broadcasted-to-websocket a binary message of %zd bytes\n", firmata2WSLen));
     }
     else
     {
-      LOG(Serial.printf("Error broadcasting-to-websocket a binary message of %zd bytes\n", firmataStreamLen));
+      LOG(Serial.printf("Error broadcasting-to-websocket a binary message of %zd bytes\n", firmata2WSLen));
     }
   }
 }

examples/esp8266-websocket/wsdemo.html renamed to examples/StandardFirmataWebSocket-esp8266/wsdemo.html

@@ -67,9 +67,9 @@
 var ws = undefined;
 
 function WebSocketTest() {
-   
+
    console.log("hello");
-   document.body.addEventListener('click', clickEvent, true); 
+   document.body.addEventListener('click', clickEvent, true);
 
    if (!("WebSocket" in window))
    {
@@ -84,13 +84,13 @@
      alert("Cannot open WebSocket " + server);
      return;
    }
-    
+
    ws.onopen = function() {
       console.log('connected to server\n');
       ws.send("hello from ws");
    };
-    
-   ws.onmessage = function (evt) { 
+
+   ws.onmessage = function (evt) {
       var len = evt.data.length;
       console.log('type=' + typeof(evt.data));
       if (evt.data instanceof ArrayBuffer)
@@ -106,8 +106,8 @@
       }
       //ws.send(evt.data);
    };
-    
-   ws.onclose = function() { 
+
+   ws.onclose = function() {
       console.log('ws closed\n');
       ws = undefined;
    };