Initial commit of Arduino library.

Author: jimblom

.gitattributes

@@ -0,0 +1,17 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

.gitignore

@@ -0,0 +1,60 @@
+# IDE settings directories/folders
+.vscode/
+
+# Windows image file caches
+Thumbs.db
+ehthumbs.db
+
+# Folder config file
+Desktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# C build files
+_build
+*.elf
+*.hex
+*.exe
+
+# Arduino CLI config file
+*.yml
+Makefile
+
+# =========================
+# Operating System Files
+# =========================
+
+# OSX
+# =========================
+
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+### Subject of the issue
+Describe your issue here.
+
+### Your workbench
+* What platform are you using?
+* What version of the device are you using? Is there a firmware version?
+* How is the device wired to your platform?
+* How is everything being powered?
+* Are there any additional details that may help us help you?
+
+### Steps to reproduce
+Tell us how to reproduce this issue. Please post stripped down example code demonstrating your issue to a gist.
+
+### Expected behaviour
+Tell us what should happen
+
+### Actual behaviour
+Tell us what happens instead

LICENSE.md

@@ -0,0 +1,55 @@
+SparkFun License Information
+============================
+
+SparkFun uses two different licenses for our files — one for hardware and one for code.
+
+Hardware
+---------
+
+**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
+
+Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
+
+You are free to:
+
+Share — copy and redistribute the material in any medium or format
+Adapt — remix, transform, and build upon the material
+for any purpose, even commercially.
+The licensor cannot revoke these freedoms as long as you follow the license terms.
+Under the following terms:
+
+Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
+No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
+Notices:
+
+You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
+No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
+
+
+Code
+--------
+
+**SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).**
+
+The MIT License (MIT)
+
+Copyright (c) 2016 SparkFun Electronics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,30 @@
+SparkFun LTE Shield Arduino Library
+==============================
+
+[DESCRIPTION]
+
+Repository Contents
+-------------------
+
+* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE. 
+* **/src** - Source files for the library (.cpp, .h).
+* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE. 
+* **library.properties** - General library properties for the Arduino package manager. 
+
+Documentation
+-------------
+
+Coming soon!
+
+License Information
+-------------------
+
+This product is _**open source**_! 
+
+Various bits of the code have different licenses applied. Anything SparkFun wrote is beerware; if you see me (or any other SparkFun employee) at the local, and you've found our code helpful, please buy us a round!
+
+Please use, reuse, and modify these files as you see fit. Please maintain attribution to SparkFun Electronics and release anything derivative under the same license.
+
+Distributed as-is; no warranty is given.
+
+- Your friends at SparkFun.

examples/00_Network_Connect/00_Network_Connect.ino

@@ -0,0 +1,67 @@
+#include <SparkFun_LTE_Shield_Arduino_Library.h>
+
+SoftwareSerial lteSerial(8, 9);
+LTE_Shield lte;
+
+// Map registration status messages to more readable strings
+String registrationString[] = {
+    "Not registered",                         // 0
+    "Registered, home",                       // 1
+    "Searching for operator",                 // 2
+    "Registration denied",                    // 3
+    "Registration unknown",                   // 4
+    "Registrered, roaming",                   // 5
+    "Registered, home (SMS only)",            // 6
+    "Registered, roaming (SMS only)",         // 7
+    "Registered, home, CSFB not preferred",   // 8
+    "Registered, roaming, CSFB not prefered"  // 9
+};
+
+void setup() {
+    Serial.begin(9600);
+
+    Serial.println(F("Initializing the LTE Shield..."));
+    Serial.println(F("...this may take ~25 seconds if the shield is off."));
+    Serial.println(F("...it may take ~5 seconds if it just turned on."));
+
+  if ( lte.begin(lteSerial, 9600) ) {
+    Serial.println(F("LTE Shield connected!"));
+  }
+  Serial.println();
+
+  Serial.println("Getting device/SIM info:");
+  // Print device information:
+  // IMEI: International Mobile Equipment Identity -- Unique number to identify phone
+  Serial.println("IMEI: " + lte.imei());
+  // IMSI: International Mobile Subscriber Identity -- Unique number to identify
+  // user of a cellular network.
+  Serial.println("IMSI: " + lte.imsi());
+  // ICCID: Integrated circuit card identifier -- Unique SIM card serial number.
+  Serial.println("ICCID: " + lte.ccid());
+    Serial.println();
+
+    // Network operator can be set to either:
+    // MNO_ATT -- AT&T 
+    // MNO_VERIZON -- Verizon
+    // MNO_TELSTRA -- Telstra
+    // MNO_TMO -- T-Mobile
+  if (!lte.setNetwork(MNO_VERIZON)) {
+      Serial.println(F("Error setting network. Try cycling power on your Arduino/shield."));
+      while (1) ;
+  }
+
+  Serial.println("Network set. Ready to go!");
+  // RSSI: Received signal strength:
+  Serial.println("RSSI: " + String(lte.rssi()));
+  // Registration Status
+  int regStatus = lte.registration();
+  if ((regStatus >= 0) && (regStatus <= 9)) {
+    Serial.println("Network registration: " + registrationString[regStatus]);
+  }
+  if (regStatus > 0) {
+      Serial.println("All set. Go to the next example!");
+  }
+}
+
+void loop() {
+}

