Merge pull request #76 from arduino-libraries/esp8266-user-pass-login

ESP8266 support for Arduino IoT Cloud (User/Pass Authentification)

Author: eclipse1985

.gitignore

@@ -2,3 +2,4 @@
 *.elf
 *~
 .vscode
+*.orig

.travis.yml

@@ -1,7 +1,4 @@
 language: generic
-env:
-  global:
-    - CLI_VERSION=latest
 matrix:
   include:
     - env:
@@ -10,6 +7,8 @@ matrix:
         - BOARD="arduino:samd:mkrwifi1010"
     - env:
         - BOARD="arduino:samd:mkrgsm1400"
+    - env:
+        - BOARD="esp8266:esp8266:huzzah"
     - env:
         - NAME=Code Formatting Check
       # must define an empty before_install phase, otherwise the default one is used
@@ -42,15 +41,16 @@ matrix:
         - codespell --skip="${TRAVIS_BUILD_DIR}/.git" --ignore-words="${TRAVIS_BUILD_DIR}/extras/codespell-ignore-words-list.txt" "${TRAVIS_BUILD_DIR}"
 # default phases
 before_install:
-  - wget http://downloads.arduino.cc/arduino-cli/arduino-cli-$CLI_VERSION-linux64.tar.bz2
-  - tar xf arduino-cli-$CLI_VERSION-linux64.tar.bz2
   - mkdir -p "$HOME/bin"
-  - mv arduino-cli-*-linux64 $HOME/bin/arduino-cli
+  - curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR="$HOME/bin" sh
   - export PATH="$PATH:$HOME/bin"
-  - arduino-cli core update-index
+  - arduino-cli core update-index --additional-urls http://arduino.esp8266.com/stable/package_esp8266com_index.json;
   - if [[ "$BOARD" =~ "arduino:samd:" ]]; then
       arduino-cli core install arduino:samd;
     fi
+  - if [[ "$BOARD" =~ "esp8266:esp8266" ]]; then
+      arduino-cli core install esp8266:esp8266 --additional-urls http://arduino.esp8266.com/stable/package_esp8266com_index.json;
+    fi
   - |
     installLibrary() {
       local -r repositoryFullName="$1"
@@ -66,32 +66,40 @@ before_install:
     }
   - installLibrary arduino-libraries/ArduinoCloudThing
   - installLibrary arduino-libraries/ArduinoECCX08
-  - installLibrary arduino-libraries/ArduinoIoTCloudBearSSL
+  - installLibrary arduino-libraries/ArduinoBearSSL
   - installLibrary arduino-libraries/ArduinoMqttClient
   - installLibrary arduino-libraries/MKRGSM
   - installLibrary arduino-libraries/RTCZero
   - installLibrary arduino-libraries/WiFi101
   - installLibrary arduino-libraries/WiFiNINA
   - installLibrary arduino-libraries/Ethernet
+  - installLibrary arduino-libraries/Arduino_ConnectionHandler
+  - installLibrary arduino-libraries/Arduino_DebugUtils
   - buildExampleSketch() { arduino-cli compile --warnings all --fqbn $BOARD $PWD/examples/$1; }
   - buildExampleUtilitySketch() { arduino-cli compile --warnings all --fqbn $BOARD $PWD/examples/utility/$1; }
 install:
   - mkdir -p $HOME/Arduino/libraries
   - ln -s $PWD $HOME/Arduino/libraries/.
 script:
-  - buildExampleSketch ArduinoIoTCloud_LED_switch
-  - buildExampleSketch ArduinoIoTCloud_Travis_CI
   - |
-    if [ "$BOARD" == "arduino:samd:mkr1000" ] || [ "$BOARD" == "arduino:samd:mkrwifi1010" ];
-    then
+    if [ "$BOARD" == "arduino:samd:mkr1000" ] || [ "$BOARD" == "arduino:samd:mkrwifi1010" ] || [ "$BOARD" == "arduino:samd:mkrgsm1400" ]; then
+      buildExampleSketch ArduinoIoTCloud_LED_switch;
+      buildExampleSketch ArduinoIoTCloud_Travis_CI;
+      buildExampleUtilitySketch Provisioning;
+    fi
+  - |
+    if [ "$BOARD" == "arduino:samd:mkr1000" ] || [ "$BOARD" == "arduino:samd:mkrwifi1010" ]; then
       buildExampleSketch WiFi_Cloud_Blink;
       buildExampleSketch MultiValue_example;
     fi
   - |
