new version

Author: lgund

del/new.js

@@ -1,21 +1,21 @@
 /*
-	Include das Express Modul
+	Express Modul eingebunden (stellt für den Webserver statische Dateien bereit )
 */
 var express 		= 	require("express")
 ,	app 			= 	express();
 
 /*
-	Include das HTTP Modul
+	HTTP Modul eingebunden (stellt Webserverdienste bereit, Zur deklaration eines Ports verwendet)
 */
 var	server		=	require("http").createServer(app);
 
 /*
-	Include das Socket Modul
+	Socket Modul eingebunden (ermöglicht Kommunikation zwischen Webinterface und main.js. Informationsübermittlung via Socket Event)
 */
-var	io			=	require("socket.io")(server);
+var	io						=	require("socket.io")(server);
 
 /*
-	Include  das MIP Modul
+	MIP Modul eingebunden (SDK beinhaltet Funktionen und Definitionen zur Bluetoothansteuerung des MIP und seiner Bestandteile)
 */
 var mip 					= 	require("wowweemip")
 ,	mipFinder				= 	new mip.Finder()
@@ -24,37 +24,45 @@ var mip 					= 	require("wowweemip")
 /*
 	Definitionen
 */
-const PORT					=	5000;
-const DEBUG					=	true;
+const PORT					=	5000;						//Der Port wurde als 5000 definiert, kann jedoch geändert werden
+const DEBUG					=	true;						//Sollen Zusaetzliche Informationen in der Shellconsole angezeigt werden?
 
-function Bot(bot)
+/*
+	Object: Bot
+*/
+function Bot(bot)											//Funktion zur Abfrage von verfügbaren MIPs
 {
 	this.bot = bot;
-	
-	this.getBotId 			= 	bot._peripheral.id;
-	this.getBotName			=	bot.name;
-	this.isConnected		=	false;
+	this.getBotId 			= 	bot._peripheral.id;			//Ließt MIP Identitätsnummer aus
+	this.getBotName			=	bot.name;					//Ließt MIP Name aus
+	this.isConnected		=	false;						//Setzt Verbindung auf false, MIP nicht verbunden
 	this.connectErrorMsg	=	"";
 };
 
+/*
+	Funktion: Funktion zum erstellen eines Arrays, welches die Daten der gefundenen MIPs beinhaltet
+*/
 function getRobotlist()
 {
 	var returnArray			=	new Array();
 	for(var bot of Robots)
 	{
 		infoArray			=	{};
-		infoArray['id']		=	bot.getBotId;
-		infoArray['name']	=	bot.getBotName;
+		infoArray['id']		=	bot.getBotId;				//MIP ID
+		infoArray['name']	=	bot.getBotName;				//MIP Name
 		returnArray.push(infoArray);
 	};
 	return JSON.stringify(returnArray);
 };
 
+/*
+	Funktion: Funktion zur Abfrage des Verbindungsstatus des MIP
+*/
 function getConnectStatus(bot)
 {
 	var returnArray			=	{};
-	returnArray['success']	=	bot.isConnected;
-	returnArray['msg']		=	bot.connectErrorMsg;
+	returnArray['success']	=	bot.isConnected;			//gibt 'success' aus, wenn MIP erfolgreich verbunden
+	returnArray['msg']		=	bot.connectErrorMsg;		//gibt 'msg' (Fehlermeldung) aus wenn Verbindung fehlgeschlagen
 	return JSON.stringify(returnArray);
 };
 
