Merge branch 'master' into dev-2.4.0

Author: sivar2311

examples/Fan/Fan.ino

@@ -0,0 +1,104 @@
+/*
+ * If you encounter any issues:
+ * - check the readme.md at https://github.com/sinricpro/esp8266-esp32-sdk/blob/master/README.md
+ * - ensure all dependent libraries are installed
+ *   - see https://github.com/sinricpro/esp8266-esp32-sdk/blob/master/README.md#arduinoide
+ *   - see https://github.com/sinricpro/esp8266-esp32-sdk/blob/master/README.md#dependencies
+ * - open serial monitor and check whats happening
+ * - check full user documentation at https://sinricpro.github.io/esp8266-esp32-sdk
+ * - visit https://github.com/sinricpro/esp8266-esp32-sdk/issues and check for existing issues or open a new one
+ */
+
+// Uncomment the following line to enable serial debug output
+//#define ENABLE_DEBUG
+
+#ifdef ENABLE_DEBUG
+       #define DEBUG_ESP_PORT Serial
+       #define NODEBUG_WEBSOCKETS
+       #define NDEBUG
+#endif 
+
+#include <Arduino.h>
+#ifdef ESP8266 
+       #include <ESP8266WiFi.h>
+#endif 
+#ifdef ESP32   
+       #include <WiFi.h>
+#endif
+
+#include "SinricPro.h"
+#include "SinricProFanUS.h"
+
+#define WIFI_SSID         "YOUR-WIFI-SSID"    
+#define WIFI_PASS         "YOUR-WIFI-PASSWORD"
+#define APP_KEY           "YOUR-APP-KEY"      // Should look like "de0bxxxx-1x3x-4x3x-ax2x-5dabxxxxxxxx"
+#define APP_SECRET        "YOUR-APP-SECRET"   // Should look like "5f36xxxx-x3x7-4x3x-xexe-e86724a9xxxx-4c4axxxx-3x3x-x5xe-x9x3-333d65xxxxxx"
+#define FAN_ID            "YOUR-DEVICE-ID"    // Should look like "5dc1564130xxxxxxxxxxxxxx"
+#define BAUD_RATE         9600                // Change baudrate to your need
+
+// we use a struct to store all states and values for our fan
+// fanSpeed (1..3)
+struct {
+  bool powerState = false;
+  int fanSpeed = 1;
+} device_state;
+
+bool onPowerState(const String &deviceId, bool &state) {
+  Serial.printf("Fan turned %s\r\n", state?"on":"off");
+  device_state.powerState = state;
+  return true; // request handled properly
+}
+
+// Fan rangeValue is from 1..3
+bool onRangeValue(const String &deviceId, int &rangeValue) {
+  device_state.fanSpeed = rangeValue;
+  Serial.printf("Fan speed changed to %d\r\n", device_state.fanSpeed);
+  return true;
+}
+
+// Fan rangeValueDelta is from -3..+3
+bool onAdjustRangeValue(const String &deviceId, int rangeValueDelta) {
+  device_state.fanSpeed += rangeValueDelta;
+  if (device_state.fanSpeed < 1) device_state.fanSpeed = 1;
+  if (device_state.fanSpeed > 3) device_state.fanSpeed = 3;
+  Serial.printf("Fan speed changed about %i to %d\r\n", rangeValueDelta, device_state.fanSpeed);
+
+  rangeValueDelta = device_state.fanSpeed; // return absolute fan speed
+  return true;
+}
+
+void setupWiFi() {
+  Serial.printf("\r\n[Wifi]: Connecting");
+  WiFi.begin(WIFI_SSID, WIFI_PASS);
+
+  while (WiFi.status() != WL_CONNECTED) {
+    Serial.printf(".");
+    delay(250);
+  }
+  Serial.printf("connected!\r\n[WiFi]: IP-Address is %s\r\n", WiFi.localIP().toString().c_str());
+}
+
+void setupSinricPro() {
+  SinricProFanUS &myFan = SinricPro[FAN_ID];
+
+  // set callback function to device
+  myFan.onPowerState(onPowerState);
+  myFan.onRangeValue(onRangeValue);
+  myFan.onAdjustRangeValue(onAdjustRangeValue);
+
+  // setup SinricPro
+  SinricPro.onConnected([](){ Serial.printf("Connected to SinricPro\r\n"); }); 
+  SinricPro.onDisconnected([](){ Serial.printf("Disconnected from SinricPro\r\n"); });
+  SinricPro.begin(APP_KEY, APP_SECRET);
+}
+
+// main setup function
+void setup() {
+  Serial.begin(BAUD_RATE); Serial.printf("\r\n\r\n");
+  setupWiFi();
+  setupSinricPro();
+}
+
+void loop() {
+  SinricPro.handle();
+}

examples/Switch/Switch.ino

@@ -41,7 +41,8 @@
 #define SWITCH_ID         "YOUR-DEVICE-ID"    // Should look like "5dc1564130xxxxxxxxxxxxxx"
 #define BAUD_RATE         9600                // Change baudrate to your need
 
-#define BTN_FLASH 0
+#define BUTTON_PIN 0   // GPIO for BUTTON (inverted: LOW = pressed, HIGH = released)
+#define LED_PIN   2   // GPIO for LED (inverted)
 
 bool myPowerState = false;
 unsigned long lastBtnPress = 0;
@@ -62,19 +63,19 @@ unsigned long lastBtnPress = 0;
 bool onPowerState(const 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);
+  digitalWrite(LED_PIN, 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 (digitalRead(BUTTON_PIN) == 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)
+    digitalWrite(LED_PIN, myPowerState?LOW:HIGH); // if myPowerState indicates device turned on: turn on led (builtin led uses inverted logic: LOW = LED ON / HIGH = LED OFF)
 
     // get Switch device back
     SinricProSwitch& mySwitch = SinricPro[SWITCH_ID];
@@ -95,8 +96,7 @@ void setupWiFi() {
     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]);
+  Serial.printf("connected!\r\n[WiFi]: IP-Address is %s\r\n", WiFi.localIP().toString().c_str());
 }
 
 // setup function for SinricPro
@@ -115,9 +115,9 @@ void setupSinricPro() {
 
 // 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
+  pinMode(BUTTON_PIN, INPUT_PULLUP); // GPIO 0 as input, pulled high
+  pinMode(LED_PIN, OUTPUT); // define LED GPIO as output
+  digitalWrite(LED_PIN, HIGH); // turn off LED on bootup
 
   Serial.begin(BAUD_RATE); Serial.printf("\r\n\r\n");
   setupWiFi();