examples/01_SMS_Send/01_SMS_Send.ino

@@ -0,0 +1,30 @@
+#include <SparkFun_LTE_Shield_Arduino_Library.h>
+
+SoftwareSerial lteSerial(8, 9);
+LTE_Shield lte;
+
+String destinationNumber = "11234567890";
+
+void setup() {
+  Serial.begin(9600);
+
+  if ( lte.begin(lteSerial, 9600) ) {
+    Serial.println(F("LTE Shield connected!"));
+  }
+  Serial.println(F("Type a message. Send a Newline (\\n) to send it..."));
+}
+
+void loop() {
+    static String message = "";
+  if (Serial.available())
+  {
+    char c = Serial.read();
+    if (c == '\n') {
+        Serial.println("Sending: " + String(message));
+        lte.sendSMS(destinationNumber, message);
+        message = "";
+    } else {
+        message += c;
+    }
+  }
+}

examples/02_TCP_Send_Hologram/02_TCP_Send_Hologram.ino

@@ -0,0 +1,46 @@
+#include <SparkFun_LTE_Shield_Arduino_Library.h>
+
+SoftwareSerial lteSerial(8, 9);
+LTE_Shield lte;
+
+String hologramDeviceKey = "LC2tG5cf";
+
+const char HOLOGRAM_URL[] = "cloudsocket.hologram.io";
+const unsigned int HOLOGRAM_PORT = 9999;
+const unsigned int HOLOGRAM_LISTEN_PORT = 4010;
+
+void setup() {
+    Serial.begin(9600);
+
+  if ( lte.begin(lteSerial, 9600) ) {
+    Serial.println(F("LTE Shield connected!"));
+  }
+
+  Serial.println(F("Type a message. Send a Newline (\\n) to send it..."));
+}
+
+void loop() {
+    lte.poll();
+}
+
+void sendHologramMessage(String message)
+{
+  int socket = -1;
+  String hologramMessage;
+
+    hologramMessage = "{\"k\":\"" + hologramDeviceKey + "\",\"d\":\"" +
+        message + "\"}";
+
+  socket = lte.socketOpen(LTE_SHIELD_TCP);
+  if (socket >= 0) {
+      Serial.println("Connecting to socket: " + String(socket));
+    if (lte.socketConnect(socket, HOLOGRAM_URL, HOLOGRAM_PORT) == LTE_SHIELD_ERROR_SUCCESS) {
+        Serial.println("Connected to Hologram.io");
+      Serial.println("Sending: " + String(hologramMessage));
+      if (lte.socketWrite(socket, hologramMessage) == LTE_SHIELD_ERROR_SUCCESS)
+      {
+          lte.socketClose(socket);
+      }
+    }
+  }
+}