First release

ChangeLog.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 1.0.0 (April 13, 2018)
+
+**First delivery**

LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -0,0 +1,59 @@
+# LiveBooster-Heracles-Arduino Library
+
+Please refers to the [Changelog](ChangeLog.md) to check the latest change and improvement.
+
+---
+
+LiveBooster-Heracles-Arduino is an [Arduino](https://www.arduino.cc/) library for [Heracles modem](https://www.avnet.com/wps/portal/ebv/solutions/ebvchips/heracles/), based on the [TinyGSM](https://github.com/vshymanskyy/TinyGSM) library.
+
+## Arduino Client interface support
+
+This library provides an Arduino standard [Client interface](https://www.arduino.cc/en/Reference/ClientConstructor), so that it is easy to integrate with lots of usages based on [TCP](https://fr.wikipedia.org/wiki/Transmission_Control_Protocol) (MQTT, HTTP, ...).
+
+As an example, this library can be used with the [IoTSoftBox library](https://github.com/Orange-OpenSource/LiveObjects-iotSoftbox-mqtt-arduino) to connect devices to [Live Objects](https://liveobjects.orange-business.com) server.
+
+## Supported boards
+
+Tested with:
+ * [Arduino MEGA ADK](https://store.arduino.cc/arduino-mega-adk-rev3)
+ * [Mediatek LinkIt ONE](https://labs.mediatek.com/en/platform/linkit-one)
+ * ... should work on other Arduino boards.
+
+## Supported modem
+
+This library targets the [EBV Heracles modem](https://www.avnet.com/wps/portal/ebv/solutions/ebvchips/heracles/).
+
+## Getting Started
+
+The Heracles modem shall be connected to the Arduino board with serial interface (Ground, Tx, Rx).
+
+Once the library has been [imported into your Arduino IDE](https://www.arduino.cc/en/Guide/Libraries#toc4), two example sketchs are accessible by menu File -> Examples -> LiveBooster-Heracles-Arduino :
+
+### "Soft Serial Test" example sketch
+
+This sketch doesn't really use the LiveBooster-Heracles-Arduino library. It should be used to check correct communication between the Arduino board and the Heracles modem: all AT commands sent on Arduino Serial Monitor are transmitted to modem, and answers from modem are transmitted to Arduino Serial Monitor.
+
+You may need to change the Serial port used on your board for modem interface.
+
+Here are some basic AT commands and expected modem answers you can use:
+
+   ```c
+   AT
+   OK
+   AT+CPIN?
+   +CPIN: READY
+   AT+COPS?
+   +COPS: 0,0,"Orange F"
+   ```
+
+If not working, check:
+ * That your modem is correctly powered. Try to reset it.
+ * Hardware connection between the modem and your board (Ground, Rx, Tx).
+ * Serial UART and baud rates used in example sketch and in Arduino Serial monitor.
+
+### "Heracles Sample Basic" example sketch
+
+This sketch connects to website arduino.cc to get file [asciilogo.txt](http://www.arduino.cc/asciilogo.txt), using the Heracles modem.
+
+## License
+This project is released under The GNU Lesser General Public License (LGPL-3.0).

examples/heracles_sample_basic/heracles_sample_basic.ino

@@ -0,0 +1,102 @@
+/*
+ * === Heracles Sample Basic ===
+ *
+ * This sketch connects to website arduino.cc to get file http://www.arduino.cc/asciilogo.txt,
+ * using the Heracles modem. The modem is connected to the Arduino board with serial interface.
+ *
+ * You may need to change the Serial port used on your board for modem interface.
+ *
+ */
+
+#include <HeraclesGsmModem.h>
+
+/*
+ * Use Serial1 UART for modem interface:
+ *    o Pins D0 (RX), D1 (TX) on LinkIt One board.
+ *    o Pins 18 (TX1), 19 (RX1) on Arduino MEGA ADK.
+ * By default, DNS is enabled.
+ */
+HeraclesGsmModem modem(Serial1);
+
+/*
+ * Selected mux is 1, and SSL is enabled (this sketch connects to HTTPS server).
+ */
+HeraclesGsmModem::GsmClient gsmClient(modem, 1, true);
+
+
+void setup() {
+
+    /* Initialize serial debug and wait for port to open */
+    Serial.begin(115200);
+    while (!Serial) {
+      delay(100);
+    }
+
+    /* Initializing serial port for modem interface */
+    Serial1.begin(115200);
+
+    /* Initializing Heracles modem */
+    Serial.print("Initializing Heracles modem... ");
+    modem.restart();
+
+    /* Check for modem firmware version (optional) */
+    String modemInfo = modem.getModemInfo();
+    if (modemInfo == "") {
+        Serial.println("FAIL");
+        while (true);
+    }
+    Serial.print("OK: ");
+    Serial.println(modemInfo);
+
+    /* Wait for network */
+    Serial.print("Waiting for network... ");
+    if (!modem.waitForNetwork()) {
+        Serial.println("FAIL");
+        while (true);
+    }
+    Serial.println("OK");
+
+    /* attachGPRS() used without any parameters for internal SIM.
+     * For external SIM, use attachGPRS("your apn", "user", "pswd") */
+    Serial.print("Connecting to APN... ");
+    if (!modem.attachGPRS()) {
+        Serial.println("FAIL");
+        while (true);
+    }
+    Serial.println("OK");
+
+    /* Connecting to arduino.cc and get file. Port 443 is the default
+     * port number for HTTPS servers. */
+    Serial.print("Connecting to arduino.cc... ");
+    if (gsmClient.connect("www.arduino.cc", 443)) {
+      Serial.println("OK");
+      gsmClient.println("GET /asciilogo.txt HTTP/1.1");
+      gsmClient.println("Host: www.arduino.cc");
+      gsmClient.println();
+    } else {
+      Serial.println("FAIL");
+    }
+
+}
+
+void loop() {
+
+    /* Wait for answer from server */
+    while (!gsmClient.available() && gsmClient.connected());
+
+    /* Get received answer */
+    while (gsmClient.available()) {
+      char c = gsmClient.read();
+      Serial.print(c);
+    }
+
+    /* Disconnecting */
+    Serial.println();
+    Serial.print("Disconnecting... ");
+
+    gsmClient.stop();
+    modem.radioOff();
+
+    Serial.println("FINISHED");
+    while (true);
+}

examples/soft_serial_test/soft_serial_test.ino

@@ -0,0 +1,43 @@
+/*
+ * === Soft Serial Test ===
+ *
+ * This sketch doesn't really use the LiveBooster-Heracles-Arduino library. It should be
+ * used to check correct communication between the Arduino board and the Heracles modem:
+ * all AT commands sent on Arduino Serial Monitor are transmitted to modem, and answers
+ * from modem are transmitted to Arduino Serial Monitor.
+ *
+ * You may need to change the Serial port used on your board for modem interface.
+ *
+ */
+
+/*
+ * Use Serial1 UART for modem interface:
+ *    o Pins D0 (RX), D1 (TX) on LinkIt One board.
+ *    o Pins 18 (TX1), 19 (RX1) on Arduino MEGA ADK.
+ */
+#define HeraclesSerial Serial1
+
+void setup() {
+
+  /* Open serial communication and wait for port to open */
+  Serial.begin(115200);
+  while (!Serial) {
+    ; // wait for serial port to connect. Needed for native USB port only
+  }
+
+  Serial.println("TEST AT COMMANDS WITH HERACLES MODEM !");
+
+  /* Set the data rate for the HeraclesSerial port */
+  HeraclesSerial.begin(115200);
+  HeraclesSerial.println("AT\r\n");
+}
+
+void loop() {
+
+  if (HeraclesSerial.available()) {
+    Serial.write(HeraclesSerial.read());
+  }
+  if (Serial.available()) {
+      HeraclesSerial.write(Serial.read());
+  }
+}

library.json

@@ -0,0 +1,17 @@
+{
+"name": "LiveBooster-Heracles-Arduino",
+"frameworks": "Arduino",
+"description": "GSM client library for the Heracles modem",
+"url": "https://github.com/Orange-OpenSource/LiveBooster-Heracles-Arduino",
+"authors":
+[
+{
+        "name": "Orange Applications for Business"
+}
+],
+"repository":
+{
+    "type": "git",
+    "url": "https://github.com/Orange-OpenSource/LiveBooster-Heracles-Arduino"
+}
+}