-    if [ "$BOARD" == "arduino:samd:mkrgsm1400" ];
-    then buildExampleSketch GSM_Cloud_Blink;
+    if [ "$BOARD" == "arduino:samd:mkrgsm1400" ]; then
+      buildExampleSketch GSM_Cloud_Blink;
+    fi
+  - |
+    if [ "$BOARD" == "esp8266:esp8266:huzzah" ]; then
+      buildExampleSketch ArduinoIoTCloud_ESP8266;
     fi
-  - buildExampleUtilitySketch Provisioning
 notifications:
   webhooks:
     urls:

README.md

@@ -25,35 +25,12 @@ The introductory tutorial linked above explains this in an easy and comprehensiv
 
 ## ArduinoIoTCloud library
 
-The library is made of multiple classes:
+As of version 0.8.0 the `ConnectionManager` libraries have been migrated into their own packages, so are the debug helpers, hence the library is made of just these classes:
 - `ArduinoIoTCloud` is the main class. It's responsible for the connection to the MQTT Broker and to Arduino IoT Cloud.
 This library has multiple `begin(...)` methods allowing you to take more control of its behavior when it comes to network **Client** or to use a `ConnectionManager`
 
-- `ConnectionManager` is an abstract Class defining methods to be implemented in derived classes, such as `WiFiConnectionManager`, `GSMConnectionManager` and so on. The right `ConnectionManager` is chosen on a board basis during compilation.
-
-- `WiFiConnectionManager` handles connection, network time retrieval, disconnection, and reconnection to Internet for WiFi equipped boards (**MKR1000**, **MKR WIFI 1010** and upcoming implementations).
-
-- `GSMConnectionManager` handles connection, network time retrieval, disconnection, and reconnection to Internet for GSM equipped boards (**MKR GSM 1400**)
-
-
 - `CloudSerial` is similar to [Serial](https://www.arduino.cc/reference/en/language/functions/communication/serial/), but used in combination with the cloud, allowing the user to send and receive custom messages using Arduino IoT Cloud as a channel.
 
-
-### ConnectionManager
-
-**Connection Manager** is configured via a series of compiler directives, including the correct implementation of the class based on which board is selected.
-
-### How to use it
-- Instantiate the class with `ConnectionManager *ArduinoIoTPreferredConnection = new WiFiConnectionManager(SECRET_SSID, SECRET_PASS);` if you are using a WiFi board, otherwise replace **WiFi** with **GSM** or any future implementation.
-
-- The `check()` method does all the work. It uses a finite state machine and is responsible for connection and reconnection to a network. The method is designed to be non-blocking by using time (milliseconds) to perform its tasks.
-
-- `getTime()` returns different implementations of the `getTIme()` method based on the board used. Time is retrieved from an NTP server and is required for the SSL connection to the cloud.
-
-- `&getClient()` returns a reference an instance of the `Client` class used to connect to the network.
-
-- `getStatus()` returns the network connection status. The different states are defined in an `enum`
-
 - `debugMessage(char *_msg, uint8_t _debugLevel, bool _timestamp = true, bool _newline = true)` is the method used to print debug messages on the physical serial. This helps providing troubleshooting information should anything go wrong.
 
 - The `setDebugMessageLevel(int _debugLevel)` method is used to set a level of granularity in information output. Every debug message comes with a level which goes from 0 to 4. A higher level means more verbosity. Debug messages with level higher than `_debugLevel` will not be shown. The lowest level has a higher importance and is usually used for errors, which are always printed. Passing -1 as a parameter will disable logging entirely, **errors will also be ignored**.
@@ -68,7 +45,7 @@ This library has multiple `begin(...)` methods allowing you to take more control
 
 - `disconnect()` closes the connection to the MQTT Client.
 
-- The `update()` method can be called periodically in the loop of the `.ino` file. If a `ConnectionManager` is implemented it checks network connections. It also makes sure that a connection with the MQTT broker is active and tries to reconnect otherwise. During `update()` data from the Cloud is retrieved and changed values are posted to the proper MQTT topic.
+- The `update()` method can be called periodically in the loop of the `.ino` file. If a `ConnectionHandler` is implemented it checks network connections. It also makes sure that a connection with the MQTT broker is active and tries to reconnect otherwise. During `update()` data from the Cloud is retrieved and changed values are posted to the proper MQTT topic.
 
 - `connected()` simply returns the current status of the MQTT connection.
 
@@ -78,4 +55,7 @@ This library has multiple `begin(...)` methods allowing you to take more control
 
 - `getThingId()` returns the **THING_ID**.
 
-- `connectionCheck()` invokes the `check()` method from a **ConnectionManager** if it is implemented. Mainly it implements a state machine and is responsible for the connection to Arduino IoT Cloud.
+- `connectionCheck()` invokes the `check()` method from a **ConnectionHandler** if it is implemented. Mainly it implements a state machine and is responsible for the connection to Arduino IoT Cloud.
+
+- `getIoTStatus()` returns the Cloud connection status. The different states are defined in an `enum`
+

examples/ArduinoIoTCloud_ESP8266/ArduinoIoTCloud_ESP8266.ino

@@ -0,0 +1,35 @@
+/*
+   Minimal demo example how to connect with the
+   Arduino IoT Cloud and a ESP8266 based WiFi board.
+*/
+
+#include "arduino_secrets.h"
+#include "thingProperties.h"
+
+void setup() {
+
+  pinMode(LED_BUILTIN, OUTPUT);
+
+  Serial.begin(9600);
+
+  /* Wait up to 5 seconds for user to open serial port */
+  unsigned long serialBeginTime = millis();
+  while (!Serial && (millis() - serialBeginTime > 5000));
+
+  initProperties();
+
+  setDebugMessageLevel(DBG_INFO);
+
+  ArduinoCloud.begin(ArduinoIoTPreferredConnection);
+}
+
+void loop() {
+  ArduinoCloud.update();
+}
+
+
+void onLedChange() {
+  Serial.print("LED set to ");
+  Serial.println(led);
+  digitalWrite(LED_BUILTIN, !led);
+}

examples/ArduinoIoTCloud_ESP8266/arduino_secrets.h

@@ -0,0 +1,5 @@
+#include <Arduino_ConnectionHandler.h>
+
+#define SECRET_SSID "my-wifi-ssid"
+#define SECRET_PASS "my-wifi-password"
+#define SECRET_DEVICE_KEY "my-device-password"

examples/ArduinoIoTCloud_ESP8266/thingProperties.h

@@ -0,0 +1,18 @@
+#include <ArduinoIoTCloud.h>
+#include <Arduino_ConnectionHandler.h>
+
+#define THING_ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" /* "Thing ID" when selecting thing within Arduino Create */
+#define BOARD_ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+
+void onLedChange();
+
+bool led;
+
+void initProperties() {
+  ArduinoCloud.setThingId(THING_ID);
+  ArduinoCloud.setBoardId(BOARD_ID);
+  ArduinoCloud.setSecretDeviceKey(SECRET_DEVICE_KEY);
+  ArduinoCloud.addProperty(led, READWRITE, ON_CHANGE, onLedChange);
+}
+
+WiFiConnectionHandler ArduinoIoTPreferredConnection(SECRET_SSID, SECRET_PASS);

examples/ArduinoIoTCloud_LED_switch/arduino_secrets.h

@@ -1,4 +1,4 @@
-#include <ConnectionManager.h>
+#include <Arduino_ConnectionHandler.h>
 
 /* MKR1000, MKR WiFi 1010 */
 #if defined(BOARD_HAS_WIFI)

examples/ArduinoIoTCloud_LED_switch/thingProperties.h

@@ -1,10 +1,8 @@
 #include <ArduinoIoTCloud.h>
-#include <ConnectionManager.h>
+#include <Arduino_ConnectionHandler.h>
 
 #if defined(BOARD_HAS_WIFI)
-  #include <WiFiConnectionManager.h>
 #elif defined(BOARD_HAS_GSM)
-  #include <GSMConnectionManager.h>
 #else
   #error "Arduino IoT Cloud currently only supports MKR1000, MKR WiFi 1010 and MKR GSM 1400"
 #endif
@@ -25,9 +23,7 @@ void initProperties() {
 }
 
 #if defined(BOARD_HAS_WIFI)
-  ConnectionManager * ArduinoIoTPreferredConnection = new WiFiConnectionManager(SECRET_SSID, SECRET_PASS);
+  WiFiConnectionHandler ArduinoIoTPreferredConnection(SECRET_SSID, SECRET_PASS);
 #elif defined(BOARD_HAS_GSM)
-  ConnectionManager * ArduinoIoTPreferredConnection = new GSMConnectionManager(SECRET_PIN, SECRET_APN, SECRET_LOGIN, SECRET_PASS);
+  GSMConnectionHandler ArduinoIoTPreferredConnection(SECRET_PIN, SECRET_APN, SECRET_LOGIN, SECRET_PASS);
 #endif
-
-

examples/ArduinoIoTCloud_Travis_CI/arduino_secrets.h

@@ -1,4 +1,4 @@
-#include <ConnectionManager.h>
+#include <Arduino_ConnectionHandler.h>
 
 /* MKR1000, MKR WiFi 1010 */
 #if defined(BOARD_HAS_WIFI)

examples/ArduinoIoTCloud_Travis_CI/thingProperties.h

@@ -3,12 +3,10 @@
  ******************************************************************************/
 
 #include <ArduinoIoTCloud.h>
-#include <ConnectionManager.h>
+#include <Arduino_ConnectionHandler.h>
 
 #if defined(BOARD_HAS_WIFI)
-  #include <WiFiConnectionManager.h>
 #elif defined(BOARD_HAS_GSM)
-  #include <GSMConnectionManager.h>
 #else
   #error "Arduino IoT Cloud currently only supports MKR1000, MKR WiFi 1010 and MKR GSM 1400"
 #endif
@@ -54,10 +52,11 @@ String str_property_6;
 String str_property_7;
 String str_property_8;
 
+
 #if defined(BOARD_HAS_WIFI)
-  ConnectionManager * ArduinoIoTPreferredConnection = new WiFiConnectionManager(SECRET_SSID, SECRET_PASS);
+  WiFiConnectionHandler ArduinoIoTPreferredConnection(SECRET_SSID, SECRET_PASS);
 #elif defined(BOARD_HAS_GSM)
-  ConnectionManager * ArduinoIoTPreferredConnection = new GSMConnectionManager(SECRET_PIN, SECRET_APN, SECRET_LOGIN, SECRET_PASS);
+  GSMConnectionHandler ArduinoIoTPreferredConnection(SECRET_PIN, SECRET_APN, SECRET_LOGIN, SECRET_PASS);
 #endif
 
 /******************************************************************************

examples/GSM_Cloud_Blink/GSM_Cloud_Blink.ino

@@ -7,14 +7,13 @@
 */
 
 #include <ArduinoIoTCloud.h>
-#include <ConnectionManager.h>
-#include <GSMConnectionManager.h>
+#include <Arduino_ConnectionHandler.h>
 
 #include "arduino_secrets.h"
 
 String cloudSerialBuffer = ""; // the string used to compose network messages from the received characters
 // handles connection to the network
-ConnectionManager * ArduinoIoTPreferredConnection = new GSMConnectionManager(SECRET_PIN, SECRET_APN, SECRET_USER_NAME, SECRET_PASSWORD);
+GSMConnectionHandler ArduinoIoTPreferredConnection(SECRET_PIN, SECRET_APN, SECRET_USER_NAME, SECRET_PASSWORD);
 
 void setup() {
   setDebugMessageLevel(3); // used to set a level of granularity in information output [0...4]
@@ -74,4 +73,4 @@ void sendString(String stringToSend) {
   if (lastSentChar != '\n') {
     CloudSerial.write('\n');
   }
-}
+}

examples/MultiValue_example/thingProperties.h

@@ -1,5 +1,5 @@
 #include <ArduinoIoTCloud.h>
-#include <WiFiConnectionManager.h>
+#include <Arduino_ConnectionHandler.h>
 
 // Set the Thing Id value
 const char THING_ID[] = "";
@@ -21,4 +21,4 @@ void initProperties() {
   ArduinoCloud.addProperty(color, READWRITE, ON_CHANGE, onColorChange);
 }
 
-ConnectionManager *ArduinoIoTPreferredConnection = new WiFiConnectionManager(SSID, PASS);
+WiFiConnectionHandler ArduinoIoTPreferredConnection(SSID, PASS);

examples/WiFi_Cloud_Blink/WiFi_Cloud_Blink.ino

@@ -8,14 +8,13 @@
 */
 
 #include <ArduinoIoTCloud.h>
-#include <ConnectionManager.h>
-#include <WiFiConnectionManager.h>
+#include <Arduino_ConnectionHandler.h>
 
 #include "arduino_secrets.h"
 
 String cloudSerialBuffer = ""; // the string used to compose network messages from the received characters
 // handles connection to the network
-ConnectionManager * ArduinoIoTPreferredConnection = new WiFiConnectionManager(SECRET_SSID, SECRET_PASS);
+WiFiConnectionHandler ArduinoIoTPreferredConnection(SECRET_WIFI_NAME, SECRET_PASSWORD);
 
 void setup() {
   setDebugMessageLevel(3); // used to set a level of granularity in information output [0...4]