Merge pull request #9 from lucalas/feature/2-replace-socket-io-client-library

Replaced socket io client library

Author: lucalas

README.md

@@ -1,11 +1,12 @@
 
 # Streamlabs Arduino Alerts [![Build Status](https://travis-ci.com/lucalas/StreamlabsArduinoAlerts.svg?branch=master)](https://travis-ci.com/lucalas/StreamlabsArduinoAlerts)
-A work in progress library to connect to your Streamlabs account and catch all the Twitch events.
+Library to connect to your Streamlabs account and catch all the `Twitch` events.
 
-## Twitch event catchable
+## Twitch catchable events
 
  - Follow
  - Subscription
+ - Resubscription
  - Donation
  - Raid
  - Host
@@ -24,18 +25,18 @@ A work in progress library to connect to your Streamlabs account and catch all t
 ## Add library
 Best thing is to use the Arduino Library Manager.
 
-Go to Sketch > Include Library > Manage Libraries.
-Install WebSockets by Markus Sattler
-Install SocketIoClient
-Install StreamlabsArduinoAlerts
-Select Sketch > Include Library > StreamlabsArduinoAlerts
+- Go to Sketch > Include Library > Manage Libraries.
+- Install `WebSockets` by Markus Sattler
+- Install `StreamlabsArduinoAlerts`
+- Select Sketch > Include Library > StreamlabsArduinoAlerts
 
 ## Methods
 #### connect(socket_token)
