Added compatibility for Linino openWRT embedded Linux OS. Refactored file names for credential/codebase setup shell scripts.

Author: ZENG

AWS-IoT-Arduino-Yun-Library/aws_iot_config_SDK.h

@@ -16,9 +16,9 @@
 #ifndef config_h
 #define config_h
 
-#define MAX_BUF_SIZE 256                // maximum number of bytes to publish/receive
-#define MAX_SUB 15                // maximum number of subscribe
-#define CMD_TIME_OUT 100                // maximum time to wait for feedback from AR9331, 100 = 10 sec
-#define MAX_SHADOW_TOPIC_LEN 64               // maximum length for shadow topic, the metadata length for shadow topic is 32, make sure your thing name length plus that does not exceed this limit
+#define MAX_BUF_SIZE 256										// maximum number of bytes to publish/receive
+#define MAX_SUB 15 												// maximum number of subscribe
+#define CMD_TIME_OUT 100										// maximum time to wait for feedback from AR9331, 100 = 10 sec
+#define MAX_SHADOW_TOPIC_LEN 64                                 // maximum length for shadow topic, the metadata length for shadow topic is 32, make sure your thing name length plus that does not exceed this limit
 
 #endif

AWS-IoT-Arduino-Yun-Library/aws_iot_error.h

@@ -33,7 +33,9 @@ typedef enum {
 	SHADOW_GET_ERROR = -13,
 	SHADOW_DELETE_ERROR = -14,
 	CONFIG_ERROR = -15,
-	OUT_OF_SKETCH_SUBSCRIBE_MEMORY = -16
+	OUT_OF_SKETCH_SUBSCRIBE_MEMORY = -16,
+	SERIAL1_COMMUNICATION_ERROR = -17
 } IoT_Error_t;
 
-#endif
+#endif
+

AWS-IoT-Arduino-Yun-Library/aws_iot_mqtt.cpp

@@ -20,43 +20,91 @@
 #include "string.h"
 #include "ctype.h"
 
-#define linux_baud 250000
+#define LINUX_BAUD_DEFAULT 250000
+#define LINUX_BAUD_LININO 115200
 #define SHADOW_TOPIC_FIXED_LEN 32 // strlen("$aws/things/") + strlen("/shadow/update/delta")
 #define RETURN_KEY 13 // ASCII code for '\r'
 #define NEXTLINE_KEY 10 // ASCII code for '\n'
+#define MAX_NUM_PARA 7 // Maximum number of parameters in protocol communication
 
 const char* OUT_OF_BUFFER_ERR_MSG = "OUT OF BUFFER SIZE";
 
