Add comments

Arduino/Arduino.ino

@@ -1,28 +1,5 @@
-/*
- MIT License
-
-Copyright (c) 2017 Maxime Coutte Peroumal Corne
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
- */
-
-
+// This simple code allow you to send data from Arduino to Unity3D.
+
 // uncomment "NATIVE_USB" if you're using ARM CPU (Arduino DUE, Arduino M0, ..)
 #define NATIVE_USB
 
@@ -39,22 +16,20 @@ void setup() {
     Serial.begin(250000); // You can choose any baudrate, just need to also change it in Unity.
     while (!Serial); // wait for Leonardo enumeration, others continue immediately
   #endif
-
-
 }
 
+// Run forever
 void loop() {
   sendData("Hello World!");
-  delay(5);
+  delay(5); // Choose your delay having in mind your ReadTimeout in Unity3D
 }
 
 void sendData(String data){
    #ifdef NATIVE_USB
-    SerialUSB.println(data); // need a end-line
+    SerialUSB.println(data); // need a end-line because wrmlh.csharp use readLine method to receive data 
   #endif
 
   #ifdef SERIAL_USB
-    Serial.println(data); // need a end-line
+    Serial.println(data); // need a end-line because wrmlh.csharp use readLine method to receive data
   #endif
 }
-

Assets/WRMHL/Scripts/Manager/wrmhl.cs

@@ -26,7 +26,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 using System.Collections.Generic;
 using UnityEngine;
 
-// This class allow you to establish the connection between your device and Unity by setting-up Thread.
+// This class allow you to establish the connection between your device and Unity by setting-up Thread and manage these Thread.
 public class wrmhl {
 
 	// ========================================================================================

Assets/WRMHL/Scripts/wrmhlRead.cs

@@ -2,7 +2,21 @@
 using System.Collections.Generic;
 using UnityEngine;
 
-// This script is used to read the data coming from the device.
+/*
+This script is used to read all the data coming from the device. For instance,
+If arduino send ->
+								{"1",
+								"2",
+								"3",}
+readQueue() will return ->
+								"1", for the first call
+								"2", for the second call
+								"3", for the thirst call
+
+This is the perfect script for integration that need to avoid data loose.
+If you need speed and low latency take a look to wrmhlReadLatest.
+*/
+
 public class wrmhlRead : MonoBehaviour {
 
 	wrmhl myDevice = new wrmhl(); // wrmhl is the bridge beetwen your computer and hardware.

Assets/WRMHL/Scripts/wrmhlReadLatest.cs

@@ -2,7 +2,19 @@
 using System.Collections.Generic;
 using UnityEngine;
 
-// This script is used to read the data coming from the device.
+/*
+This script is used to read the latest data coming from the device. For instance,
+If arduino send ->
+								{"1",
+								"2",
+								"3",}
+readLatest() will return ->
+								"3"
+
+This is the perfect script for integration that need speed and low latency.
+If you need to avoid data loose take a look to wrmhlRead.
+*/
+
 public class wrmhlReadLatest : MonoBehaviour {
 
 	wrmhl myDevice = new wrmhl(); // wrmhl is the bridge beetwen your computer and hardware.

ProjectSettings/ProjectVersion.txt

@@ -1 +1 @@
-m_EditorVersion: 5.6.3p2
+m_EditorVersion: 2017.2.0f3

UnityPackageManager/manifest.json

@@ -0,0 +1,4 @@
+{
+	"dependencies": {
+	}
+}