Merge pull request #6 from fpistm/fw_update

Update library

Author: fpistm

README.md

@@ -26,15 +26,38 @@ as a simple LoRa® radio module.
 
 * The module supports only class A.
 * Sleep mode is not supported in OTAA mode with the version 2.6 of the firmware.
-* The same USART is shared between I-NUCLEO-LRWAN1 LoRa® expansion board and
-Nucleo-64 boards. See UM1724, §6.8 section to solve the issue.
+* Important note for Nucleo64:
+
+  By default, D0/D1 of CN9 board connector are respectively not connected to
+  PA3 and PA2 (SB62 and SB63 opened).
+  Those pins are connected to STLink USART thanks to SB13, SB14.
+
+  To use the shield:
+    - Connect shield D0(Tx) to PC11(Rx)
+    - Connect shield D1(Rx) to PC10(Tx)
+
+  or
+
+    - Close SB62 and SB63 to connect D0/D1 of CN9 connector to PA3 and PA2
+    - Open SB13 and SB14 to disconnect PA3 and PA2 from STLink UART
+
+  but in this case, you will have to wire STLink Rx/Tx of CN3 connector to
+  another pins and update Serial instance before call `Serial.begin(115200);`
+  using:
+  ```
+  Serial.setRx(Rx pin);
+  Serial.setTx(Tx pin);
+  ```
+  
+  See [UM1724](https://www.st.com/resource/en/user_manual/dm00105823.pdf), §6.8 section for more information.
 
 ## Examples
 
-* **getDevEUI**: display the unique device EUI.
+* **getInfo**: display several info about LoRa shield (Firmware version, device EUI,...)
 * **LoRaWANABP**: send/receive data in ABP mode.
 * **LoRaWANOTAA**: send/receive data in OTAA mode.
-* **LoRaPingPong**: P2P exchange in LoRa®
+* **LoRaPingPong**: P2P exchange in LoRa®.
+* **BridgeSerial**: Send/Receive AT command from/to PC terminal to/from shield (console mode).
 
 ## Advice
 
@@ -51,7 +74,7 @@ to increase the delay time of the RX1 window.
 ## Version
 
 This library is based on the STM32CubeExpansion_LRWAN_V1.1.2 driver.
-This library has been validated with the version 2.6 of the firmware.
+This library has been validated with the version 2.6 and 3.6 of the firmware.
 
 ## Documentation
 

examples/BridgeSerial/BridgeSerial.ino

@@ -0,0 +1,47 @@
+/*
+  Allows to relay UART data from/to a PC terminal to/from LORA shield.
+
+  Shield uses a LPUART interface as the AT command console, the D0 and D1 pin
+  is the LPUART TX and LPUART RX, and the default configuration is 115200,N,8,1
+
+  Important note for Nucleo64:
+  by default, D0/D1 of CN9 board connector are respectively not connected to
+  PA3 and PA2 (SB62 and SB63 opened).
+  Those pins are connected to STLink USART thanks to SB13, SB14.
+
+  To use the shield:
+    - Connect shield D0(Tx) to PC11(Rx)
+    - Connect shield D1(Rx) to PC10(Tx)
+  or
+    - Close SB62 and SB63 to connect D0/D1 of CN9 connector to PA3 and PA2
+    - Open SB13 and SB14 to disconnect PA3 and PA2 from STLink UART
+  but in this case, you will have to wire STLink Rx/Tx of CN3 connector to
+  another pins and update Serial instance before call `Serial.begin(115200);`
+  using:
+  Serial.setRx(Rx pin);
+  Serial.setTx(Tx pin);
+*/
+HardwareSerial SerialLora(D0, D1);
+
+void setup()
+{
+  Serial.begin(115200);
+  SerialLora.begin(115200);
+}
+
+// The loop function runs over and over again forever
+void loop()
+{
+  char c;
+
+  if (SerialLora.available() > 0)
+  {
+    c = SerialLora.read();
+    Serial.print(c);
+  }
+  if (Serial.available() > 0)
+  {
+    c = Serial.read();
+    SerialLora.print(c);
+  }
+}

examples/LoRaPingPong/LoRaPingPong.ino

@@ -11,8 +11,10 @@
 
 #define SEND_PERIOD_MS 1000 //send period every second.
 
-// Serial port use to communicate with the USI shield. Specific to the board Discovery L475 IoT.
-HardwareSerial SerialLora(PA_1, PA_0);
+// Serial port use to communicate with the USI shield.
+// By default, use D0 (Rx) and D1(Tx).
+// For Nucleo64, see "Known limitations" chapter in the README.md
+HardwareSerial SerialLora(D0, D1);
 
 // Messages to exchange
 uint8_t PingMsg[] = "PING";

examples/LoRaWANABP/LoRaWANABP.ino

@@ -20,7 +20,10 @@
 
 #define FRAME_DELAY 300000  // in ms. Every 5 minutes by default.
 
-HardwareSerial SerialLora(PA_1, PA_0);
+// Serial port use to communicate with the USI shield.
+// By default, use D0 (Rx) and D1(Tx).
+// For Nucleo64, see "Known limitations" chapter in the README.md
+HardwareSerial SerialLora(D0, D1);
 
 // Device address, network & application keys
 const char devAddr[] = "ef00cb01";

examples/LoRaWANOTAA/LoRaWANOTAA.ino

@@ -23,12 +23,14 @@
 
 #define FRAME_DELAY 300000  // in ms. Every 5 minutes by default.
 
-// Serial port use to communicate with the USI shield. Specific to the board Discovery L475 IoT.
-HardwareSerial SerialLora(PA_1, PA_0);
+// Serial port use to communicate with the USI shield.
+// By default, use D0 (Rx) and D1(Tx).
+// For Nucleo64, see "Known limitations" chapter in the README.md
+HardwareSerial SerialLora(D0, D1);
 
 // AppKey and AppEUI.
 const char appKey[] = "0123456789abcdef0123456789abcdef";
-const char appEUI[] = "abcdef0123456789abcdef0123456789";
+const char appEUI[] = "0101010101010101";
 
 // Data send
 char frameTx[] = "Hello world!";

examples/getDevEUI/getDevEUI.ino

@@ -0,0 +1,63 @@
+/*
+  getInfo.ino
+
+  Display several information about the module. The devEUI of the USI module
+  can't be modified. It is useful to read it to configure the module in a
+  LoRaWAN network when asked by the network server.
+*/
+
+#include "LoRaWANNode.h"
+
+// Serial port use to communicate with the USI shield.
+// By default, use D0 (Rx) and D1(Tx).
+HardwareSerial SerialLora(D0, D1);
+
+void setup()
+{
+  Serial.begin(115200);
+  Serial.println("-- Get Info sketch --");
+
+  // Enable the USI module and set the radio band.
+  while (!loraNode.begin(&SerialLora, LORA_BAND_EU_868)) {
+    Serial.println("Lora module not ready");
+    delay(1000);
+  }
+
+  // Get the DevEUI
+  String str = "Firmware version: ";
+  loraNode.getFWVersion(&str);
+  Serial.println(str);
+
+  str = "LoRa stack version: ";
+  loraNode.getVersion(&str);
+  Serial.println(str);
+
+  str = "Unique DevEUI: 0x";
+  loraNode.getDevEUI(&str);
+  Serial.println(str);
+
+  str = "Application EUI: 0x";
+  loraNode.getAppEUI(&str);
+  Serial.println(str);
+
+  str = "Application key: 0x";
+  loraNode.getAppKey(&str);
+  Serial.println(str);
+
+  str = "Network session Key: 0x";
+  loraNode.getNwkSKey(&str);
+  Serial.println(str);
+
+  str = "Application session key: 0x";
+  loraNode.getAppSKey(&str);
+  Serial.println(str);
+
+  str = "Device address: 0x";
+  loraNode.getDevAddr(&str);
+  Serial.println(str);
+}
+
+void loop()
+{
+  //empty loop
+}

examples/getInfo/getInfo.ino

@@ -71,6 +71,7 @@ LoraRadio::LoraRadio()
 bool LoraRadio::begin(HardwareSerial *serialx)
 {
   uint8_t nbTry = 0;
+  uint8_t enable = 0;
 
   if(serialx == NULL) {
     return false;
@@ -83,8 +84,14 @@ bool LoraRadio::begin(HardwareSerial *serialx)
 
   LoRa_DumyRequest();
 
-  //Echo mode must be disabled
-  Modem_AT_Cmd(AT_EXCEPT, AT_ATE, 0);
+  // Local echo mode must be disabled
+  Modem_AT_Cmd(AT_EXCEPT, AT_ATE, &enable);
+
+  // Verbose response must be enabled for the AT parser
+  enable = 1;
+  if (Modem_AT_Cmd(AT_EXCEPT, AT_VERB, &enable) != AT_OK) {
+    AT_VERB_cmd = false;
+  }
 
   // Enable Lora module
   /*
@@ -410,55 +417,55 @@ uint8_t LoraRadio::parseRcvData(void *pdata)
     return AT_END_ERROR;
   }
 
-  /*cleanup the response buffer*/
+  // Cleanup the response buffer
   memset(response, 0x00, DATA_RX_MAX_BUFF_SIZE);
 
-  while (!ResponseComplete)
-  {
+  while (!ResponseComplete) {
     msStart = millis();
-    while (HW_UART_Modem_IsNewCharReceived() == RESET) {
+    while (!HW_UART_Modem_IsNewCharReceived()) {
       if((millis() - msStart) > RESPONSE_TIMEOUT) {
         return AT_UART_LINK_ERROR;
       }
     }
 
-    /*process the response*/
+    // Process the response
     response[i] = HW_UART_Modem_GetNewChar();
 
-    /*wait up to carriage return OR the line feed marker*/
-    if (/*(response[i] =='\r') || */(response[i] == '\n'))
-    {
+    // Wait up to carriage return OR the line feed marker
+    if (/*(response[i] =='\r') || */(response[i] == '\n')) {
       DBG_PRINTF("LoRa radio rcv: %s\r\n", response);
 
-      if (i!= 0)      /*trap the asynchronous event*/
-      {
-        /*first statement to get back the return value*/
+      if (i!= 0) {  // Trap the asynchronous event
+        // First statement to get back the return value
         response[i] = '\0';
-        ptrChr = strchr(&response[0],'+');       /*to skip the '\0''\r'*/
-        if (strncmp(ptrChr, "+RCV:", sizeof("+RCV:")-1) == 0) {
+        ptrChr = strchr(&response[0],'+'); // Skip the '\0''\r'
+        if (strncmp(ptrChr, "+RCV", sizeof("+RCV")-1) == 0) {
           RetCode = AT_OK;
-          ptrChr = strchr(&response[1],':');       /*to skip the '\0''\r'*/
-          strcpy((char *)pdata,ptrChr+2);
+          if(AT_VERB_cmd) {
+            ptrChr = strrchr(&response[1], ',');
+            strcpy((char *)pdata, ptrChr+1);
+          } else {
+            ptrChr = strchr(&response[1],':');
+            strcpy((char *)pdata, ptrChr+2);
+		  }
           ResponseComplete = 1;
         } else {
           RetCode = AT_END_ERROR;
         }
         memset(response, 0x00, 16);
-        i= -1;             /*to compensate the next index iteration and restart in [0]*/
+        i= -1; // Compensate the next index iteration and restart in [0]
       }
-    }
-    else
-    {
-      if (i ==  (DATA_RX_MAX_BUFF_SIZE-1)) /* frame overflow */
-      {
+    } else {
+      if (i ==  (DATA_RX_MAX_BUFF_SIZE-1)) {
+        //  Frame overflow
         i = 0;
         return (AT_TEST_PARAM_OVERFLOW);
       }
     }
     i++;
   }
 
-  return ( RetCode);   /*version of HAL .. there was not Rx field state*/
+  return RetCode;
 }
 
 LoraRadio loraRadio;

src/LoRaRadio.cpp

@@ -90,7 +90,8 @@ class LoraRadio {
 
   LoraRadio();
 
-  bool begin(HardwareSerial *serialx);  //begin initialization function
+  // Begin initialization function
+  bool begin(HardwareSerial *serialx);
   void end(void);
 
   bool setFrequency(uint32_t freq);