-IoT_Error_t aws_iot_mqtt_client::setup(char* client_id, bool clean_session, MQTTv_t MQTT_version) {
+// Choose different baudrate for different version of openWRT OS
+Baud_t aws_iot_mqtt_client::find_baud_type() {
+	Baud_t rc_type = BAUD_TYPE_UNKNOWN;
+	// 1st attempt
+	Serial1.begin(LINUX_BAUD_DEFAULT);
+	while(!Serial1);
+	exec_cmd("\n", true, false); // jump over the welcoming prompt for Open WRT
+	delay(1000); // in case this is the first boot-up
+	int i;
+	for(i = 0; i < MAX_NUM_PARA + 1; i++) {
+		// exit the previous python process and jump over the half-baked protocol communication
+		exec_cmd("~\n", true, false);
+	}
+	delay(1500); // delay 1500 ms for all related python script to exit
+
+	exec_cmd("uname\n", true, false); // check OS version
+	if(strncmp(rw_buf, "Linux", 5) != 0) { // Not an Arduino?
+		Serial1.begin(LINUX_BAUD_LININO);
+		while(!Serial1);
+		exec_cmd("\n", true, false); // jump over the welcoming prompt for Open WRT
+		delay(1000); // in case this is the first boot-up
+		int i;
+		for(i = 0; i < MAX_NUM_PARA + 1; i++) {
+			// exit the previous python process and jump over all possible half-baked protocol communication
+			exec_cmd("~\n", true, false);
+		}
+		delay(1500); // delay 1500 ms for all related python script to exit
+
+		exec_cmd("uname\n", true, false); // check OS version
+		if(strncmp(rw_buf, "Linux", 5) != 0) {
+			// No more board types to try
+		}
+		else {rc_type = BAUD_TYPE_LININO;}
+	}
+	else {rc_type = BAUD_TYPE_ARDUINO;}
+
+	return rc_type;
+}
+
+IoT_Error_t aws_iot_mqtt_client::setup_exec(char* client_id, bool clean_session, MQTTv_t MQTT_version) {
+	// Serial1 is started before this call
 	IoT_Error_t rc = NONE_ERROR;
-	if(client_id == NULL) {rc = NULL_VALUE_ERROR;}
-	else if(strlen(client_id) >= MAX_BUF_SIZE) {rc = OVERFLOW_ERROR;}
-	else {
-		my_client_id = client_id;
-		// Start Serial1
-		Serial1.begin(linux_baud);
-		while(!Serial1); // blocking until Serial1 is ready
+	exec_cmd("cd /root\n", false, false);
+	exec_cmd("python aws_iot_mqtt_client.py\n", false, false);
 
-		exec_cmd("cd .\n", false, false); // placeholder: jump over the welcoming prompt for Open WRT
-		exec_cmd("cd /root\n", false, false);
-	    	exec_cmd("~\n", true, false); // exit the previous python process
-	    	delay(1000); // delay 1000 ms for all related python script to exit
-		exec_cmd("python aws_iot_mqtt_client.py\n", false, false);
+	// Create obj
+	exec_cmd("i\n", false, false);
 
-		// Create obj
-		exec_cmd("i\n", false, false);
+	sprintf(rw_buf, "%s\n", client_id);
+	exec_cmd(rw_buf, false, false);
 
-		sprintf(rw_buf, "%s\n", client_id);
-		exec_cmd(rw_buf, false, false);
+	int num_temp = clean_session ? 1 : 0;
+	sprintf(rw_buf, "%d\n", num_temp);
+	exec_cmd(rw_buf, false, false);
 
-		int num_temp = clean_session ? 1 : 0;
-		sprintf(rw_buf, "%d\n", num_temp);
-		exec_cmd(rw_buf, false, false);
+	sprintf(rw_buf, "%u\n", MQTT_version);
+	exec_cmd(rw_buf, true, false);
 
-		sprintf(rw_buf, "%u\n", MQTT_version);
-		exec_cmd(rw_buf, true, false);
+	if(strncmp(rw_buf, "I T", 3) != 0) {rc = SET_UP_ERROR;}
 
-		if(strncmp(rw_buf, "I T", 3) != 0) {rc = SET_UP_ERROR;}
+	return rc;
+}
+
+IoT_Error_t aws_iot_mqtt_client::setup(char* client_id, bool clean_session, MQTTv_t MQTT_version) {
+	IoT_Error_t rc = NONE_ERROR;
+	if(client_id == NULL) {rc = NULL_VALUE_ERROR;}
+	else if(strlen(client_id) >= MAX_BUF_SIZE) {rc = OVERFLOW_ERROR;}
+	// No input error below this line
+	else {
+		my_client_id = client_id;
+		Baud_t baud_type = find_baud_type(); // Find out baud type
+		// Communication failed due to baud rate issue
+		if(BAUD_TYPE_UNKNOWN == baud_type) {rc = SERIAL1_COMMUNICATION_ERROR;}
+		else {
+			rc = setup_exec(client_id, clean_session, MQTT_version);
+		}
 	}
 
 	return rc;

AWS-IoT-Arduino-Yun-Library/aws_iot_mqtt.h

@@ -26,6 +26,12 @@ typedef enum {
 	MQTTv311 = 4
 } MQTTv_t;
 
+typedef enum {
+	BAUD_TYPE_UNKNOWN = -1,
+	BAUD_TYPE_ARDUINO = 0,
+	BAUD_TYPE_LININO = 1
+} Baud_t;
+
 typedef void(*message_callback)(char*, int);
 
 class aws_iot_mqtt_client {
@@ -70,6 +76,8 @@ class aws_iot_mqtt_client {
 		bool timeout_flag; // Is there a timeout when executing RPC
 		unsigned int ThingShadow_req_num; // sequence number for ThingShadow request
 		IoT_Error_t base_subscribe(char* topic, int qos, message_callback cb, int is_delta);
+		Baud_t find_baud_type();
+		IoT_Error_t setup_exec(char* client_id, bool clean_session, MQTTv_t MQTT_version);
 		void exec_cmd(const char* cmd, bool wait, bool single_line);
 		bool is_num(char* src);
 };

AWS-IoT-Arduino-Yun-Library/aws_iot_version.h

@@ -18,7 +18,7 @@
 
 #define VERSION_MAJOR 1
 #define VERSION_MINOR 0
-#define VERSION_PATCH 1
+#define VERSION_PATCH 2
 #define VERSION_TAG ""
 
 #endif

AWS-IoT-Arduino-Yun-Library/keywords.txt

@@ -1,18 +1,18 @@
 aws_iot_mqtt	KEYWORD1
 aws_iot_mqtt_client	KEYWORD1
-aws_iot_version	KEYWORD1
-aws_iot_config	KEYWORD1
-setup	KEYWORD2
-config	KEYWORD2
-connect	KEYWORD2
-publish	KEYWORD2
-subscribe	KEYWORD2
-unsubscribe	KEYWORD2
-disconnect	KEYWORD2
-yield	KEYWORD2
-shadow_init	KEYWORD2
+aws_iot_version		KEYWORD1
+aws_iot_config		KEYWORD1
+setup			KEYWORD2
+config			KEYWORD2
+connect			KEYWORD2
+publish			KEYWORD2
+subscribe		KEYWORD2
+unsubscribe		KEYWORD2
+disconnect		KEYWORD2
+yield			KEYWORD2
+shadow_init		KEYWORD2
 shadow_register_delta_func	KEYWORD2
 shadow_unregister_delta_func	KEYWORD2
-shadow_get	KEYWORD2
-shadow_update	KEYWORD2
-shadow_delete	KEYWORD2
+shadow_get			KEYWORD2
+shadow_update			KEYWORD2
+shadow_delete			KEYWORD2

CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.0.2 (November 5, 2015)
+Features:
+
+N/A
+
+Bugfixes/Improvements:
+
+* Added compatibility for Linino openWRT embedded Linux OS (BusyBox v1.19.4 2015-10-03 14:03:26 CEST)
+* Refactored file names for credential/codebase upload shell scripts and environment setup shell scripts
+
 # 1.0.1 (November 3, 2015)
 Features:
 

README.md

@@ -43,10 +43,10 @@ For Arduino IDE installation on Linux, please visit [here](http://playground.ard
 2. Make sure your computer is connected to the same network (local IP address range).  
 3. Download the AWS IoT CA file from [here](https://www.symantec.com/content/en/us/enterprise/verisign/roots/VeriSign-Class%203-Public-Primary-Certification-Authority-G5.pem).
 4. Put your AWS IoT CA file, private key and certificate into `AWS-IoT-Arduino-Yun-SDK/certs`.  
-5. Under `AWS-IoT-Arduino-Yun-SDK`, Modify `mySCP.sh` and `mySETUP.sh` and replace `[your_boards_IP]` with your board’s IP address and `[your_boards_IP]` with your password (default for Arduino Yún: “arduino”).  
-6. Open a terminal, cd to `AWS-IoT-Arduino-Yun-SDK`. Do `chmod 755 mySCP.sh` and execute it as `./mySCP.sh`.  
+5. Under `AWS-IoT-Arduino-Yun-SDK`, Modify `codebase_upload.sh` and `environment_setup.sh` and replace `[your_boards_IP]` with your board’s IP address and `[your_boards_IP]` with your password (default for Arduino Yún: “arduino”).  
+6. Open a terminal, cd to `AWS-IoT-Arduino-Yun-SDK`. Do `chmod 755 codebase_upload.sh` and execute it as `./codebase_upload.sh`.  
 	This will upload the python code and keys, CA files and certificates to openWRT running on the more powerful microcontroller on you Arduino Yún board.
-7. In the same directory, do `chmod 755 mySETUP.sh` and execute it as `./mySETUP.sh`.  
+7. In the same directory, do `chmod 755 environment_setup.sh` and execute it as `./environment_setup.sh`.  
 	This will download and install libraries for openWRT to implement the necessary scripting environment as well as communication protocols.
 
   Step 7 can take 15-20 minutes for the device to download and install the required packages (distribute, python-openssl, pip, paho-mqtt).  
@@ -582,7 +582,8 @@ The following error codes are defined in `AWS-IoT-Arduino-Yun-Library/aws_iot_er
 		SHADOW_GET_ERROR = -13,
 		SHADOW_DELETE_ERROR = -14,
 		CONFIG_ERROR = -15,
-		OUT_OF_SKETCH_SUBSCRIBE_MEMORY = -16
+		OUT_OF_SKETCH_SUBSCRIBE_MEMORY = -16,
+		SERIAL1_COMMUNICATION_ERROR = -17
 	} IoT_Error_t;
 
 <a name="support"></a>