- added ping command in i2c-console

- restructure main console scan command

Author: dannyp11

c-project/without-os/i2c-console/I2CConsole.h

@@ -17,7 +17,8 @@ typedef enum _i2ccommand
 	SEND = 0,
 	SENDNRECV,
 	SET_ADDRESS,
-	SET_SLOW
+	SET_SLOW,
+	PING
 } I2CConsoleCommand;
 
 typedef struct _i2cMessage
@@ -44,6 +45,7 @@ typedef struct _i2cMessage
  * LOOP 3 TX "hello world" - loop in 3 seconds for sending TX "hello world"
  * LOOP 5 RX 6 2 ab 03 	- loop in 5 seconds for sending RX 6 2 ab 03
  * SLOW 0			 - set slow sending off
+ * PING 23			- check if address 0x23 is alive
  *
  * @param inputmessage
  * @param result
@@ -62,6 +64,7 @@ uint8_t I2CConsoleParser(const char * message, I2CConsoleMessage * result);
  * 			- 1 on failed sending/recv
  * 			- 2 on invalid message
  * 			- 3 on invalid address
+ * 			- 4 on timeout of ping
  */
 uint8_t I2CConsoleSendCommand(I2CConsoleMessage * command);
 

c-project/without-os/i2c-console/I2CConsoleIO.c

@@ -41,6 +41,11 @@ uint8_t I2CConsoleSendCommand(I2CConsoleMessage * command)
 		{
 			_i2c_address = (uint8_t) command->address;
 		}
+		else if (command->command == PING)
+		{
+			// don't change command address if it's PING
+			;
+		}
 		else
 		{
 			command->address = _i2c_address;
@@ -71,7 +76,7 @@ uint8_t I2CConsoleSendCommand(I2CConsoleMessage * command)
 			command->isDelayBetweenBytes = _i2c_slowTx;
 		}
 
-		if (_i2c_address != 0x00)
+		if (command->address != 0x00)
 		{
 			if (command->command == SEND)
 			{
@@ -104,6 +109,12 @@ uint8_t I2CConsoleSendCommand(I2CConsoleMessage * command)
 							command->rx_len, _i2c_slowTx);
 				}
 			}