@@ -70,27 +78,27 @@ server.listen(PORT);
 app.use(express.static(__dirname + '/web'));
 
 /*
-	Socket
+	Socket (für die Kommunikation zwischen Webinterface und main.js)
 */
 io.sockets.on('connection', function(socket) {
 	// Socket um Farbe zu ändern
 	socket.on('setLed', function(r, g, b) {
-		MiPRobot.prototype.setMipChestLedWithColor.call(ConnectedBot.bot, r, g, b, 0x00);
+		MiPRobot.prototype.setMipChestLedWithColor.call(ConnectedBot.bot, r, g, b, 0x00);		//setzt LED standardgemäß auf aus. Farbeinstellung erfolgt über Webinterface
 	});
 
-	// Socket um Farbe zu ändern
+	// Socket um Sound abzuspielen
 	socket.on('playSound', function(soundNumber) {
-		MiPRobot.prototype.playMipSound.call(ConnectedBot.bot, soundNumber, 0);
+		MiPRobot.prototype.playMipSound.call(ConnectedBot.bot, soundNumber, 0);					//Ruft je nach Wahl den entsprechenden Sound auf
 	});
 
-	// Socket Drive
+	// Socket zum Fahren
 	socket.on('drive', function(cm) {
-		MiPRobot.prototype.driveDistanceByCm.call(ConnectedBot.bot, cm, 0);
+		MiPRobot.prototype.driveDistanceByCm.call(ConnectedBot.bot, cm, 0);						//Fahrdistanz standardgemäß auf 0. Je nach Wahl wird die gewünschte Distanz übergeben und ausgeführt
 	});
 
-	// Socket Direction
+	// Socket für Fahrrichtung
 	socket.on('direction', function(degree) {
-		MiPRobot.prototype.driveDistanceByCm.call(ConnectedBot.bot, 10, degree);
+		MiPRobot.prototype.driveDistanceByCm.call(ConnectedBot.bot, 3, degree);				//Fahrtrischtung in Grad. Auch über Webinterface einstellbar.
 	});
 
 	// Socket mit vorhandenen Botnamen
@@ -102,40 +110,40 @@ io.sockets.on('connection', function(socket) {
 		{
 			if(DEBUG)
 			{
-				console.log("--> Try to connect to: "+bot.getBotId);
+				console.log("--> Try to connect to: "+bot.getBotId);									//schreibt ins Log, mit welchem MIP sich derzeit versucht wird zu verbinden
 			};
 			if(bot.getBotId == id)
 			{
-				mipFinder.connect(bot.bot, function(err) {
-					if (err != null)
+				mipFinder.connect(bot.bot, function(err) {	
+					if (err != null)																	//Tritt ein Verbindungsfehler auf, wird folgende Anweisung aufgerufen
 					{
 						if(DEBUG)
 						{
-							console.log("--> Connect failed: "+err);
-						};
+							console.log("--> Connect failed: "+err);									//Konsole gibt aus: "--> Connect failed: " und Fehlercode
+						};	
 						bot.connectErrorMsg 	=	err;
 						socket.emit('getConnectStatus', getConnectStatus(bot));
 						return;
 					};
 
-					if(DEBUG)
-					{
-						console.log("--> Connect was successful!");
+					if(DEBUG)																			//War die Verbindung erfolgreich, wird folgende If Anweisung aufgerufen
+					{	
+						console.log("--> Connect was successful!");										//Konsolenlogeintrag "--> Connect was successful!"
 						console.log('----------------------------------------------------------------');
 					};
-					bot.isConnected				=	true;
-					ConnectedBot				=	bot;
+					bot.isConnected				=	true;												//Setzt Verbindungsstatus auf true (Verbunden)
+					ConnectedBot				=	bot;												//übergibt verbundenen Bot an Variable bot
 
-					ConnectedBot.bot.enableBTReceiveDataNotification(true, function(err, data) {
-						if (err)
+					ConnectedBot.bot.enableBTReceiveDataNotification(true, function(err, data) {		//Prüft ob gesendete Daten empfangen wurden
+						if (err)																		//Nicht empfangen -> Fehler
 						{
 							console.log(err);
 							return;
 						};
 
 						ConnectedBot.bot.convertMiPResponse(data, function(command, arr)
 						{
-							if(DEBUG)
+							if(DEBUG)																	//Empfangen -> Gibt aus, was empfangen wurde
 							{
 								console.log("--> "+command+": "+arr);
 							};
@@ -151,53 +159,14 @@ io.sockets.on('connection', function(socket) {
 
 					MiPRobot.prototype.readMipHardwareVersion.call(ConnectedBot.bot);
 					MiPRobot.prototype.readMipFirmwareVersion.call(ConnectedBot.bot);
-					//ConnectedBot.bot.readMipVolumeLevel;
-					/*ConnectedBot.bot.readMipStatus(function(data)
-					{
-						console.log(data);
-					});*/
-					/*console.log(ConnectedBot.bot.(100, 0, function(err) {
-			console.log("moving toward");
-		}));*/
-					
 					socket.emit('getConnectStatus', getConnectStatus(bot));
 				});
 			};
 		};
-		/*var selectedRobot, mipFinder	= new mip.Finder();
-		
-		for(var bot of Robots)
-		{
-			if(bot.Name == data)
-			{
-				selectedRobot = bot
-			};
-		};*/
-		/*mipFinder.scan(function(err, robots) {
-			console.log("GALL");
-			if (err != null)
-			{
-				console.log(err);
-				return;
-			};
-			
-			for (var i in robots)
-			{
-				console.log(robots[i].name+" vs "+data);
-				if(robots[i].name == data)
-				{
-					console.log(robots[i].name);
-					mipFinder.connect(robots[i], function(err) {
-						console.log(data);
-					});
-				};
-			};
-		});*/
-		
 	});
 });
 
-
+//gibt den folgenden Text in Konsole aus
 console.log('----------------------------------------------------------------');
 console.log('---> Studienprojekt MIP Control');
 console.log('----------------------------------------------------------------');
@@ -206,6 +175,8 @@ console.log('---> Entwickler: Lukas Gundermann');
 console.log('----------------------------------------------------------------');
 console.log('---> Server: http://localhost:'+PORT+'/');
 console.log('----------------------------------------------------------------');
+
+//Funktion zum scannen nach verfügbaren Bluetoothverbindungen von MIPs
 mipFinder.scan(function(err, robots) {
 	if (err != null)
 	{

del/test.js

@@ -2,7 +2,7 @@
   "name": "mip",
   "version": "1.0.0",
   "description": "",
-  "main": "index.js",
+  "main": "main.js",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },