OTTA -> OTAA, added compatibility description

Harrison-Xu · web-flow · commit 3a6d86b04041 · 2025-05-12T02:38:50.000Z
diff --git a/README.md b/README.md
@@ -2,18 +2,34 @@
 
 ## Overview
 
-### SKU:U116/U117/U115
+### Compatible Products: 
 
-Contains M5Stack-**LoRaWAN** series related case programs. The hardware is based on the ASR6501 series of modules to realize the LoRaWAN communication function.
+| SKU  | Name                |
+|------|---------------------|
+| U115 | Unit LoRaWAN915     |
+| U116 | Unit LoRaWAN470     |
+| U117 | Unit LoRaWAN868     |
+| K061 | Atom DTU LoRaWAN915 |
+| K062 | Atom DTU LoRaWAN470 |
+| K063 | Atom DTU LoRaWAN868 |
+
+Please note that all the six products above (compatible with this library) are EOL. For new LoRaWAN products like Unit LoRaWAN-US915 (U184-US915) and Atom DTU LoRaWAN-US915 (A152-US915), please use [M5-LoRaWAN-RAK](https://github.com/m5stack/M5-LoRaWAN-RAK) library instead. 
+
+Contains M5Stack-**LoRaWAN** series related case programs. The hardware is based on the ASR6501 series of modules to realize the LoRaWAN communication function. 
 
 ## Related Link
 
-[Document & AT Command M5Unit-LoRaWAN470](https://docs.m5stack.com/en/unit/lorawan470)
+[Document & AT Command Unit LoRaWAN470](https://docs.m5stack.com/en/unit/lorawan470)
+
+[Document & AT Command Unit LoRaWAN868](https://docs.m5stack.com/en/unit/lorawan868)
+
+[Document & AT Command Unit LoRaWAN915](https://docs.m5stack.com/en/unit/lorawan915)
 
-[Document & AT Command M5Unit-LoRaWAN868](https://docs.m5stack.com/en/unit/lorawan868)
+[Document & AT Command Atom DTU LoRaWAN470](https://docs.m5stack.com/en/atom/atom_dtu_lorawan470)
 
-[Document & AT Command M5Unit-LoRaWAN915](https://docs.m5stack.com/en/unit/lorawan915)
+[Document & AT Command Atom DTU LoRaWAN868](https://docs.m5stack.com/en/atom/atom_dtu_lorawan868)
 
+[Document & AT Command Atom DTU LoRaWAN915](https://docs.m5stack.com/en/atom/atom_dtu_lorawan915)
 
 ## License
 
diff --git a/examples/LoRaWAN_OTAA/LoRaWAN_OTAA.ino b/examples/LoRaWAN_OTAA/LoRaWAN_OTAA.ino
@@ -22,7 +22,7 @@ void setup() {
     while (!LoRaWAN.checkDeviceConnect())
         ;
     Serial.println("Module Config...");
-    LoRaWAN.configOTTA("00bb9da5b97addf1",                  // Device EUI
+    LoRaWAN.configOTAA("00bb9da5b97addf1",                  // Device EUI
                        "0000000000000000",                  // APP EUI
                        "27dfe264ca33ac1957c005eb48ba4721",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN470_M5Atom/Unit_LoRaWAN470_M5Atom.ino b/examples/Unit_LoRaWAN470_M5Atom/Unit_LoRaWAN470_M5Atom.ino
@@ -44,7 +44,7 @@ void setup() {
 
     Serial.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("00bb9da5b97addf1",                  // Device EUI
+    LoRaWAN.configOTAA("00bb9da5b97addf1",                  // Device EUI
                        "0000000000000000",                  // APP EUI
                        "27dfe264ca33ac1957c005eb48ba4721",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN470_M5Core/Unit_LoRaWAN470_M5Core.ino b/examples/Unit_LoRaWAN470_M5Core/Unit_LoRaWAN470_M5Core.ino
@@ -51,7 +51,7 @@ void setup() {
 
     display.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("00bb9da5b97addf1",                  // Device EUI
+    LoRaWAN.configOTAA("00bb9da5b97addf1",                  // Device EUI
                        "0000000000000000",                  // APP EUI
                        "27dfe264ca33ac1957c005eb48ba4721",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN470_M5Core2/Unit_LoRaWAN470_M5Core2.ino b/examples/Unit_LoRaWAN470_M5Core2/Unit_LoRaWAN470_M5Core2.ino
@@ -51,7 +51,7 @@ void setup() {
 
     display.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("00bb9da5b97addf1",                  // Device EUI
+    LoRaWAN.configOTAA("00bb9da5b97addf1",                  // Device EUI
                        "0000000000000000",                  // APP EUI
                        "27dfe264ca33ac1957c005eb48ba4721",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN470_M5StickC/Unit_LoRaWAN470_M5StickC.ino b/examples/Unit_LoRaWAN470_M5StickC/Unit_LoRaWAN470_M5StickC.ino
@@ -51,7 +51,7 @@ void setup() {
 
     display.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("00bb9da5b97addf1",                  // Device EUI
+    LoRaWAN.configOTAA("00bb9da5b97addf1",                  // Device EUI
                        "0000000000000000",                  // APP EUI
                        "27dfe264ca33ac1957c005eb48ba4721",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN470_M5StickCPlus/Unit_LoRaWAN470_M5StickCPlus.ino b/examples/Unit_LoRaWAN470_M5StickCPlus/Unit_LoRaWAN470_M5StickCPlus.ino
@@ -51,7 +51,7 @@ void setup() {
 
     display.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("00bb9da5b97addf1",                  // Device EUI
+    LoRaWAN.configOTAA("00bb9da5b97addf1",                  // Device EUI
                        "0000000000000000",                  // APP EUI
                        "27dfe264ca33ac1957c005eb48ba4721",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN868_M5Atom/Unit_LoRaWAN868_M5Atom.ino b/examples/Unit_LoRaWAN868_M5Atom/Unit_LoRaWAN868_M5Atom.ino
@@ -44,7 +44,7 @@ void setup() {
 
     Serial.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("00bb9da5b97addf1",                  // Device EUI
+    LoRaWAN.configOTAA("00bb9da5b97addf1",                  // Device EUI
                        "0000000000000000",                  // APP EUI
                        "27dfe264ca33ac1957c005eb48ba4721",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN868_M5Core/Unit_LoRaWAN868_M5Core.ino b/examples/Unit_LoRaWAN868_M5Core/Unit_LoRaWAN868_M5Core.ino
@@ -51,7 +51,7 @@ void setup() {
 
     Serial.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("00bb9da5b97addf1",                  // Device EUI
+    LoRaWAN.configOTAA("00bb9da5b97addf1",                  // Device EUI
                        "0000000000000000",                  // APP EUI
                        "27dfe264ca33ac1957c005eb48ba4721",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN868_M5Core2/Unit_LoRaWAN868_M5Core2.ino b/examples/Unit_LoRaWAN868_M5Core2/Unit_LoRaWAN868_M5Core2.ino
@@ -51,7 +51,7 @@ void setup() {
 
     Serial.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("00bb9da5b97addf1",                  // Device EUI
+    LoRaWAN.configOTAA("00bb9da5b97addf1",                  // Device EUI
                        "0000000000000000",                  // APP EUI
                        "27dfe264ca33ac1957c005eb48ba4721",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN868_M5StickC/Unit_LoRaWAN868_M5StickC.ino b/examples/Unit_LoRaWAN868_M5StickC/Unit_LoRaWAN868_M5StickC.ino
@@ -50,7 +50,7 @@ void setup() {
 
     Serial.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("00bb9da5b97addf1",                  // Device EUI
+    LoRaWAN.configOTAA("00bb9da5b97addf1",                  // Device EUI
                        "0000000000000000",                  // APP EUI
                        "27dfe264ca33ac1957c005eb48ba4721",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN868_M5StickCPlus/Unit_LoRaWAN868_M5StickCPlus.ino b/examples/Unit_LoRaWAN868_M5StickCPlus/Unit_LoRaWAN868_M5StickCPlus.ino
@@ -50,7 +50,7 @@ void setup() {
 
     Serial.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("00bb9da5b97addf1",                  // Device EUI
+    LoRaWAN.configOTAA("00bb9da5b97addf1",                  // Device EUI
                        "0000000000000000",                  // APP EUI
                        "27dfe264ca33ac1957c005eb48ba4721",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN915_M5Atom/Unit_LoRaWAN915_M5Atom.ino b/examples/Unit_LoRaWAN915_M5Atom/Unit_LoRaWAN915_M5Atom.ino
@@ -51,7 +51,7 @@ void setup() {
 
     Serial.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("d896e0ff00000240",                  // Device EUI
+    LoRaWAN.configOTAA("d896e0ff00000240",                  // Device EUI
                        "0000000000000001",                  // APP EUI
                        "98929b92f09e2daf676d646d0f61d250",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN915_M5Core/Unit_LoRaWAN915_M5Core.ino b/examples/Unit_LoRaWAN915_M5Core/Unit_LoRaWAN915_M5Core.ino
@@ -51,7 +51,7 @@ void setup() {
 
     Serial.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("d896e0ff00000240",                  // Device EUI
+    LoRaWAN.configOTAA("d896e0ff00000240",                  // Device EUI
                        "0000000000000001",                  // APP EUI
                        "98929b92f09e2daf676d646d0f61d250",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN915_M5Core2/Unit_LoRaWAN915_M5Core2.ino b/examples/Unit_LoRaWAN915_M5Core2/Unit_LoRaWAN915_M5Core2.ino
@@ -51,7 +51,7 @@ void setup() {
 
     Serial.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("d896e0ff00000240",                  // Device EUI
+    LoRaWAN.configOTAA("d896e0ff00000240",                  // Device EUI
                        "0000000000000001",                  // APP EUI
                        "98929b92f09e2daf676d646d0f61d250",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN915_M5StickC/Unit_LoRaWAN915_M5StickC.ino b/examples/Unit_LoRaWAN915_M5StickC/Unit_LoRaWAN915_M5StickC.ino
@@ -50,7 +50,7 @@ void setup() {
 
     Serial.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("d896e0ff00000240",                  // Device EUI
+    LoRaWAN.configOTAA("d896e0ff00000240",                  // Device EUI
                        "0000000000000001",                  // APP EUI
                        "98929b92f09e2daf676d646d0f61d250",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/examples/Unit_LoRaWAN915_M5StickCPlus/Unit_LoRaWAN915_M5StickCPlus.ino b/examples/Unit_LoRaWAN915_M5StickCPlus/Unit_LoRaWAN915_M5StickCPlus.ino
@@ -51,7 +51,7 @@ void setup() {
 
     Serial.println("LoraWan config");
     // Set Join Mode OTAA.
-    LoRaWAN.configOTTA("d896e0ff00000240",                  // Device EUI
+    LoRaWAN.configOTAA("d896e0ff00000240",                  // Device EUI
                        "0000000000000001",                  // APP EUI
                        "98929b92f09e2daf676d646d0f61d250",  // APP KEY
                        "2"  // Upload Download Mode
diff --git a/library.json b/library.json
@@ -1,7 +1,7 @@
 {
   "name": "M5-LoRaWAN",
-  "description": "Library for UNIT LoRaWAN",
-  "keywords": "M5Stack Unit LoRaWAN",
+  "description": "Library for Unit LoRaWAN and Atom DTU LoRaWAN",
+  "keywords": ["M5Stack Unit LoRaWAN", "M5Stack Atom DTU LoRaWAN"],
   "authors": {
     "name": "M5Stack",
     "url": "http://www.m5stack.com"
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/m5stack/M5-LoRaWAN.git"
   },
-  "version": "0.0.1",
+  "version": "0.0.2",
   "frameworks": "arduino",
   "platforms": "espressif32"
 }
diff --git a/library.properties b/library.properties
@@ -1,8 +1,8 @@
 name=M5-LoRaWAN
-version=0.0.1
+version=0.0.2
 author=M5Stack
 maintainer=M5Stack
-sentence=Library for UNIT LoRaWAN
+sentence=Library for Unit LoRaWAN and Atom DTU LoRaWAN
 paragraph=See more on http://M5Stack.com
 category=Device Control
 url=https://github.com/m5stack/M5-LoRaWAN
diff --git a/src/M5_LoRaWAN.cpp b/src/M5_LoRaWAN.cpp
@@ -90,7 +90,7 @@ String M5_LoRaWAN::receiveMsg() {
  *  @param app_key Node AppKey
  *  @param ul_dl_mode Setting the upstream and downstream co-channel 1:
  * Co-channel mode 2: Co-channel mode */
-void M5_LoRaWAN::configOTTA(String device_eui, String app_eui, String app_key,
+void M5_LoRaWAN::configOTAA(String device_eui, String app_eui, String app_key,
                             String ul_dl_mode) {
     writeCMD("AT+CJOINMODE=0\r\n");
     writeCMD("AT+CDEVEUI=" + device_eui + "\r\n");
diff --git a/src/M5_LoRaWAN.h b/src/M5_LoRaWAN.h
@@ -26,7 +26,7 @@ class M5_LoRaWAN {
     bool checkDeviceConnect();
     bool checkJoinStatus();
     void writeCMD(String command);
-    void configOTTA(String device_eui, String app_eui, String app_key,
+    void configOTAA(String device_eui, String app_eui, String app_key,
                     String ul_dl_mode);
     void configABP(String device_addr, String app_skey, String net_skey,
                    String ul_dl_mode);

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ void setup() {`
`22`	`22`	`while (!LoRaWAN.checkDeviceConnect())`
`23`	`23`	`;`
`24`	`24`	`Serial.println("Module Config...");`
`25`		`- LoRaWAN.configOTTA("00bb9da5b97addf1", // Device EUI`
	`25`	`+ LoRaWAN.configOTAA("00bb9da5b97addf1", // Device EUI`
`26`	`26`	`"0000000000000000", // APP EUI`
`27`	`27`	`"27dfe264ca33ac1957c005eb48ba4721", // APP KEY`
`28`	`28`	`"2" // Upload Download Mode`