Merge pull request #199 from TheThingsNetwork/asian-frequency-plans

Asian frequency plans

Author: johanstokking

docs/TheThingsNetwork.md

@@ -14,9 +14,9 @@ TheThingsNetwork ttn(Stream& modemStream, Stream& debugStream, fp_ttn_t fp, uint
 
 - `Stream& modemStream`: Stream for the LoRa modem ([see notes](https://www.thethingsnetwork.org/docs/devices/arduino/usage.html)).
 - `Stream& debugStream`: Stream to write debug logs to ([see notes](https://www.thethingsnetwork.org/docs/devices/arduino/usage.html)).
-- `fp_ttn_fp fp`: The frequency plan: `TTN_FP_EU868` or `TTN_FP_US915` depending on the region you deploy in.
-- `uint8_t sf = 7`: Optional custom spreading factor. Can be `7` to `12` for `TTN_FP_EU868` and `7` to `10` for `TTN_FP_US915`. Defaults to `7`.
-- `uint8_t fsb = 2`: Optional custom frequency sub-band. Can be `1` to `8`. Defaults to `2` (for US915).
+- `fp_ttn_fp fp`: The frequency plan: `TTN_FP_EU868`, `TTN_FP_US915`, `TTN_FP_AS920_923`, `TTN_FP_AS923_925` or `TTN_FP_KR920_923` depending on the region you deploy in. See [the wiki](https://www.thethingsnetwork.org/wiki/LoRaWAN/Frequencies/Frequency-Plans).
+- `uint8_t sf = 7`: Optional custom spreading factor. Can be `7` to `10` for `TTN_FP_US915` and `7` to `12` for other frequency plans. Defaults to `7`.
+- `uint8_t fsb = 2`: Optional custom frequency subband. Can be `1` to `8`. Defaults to `2` (for US915).
 
 ## Method: `reset`
 

keywords.txt

@@ -74,7 +74,10 @@ TTN_ERROR_UNEXPECTED_RESPONSE  LITERAL1
 TTN_SUCCESSFUL_TRANSMISSION    LITERAL1
 TTN_SUCCESSFUL_RECEIVE         LITERAL1
 TTN_FP_EU868                   LITERAL1
-TTN_FP_EU915                   LITERAL1
+TTN_FP_US915                   LITERAL1
+TTN_FP_AS920_923               LITERAL1
+TTN_FP_AS923_925               LITERAL1
+TTN_FP_KR920_923               LITERAL1
 
 TTN_PIN_LED                    LITERAL1
 
@@ -86,4 +89,4 @@ TTN_YELLOW                     LITERAL1
 TTN_CYAN                       LITERAL1
 TTN_MAGENTA                    LITERAL1
 TTN_WHITE                      LITERAL1
-TTN_BLACK                      LITERAL1
+TTN_BLACK                      LITERAL1

src/TheThingsNetwork.cpp

@@ -486,15 +486,7 @@ bool TheThingsNetwork::provision(const char *appEui, const char *appKey)
   sendMacSet(MAC_DEVEUI, buffer);
   sendMacSet(MAC_APPEUI, appEui);
   sendMacSet(MAC_APPKEY, appKey);
-  switch (fp)
-  {
-  case TTN_FP_AS920_923:
-    // TODO: temporarily removed 'mac save' because RN2903AS crashes on this command!
-    break;
-  default:
-    saveState();
-    break;
-  }
+  saveState();
   return true;
 }
 
@@ -658,6 +650,10 @@ void TheThingsNetwork::configureUS915(uint8_t fsb)
 
 void TheThingsNetwork::configureAS920_923()
 {
+  /* RN2903AS 1.0.3rc9 defaults
+   * CH0 = 923.2MHz
+   * CH1 = 923.4MHz
+   */
   sendMacSet(MAC_ADR, "off"); // TODO: remove when ADR is implemented for this plan
   sendMacSet(MAC_RX2, "2 923200000");
 
@@ -681,10 +677,67 @@ void TheThingsNetwork::configureAS920_923()
   //sendChSet(MAC_CHANNEL_FREQ, 8, "922100000");
   //sendChSet(MAC_CHANNEL_DRRANGE, 8, "6 6");
   //sendChSet(MAC_CHANNEL_STATUS, 8, "on");
-  // TODO: Add FSK channel
+  // TODO: Add FSK channel on 921800000
   sendMacSet(MAC_PWRIDX, TTN_PWRIDX_AS920_923);
 }
 
+void TheThingsNetwork::configureAS923_925()
+{
+  /* RN2903AS 1.0.3rc9 defaults
+   * CH0 = 923.2MHz
+   * CH1 = 923.4MHz
+   */
+  sendMacSet(MAC_ADR, "off"); // TODO: remove when ADR is implemented for this plan
+  sendMacSet(MAC_RX2, "2 923200000");
+
+  char buf[10];
+  uint32_t freq = 923600000;
+  uint8_t ch;
+  for (ch = 0; ch < 8; ch++)
+  {
+    sendChSet(MAC_CHANNEL_DCYCLE, ch, "799");
+    if (ch > 1)
+    {
+      sprintf(buf, "%lu", freq);
+      sendChSet(MAC_CHANNEL_FREQ, ch, buf);
+      sendChSet(MAC_CHANNEL_DRRANGE, ch, "0 5");
+      sendChSet(MAC_CHANNEL_STATUS, ch, "on");
+      freq = freq + 200000;
+    }
+  }
+  // TODO: SF7BW250/DR6 channel, not properly supported by RN2903AS yet
+  //sendChSet(MAC_CHANNEL_DCYCLE, 8, "799");
+  //sendChSet(MAC_CHANNEL_FREQ, 8, "924500000");
+  //sendChSet(MAC_CHANNEL_DRRANGE, 8, "6 6");
+  //sendChSet(MAC_CHANNEL_STATUS, 8, "on");
+  // TODO: Add FSK channel on 924800000
+  sendMacSet(MAC_PWRIDX, TTN_PWRIDX_AS923_925);
+}
+
+void TheThingsNetwork::configureKR920_923()
+{
+  sendMacSet(MAC_ADR, "off"); // TODO: remove when ADR is implemented for this plan
+  sendMacSet(MAC_RX2, "0 921900000"); // KR still uses SF12 for now. Might change to SF9 later.
+
+  //disable two default LoRaWAN channels
+  sendChSet(MAC_CHANNEL_STATUS, 0, "off");
+  sendChSet(MAC_CHANNEL_STATUS, 1, "off");
+
+  char buf[10];
+  uint32_t freq = 922100000;
+  uint8_t ch;
+  for (ch = 2; ch < 9; ch++)
+  {
+    sendChSet(MAC_CHANNEL_DCYCLE, ch, "799");
+    sprintf(buf, "%lu", freq);
+    sendChSet(MAC_CHANNEL_FREQ, ch, buf);
+    sendChSet(MAC_CHANNEL_DRRANGE, ch, "0 5");
+    sendChSet(MAC_CHANNEL_STATUS, ch, "on");
+    freq = freq + 200000;
+  }
+  sendMacSet(MAC_PWRIDX, TTN_PWRIDX_KR920_923);
+}
+
 void TheThingsNetwork::configureChannels(uint8_t fsb)
 {
   switch (fp)
@@ -698,6 +751,12 @@ void TheThingsNetwork::configureChannels(uint8_t fsb)
   case TTN_FP_AS920_923:
     configureAS920_923();
     break;
+  case TTN_FP_AS923_925:
+    configureAS923_925();
+    break;
+  case TTN_FP_KR920_923:
+    configureKR920_923();
+    break;
   default:
     debugPrintMessage(ERR_MESSAGE, ERR_INVALID_FP);
     break;
@@ -712,6 +771,8 @@ bool TheThingsNetwork::setSF(uint8_t sf)
   {
   case TTN_FP_EU868:
   case TTN_FP_AS920_923:
+  case TTN_FP_AS923_925:
+  case TTN_FP_KR920_923:
     dr = 12 - sf;
     break;
   case TTN_FP_US915:

src/TheThingsNetwork.h

@@ -15,6 +15,8 @@
 #define TTN_PWRIDX_EU868 "1"
 #define TTN_PWRIDX_US915 "5"
 #define TTN_PWRIDX_AS920_923 "1" // TODO: should be 0, but the current RN2903AS firmware doesn't accept that value (probably still using EU868: 1=14dBm)
+#define TTN_PWRIDX_AS923_925 "1" // TODO: should be 0
+#define TTN_PWRIDX_KR920_923 "1" // TODO: should be 0
 
 #define TTN_BUFFER_SIZE 300
 
@@ -32,7 +34,9 @@ enum ttn_fp_t
 {
   TTN_FP_EU868,
   TTN_FP_US915,
-  TTN_FP_AS920_923
+  TTN_FP_AS920_923,
+  TTN_FP_AS923_925,
+  TTN_FP_KR920_923
 };
 
 class TheThingsNetwork
@@ -60,6 +64,8 @@ class TheThingsNetwork
   void configureEU868();
   void configureUS915(uint8_t fsb);
   void configureAS920_923();
+  void configureAS923_925();
+  void configureKR920_923();
   void configureChannels(uint8_t fsb);
   bool setSF(uint8_t sf);
   bool waitForOk();

test/TheThingsNetwork/TheThingsNetwork.ino

@@ -12,9 +12,10 @@ const char *appSKey = "00000000000000000000000000000000";
 
 TheThingsNetwork ttn(loraSerial, debugSerial, TTN_FP_EU868);
 
-TheThingsNetwork ttn2(loraSerial, debugSerial, TTN_FP_EU868, 10);
+TheThingsNetwork ttn2(loraSerial, debugSerial, TTN_FP_US915, 10);
+
+TheThingsNetwork ttn3(loraSerial, debugSerial, TTN_FP_AS923_925, 10, 4);
 
-TheThingsNetwork ttn3(loraSerial, debugSerial, TTN_FP_EU868, 10, 4);
 
 void setup()
 {