Example cleanup, add serial passthrough.

Author: jimblom

examples/00_Network_Connect/00_Network_Connect.ino

@@ -48,6 +48,13 @@ String registrationString[] = {
   "Registered, roaming, CSFB not prefered"  // 9
 };
 
+// Network operator can be set to either:
+// MNO_ATT -- AT&T 
+// MNO_VERIZON -- Verizon
+// MNO_TELSTRA -- Telstra
+// MNO_TMO -- T-Mobile
+const mobile_network_operator_t MOBILE_NETWORK_OPERATOR = MNO_VERIZON;
+
 void setup() {
   Serial.begin(9600);
 
@@ -79,12 +86,7 @@ void setup() {
   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)) {
+  if (!lte.setNetwork(MOBILE_NETWORK_OPERATOR)) {
     Serial.println(F("Error setting network. Try cycling power on your Arduino/shield."));
     while (1) ;
   }

examples/01_SMS_Send/01_SMS_Send.ino

@@ -54,7 +54,8 @@ void loop() {
     // Read a message until a \n (newline) is received
     if (c == '\n') {
       // Once we receive a newline. send the text.
-      Serial.println("Sending: " + String(message));
+      Serial.println("Sending: \"" + String(message) + "\" to " + 
+        DESTINATION_NUMBER);
       // Call lte.sendSMS(String number, String message) to send an SMS
       // message.
       lte.sendSMS(DESTINATION_NUMBER, message);

examples/02_TCP_Send_Hologram/02_TCP_Send_Hologram.ino

@@ -1,5 +1,5 @@
 /*
-  Send an SMS with the SparkFun LTE Cat M1/NB-IoT Shield
+  Send a TCP message to Hologram
   By: Jim Lindblom
   SparkFun Electronics
   Date: October 23, 2018
@@ -8,7 +8,7 @@
   Feel like supporting our work? Buy a board from SparkFun!
   https://www.sparkfun.com/products/14997
 
-  This example demonstrates how to send an SMS message with the LTE Shield.
+  This example demonstrates how to send TCP messages to a Hologram server
 
   Before beginning, you should have your shield connected on a MNO.
   See example 00 for help with that.
@@ -35,12 +35,11 @@ SoftwareSerial lteSerial(8, 9);
 LTE_Shield lte;
 
 // Plug in your Hologram device key here:
-String HOLOGRAM_DEVICE_KEY = "LC2tG5cf";
+String HOLOGRAM_DEVICE_KEY = "Ab12CdE4";
 
 // These values should remain the same:
 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);

examples/03_TCP_Receive_Hologram/03_TCP_Receive_Hologram.ino

@@ -1,5 +1,5 @@
 /*
-  Send an SMS with the SparkFun LTE Cat M1/NB-IoT Shield
+  Receive a TCP message from Hologram server
   By: Jim Lindblom
   SparkFun Electronics
   Date: October 23, 2018
@@ -8,15 +8,16 @@
   Feel like supporting our work? Buy a board from SparkFun!
   https://www.sparkfun.com/products/14997
 
-  This example demonstrates how to send an SMS message with the LTE Shield.
+  This example demonstrates how to to sset your shield/Arduino up as a 
+  TCP server and receive a message from a Hologram server.
 
   Before beginning, you should have your shield connected on a MNO.
   See example 00 for help with that.
 
   Once programmed, open the serial monitor, set the baud rate to 9600.
   Use the Hologram dashboard to send a message (via Cloud data) to your device.
   You should see the message relayed to your serial monitor.
-  Make sure the port your sending to matches HOLOGRAM_LISTEN_PORT.
+  Make sure the port you're sending to matches HOLOGRAM_LISTEN_PORT.
   
   Hardware Connections:
   Attach the SparkFun LTE Cat M1/NB-IoT Shield to your Arduino

examples/05_Hologram_Data_Feed/05_Hologram_Data_Feed.ino

@@ -1,80 +1,126 @@
-
-
+/*
+  Receive a message from Hologram, then send data on command
+  By: Jim Lindblom
+  SparkFun Electronics
+  Date: October 23, 2018
+  License: This code is public domain but you buy me a beer if you use this 
+  and we meet someday (Beerware license).
+  Feel like supporting our work? Buy a board from SparkFun!
+  https://www.sparkfun.com/products/14997
+
+  This example combines a bit of example 2 (TCP Send to Hologram) and
+  example 3 (TCP receive from Hologram). On a specific message receipt from
+  Hologram (read_analog), this sketch will send a JSON-encoded list of
+  all six analog measurements.
+
+  After uploading the code, open your Hologram dashboard, select  your
+  device and send a message matching "read_analog" to the device. 
+  
+  Shortly after this the sketch should respond with a JSON-encoded list 
+  of all six analog measurements. This JSON string can be used for Hologram 
+  routes to send emails, text  messages, or more. (See the LTE Shield hookup 
+  guide for more information.)
+
+  Hardware Connections:
+  Attach the SparkFun LTE Cat M1/NB-IoT Shield to your Arduino
+  Power the shield with your Arduino -- ensure the PWR_SEL switch is in
+    the "ARDUINO" position.
+*/
+
+//Click here to get the library: http://librarymanager/All#SparkFun_LTE_Shield_Arduino_Library
 #include <SparkFun_LTE_Shield_Arduino_Library.h>
 
+// Create a SoftwareSerial object to pass to the LTE_Shield library
 SoftwareSerial lteSerial(8, 9);
+// Create a LTE_Shield object to use throughout the sketch
 LTE_Shield lte;
 
-#define SEND_INTERVAL 60000
-
-String HOLOGRAM_DEVICE_KEY = "LC2tG5cf";
+// Hologram device key. Used to send messages:
+String HOLOGRAM_DEVICE_KEY = "Ab12CdE4";
+// Hologram message topic(s):
 String HOLOGRAM_ANALOG_TOPIC = "ANALOG";
 
+// Hologram Server constants. Shouldn't have to change:
 const char HOLOGRAM_URL[] = "cloudsocket.hologram.io";
 const unsigned int HOLOGRAM_PORT = 9999;
 const unsigned int HOLOGRAM_LISTEN_PORT = 4010;
 
+// Pair analog pins up with a JSON identifier string
 #define ANALOG_PINS_TO_READ 6
 int readPins[ANALOG_PINS_TO_READ] = {A0, A1, A2, A3, A4, A5};
 String pinNames[ANALOG_PINS_TO_READ] = {"A0", "A1", "A2", "A3", "A4", "A5"};
 
-boolean doSendAnalog = false;
-boolean doServerListen = true;
-int listenSocket = -1;
+// loop flags to check:
+boolean doSendAnalog = false; // Send analog values
+boolean doServerListen = true; // Open listening server
+int listenSocket = -1; // Listen socket -1 is incactive, 0-5 for active socket
 
+// Callback to process a data read from a socket
 void processSocketRead(int socket, String response) {
-    if (response == "read_analog") {
-        doSendAnalog = true;
-    } else {
-        Serial.println("Server read: " + String(response));
-    }
+  // Look for the specified string
+  if (response == "read_analog") {
+    doSendAnalog = true; // If found set a flag to send analog values
+  } else {
+    Serial.println("Server read: " + String(response));
+  }
 }
 
+// Callback to process a closed socket
 void processSocketClose(int socket) {
-    Serial.println("Socket " + String(socket) + " closed");
-    if (socket == listenSocket) {
-        doServerListen = true;
-    }
+  Serial.println("Socket " + String(socket) + " closed");
+  // If the socket was our listening socket, trigger flag to re-open
+  if (socket == listenSocket) {
+    doServerListen = true;
+  }
 }
 
 void setup() {
-    Serial.begin(9600);
+  Serial.begin(9600);
 
-    for (int i=0; i<ANALOG_PINS_TO_READ; i++) {
-        pinMode(readPins[i], INPUT);
-    }
+  for (int i=0; i<ANALOG_PINS_TO_READ; i++) {
+    pinMode(readPins[i], INPUT);
+  }
 
-    if (!lte.begin(lteSerial)) {
-        Serial.println("Could not initialize LTE Shield");
-        while (1) ;
-    }
+  if (!lte.begin(lteSerial)) {
+    Serial.println("Could not initialize LTE Shield");
+    while (1) ;
+  }
 
+  // Configure callbacks for data read and socket close
   lte.setSocketReadCallback(&processSocketRead);
   lte.setSocketCloseCallback(&processSocketClose);
 }
 
 void loop() {
-    lte.poll();
-
-    if (doSendAnalog) {
-        Serial.println("Sending analog values");
-        sendAnalogValues();
-        doSendAnalog = false;
-    }
+  // Poll as often as possible. Try to keep other functions
+  // in loop as short as possible.
+  lte.poll();
+
+  // If sendAnalog flag is set, do it and clear flag
+  if (doSendAnalog) {
+    Serial.println("Sending analog values");
+    sendAnalogValues();
+    doSendAnalog = false;
+  }
 
-    if (doServerListen) {
-        listenHologramMessage();
-        doServerListen = false;
-    }
+  // If serverlisten flag is set, set up listening server
+  // then clear flag
+  if (doServerListen) {
+    listenHologramMessage();
+    doServerListen = false;
+  }
 }
 
 void listenHologramMessage()
 {
   int sock = -1;
   LTE_Shield_error_t err;
 
+  // Open a new available socket
   sock = lte.socketOpen(LTE_SHIELD_TCP);
+  // If a socket is available it should return a value between 0-5
   if (sock >= 0) {
+    // Listen on the socket on the defined port
     err = lte.socketListen(sock, HOLOGRAM_LISTEN_PORT);
     if (err == LTE_SHIELD_ERROR_SUCCESS) {
       Serial.print(F("Listening socket open: "));
@@ -89,15 +135,16 @@ void listenHologramMessage()
   }
 }
 
+// Compile analog reads into a JSON-encoded string, then send to Hologram
 void sendAnalogValues(void) {
-    String toSend = "{";
-    for (int i = 0; i < ANALOG_PINS_TO_READ; i++) {
-        toSend += "\\\"" + pinNames[i] + "\\\": ";
-        toSend += String(analogRead(readPins[i]));
-        if (i < 5) toSend += ", ";
-    }
-    toSend += "}";
-    sendHologramMessage(toSend);
+  String toSend = "{";
+  for (int i = 0; i < ANALOG_PINS_TO_READ; i++) {
+    toSend += "\\\"" + pinNames[i] + "\\\": ";
+    toSend += String(analogRead(readPins[i]));
+    if (i < 5) toSend += ", ";
+  }
+  toSend += "}";
+  sendHologramMessage(toSend);
 }
 
 void sendHologramMessage(String message) {

examples/Serial_Passthrough/Serial_Passthrough.ino

@@ -0,0 +1,49 @@
+/*
+  Send AT commands to the SARA-R4 via the Serial Port
+  By: Jim Lindblom
+  SparkFun Electronics
+  Date: October 26, 2018
+  License: This code is public domain but you buy me a beer if you use this 
+  and we meet someday (Beerware license).
+  Feel like supporting our work? Buy a board from SparkFun!
+  https://www.sparkfun.com/products/14997
+
+  This example sketch provides a direct interface to the SARA-R4 module's
+  AT command port. It will initialize the device, and then let you run free!
+  Consult the SARA-R4 AT command set for a list of commands.
+
+  After uploading the code, open your Serial Monitor, set the baud rate to 
+  9600 baud. We also recommend setting the line-ending setting to
+  "Carriage Return", so your AT commands will be read in by the SARA module.
+
+  Hardware Connections:
+  Attach the SparkFun LTE Cat M1/NB-IoT Shield to your Arduino
+  Power the shield with your Arduino -- ensure the PWR_SEL switch is in
+    the "ARDUINO" position.
+*/
+
+//Click here to get the library: http://librarymanager/All#SparkFun_LTE_Shield_Arduino_Library
+#include <SparkFun_LTE_Shield_Arduino_Library.h>
+
+// Create a SoftwareSerial object to pass to the LTE_Shield library
+SoftwareSerial lteSerial(8, 9);
+// Create a LTE_Shield object to use throughout the sketch
+LTE_Shield lte;
+
+void setup() {
+  Serial.begin(9600);
+
+  if ( lte.begin(lteSerial, 9600) ) {
+    Serial.println(F("LTE Shield connected!"));
+  }
+  Serial.println(F("Ready to passthrough!\r\n"));
+}
+
+void loop() {
+  if (Serial.available()) {
+    lteSerial.write((char) Serial.read());
+  }
+  if (lteSerial.available()) {
+    Serial.write((char) lteSerial.read());
+  }
+}

src/SparkFun_LTE_Shield_Arduino_Library.cpp

@@ -71,11 +71,11 @@ const char LTE_SHIELD_RESPONSE_OK[] = "OK\r\n";
 #define NUM_SUPPORTED_BAUD 6
 const unsigned long LTE_SHIELD_SUPPORTED_BAUD[NUM_SUPPORTED_BAUD] =
 {
+    115200,
     9600,
     19200,
     38400,
     57600,
-    115200,
     230400
 };
 #define LTE_SHIELD_DEFAULT_BAUD_RATE 115200