Added the network info example and extra network operators

Author: PaulZC

examples/Example201_NetworkInfo/Example201_NetworkInfo.ino

@@ -0,0 +1,120 @@
+/*
+  Register your SARA-R5/SIM combo on a mobile network operator
+  By: Paul Clark
+  SparkFun Electronics
+  Date: October 20th 2020
+
+  Please see LICENSE.md for the license information
+
+  This example demonstrates how to initialize your MicroMod Asset Tracker Carrier Board and
+  connect it to a mobile network operator (Verizon, AT&T, T-Mobile, etc.).
+
+  Before beginning, you may need to adjust the mobile network operator (MNO)
+  setting on line 83. See comments above that line to help select either
+  Verizon, T-Mobile, AT&T or others.
+  
+  This code is intend to run on the MicroMod Asset Tracker Carrier Board
+  using (e.g.) the MicroMod Artemis Processor Board
+
+  Select the SparkFun RedBoard Artemis ATP from the SparkFun Apollo3 boards
+  
+*/
+
+//Click here to get the library: http://librarymanager/All#SparkFun_u-blox_SARA-R5_Arduino_Library
+#include <SparkFun_u-blox_SARA-R5_Arduino_Library.h>
+
+// Uncomment the next line to connect to the SARA-R5 using hardware Serial1
+#define saraSerial Serial1
+
+// Uncomment the next line to create a SoftwareSerial object to pass to the SARA-R5 library instead
+//SoftwareSerial saraSerial(8, 9);
+
+// Create a SARA_R5 object to use throughout the sketch
+SARA_R5 assetTracker;
+
+// 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
+  "Registered, roaming",                    // 5
+  "Registered, home (SMS only)",            // 6
+  "Registered, roaming (SMS only)",         // 7
+  "Registered, emergency service only",     // 8
+  "Registered, home, CSFB not preferred",   // 9
+  "Registered, roaming, CSFB not prefered"  // 10
+};
+
+// Network operator can be set to e.g.:
+// MNO_SW_DEFAULT -- DEFAULT
+// MNO_SIM_ICCID -- SIM DEFAULT
+// MNO_ATT -- AT&T 
+// MNO_VERIZON -- Verizon
+// MNO_TELSTRA -- Telstra
+// MNO_TMO -- T-Mobile US
+// MNO_CT -- China Telecom
+// MNO_VODAFONE
+// MNO_STD_EUROPE
+const mobile_network_operator_t MOBILE_NETWORK_OPERATOR = MNO_SIM_ICCID;
+
+// APN -- Access Point Name. Gateway between GPRS MNO
+// and another computer network. E.g. "hologram
+//const String APN = "hologram";
+// The APN can be omitted: this is the so-called "blank APN" setting that may be suggested by
+// network operators (e.g. to roaming devices); in this case the APN string is not included in
+// the message sent to the network.
+const String APN = "";
+
+void setup() {
+  Serial.begin(9600);
+
+  Serial.println(F("Initializing the Asset Tracker (SARA-R5)..."));
+  Serial.println(F("...this may take ~25 seconds if the SARA is off."));
+  Serial.println(F("...it may take ~5 seconds if it just turned on."));
+
+  // Initialize the SARA
+  if (assetTracker.begin(saraSerial, 9600))
+  {
+    Serial.println(F("Asset Tracker (SARA-R5) connected!"));
+  }
+  else
+  {
+    Serial.println(F("Unable to communicate with the SARA."));
+    Serial.println(F("Manually power-on (hold POWER for 3 seconds) on and try again."));
+    while (1) ; // Loop forever on fail
+  }
+  Serial.println();
+
+  if (!assetTracker.setNetwork(MOBILE_NETWORK_OPERATOR))
+  {
+    Serial.println(F("Error setting network. Try cycling the power."));
+    while (1) ;
+  }
+  
+  if (assetTracker.setAPN(APN) == SARA_R5_SUCCESS)
+  {
+    Serial.println(F("APN successfully set."));
+  }
+  
+  Serial.println(F("Network set. Ready to go!"));
+  
+  // RSSI: Received signal strength:
+  Serial.println("RSSI: " + String(assetTracker.rssi()));
+  // Registration Status
+  int regStatus = assetTracker.registration();
+  if ((regStatus >= 0) && (regStatus <= 10))
+  {
+    Serial.println("Network registration: " + registrationString[regStatus]);
+  }
+  
+  if (regStatus > 0) {
+    Serial.println(F("All set. Go to the next example!"));
+  }
+}
+
+void loop() {
+  // Do nothing. Now that we're registered move on to the next example.
+}

