v3.0.0

CHANGELOG.md

@@ -1,21 +1,17 @@
-# Changelog
-#### File: LoRaE5
+# Library Changelog
 #### Author: Sylvain Montagny & Dorian Desserey
 
 
 ## Knows limitation
-* Tested on "EU868" & "US915".
-* Tested compatibility only with: 
-1. "Leonardo", "Zero" and "Due" Arduino boards,
-2. "ESP32_DevKitc_V4" Espressif board,
-3. "F446RE" and "L073RZ" Nucleo boards,
-4. "Wio Terminal" Seeed board,
+* Tested on "EU868" & "US915" only.
 * "LoRaWAN modem is busy" message may occurs for Class C/ABP.
 
+
+
 ## Version: V3.0.0 | 2024-05-14
 
 ### Added
-- A “config_board.h” header to manage several defined boards and allow you to choose the serial configuration for the others.
+- A “config_board.h” header file has been added to to manage the serial configuration (Debug and LoRa Module connection).
 - Implement a setup_hardware() method.
 
 ### Modified

README.md

@@ -10,8 +10,17 @@ Savoie Mont Blanc University provides many educationnal ressources about LoRaWAN
 
 
 # 2. About this Arduino library
+This library has been tested with the following boards: 
+1. Legacy Arduino : **Leonardo**, **Zero**, **Due**...
+2. ESP32 Espressif
+3. STM32 Nucleo Boards : **NUCLEO_F446**, **NUCLEO_L073**...
+4. Seed Studio: **Wio Terminal**
 
-This Arduino Library communicates with the [Grove Wio E5 LoRa-E5](https://wiki.seeedstudio.com/Grove_LoRa_E5_New_Version/). The configuration is made thanks to a unique file called config_application. Here are the possible configuration :
+:bulb: If you've tested this library with any other boards than the one listed we would be happy to have your feedback :
+- Report an [issue on github](https://github.com/SylvainMontagny/LoRaE5/issues/new) (label **"Test board failure"**) in case of **failure**.
+- Report an [issue on github](https://github.com/SylvainMontagny/LoRaE5/issues/new) (label **"Test board sucess"**) in case of **success**.
+
+This Arduino Library communicates with the [Grove Wio E5 LoRa-E5](https://wiki.seeedstudio.com/Grove_LoRa_E5_New_Version/). The application configuration is done thanks to a unique file called **config_application.h**. Here are the possible configuration :
 
 | #define           	| Possible values      	|  Behavior                                                    	|
 |----------------------	|--------------------	|---------------------------------------------------------------|
@@ -25,42 +34,33 @@ This Arduino Library communicates with the [Grove Wio E5 LoRa-E5](https://wiki.s
 | SEND_BY_PUSH_BUTTON  	| true or false      	|  Sending method (Time or Push Button)                        	|
 | FRAME_DELAY          	| Time (ms)         	|  Time between 2 frames (Minimum 7000)                        	|
 
-:warning: **Notice** : 
-- **EU868**: The Spreading Factor is between 7 & 12
-- **US915**: The Spreading Factor is between 7 & 10
-
-This library has only been tested with an **Arduino Leonardo** and an **Arduino Zero** boards.
-
 
+The board configuration is done thanks to a unique file called **config_board.h**. The default configuration is:
+- **Serial** for debug
+- **Serial1** for the module connection
+
+
 ## 2.1. Arduino IDE Installation
 
-- Install Arduino IDE from the [Arduino Website](https://www.arduino.cc/)
-- In Arduino IDE, go to **tools > Manage Librairies...** or **Ctrl + Shift + I**
+- Install Arduino IDE from the [Arduino Website](https://www.arduino.cc/).
+- In Arduino IDE, go to **tools > Manage Librairies...**.
 - Write in the section **Filter your search...** : "lora e5".
-- Choose your desired version and then click on **Install**.
+- Choose the last version and then click on **Install**.
 
 
 ## 2.2. Arduino Hardware
 
-This library works with any Arduino boards with two serial ports (or one USB + one Serial). It has been tested on an Arduino **Leonardo, Zero & Due** boards with: 
-- Debug_Serial: Connection to computer: 115200 baud. 
-- LoRa_Serial: Serial link for the communication between the Arduino MCU and the LoRa-E5 LoRaWAN module. 
-
-Your LoRa-E5 module need to be connected to the RX-TX arduino header pin.
-
-It also works with :
-- Espressif "ESP32_DevKitc_V4" board,
-- Nucleo "F446RE" and "L073RZ" boards,
-- Seeed "Wio Terminal" board,
+This library works with any boards with two serial ports (or one USB + one Serial). 
+- Debug_Serial (**Serial** by default): Connection to computer: 115200 baud. 
+- LoRa_Serial (**Serial1** by default): Serial link for the communication between the Arduino MCU and the LoRa-E5 LoRaWAN module. 
 
 
 ## 2.3. How to use this library
 
 - Set up the LoRaWAN parameters in **config_application.h** file. If you use ABP, you need to configure devAdddr, nwkSKey and appSKey. If you use OTAA you need to configure devEUI, appEUI and appKey.
 - Set up the hardware parameters in **config_board.h** file. Choose the right setting for your board (Serial or Pins).
-- Set up your Gateway or use a public coverage.
 - Register your Device on a Network Server (TTN, Actility, LORIOT, ...)
-- Open the Serial Monitor in the arduino IDE to see the logs. :warning: 115200 baud.
+- Open the Serial Monitor in the arduino IDE to see the logs. (:warning: 115200 baud).
 
 
 ## 2.4. How to add sensors

library.properties

@@ -1,9 +1,9 @@
 name=LoRaWAN-Seeed-Grove-Wio-E5
-version=2.0.1
+version=3.0.0
 author=Sylvain Montagny,[email protected]
 maintainer=Savoie Mont Blanc University
 sentence=Sending LoRaWAN frame with a Grove Wio E5 module.
 paragraph=This library proposes a simpler access to the LoRa-E5 module (LoRaE5). It handles uplinks, downlinks, ABP, OTAA, confirmed, unconfirmed, and port selection. EU868 and US915.
 category=Communication
 url=https://github.com/SylvainMontagny/LoRaE5
-architectures=Leonardo, Zero
+architectures=All Arduino legacy, ESP32, STM32 Nucleo (STM32duino), Seeed studio.