made library ArduinoIDE compatible

Author: sivar2311

README.md

@@ -1,21 +1,24 @@
 
 # SinricPro (ESP8266 / ESP32 SDK)
 ## Installation
-This library is designed for use with [platform.io](https://platformio.org/platformio-ide). We recommend using [VS Code](https://code.visualstudio.com/) as code editor.  
 
+### VS Code & PlatformIO:
 1. Install [VS Code](https://code.visualstudio.com/)  
-2. Install [platform.io](https://platformio.org/platformio-ide)  
-3. Open the [example](https://github.com/sinricpro/esp8266-esp32-sdk/tree/master/examples/Switch) project using VS Code.
-4. Install **SinricPro** library by using [Library Manager](https://docs.platformio.org/en/latest/librarymanager/)
+2. Install [PlatformIO](https://platformio.org/platformio-ide)  
+3. Install **SinricPro** library by using [Library Manager](https://docs.platformio.org/en/latest/librarymanager/)
 
 ![sinricpro library manager](https://github.com/sinricpro/images/blob/master/platformio-install-sinricpro.png)
 
+### ArduinoIDE
+1. Download **SinricPro** [esp8266-esp32-sdk-master.zip](https://github.com/sinricpro/esp8266-esp32-sdk/archive/master.zip) from git
+2. Extract ZIP File to Arduino Library Folder (C:\Users\USERNAME\Documents\Arduino\libraries\SinricPro)
+3. Open Example in ArduinoIDE (File / Examples / SinricPro / ... )
 
 ---
 
 ## Dependencies
-[ArduinoJson](https://github.com/bblanchon/ArduinoJson)<br>
-[WebSocketsClient](https://github.com/Links2004/arduinoWebSockets)<br>
+[ArduinoJson](https://github.com/bblanchon/ArduinoJson) (Version 6.12.0)   
+[WebSocketsClient](https://github.com/Links2004/arduinoWebSockets) (Version 2.2.0)  
 [NTPClient](https://github.com/arduino-libraries/NTPClient)
 
 ---

examples/Doorbell/src/doorbell.cpp renamed to examples/doorbell/doorbell.ino

@@ -8,19 +8,19 @@
   },
   "authors": [
     {
-      "name": "sivar2311",
+      "name": "Boris Jaeger",
       "email": "[email protected]",
       "maintainer": true
     }
   ],
-  "version": "2.0.1",
+  "version": "2.0.2",
   "frameworks": "arduino",
   "platforms": [
     "espressif8266",
     "espressif32"
   ],
   "examples":[
-    "examples/Switch/src/switch.cpp",
-    "examples/Doorbell/src/doorbell.cpp"
+    "pio-examples/switch/src/switch.cpp",
+    "pio-examples/doorbell/src/doorbell.cpp"
   ]
 }

examples/Switch/src/switch.cpp renamed to examples/switch/switch.ino

@@ -0,0 +1,11 @@
+name=SinricPro
+version=2.0.1
+author=Boris Jäger <[email protected]>
+maintainer=Boris Jäger <[email protected]>
+sentence=An Arduino SDK for https://sinric.pro
+paragraph=Simple way to control your IOT development boards like ESP8226 or ESP32 with Amazon Alexa or Google Home
+category=Communication
+url=https:://sinric.pro
+architectures=esp8266,esp32
+repository=https://github.com/sinricpro/esp8266-esp32-sdk.git
+license=CC-BY-SA

library.json

@@ -0,0 +1,80 @@
+/*
+ * Example for how to use SinricPro Doorbell device:
+ * - setup a doorbell device
+ * - send event to sinricPro server if button is pressed
+ */
+
+#include <Arduino.h>
+#ifdef ESP8266 
+       #include <ESP8266WiFi.h>
+#endif 
+#ifdef ESP32   
+       #include <WiFi.h>
+#endif
+
+#include "SinricPro.h"
+#include "SinricProDoorbell.h"
+
+#define WIFI_SSID         "YOUR-WIFI-SSID"
+#define WIFI_PASS         "YOUR-WIFI-PASSWORD"
+#define SOCKET_AUTH_TOKEN "YOUR-SOCKET-AUTH-TOKEN"
+#define SIGNING_KEY       "YOUR-SIGNING-KEY"
+
+#define DOORBELL_ID       "YOUR-DEVICE-ID"
+
+
+// change this to your button PIN
+// on NodeMCU D3 / GPIO-0 is flash button PIN so you can use the builtin flash button
+#define BUTTON_PIN 0
+
+// define SinricPro Doorbell Device
+SinricProDoorbell myDoorbell(DOORBELL_ID);
+
+// checkButtonpress
+// reads if BUTTON_PIN gets LOW and send Event
+void checkButtonPress() {
+  static unsigned long lastBtnPress;
+  unsigned long actualMillis = millis();
+
+  if (actualMillis-lastBtnPress > 500) {
+    if (digitalRead(BUTTON_PIN)==LOW) {
+      lastBtnPress = actualMillis;
+      myDoorbell.sendDoorbellEvent();
+    }
+  }
+}
+
+// setup function for WiFi connection
+void setupWiFi() {
+  Serial.printf("\r\n[Wifi]: Connecting");
+  WiFi.begin(WIFI_SSID, WIFI_PASS);
+
+  while (WiFi.status() != WL_CONNECTED) {
+    Serial.printf(".");
+    delay(250);
+  }
+  IPAddress localIP = WiFi.localIP();
+  Serial.printf("connected!\r\n[WiFi]: IP-Address is %d.%d.%d.%d\r\n", localIP[0], localIP[1], localIP[2], localIP[3]);
+}
+
+// setup function for SinricPro
+void setupSinricPro() {
+  // add device to SinricPro
+  SinricPro.add(myDoorbell);
+  // setup SinricPro
+  SinricPro.begin(SOCKET_AUTH_TOKEN, SIGNING_KEY);
+}
+
+// main setup function
+void setup() {
+  pinMode(BUTTON_PIN, INPUT_PULLUP); // BUTTIN_PIN as INPUT
+
+  Serial.begin(115200);
+  setupWiFi();
+  setupSinricPro();
+}
+
+void loop() {
+  checkButtonPress();
+  SinricPro.handle();
+}

library.properties

@@ -0,0 +1,103 @@
+/*
+ * Example for how to use SinricPro Switch device:
+ * - setup a switch device
+ * - handle request using callback (turn on/off builtin led indicating device power state)
+ * - send event to sinricPro server (flash button is used to turn on/off device manually)
+ */
+
+#include <Arduino.h>
+#ifdef ESP8266 
+       #include <ESP8266WiFi.h>
+#endif 
+#ifdef ESP32   
+       #include <WiFi.h>
+#endif
+
+#include "SinricPro.h"
+#include "SinricProSwitch.h"
+
+#define WIFI_SSID         "YOUR-WIFI-SSID"
+#define WIFI_PASS         "YOUR-WIFI-PASSWORD"
+#define SOCKET_AUTH_TOKEN "YOUR-SOCKET-AUTH-TOKEN"
+#define SIGNING_KEY       "YOUR-SIGNING-KEY"
+#define SWITCH_ID         "YOUR-DEVICE-ID"
+
+#define BTN_FLASH 0
+
+SinricProSwitch mySwitch(SWITCH_ID);
+bool myPowerState = false;
+unsigned long lastBtnPress = 0;
+
+/* bool onPowerState(String deviceId, bool &state) 
+ *
+ * Callback for setPowerState request
+ * parameters
+ *  String deviceId (r)
+ *    contains deviceId (useful if this callback used by multiple devices)
+ *  bool &state (r/w)
+ *    contains the requested state (true:on / false:off)
+ *    must return the new state
+ * 
+ * return
+ *  true if request should be marked as handled correctly / false if not
+ */
+bool onPowerState(String deviceId, bool &state) {
+  Serial.printf("Device %s turned %s (via SinricPro) \r\n", deviceId.c_str(), state?"on":"off");
+  myPowerState = state;
+  digitalWrite(LED_BUILTIN, myPowerState?LOW:HIGH);
+  return true; // request handled properly
+}
+
+void handleButtonPress() {
+  unsigned long actualMillis = millis(); // get actual millis() and keep it in variable actualMillis
+  if (digitalRead(BTN_FLASH) == LOW && actualMillis - lastBtnPress > 1000)  { // is button pressed (inverted logic! button pressed = LOW) and debounced?
+    if (myPowerState) {     // flip myPowerState: if it was true, set it to false, vice versa
+      myPowerState = false;
+    } else {
+      myPowerState = true;
+    }
+    digitalWrite(LED_BUILTIN, myPowerState?LOW:HIGH); // if myPowerState indicates device turned on: turn on led (builtin led uses inverted logic: LOW = LED ON / HIGH = LED OFF)
+    Serial.printf("Device %s turned %s (manually via flashbutton)\r\n", mySwitch.getDeviceId(), myPowerState?"on":"off");
+    mySwitch.sendPowerStateEvent(myPowerState); // send the new powerState to SinricPro server
+    lastBtnPress = actualMillis;  // update last button press variable
+  } 
+}
+
+// setup function for WiFi connection
+void setupWiFi() {
+  Serial.printf("\r\n[Wifi]: Connecting");
+  WiFi.begin(WIFI_SSID, WIFI_PASS);
+
+  while (WiFi.status() != WL_CONNECTED) {
+    Serial.printf(".");
+    delay(250);
+  }
+  IPAddress localIP = WiFi.localIP();
+  Serial.printf("connected!\r\n[WiFi]: IP-Address is %d.%d.%d.%d\r\n", localIP[0], localIP[1], localIP[2], localIP[3]);
+}
+
+// setup function for SinricPro
+void setupSinricPro() {
+  // set callback function to device
+  mySwitch.onPowerState(onPowerState);
+  // add device to SinricPro
+  SinricPro.add(mySwitch);
+  // setup SinricPro
+  SinricPro.begin(SOCKET_AUTH_TOKEN, SIGNING_KEY);
+}
+
+// main setup function
+void setup() {
+  pinMode(BTN_FLASH, INPUT_PULLUP); // GPIO 0 as input, pulled high
+  pinMode(LED_BUILTIN, OUTPUT); // define LED GPIO as output
+  digitalWrite(LED_BUILTIN, HIGH); // turn off LED on bootup
+
+  Serial.begin(115200);
+  setupWiFi();
+  setupSinricPro();
+}
+
+void loop() {
+  handleButtonPress();
+  SinricPro.handle();
+}