keywords.txt

@@ -115,12 +115,23 @@ gpsRequest	KEYWORD2
 SARA-R410M-02B	LITERAL1
 MNO_INVALID	LITERAL1
 MNO_SW_DEFAULT	LITERAL1
-MNO_SIM_ICCD	LITERAL1
+MNO_SIM_ICCID	LITERAL1
 MNO_ATT	LITERAL1
 MNO_VERIZON	LITERAL1
 MNO_TELSTRA	LITERAL1
 MNO_TMO	LITERAL1
 MNO_CT	LITERAL1
+MNO_SPRINT	LITERAL1
+MNO_VODAFONE	LITERAL1
+MNO_NTT_DOCOMO	LITERAL1
+MNO_TELUS	LITERAL1
+MNO_SOFTBANK	LITERAL1
+MNO_DT	LITERAL1
+MNO_US_CELLULAR	LITERAL1
+MNO_SKT	LITERAL1
+MNO_GLOBAL	LITERAL1
+MNO_STD_EUROPE	LITERAL1
+MNO_STD_EU_NOEPCO	LITERAL1
 SARA_R5_ERROR_INVALID	LITERAL1
 SARA_R5_ERROR_SUCCESS	LITERAL1
 SARA_R5_ERROR_OUT_OF_MEMORY	LITERAL1
@@ -129,6 +140,7 @@ SARA_R5_ERROR_UNEXPECTED_PARAM	LITERAL1
 SARA_R5_ERROR_UNEXPECTED_RESPONSE	LITERAL1
 SARA_R5_ERROR_NO_RESPONSE	LITERAL1
 SARA_R5_ERROR_DEREGISTERED	LITERAL1
+SARA_R5_ERROR_ERROR	LITERAL1
 SARA_R5_SUCCESS	LITERAL1
 SARA_R5_REGISTRATION_INVALID	LITERAL1
 SARA_R5_REGISTRATION_NOT_REGISTERED	LITERAL1
@@ -139,12 +151,23 @@ SARA_R5_REGISTRATION_UNKNOWN	LITERAL1
 SARA_R5_REGISTRATION_ROAMING	LITERAL1
 SARA_R5_REGISTRATION_HOME_SMS_ONLY	LITERAL1
 SARA_R5_REGISTRATION_ROAMING_SMS_ONLY	LITERAL1
+SARA_R5_REGISTRATION_EMERGENCY_SERV_ONLY	LITERAL1
 SARA_R5_REGISTRATION_HOME_CSFB_NOT_PREFERRED	LITERAL1
 SARA_R5_REGISTRATION_ROAMING_CSFB_NOT_PREFERRED	LITERAL1
 SARA_R5_TCP	LITERAL1
 SARA_R5_UDP	LITERAL1
 SARA_R5_MESSAGE_FORMAT_PDU	LITERAL1
 SARA_R5_MESSAGE_FORMAT_TEXT	LITERAL1
+PDP_TYPE_INVALID	LITERAL1
+PDP_TYPE_IP	LITERAL1
+PDP_TYPE_NONIP	LITERAL1
+PDP_TYPE_IPV4V6	LITERAL1
+PDP_TYPE_IPV6	LITERAL1
+L2P_DEFAULT	LITERAL1
+L2P_PPP	LITERAL1
+L2P_M_HEX	LITERAL1
+L2P_M_RAW_IP	LITERAL1
+L2P_M_OPT_PPP	LITERAL1
 GPIO1	LITERAL1
 GPIO2	LITERAL1
 GPIO3	LITERAL1
@@ -158,16 +181,29 @@ NETWORK_STATUS	LITERAL1
 GNSS_SUPPLY_ENABLE	LITERAL1
 GNSS_DATA_READY	LITERAL1
 GNSS_RTC_SHARING	LITERAL1
+JAMMING_DETECTION	LITERAL1
 SIM_CARD_DETECTION	LITERAL1
 HEADSET_DETECTION	LITERAL1
 GSM_TX_BURST_INDICATION	LITERAL1
-MODULE_OPERATING_STATUS_INDICATION	LITERAL1
-MODULE_FUNCTIONALITY_STATUS_INDICATION	LITERAL1
+MODULE_STATUS_INDICATION	LITERAL1
+MODULE_OPERATING_MODE_INDICATION	LITERAL1
 I2S_DIGITAL_AUDIO_INTERFACE	LITERAL1
 SPI_SERIAL_INTERFACE	LITERAL1
 MASTER_CLOCK_GENRATION	LITERAL1
 UART_INTERFACE	LITERAL1
 WIFI_ENABLE	LITERAL1
 RING_INDICATION	LITERAL1
 LAST_GASP_ENABLE	LITERAL1
+EXTERNAL_GNSS_ANTENNA	LITERAL1
+TIME_PULSE_GNSS	LITERAL1
+TIME_PULSE_OUTPUT	LITERAL1
+TIMESTAMP	LITERAL1
+FAST_POWER_OFF	LITERAL1
+LWM2M_PULSE	LITERAL1
+HARDWARE_FLOW_CONTROL	LITERAL1
+ANTENNA_TUNING	LITERAL1
+EXT_GNSS_TIME_PULSE	LITERAL1
+EXT_GNSS_TIMESTAMP	LITERAL1
+DTR_MODE	LITERAL1
+KHZ_32768_OUT	LITERAL1
 PAD_DISABLED	LITERAL1

src/SparkFun_u-blox_SARA-R5_Arduino_Library.cpp

@@ -843,8 +843,18 @@ SARA_R5_error_t SARA_R5::setAPN(String apn, uint8_t cid, SARA_R5_pdp_type pdpTyp
         return SARA_R5_ERROR_UNEXPECTED_PARAM;
         break;
     }
-    sprintf(command, "%s=%d,\"%s\",\"%s\"", SARA_R5_MESSAGE_PDP_DEF,
+    if (apn == NULL)
+    {
+      if (_printDebug == true) _debugPort->println("APN: NULL");
+      sprintf(command, "%s=%d,\"%s\",\"\"", SARA_R5_MESSAGE_PDP_DEF,
+            cid, pdpStr);
+    }
+    else
+    {
+      if (_printDebug == true) _debugPort->println("APN: " + ((String)apn));
+      sprintf(command, "%s=%d,\"%s\",\"%s\"", SARA_R5_MESSAGE_PDP_DEF,
             cid, pdpStr, apn.c_str());
+    }
 
     err = sendCommandWithResponse(command, SARA_R5_RESPONSE_OK, NULL,
                                   SARA_R5_STANDARD_RESPONSE_TIMEOUT);

src/SparkFun_u-blox_SARA-R5_Arduino_Library.h

@@ -48,16 +48,31 @@
 #define SARA_R5_POWER_PIN -1
 #define SARA_R5_RESET_PIN -1
 
+// The standard Europe profile should be used as the basis for all other MNOs in Europe outside of Vodafone
+// and Deutsche Telekom. However, there may be changes that need to be applied to the module for proper
+// operation with any given European MNO such as attach type, RAT preference, band selection, etc. Please
+// consult with the preferred network provider.
 typedef enum
 {
     MNO_INVALID = -1,
     MNO_SW_DEFAULT = 0,
-    MNO_SIM_ICCD = 1,
-    MNO_ATT = 2,
+    MNO_SIM_ICCID = 1,
+    MNO_ATT = 2,        // AT&T
     MNO_VERIZON = 3,
     MNO_TELSTRA = 4,
-    MNO_TMO = 5,
-    MNO_CT = 6
+    MNO_TMO = 5,        // T-Mobile US
+    MNO_CT = 6,         // China Telecom
+    MNO_SPRINT = 8,
+    MNO_VODAFONE = 19,
+    MNO_NTT_DOCOMO = 20,
+    MNO_TELUS = 21,
+    MNO_SOFTBANK = 28,
+    MNO_DT = 31,        // Deutsche Telekom
+    MNO_US_CELLULAR = 32,
+    MNO_SKT = 39,
+    MNO_GLOBAL = 90,
+    MNO_STD_EUROPE = 100,
+    MNO_STD_EU_NOEPCO = 101
 } mobile_network_operator_t;
 
 typedef enum