Use strings for keys (closes #104)

Nicolasdejean · FokkeZB · commit aa1e0edeceed · 2016-10-26T12:59:58.000+02:00
diff --git a/API.md b/API.md
@@ -55,12 +55,12 @@ See the [Receive](https://github.com/TheThingsNetwork/arduino-device-lib/blob/ma
 Activate the device via OTAA (default).
 
 ```c
-bool join(const byte appEui[8], const byte appKey[16], int8_t retries = -1, uint32_t retryDelay = 10000);
+bool join(const char *appEui, const char *appKey, int8_t retries = -1, uint32_t retryDelay = 10000);
 bool join(int8_t retries = -1, uint32_t retryDelay = 10000);
 ```
 
-- `const byte appEui[8]`: Application EUI the device is registered to.
-- `const byte appKey[16]`: Application Key assigned to the device.
+- `const char *appEui`: Application EUI the device is registered to.
+- `const char *appKey`: Application Key assigned to the device.
 - `int8_t retries = -1`: Number of times to retry after failed or unconfirmed join. Defaults to `-1` which means infinite.
 - `uint32_t retryDelay = 10000`: Delay in ms between attempts. Defaults to 10 seconds.
 
@@ -72,13 +72,13 @@ Call the method without the first two arguments if the device's LoRa module come
 Activate the device via ABP.
 
 ```c
-bool personalize(const byte devAddr[4], const byte nwkSKey[16], const byte appSKey[16]);
+bool personalize(const char *devAddr, const char *nwkSKey, const char *appSKey);
 bool personalize();
 ```
 
-- `const byte devAddr[4]`: Device Address assigned to the device.
-- `const byte nwkSKey[16]`: Network Session Key assigned to the device for identification.
-- `const byte appSKey[16]`: Application Session Key assigned to the device for encryption.
+- `const char *devAddr`: Device Address assigned to the device.
+- `const char *nwkSKey`: Network Session Key assigned to the device for identification.
+- `const char *appSKey`: Application Session Key assigned to the device for encryption.
 
 Returns `true` or `false` depending on whether the activation was successful.
 
@@ -124,8 +124,8 @@ See the [Receive](https://github.com/TheThingsNetwork/arduino-device-lib/blob/ma
 Sets the information needed to activate the device via OTAA, without actually activating. Call join() without the first 2 arguments to activate.
 
 ```c
-bool provision(const byte appEui[8], const byte appKey[16]);
+bool provision(const char *appEui, const char *appKey);
 ```
 
-- `const byte appEui[8]`: Application Identifier for the device.
-- `const byte appKey[16]`: Application Key assigned to the device.
+- `const char *appEui`: Application Identifier for the device.
+- `const char *appKey`: Application Key assigned to the device.
diff --git a/examples/ABP/ABP.ino b/examples/ABP/ABP.ino
@@ -1,9 +1,9 @@
 #include <TheThingsNetwork.h>
 
 // Set your DevAddr, NwkSKey and AppSKey
-const byte devAddr[4] = {0x00, 0x00, 0x00, 0x00};
-const byte nwkSKey[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
-const byte appSKey[16] = {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
+const char *devAddr = "00000000";
+const char *nwkSKey = "00000000000000000000000000000000";
+const char *appSKey = "00000000000000000000000000000000";
 
 #define loraSerial Serial1
 #define debugSerial Serial
diff --git a/examples/DeviceInfo/DeviceInfo.ino b/examples/DeviceInfo/DeviceInfo.ino
@@ -20,6 +20,6 @@ void loop()
   debugSerial.println("Use the EUI to register the device for OTAA");
   debugSerial.println("-------------------------------------------");
   debugSerial.println();
-  
+
   delay(10000);
 }
diff --git a/examples/QuickStart/QuickStart.ino b/examples/QuickStart/QuickStart.ino
@@ -1,8 +1,8 @@
 #include <TheThingsNetwork.h>
 
 // Set your AppEUI and AppKey
-const byte appEui[8] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
-const byte appKey[16] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
+const char *appEui = "0000000000000000";
+const char *appKey = "00000000000000000000000000000000";
 
 #define loraSerial Serial1
 #define debugSerial Serial
diff --git a/examples/Receive/Receive.ino b/examples/Receive/Receive.ino
@@ -1,8 +1,8 @@
 #include <TheThingsNetwork.h>
 
 // Set your AppEUI and AppKey
-const byte appEui[8] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
-const byte appKey[16] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
+const char *appEui = "0000000000000000";
+const char *appKey = "00000000000000000000000000000000";
 
 #define loraSerial Serial1
 #define debugSerial Serial
diff --git a/examples/Send/Send.ino b/examples/Send/Send.ino
@@ -1,8 +1,8 @@
 #include <TheThingsNetwork.h>
 
 // Set your AppEUI and AppKey
-const byte appEui[8] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
-const byte appKey[16] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
+const char *appEui = "0000000000000000";
+const char *appKey = "00000000000000000000000000000000";
 
 #define loraSerial Serial1
 #define debugSerial Serial
diff --git a/examples/Sensors/DHT/DHT.ino b/examples/Sensors/DHT/DHT.ino
@@ -4,8 +4,8 @@
 #include <DHT.h>
 
 // Set your AppEUI and AppKey
-const byte appEui[8] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
-const byte appKey[16] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
+const char *appEui = "0000000000000000";
+const char *appKey = "00000000000000000000000000000000";
 
 #define loraSerial Serial1
 #define debugSerial Serial
diff --git a/examples/Sensors/LightSensor/LightSensor.ino b/examples/Sensors/LightSensor/LightSensor.ino
@@ -1,8 +1,8 @@
 #include <TheThingsNetwork.h>
 
 // Set your AppEUI and AppKey
-const byte appEui[8] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
-const byte appKey[16] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
+const char *appEui = "0000000000000000";
+const char *appKey = "00000000000000000000000000000000";
 
 //define AnalogPin for sensor
 #define LightPin A0
diff --git a/examples/Workshop/Workshop.ino b/examples/Workshop/Workshop.ino
@@ -6,16 +6,16 @@
 // After you registered your ABP device, go to The Things Network Dashboard
 // and copy the Device Addr, Network Session Key and App Session Key
 
-// Set your Device Address, for example: { 0x02, 0xDE, 0xAE, 0x00 };
-const byte devAddr[4] = { ... };
+// Set your Device Address, for example: "1C55B133";
+const char *devAddr = "00000000";
 
-// Set your Network Session Key, for example: { 0x2B, 0x7E, 0x15, 0x16, ... };
+// Set your Network Session Key, for example: "0C11F84C5E4315CCDE50AB31C430BBE5";
 // This is used by the network to identify your device
-const byte nwkSKey[16] = { ... };
+const char *nwkSKey = "00000000000000000000000000000000";
 
-// Set your Application Session Key, for example: { 0x2B, 0x7E, 0x15, 0x16, ... };
+// Set your Application Session Key, for example: "6C250A6B559B1BA0A51696ED20E3CF56";
 // This is used by the network for encryption
-const byte appSKey[16] = { ... };
+const char *appSKey = "00000000000000000000000000000000";
 
 #define loraSerial Serial1
 #define debugSerial Serial
diff --git a/src/TheThingsNetwork.cpp b/src/TheThingsNetwork.cpp
@@ -100,11 +100,20 @@ void TheThingsNetwork::onMessage(void (*cb)(const byte* payload, size_t length,
   this->messageCallback = cb;
 }
 
-bool TheThingsNetwork::personalize(const byte devAddr[4], const byte nwkSKey[16], const byte appSKey[16]) {
+bool TheThingsNetwork::personalize(const char *devAddr, const char *nwkSKey, const char *appSKey) {
   reset();
-  sendCommand(F("mac set devaddr"), devAddr, 4);
-  sendCommand(F("mac set nwkskey"), nwkSKey, 16);
-  sendCommand(F("mac set appskey"), appSKey, 16);
+  String addr = "mac set devaddr ";
+  addr.concat(devAddr);
+  sendCommand(addr);
+
+  String nKey = "mac set nwkskey ";
+  nKey.concat(nwkSKey);
+  sendCommand(nKey);
+
+  String aKey = "mac set appskey ";
+  aKey.concat(appSKey);
+  sendCommand(aKey);
+
   return personalize();
 }
 
@@ -124,9 +133,15 @@ bool TheThingsNetwork::personalize() {
   return true;
 }
 
-bool TheThingsNetwork::provision(const byte appEui[8], const byte appKey[16]) {
-  sendCommand(F("mac set appeui"), appEui, 8);
-  sendCommand(F("mac set appkey"), appKey, 16);
+bool TheThingsNetwork::provision(const char *appEui, const char *appKey) {
+  String eui = "mac set appeui ";
+  eui.concat(appEui);
+  sendCommand(eui);
+
+  String key = "mac set appkey ";
+  key.concat(appKey);
+  sendCommand(key);
+
   return sendCommand(F("mac save"));
 }
 
@@ -163,7 +178,7 @@ bool TheThingsNetwork::join(int8_t retries, uint32_t retryDelay) {
   return false;
 }
 
-bool TheThingsNetwork::join(const byte appEui[8], const byte appKey[16], int8_t retries, uint32_t retryDelay) {
+bool TheThingsNetwork::join(const char *appEui, const char *appKey, int8_t retries, uint32_t retryDelay) {
   reset();
   provision(appEui, appKey);
   return join(retries, retryDelay);
diff --git a/src/TheThingsNetwork.h b/src/TheThingsNetwork.h
@@ -51,7 +51,7 @@ class TheThingsNetwork
     String readValue(String key);
     bool sendCommand(String cmd);
     bool sendCommand(String cmd, String value);
-    bool sendCommand(String cmd, const byte* buf, size_t length);
+    bool sendCommand(String cmd, const byte *buf, size_t length);
     void reset(bool adr = true);
     void configureEU868(uint8_t sf);
     void configureUS915(uint8_t sf, uint8_t fsb);
@@ -61,10 +61,10 @@ class TheThingsNetwork
     TheThingsNetwork(Stream& modemStream, Stream& debugStream, ttn_fp_t fp, uint8_t sf = TTN_DEFAULT_SF, uint8_t fsb = TTN_DEFAULT_FSB);
     void showStatus();
     void onMessage(void (*cb)(const byte* payload, size_t length, port_t port));
-    bool provision(const byte appEui[8], const byte appKey[16]);
-    bool join(const byte appEui[8], const byte appKey[16], int8_t retries = -1, uint32_t retryDelay = 10000);
+    bool provision(const char *appEui, const char *appKey);
+    bool join(const char *appEui, const char *appKey, int8_t retries = -1, uint32_t retryDelay = 10000);
     bool join(int8_t retries = -1, uint32_t retryDelay = 10000);
-    bool personalize(const byte devAddr[4], const byte nwkSKey[16], const byte appSKey[16]);
+    bool personalize(const char *devAddr, const char *nwkSKey, const char *appSKey);
     bool personalize();
     int sendBytes(const byte* payload, size_t length, port_t port = 1, bool confirm = false);
     int poll(port_t port = 1, bool confirm = false);

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,6 @@ void loop()`
`20`	`20`	`debugSerial.println("Use the EUI to register the device for OTAA");`
`21`	`21`	`debugSerial.println("-------------------------------------------");`
`22`	`22`	`debugSerial.println();`
`23`		`-`
	`23`	`+`
`24`	`24`	`delay(10000);`
`25`	`25`	`}`