GPS example (#1)

GPS/GPS.ino

@@ -0,0 +1,349 @@
+/*******************************************************************************
+ * Copyright (c) 2015 Thomas Telkamp and Matthijs Kooijman
+ * Copyright (c) 2018 Terry Moore, MCCI
+ *
+ * Permission is hereby granted, free of charge, to anyone
+ * obtaining a copy of this document and accompanying files,
+ * to do whatever they want with them without any restriction,
+ * including, but not limited to, copying, modification and redistribution.
+ * NO WARRANTY OF ANY KIND IS PROVIDED.
+ *
+ * This example sends a valid LoRaWAN packet with payload "Hello,
+ * world!", using frequency and encryption settings matching those of
+ * the The Things Network. It's pre-configured for the Adafruit
+ * Feather M0 LoRa.
+ *
+ *******************************************************************************/
+
+
+/*******************************************************************************
+ *
+ * For Helium developers, follow the Arduino Quickstart guide:
+ * https://developer.helium.com/device/arduino-quickstart
+ * TLDR: register your device on the console:
+ * https://console.helium.com/devices
+ *
+ * The App EUI (as lsb) and App Key (as msb) get inserted below.
+ *
+ *******************************************************************************/
+
+#include <lmic.h>
+#include <arduino_lmic_hal_configuration.h>
+#include <arduino_lmic_hal_boards.h>
+#include <arduino_lmic_lorawan_compliance.h>
+#include <arduino_lmic_user_configuration.h>
+#include <arduino_lmic.h>
+#include <hal/hal.h>
+#include <SPI.h>
+#include <Adafruit_GPS.h>
+
+#define GPSSerial Serial1
+
+// Connect to the GPS on the hardware port
+Adafruit_GPS GPS(&GPSSerial);
+
+
+// This is the "App EUI" in Helium. Make sure it is little-endian (lsb).
+static const u1_t PROGMEM APPEUI[8]= { FILL_ME_IN };
+void os_getArtEui (u1_t* buf) { memcpy_P(buf, APPEUI, 8);}
+
+// This should also be in little endian format
+// These are user configurable values and Helium console permits anything
+static const u1_t PROGMEM DEVEUI[8]= { 0x48, 0x65, 0x6c, 0x69, 0x75, 0x6d, 0x20, 0x20 };
+void os_getDevEui (u1_t* buf) { memcpy_P(buf, DEVEUI, 8);}
+
+// This is the "App Key" in Helium. It is big-endian (msb).
+static const u1_t PROGMEM APPKEY[16] = { FILL_ME_IN };
+void os_getDevKey (u1_t* buf) {  memcpy_P(buf, APPKEY, 16);}
+
+static uint8_t mydata[] = "Hello, world!";
+static osjob_t sendjob;
+
+// Schedule TX every this many seconds (might become longer due to duty
+// cycle limitations).
+const unsigned TX_INTERVAL = 10;
+
+// Pin mapping
+//
+// Adafruit BSPs are not consistent -- m0 express defs ARDUINO_SAMD_FEATHER_M0,
+// m0 defs ADAFRUIT_FEATHER_M0
+//
+#if defined(ARDUINO_SAMD_FEATHER_M0) || defined(ADAFRUIT_FEATHER_M0)
+// Pin mapping for Adafruit Feather M0 LoRa, etc.
+const lmic_pinmap lmic_pins = {
+    .nss = 8,
+    .rxtx = LMIC_UNUSED_PIN,
+    .rst = 4,
+    .dio = {3, 6, LMIC_UNUSED_PIN},
+    .rxtx_rx_active = 0,
+    .rssi_cal = 8,              // LBT cal for the Adafruit Feather M0 LoRa, in dB
+    .spi_freq = 8000000,
+};
+
+#elif defined(MCCI_CATENA_4610) 
+#include "arduino_lmic_hal_boards.h"
+const lmic_pinmap lmic_pins = *Arduino_LMIC::GetPinmap_Catena4610();
+#elif defined(ARDUINO_DISCO_L072CZ_LRWAN1)
+namespace Arduino_LMIC {
+const HalPinmap_t GetPinmap_Disco_L072cz_Lrwan1();
+}
+const lmic_pinmap lmic_pins = Arduino_LMIC::GetPinmap_Disco_L072cz_Lrwan1();
+#else
+# error "Unknown target"
+#endif
+
+void onEvent (ev_t ev) {
+    Serial.print(os_getTime());
+    Serial.print(": ");
+    switch(ev) {
+        case EV_SCAN_TIMEOUT:
+            Serial.println(F("EV_SCAN_TIMEOUT"));
+            break;
+        case EV_BEACON_FOUND:
+            Serial.println(F("EV_BEACON_FOUND"));
+            break;
+        case EV_BEACON_MISSED:
+            Serial.println(F("EV_BEACON_MISSED"));
+            break;
+        case EV_BEACON_TRACKED:
+            Serial.println(F("EV_BEACON_TRACKED"));
+            break;
+        case EV_JOINING:
+            Serial.println(F("EV_JOINING"));
+            break;
+        case EV_JOIN_TXCOMPLETE:
+            Serial.println(F("EV_JOIN_TXCOMPLETE"));
+            break;
+        case EV_JOINED:
+            Serial.println(F("EV_JOINED"));
+            {
+              u4_t netid = 0;
+              devaddr_t devaddr = 0;
+              u1_t nwkKey[16];
+              u1_t artKey[16];
+              LMIC_getSessionKeys(&netid, &devaddr, nwkKey, artKey);
+              Serial.print("netid: ");
+              Serial.println(netid, DEC);
+              Serial.print("devaddr: ");
+              Serial.println(devaddr, HEX);
+              Serial.print("artKey: ");
+              for (size_t i=0; i<sizeof(artKey); ++i) {
+                if (i != 0)
+                  Serial.print("-");
+                Serial.print(artKey[i], HEX);
+              }
+              Serial.println("");
+              Serial.print("nwkKey: ");
+              for (size_t i=0; i<sizeof(nwkKey); ++i) {
+                      if (i != 0)
+                              Serial.print("-");
+                      Serial.print(nwkKey[i], HEX);
+              }
+              Serial.println("");
+            }
+            // Disable link check validation (automatically enabled
+            // during join, but because slow data rates change max TX
+            // size, we don't use it in this example.
+            LMIC_setLinkCheckMode(0);
+            break;
+        /*
+        || This event is defined but not used in the code. No
+        || point in wasting codespace on it.
+        ||
+        || case EV_RFU1:
+        ||     Serial.println(F("EV_RFU1"));
+        ||     break;
+        */
+        case EV_JOIN_FAILED:
+            Serial.println(F("EV_JOIN_FAILED"));
+            break;
+        case EV_REJOIN_FAILED:
+            Serial.println(F("EV_REJOIN_FAILED"));
+            break;
+            break;
+        case EV_TXCOMPLETE:
+            Serial.println(F("EV_TXCOMPLETE (includes waiting for RX windows)"));
+            if (LMIC.txrxFlags & TXRX_ACK)
+              Serial.println(F("Received ack"));
+            if (LMIC.dataLen) {
+              Serial.println(F("Received "));
+              Serial.println(LMIC.dataLen);
+              Serial.println(F(" bytes of payload"));
+            }
+            // Schedule next transmission
+            os_setTimedCallback(&sendjob, os_getTime()+sec2osticks(TX_INTERVAL), do_send);
+            break;
+        case EV_LOST_TSYNC:
+            Serial.println(F("EV_LOST_TSYNC"));
+            break;
+        case EV_RESET:
+            Serial.println(F("EV_RESET"));
+            break;
+        case EV_RXCOMPLETE:
+            // data received in ping slot
+            Serial.println(F("EV_RXCOMPLETE"));
+            break;
+        case EV_LINK_DEAD:
+            Serial.println(F("EV_LINK_DEAD"));
+            break;
+        case EV_LINK_ALIVE:
+            Serial.println(F("EV_LINK_ALIVE"));
+            break;
+        /*
+        || This event is defined but not used in the code. No
+        || point in wasting codespace on it.
+        ||
+        || case EV_SCAN_FOUND:
+        ||    Serial.println(F("EV_SCAN_FOUND"));
+        ||    break;
+        */
+        case EV_TXSTART:
+            Serial.println(F("EV_TXSTART"));
+            break;
+        default:
+            Serial.print(F("Unknown event: "));
+            Serial.println((unsigned) ev);
+            break;
+    }
+}
+
+void do_send(osjob_t* j){
+    // Check if there is not a current TX/RX job running
+    if (LMIC.opmode & OP_TXRXPEND) {
+        Serial.println(F("OP_TXRXPEND, not sending"));
+    } else {
+        
+       // Prepare upstream data transmission at the next possible time.
+        static uint8_t payload[32];
+        uint8_t idx = 0;
+        uint32_t data;
+
+        if (GPS.newNMEAreceived()) {
+          GPS.parse(GPS.lastNMEA());
+        }
+        
+        if (GPS.fix) {
+          Serial.println(GPS.latitudeDegrees);
+          Serial.println(GPS.longitudeDegrees);
+          data = (int)(GPS.latitude_fixed * (GPS.lat == 'N' ? 1 : -1) + 90 * 1E7);
+          payload[idx++] = data >> 24;
+          payload[idx++] = data >> 16;
+          payload[idx++] = data >> 8;
+          payload[idx++] = data;
+          data = (int)(GPS.longitude_fixed * (GPS.lon == 'E' ? 1 : -1) + 180 * 1E7);
+          payload[idx++] = data >> 24;
+          payload[idx++] = data >> 16;
+          payload[idx++] = data >> 8;
+          payload[idx++] = data;
+          data = (int)(GPS.altitude + 0.5);
+          payload[idx++] = data >> 8;
+          payload[idx++] = data;
+          payload[idx++] = 0;
+          payload[idx++] = 0;
+        } else {
+          for (idx=0; idx<12; idx++) {
+            payload[idx] = 0;
+          }
+        }
+        Serial.println(F("Packet queued"));
+        LMIC_setTxData2(1, payload, idx, 0);  
+    }
+   
+}
+
+void setup() {
+    delay(5000);
+    while (! Serial)
+        ;
+    Serial.begin(9600);
+    Serial.println(F("Starting"));
+
+    #if defined(ARDUINO_DISCO_L072CZ_LRWAN1)
+    SPI.setMOSI(RADIO_MOSI_PORT);
+    SPI.setMISO(RADIO_MISO_PORT);
+    SPI.setSCLK(RADIO_SCLK_PORT);
+    SPI.setSSEL(RADIO_NSS_PORT);
+    // SPI.begin();
+    #endif
+
+    #ifdef VCC_ENABLE
+    // For Pinoccio Scout boards
+    pinMode(VCC_ENABLE, OUTPUT);
+    digitalWrite(VCC_ENABLE, HIGH);
+    delay(1000);
+    #endif
+
+    // LMIC init
+    os_init();
+    // Reset the MAC state. Session and pending data transfers will be discarded.
+    LMIC_reset();
+
+    // allow much more clock error than the X/1000 default. See:
+    // https://github.com/mcci-catena/arduino-lorawan/issues/74#issuecomment-462171974
+    // https://github.com/mcci-catena/arduino-lmic/commit/42da75b56#diff-16d75524a9920f5d043fe731a27cf85aL633
+    // the X/1000 means an error rate of 0.1%; the above issue discusses using values up to 10%.
+    // so, values from 10 (10% error, the most lax) to 1000 (0.1% error, the most strict) can be used.
+    LMIC_setClockError(1 * MAX_CLOCK_ERROR / 40);
+    
+    LMIC_setLinkCheckMode(0);
+    LMIC_setDrTxpow(DR_SF8, 20); 
+    LMIC_selectSubBand(6);
+
+    GPS.begin(9600);
+    // Only interrested in GGA, no antenna status
+    GPS.sendCommand(PMTK_SET_NMEA_OUTPUT_RMCGGA);
+    GPS.sendCommand(PGCMD_NOANTENNA);
+  
+    // Update every second
+    GPS.sendCommand(PMTK_SET_NMEA_UPDATE_1HZ); // 1 Hz update rate
+
+    // Start job (sending automatically starts OTAA too)
+    do_send(&sendjob);
+}
+
+void loop() {
+    GPS.read();
+    os_runloop_once();
+}
+
+namespace Arduino_LMIC { 
+
+    class HalConfiguration_Disco_L072cz_Lrwan1_t : public HalConfiguration_t
+            {
+    public:
+            enum DIGITAL_PINS : uint8_t
+                    {
+                    PIN_SX1276_NSS = 37,
+                    PIN_SX1276_NRESET = 33,
+                    PIN_SX1276_DIO0 = 38,
+                    PIN_SX1276_DIO1 = 39,
+                    PIN_SX1276_DIO2 = 40,
+                    PIN_SX1276_RXTX = 21,
+                    };
+
+        virtual bool queryUsingTcxo(void) override { return false; };
+            };
+    // save some typing by bringing the pin numbers into scope
+    static HalConfiguration_Disco_L072cz_Lrwan1_t myConfig;
+
+    static const HalPinmap_t myPinmap =
+            {
+            .nss = HalConfiguration_Disco_L072cz_Lrwan1_t::PIN_SX1276_NSS,
+            .rxtx = HalConfiguration_Disco_L072cz_Lrwan1_t::PIN_SX1276_RXTX, 
+            .rst = HalConfiguration_Disco_L072cz_Lrwan1_t::PIN_SX1276_NRESET,
+
+            .dio = {HalConfiguration_Disco_L072cz_Lrwan1_t::PIN_SX1276_DIO0, 
+                    HalConfiguration_Disco_L072cz_Lrwan1_t::PIN_SX1276_DIO1, 
+                    HalConfiguration_Disco_L072cz_Lrwan1_t::PIN_SX1276_DIO2, 
+                },
+            .rxtx_rx_active = 1,
+            .rssi_cal = 10,
+            .spi_freq = 8000000,     /* 8MHz */
+            .pConfig = &myConfig
+            };
+
+    const HalPinmap_t GetPinmap_Disco_L072cz_Lrwan1(void)
+            {
+            return myPinmap;
+            }
+}; // end namespace Arduino_LMIC

README.md

@@ -6,6 +6,10 @@ From the Arduino IDE, open the Library Manager (Sketch->Include Library->Manage
 
 ![](https://developer.helium.com/static/library_manager-56bed2bb23b6f93e5cc3b25bdfd345a2.png)
 
+## Adafruit GPS Library [Optional]
+
+From the Arduino IDE, open the Library Manager (Sketch->Include Library->Manage Libraries). In the search box, type Adafruit GPS Library.
+
 ## Board Support
 
 ### B-L072Z-LRWAN1 - ST STM32L0 Discovery kit  
@@ -22,7 +26,10 @@ Arduino IDE:
 Install board support package, find instructions [here](https://github.com/mcci-catena/Arduino_Core_STM32#getting-started). 
 
 Arduino IDE:  
-Select Tools -> Board: -> MCCI Catena 4610.  
+Select Tools -> Board: -> MCCI Catena 4610.
+
+For the GPS sketch:
+Select Tools -> Serial Interface -> USB + HW Serial  
 
 [Catena 4610 Product Page](https://store.mcci.com/collections/iot-building-blocks/products/mcci-catena-4610-integrated-node-for-lorawan-technology)  
 [Catena 4610 Pin Mapping Diagram](https://github.com/mcci-catena/HW-Designs/blob/master/Boards/Catena-4610/Catena-4610-Pinmapping.png)
@@ -36,7 +43,7 @@ Select Tools -> Board: -> MCCI Catena 4610.
 [Adafruit Feather M0 with RFM95 Product Page](https://www.adafruit.com/product/3178)  
 [Adafruit Feather M0 with RFM95 Datasheets & Files](https://learn.adafruit.com/adafruit-feather-m0-radio-with-lora-radio-module/downloads)
 
-## Programming(Upload Method):
+## Programming (Uploading Method):
 
 ### B-L072Z-LRWAN1 - ST STM32L0 Discovery kit 
 
@@ -52,7 +59,7 @@ Select Tools -> Upload Method -> STM32CubeProgrammer(SWD)
 
 #### DFU
 Arduino IDE:  
-Select Tools -> Upload Method -> DFU  
+Select Tools -> Upload Method -> DFU
 
 To put the board in DFU mode, hold down the boot button while pressing and releasing the reset button.
 

longfi-us915/longfi-us915.ino

@@ -103,11 +103,6 @@ const lmic_pinmap lmic_pins = {
 #elif defined(MCCI_CATENA_4610) 
 #include "arduino_lmic_hal_boards.h"
 const lmic_pinmap lmic_pins = *Arduino_LMIC::GetPinmap_Catena4610();
-#elif defined(ARDUINO_DISCO_L072CZ_LRWAN1)
-namespace Arduino_LMIC {
-const HalPinmap_t GetPinmap_Disco_L072cz_Lrwan1();
-}
-const lmic_pinmap lmic_pins = Arduino_LMIC::GetPinmap_Disco_L072cz_Lrwan1();
 #else
 # error "Unknown target"
 #endif
@@ -326,4 +321,4 @@ namespace Arduino_LMIC {
             return myPinmap;
             }
 
-}; // end namespace Arduino_LMIC
+}; // end namespace Arduino_LMIC