-Method to connect to Streamlabs server, required [socket token](https://streamlabs.readme.io/docs/sockettoken).
+Method to connect to Streamlabs server, required [socket token](#get-streamlabs-socket-token).
 
 #### followTwitchEvent(callback)
 #### subscriptionsTwitchEvent(callback)
+#### resubscriptionsTwitchEvent(callback)
 #### hostTwitchEvent(callback)
 #### bitsTwitchEvent(callback)
 #### raidsTwitchEvent(callback)
@@ -68,5 +69,8 @@ void loop() {
 
 Event result documentation can be found on Streamlabs WebSite [HERE](https://dev.streamlabs.com/docs/socket-api)
 
+## Get Streamlabs Socket Token
+You can find yours at https://streamlabs.com/dashboard#/apisettings under "API TOKENS" then "Your Socket API Token". This token is bound to the account that you are logged in with. If you need to access the alerts of a streamer, ask them to provide you with a token from the above location.
+
 ### Issues ###
 Submit issues to: https://github.com/lucalas/StreamlabsArduinoAlerts/issues

examples/esp8266/StreamlabsArduinoAlerts/StreamlabsArduinoAlerts.ino

@@ -27,11 +27,26 @@ void subscriptionEvent(const char * payload) {
   Serial.println(payload);
 }
 
+void resubscriptionEvent(const char * payload) {
+  Serial.print("got resubscriptionEvent message: ");
+  Serial.println(payload);
+}
+
+void hostEvent(const char * payload) {
+  Serial.print("got hostEvent message: ");
+  Serial.println(payload);
+}
+
 void bitsEvent(const char * payload) {
   Serial.print("got bitsEvent message: ");
   Serial.println(payload);
 }
 
+void raidEvent(const char * payload) {
+  Serial.print("got raidEvent message: ");
+  Serial.println(payload);
+}
+
 void donationsEvent(const char * payload) {
   Serial.print("got donationsEvent message: ");
   Serial.println(payload);
@@ -57,7 +72,10 @@ void setup() {
 
     streamlabsAPI.followTwitchEvent(followerEvent);
     streamlabsAPI.subscriptionsTwitchEvent(subscriptionEvent);
+    streamlabsAPI.resubscriptionsTwitchEvent(resubscriptionEvent);
+    streamlabsAPI.hostTwitchEvent(hostEvent);
     streamlabsAPI.bitsTwitchEvent(bitsEvent);
+    streamlabsAPI.raidTwitchEvent(raidEvent);
     streamlabsAPI.donationEvent(donationsEvent);
     streamlabsAPI.connect(SOCKET_TOKEN);
 }

library.properties

@@ -1,10 +1,10 @@
 name=StreamlabsArduinoAlerts
-version=0.1
+version=1.0
 author=Luca Taddeo
 maintainer=Luca Taddeo
 sentence=Library to get Streamlabs event from Twitch
-paragraph=A work in progress library to connect to your Streamlabs account and catch all the Twitch events.
+paragraph=Library to connect to your Streamlabs account and catch all the Twitch events.
 category=Communication
 url=https://github.com/lucalas/StreamlabsArduinoAlerts
 architectures=*
-depends=SocketIoClient, WebSockets
+depends=WebSockets

src/StreamlabsAPI.cpp

@@ -1,18 +1,16 @@
 #include "StreamlabsAPI.h"
-#include <ArduinoJson.h>
 
 
 void StreamlabsAPI::loop() {
     webSocket.loop();
 }
 
-bool StreamlabsAPI::connect(const char* socketToken) {
-    webSocket.on("event", std::bind(&StreamlabsAPI::event, this, std::placeholders::_1, std::placeholders::_2));    
-
+void StreamlabsAPI::connect(const char* socketToken) {
+    webSocket.onEvent(std::bind(&StreamlabsAPI::event, this, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3));
     String queryParams = SL_DEFAULT_QUERYPARAMETES;
-    queryParams += "&token=";
-    queryParams += socketToken;
-    webSocket.beginSSL(SL_HOSTNAME, SL_PORT, queryParams.c_str(), SL_FINGERPRINT);
+    queryParams.concat("token=");
+    queryParams.concat(socketToken);
+    webSocket.beginSSL(SL_HOSTNAME, SL_PORT, queryParams.c_str());
 }
 
 void StreamlabsAPI::followTwitchEvent(std::function<void (const char * payload)> func) {
@@ -23,6 +21,10 @@ void StreamlabsAPI::subscriptionsTwitchEvent(std::function<void (const char * pa
     events["subscription"] = func;
 }
 
+void StreamlabsAPI::resubscriptionsTwitchEvent(std::function<void (const char * payload)> func) {
+    events["resub"] = func;
+}
+
 void StreamlabsAPI::hostTwitchEvent(std::function<void (const char * payload)> func) {
     events["host"] = func;
 }
@@ -39,18 +41,22 @@ void StreamlabsAPI::donationEvent(std::function<void (const char * payload)> fun
     events["donation"] = func;
 }
 
-StaticJsonDocument<10000> doc;
-void StreamlabsAPI::event(const char * payload, size_t length) {
-    // FIXME remove deserialized and parse string to get the type
-    DeserializationError error = deserializeJson(doc, payload);
-    if (error) {
-        Serial.print("deserializeJson() failed: ");
-        return;
-    }
+void StreamlabsAPI::event(socketIOmessageType_t type, uint8_t * payload, size_t length) {
+    const char* data = reinterpret_cast<char*>(payload);
+    DEBUG_STREAMLABS_ALERTS("------STREAMLABS EVENT------\n");
+    DEBUG_STREAMLABS_ALERTS("SocketIO message type: %d\n", type);
+    DEBUG_STREAMLABS_ALERTS("SocketIO data: %s\n", data);
+
+    String payloadS = String((char *) payload);
+    int startOfType = payloadS.indexOf("\"type\":\"");
+    int endOfType = payloadS.indexOf("\"", startOfType + 8);
+    String typeS = payloadS.substring(startOfType + 8, endOfType);
+
+    DEBUG_STREAMLABS_ALERTS("Streamlabs event type: %s\n", typeS.c_str());
+    DEBUG_STREAMLABS_ALERTS("-----------------------------\n");
 
-    const char* type = doc["type"];
-	auto e = events.find(type);
+	auto e = events.find(typeS);
 	if(e != events.end()) {
-		e->second(payload);
+		e->second(data);
     }
 }

src/StreamlabsAPI.h

@@ -1,26 +1,36 @@
 #include <Arduino.h>
 #include <map>
-#include <SocketIoClient.h>
+#include <SocketIOclient.h>
+
+#ifdef DEBUG_ESP_PORT
+#define DEBUG_STREAMLABS_ALERTS(...)               \
+    {                                       \
+        DEBUG_ESP_PORT.printf(__VA_ARGS__); \
+        DEBUG_ESP_PORT.flush();             \
+    }
+#else
+#define DEBUG_STREAMLABS_ALERTS(...)
+#endif
 
 #define SL_HOSTNAME "sockets.streamlabs.com"
 #define SL_PORT 443
-#define SL_DEFAULT_QUERYPARAMETES "/socket.io/?transport=websocket"
-#define SL_FINGERPRINT "E7 93 77 36 DA D4 15 0F C1 C1 8F 14 D5 2A C8 72 93 D0 6F 2A"
+#define SL_DEFAULT_QUERYPARAMETES "/socket.io/?"
 
 
 #ifndef STREAMLABSAPI_H_
 #define STREAMLABSAPI_H_
 
 class StreamlabsAPI {
     private:
-        SocketIoClient webSocket;
+        SocketIOclient webSocket;
 	    std::map<String, std::function<void (const char * payload)>> events;
-        void event(const char * payload, size_t length);
+        void event(socketIOmessageType_t type, uint8_t * payload, size_t length);
     public:
         void loop();
-        bool connect(const char* socketToken);
+        void connect(const char* socketToken);
         void followTwitchEvent(std::function<void (const char * payload)> func);
         void subscriptionsTwitchEvent(std::function<void (const char * payload)> func);
+        void resubscriptionsTwitchEvent(std::function<void (const char * payload)> func);
         void hostTwitchEvent(std::function<void (const char * payload)> func);
         void bitsTwitchEvent(std::function<void (const char * payload)> func);
         void raidsTwitchEvent(std::function<void (const char * payload)> func);