+			else if (command->command == PING)
+			{
+				retVal = (I2CCheckAlive(command->address) == 0) ? retVal : 4;
+				TRACE_INT(retVal);
+				LOG("address %x", command->address);
+			}
 		}
 		else
 		{

c-project/without-os/i2c-console/I2CConsoleParser.c

@@ -237,6 +237,22 @@ uint8_t processRX(const char * message, I2CConsoleMessage * result,
 	return errcode;
 }
 
+uint8_t processPing(const char * message, I2CConsoleMessage * result,
+		uint8_t errcode)
+{
+	if (errcode) return errcode;
+
+	// set address
+	result->command = PING;
+	if (sscanf(message, "%x", &result->address) != 1)
+	{
+		TRACE()
+		errcode = 1;
+	}
+
+	return errcode;
+}
+
 /**
  * internal - final touch of result
  *
@@ -289,10 +305,11 @@ void parserInit()
 	registerParserCallback("slow", processSlow);
 	registerParserCallback("tx", processTX);
 	registerParserCallback("rx", processRX);
+	registerParserCallback("ping", processPing);
 }
 
 /**
- * log - done command: tx rx addr slow
+ * log - done command: tx rx addr slow ping
  *
  * wip -
  *

c-project/without-os/i2c-console/main.c

@@ -7,21 +7,18 @@
 #include "I2CConsole.h"
 #include "SerialDebug.h"
 #include "PgmStorage.h"
-#include "Timer.h"
-#include "I2C.h"
 #include "Millis.h"
 
 #include <stdio.h>
 #include <util/delay.h>
 
-
-const char PROGMEM helpaddr1[] = "Hint address: LCD 0x28, compass 0x19";
 const char PROGMEM help1[] = "Sample command \t\t - explanation (command case insensitive)";
 const char PROGMEM help2[] = "ADDR 28 \t\t - set i2c 7-bit address as 0x28";
 const char PROGMEM help3[] = "TX 2 00 03 \t\t - send 2 bytes 0x00 and 0x03";
 const char PROGMEM help0[] = "TX \"hello world\" \t - send string \"hello world\"";
 const char PROGMEM help4[] = "RX 6 2 ab 03 \t\t - send 2 bytes 0xab and 0x03, receive 6 bytes back to rx";
 const char PROGMEM help41[] = "SLOW 0 \t\t\t - set slow sending off";
+const char PROGMEM help42[] = "PING 23 \t\t - check if address 0x23 is alive";
 const char PROGMEM helploop1[] = "LOOP 2 TX 2 00 03 \t - loop the command 'TX 2 00 03' for 2 seconds";
 const char PROGMEM helploop2[] = "LOOP 5 RX 6 1 ab \t - loop the command 'RX 6 1 ab' for 5 seconds";
 const char PROGMEM help5[] = "---------------";
@@ -38,9 +35,6 @@ void showHelp()
 {
 	char msg[PGM_SIZE];
 
-	PgmStorageGet(msg, helpaddr1);
-	SerialDebugPrint(msg);
-
 	PgmStorageGet(msg, help1);
 	SerialDebugPrint(msg);
 
@@ -59,6 +53,9 @@ void showHelp()
 	PgmStorageGet(msg, help41);
 	SerialDebugPrint(msg);
 
+	PgmStorageGet(msg, help42);
+	SerialDebugPrint(msg);
+
 	PgmStorageGet(msg, helploop1);
 	SerialDebugPrint(msg);
 
@@ -187,15 +184,38 @@ void showHistory()
 void runScan()
 {
 	uint8_t device_addr;
+	I2CConsoleMessage msg;
+	char foundDevice = 0;
 
 	SerialDebugPrint("Scanning for devices ...");
 	for (device_addr = 0; device_addr < 128; ++device_addr)
 	{
-		if (!I2CCheckAlive(device_addr))
+		char buff[20];
+		snprintf(buff, 20, "ping %x", device_addr);
+
+		if (!I2CConsoleParser(buff, &msg))
 		{
-			SerialDebugPrint("Found device 0x%x", device_addr);
+			uint8_t sendResult = I2CConsoleSendCommand(&msg);
+			if (!sendResult)
+			{
+				SerialDebugPrint("Found device 0x%x", device_addr);
+				foundDevice = 1;
+			}
+			else
+			{
+				LOG("Error code %d for %s", sendResult, buff);
+			}
+		}
+		else
+		{
+			LOG("Error parsing %s", buff);
 		}
 	}
+
+	if (!foundDevice)
+	{
+		SerialDebugPrint("No I2C device found");
+	}
 }
 
 void parseNRunMessage(const char * message)
@@ -220,14 +240,14 @@ void parseNRunMessage(const char * message)
 		uint8_t sendResult = I2CConsoleSendCommand(&cmd);
 		if (sendResult == 0)
 		{
-			SerialDebugPrint("sent %s", message);
+			SerialDebugPrint("OK - '%s'", message);
 
 			if (cmd.command == SENDNRECV)
 			{
 				SerialDebugPrint("RX result:");
 				for (i = 0; i < cmd.rx_len; ++i)
 				{
-					SerialDebugPrint(" rx[%d] = 0x%x = %d = '%c'", i, cmd.rx[i],
+					SerialDebugPrint(" rx[%d] = 0x%x \t= %d \t= '%c'", i, cmd.rx[i],
 							cmd.rx[i], cmd.rx[i]);
 				}
 			}

c-project/without-os/i2c-console/test/I2CConsoleTest.h

@@ -33,6 +33,7 @@ class MyTS: public CxxTest::TestSuite
 		const string input3 = "RX 6 2 ab 03";
 		const string input4 = "TX 10 1 2 3 4 5 6 7 8 9 10";
 		const string input5 = "slow 0";
+		const string input6 = "ping 23";
 
 		I2CConsoleMessage message;
 		resetMessage(&message);
@@ -71,13 +72,20 @@ class MyTS: public CxxTest::TestSuite
 		TS_ASSERT_EQUALS(message.isValid, 1);
 		TS_ASSERT_EQUALS(message.tx_len, 10);
 		I2CConsoleDumpCommand(&message);
-//
+
 		resetMessage(&message);
 		TS_ASSERT_EQUALS(I2CConsoleParser(input5.c_str(), &message), 0);
 		TS_ASSERT_EQUALS(message.command, SET_SLOW);
 		TS_ASSERT_EQUALS(message.isValid, 1);
 		TS_ASSERT_EQUALS(message.isDelayBetweenBytes, 0);
 		I2CConsoleDumpCommand(&message);
+
+		resetMessage(&message);
+		TS_ASSERT_EQUALS(I2CConsoleParser(input6.c_str(), &message), 0);
+		TS_ASSERT_EQUALS(message.command, PING);
+		TS_ASSERT_EQUALS(message.isValid, 1);
+		TS_ASSERT_EQUALS(message.address, 0x23);
+		I2CConsoleDumpCommand(&message);
 	}
 
 	void testConsoleParserMessageSuccess()

common/utils/SerialDebug.h

@@ -9,7 +9,6 @@
 #define SERIALDEBUG_H_
 
 #include <stdio.h>
-#include <string.h>
 
 #include "MemoryFree.h"
 #include "AVRString.h"