move TP function to GG_for_Arduino, add gg_con_RegistMemCMD()

Author: mkogax

README.md

@@ -18,9 +18,19 @@ You can implement a command line interface on your Arduino and add your own comm
 ### Pre-registered commands
 
 * `help` help
+
+### Prepared command (gg_con_RegistMemCMD())
+
 * `md` mem dump
 * `ms` mem set
 * `mf` mem fill
+
+See example below.
+
+* [GG_console.ino](examples/GG_console/GG_console.ino).
+
+### Prepared command (gg_tp_start())
+
 * `tp` TP(test point) select
 
 ### How to add your own command
@@ -60,15 +70,11 @@ All functions do not use the heap.
 |--|---|
 |***GG_for_Arduino.h***||
 |int gg_start(const char \*title)|Start processing GG for Arduino|
-|int gg_tp1_no|Arduino output pin number for TP1. Set before gg_start() if necessary|
-|int gg_tp2_no|Arduino output pin number for TP2. Set before gg_start() if necessary|
 |long gg_con_baud|baud rate. Set before gg_start() if necessary|
-|***gg_base.h***||
+|int gg_tp_start(int tp1_no, int tp2_no)|TP function start (output pin initialization and command registration)|
 |GG_TP_ON(number)|Turn on the TP status number|
 |GG_TP_OFF(number)|Turn off the TP status number|
 |***gg_uty.h***||
-|GG_TP_ON(number)|Turn on the TP status number|
-|GG_TP_OFF(number)|Turn off the TP status number|
 |int gg_GetC(void)|1 character input (-1 = no input)|
 |int gg_PutC(int c)|1 character output|
 |int gg_PutS(const char \*s)|String output|
@@ -117,4 +123,4 @@ All functions do not use the heap.
 |int gg_con_CmdN(void)|Number of command registrations|
 |int gg_con_CmdHelp(char \*cmd)|Help for the specified command|
 |int gg_con_CmdHelpAll(void)|Display command list|
-|int gg_con_RegistCMD(void)|Registration of basic commands to be pre-registered|
+|int gg_con_RegistMemCMD(void)|Registration of memory commands|

README_J.md

@@ -13,12 +13,22 @@ Arduinoでコマンドラインインターフェース（コンソールの基
 * エコーバックはGGが出す（端末でキーを打てば打ったキーが表示されます）
 * CR(\r)またはLF(\n)でコマンド実行
 
-### 定義済みコマンド
+### 登録済みコマンド
 
 * `help` コマンド一覧の表示
+
+### gg_con_RegistMemCMD()で追加登録されるコマンド
+
 * `md` メモリダンプ
 * `ms` メモリセット
 * `mf` メモリフィル（ブロックセット）
+
+下記の例をご覧ください。
+
+* [GG_console.ino](examples/GG_console/GG_console.ino).
+
+### gg_tp_start()で追加登録されるコマンド
+
 * `tp` TP(テストポイント)の状態番号の表示と変更
 
 ### コマンドの追加方法
@@ -59,13 +69,15 @@ TP（テストポイント）機能を使ってプログラムのタイミング
 |--|---|
 |***GG_for_Arduino.h***||
 |int gg_start(const char \*title)|GG for Arduino の開始|
-|int gg_tp1_no|TP1のArduinoピン番号. TP1を使うならgg_start()の前にセット|
-|int gg_tp2_no|TP2のArduinoピン番号. TP2を使うならgg_start()の前にセット|
 |long gg_con_baud|ボーレート. 115200から変更するならgg_start()の前にセット|
-|***gg_base.h***||
+|int gg_tp_start(int tp1_no, int tp2_no)|TP機能スタート(出力ピン初期化とコマンド登録)|
 |GG_TP_ON(number)|TP状態番号をON|
 |GG_TP_OFF(number)|TP状態番号をOFF|
 |***gg_uty.h***||
+|int gg_GetC(void)|1 character input (-1 = no input)|
+|int gg_PutC(int c)|1 character output|
+|int gg_PutS(const char \*s)|String output|
+|***gg_uty.h***||
 |int gg_GetC(void)|1文字入力 (-1 = 入力なし)|
 |int gg_PutC(int c)|1文字出力|
 |int gg_PutS(const char \*s)|文字列出力|
@@ -114,4 +126,4 @@ TP（テストポイント）機能を使ってプログラムのタイミング
 |int gg_con_CmdN(void)|コマンド登録数|
 |int gg_con_CmdHelp(char \*cmd)|cmdのヘルプ表示|
 |int gg_con_CmdHelpAll(void)|コマンド一覧の表示|
-|int gg_con_RegistCMD(void)|定義済みコマンドの登録(内部で使用)|
+|int gg_con_RegistMemCMD(void)|メモリ系コマンド登録|

examples/GG_console/GG_console.ino

@@ -4,10 +4,27 @@
   GG for Arduino ** Simple console demo
   Arduino standard serial (115200bps / 8bit length / non-parity)
   Enter the help command to display the command list.
+
+
+  Example
+
+  ** GG **
+  >help
+          help [cmd..]                  : command help
+  -- memory command --
+            md [addr [alen]]            : mem dump
+            ms addr data..              : mem set
+            mf addr alen data           : mem fill
+  >md 0x0000 20
+  00000000  00 00 D8 21 04 00 00 00  00 00 00 00 06 03 F2 02  ...!.... ........
+  00000010  D8 21 00 00  .!..
+  >
+
 */
 
 void setup() {
   gg_start("** GG **\n>");    // Start processing GG for Arduino
+  gg_con_RegistMemCMD();      // register memory command
 }
 
 void loop() {

examples/GG_console_cmd/GG_console_cmd.ino

@@ -15,15 +15,10 @@
 
   ** GG **
   >help
-  -- GG standard command --
           help [cmd..]                  : command help
-            md [addr [alen]]            : mem dump
-            ms addr data..              : mem set
-            mf addr alen data           : mem fill
-            tp [#1 [#2]]                : TP(test pin) set
-  -- Example of registering a console command --
-         test1 [...]                    : Displays the arguments when the command is executed
-  >test1 1 22 333 0xabcd 100+20+0x1000
+  -- Example of original command registration --
+         test1 [...]                    : Display command line arguments when executing this command
+  >test1  1 22 333 0xabcd 100+20+0x1000
   argc=6
   argv[ 0] test1            (0x00000000,0)
   argv[ 1] 1                (0x00000001,1)

examples/GG_printf/GG_printf.ino

@@ -4,6 +4,19 @@
   GG for Arduino ** Printf() demo
   Arduino standard serial (115200bps / 8bit length / non-parity)
   No command line interface
+
+
+  Example
+
+  ** GG start
+  [setup] millis()=       0
+  [loop] millis()=       0
+  c=  1=0x01=0b00000001
+  delay(1000)
+  [loop] millis()=    1002
+  c=  2=0x02=0b00000010
+  delay(1000)
+
 */
 
 void setup() {

examples/GG_tp/GG_tp.ino

@@ -13,12 +13,29 @@
   You can specify which status number to output to the output pin with the "tp" command.
   >tp 10 20  (TP1 output:status number 10, TP2 output:status number 20）
 
+
+  Example
+
+  ** GG **
+  >help
+          help [cmd..]                  : command help
+  -- TP command --
+            tp [#1 [#2]]                : TP(test point) select
+  >tp
+  <TP status number(The specified status number appears in TP)>
+  TP1 =  -1 (-1=do nothing)
+  TP2 =  -1 (-1=do nothing)
+  >tp 10 20
+  <TP status number(The specified status number appears in TP)>
+  TP1 =  10 (-1=do nothing)
+  TP2 =  20 (-1=do nothing)
+  >
+
  */
 
 void setup() {
-  gg_tp1_no = 2;  // Arduino pin number for TP1
-  gg_tp2_no = 3;  // Arduino pin number for TP2
   gg_start("** GG **\n>");    // Start processing GG for Arduino
+  gg_tp_start(2, 3);          // regiter tp command, setup TP1 and TP2 (Arduino pin number)
 }
 
 void loop() {

src/ggdef.h renamed to src/GG_HW_def.h

@@ -1,16 +1,17 @@
 /*
-	ggdef.h	GGツール 個別定義部
+	GG_HW_def.h	GGツール HW定義(HW環境依存部)
 	
 	2022.01.08	M.Kogan	初版開発開始
+	2022.06.05	M.Kogan	ファイル名変更,TP分離
 
 	***********************************
 	***        Arduino専用          ***
 	***********************************
 
 */
 
-#ifndef 	__GGDEF_H__
-#define 	__GGDEF_H__
+#ifndef 	__GG_HW_DEF_H__
+#define 	__GG_HW_DEF_H__
 
 //------------------
 //	割込み禁止制御
@@ -46,20 +47,4 @@ typedef unsigned long long	uint64_t;
 
 #define NULL (0)
 
-
-//------------------
-//	テストポイント(TP機能)設定
-//------------------
-//	以下のテストポイント(TP機能)設定が必要
-//	GG_TP_NOCODE		テストポイント(TP機能)コードの非生成(なければコード生成する)
-//	GG_TP1_ON/OFF		TP1(出力ピン1)制御
-//	GG_TP2_ON/OFF		TP2(出力ピン2)制御
-
-extern void gg_tp1_set(int flag);		// TP1(出力ピン1)出力(GG_for_Arduino.cpp)
-extern void gg_tp2_set(int flag);		// TP2(出力ピン2)出力(GG_for_Arduino.cpp)
-#define GG_TP1_ON()		(gg_tp1_set(1))	// TP1(出力ピン1)をON
-#define GG_TP1_OFF()	(gg_tp1_set(0))	// TP1(出力ピン1)をOFF
-#define GG_TP2_ON()		(gg_tp2_set(1))	// TP2(出力ピン2)をON
-#define GG_TP2_OFF()	(gg_tp2_set(0))	// TP2(出力ピン2)をOFF
-
-#endif	//	__GG_USERDEF_H__
+#endif	//	__GG_HW_DEF_H__

src/GG_for_Arduino.cpp

@@ -9,8 +9,6 @@
 #include "Arduino.h"
 
 int gg_DI_count;					// 割込み禁止ネスト数(0=割込み許可中)
-int gg_tp1_no = -1;					// TP1出力ピン番号(-1=なし)
-int gg_tp2_no = -1;					// TP2出力ピン番号(-1=なし)
 long gg_con_baud = 115200;			// コンソール用シリアル(Serial)のボーレート(-1=gg_start()で初期化しない)
 
 static int std_putc_sub(int c)
@@ -30,9 +28,6 @@ static int std_getc()
 
 int gg_start(const char *title)		// Arduino用GGの処理開始
 {
-	// TP出力の初期化(セットされてれば出力に初期化)
-	if (gg_tp1_no>=0) pinMode(gg_tp1_no, OUTPUT);
-	if (gg_tp2_no>=0) pinMode(gg_tp2_no, OUTPUT);
 
 	// コンソール用シリアルのボーレート設定(負数であればセットしない)
 	if (gg_con_baud>0) {
@@ -42,9 +37,13 @@ int gg_start(const char *title)		// Arduino用GGの処理開始
 	}
 
 	// GGツールベース初期化
-	ggbase_init();    	// GGツール初期化
-	gg_con_MonInit();	// GGモニタ初期化	
-	gg_con_RegistCMD();	// 標準コマンド登録
+	gg_con_MonInit();		// GGモニタ初期化	
+	gg_con_RegistHelpCMD();	// helpコマンド登録(最初はこれだけ)
+
+	// tp1/tp2番号指定あればTP機能スタート(旧v1.0.x対応)	2022.06.05 M.Kogan
+	if ((gg_tp1_no>=0)||(gg_tp2_no>=0)) {
+		gg_tp_start(gg_tp1_no, gg_tp2_no);		// TP機能スタート(出力ピン初期化とコマンド登録)
+	}
 
 	// デバッグモニタ開始(タイトル表示) 旧:gg_con_MonStart()
 	if (title) gg_PutS(title);
@@ -55,6 +54,12 @@ int gg_start(const char *title)		// Arduino用GGの処理開始
 //
 //	テストポイント(TP機能)
 //
+int gg_tp1_sel = -1;			// TP1(出力ピン1)状態番号変数
+int gg_tp2_sel = -1;			// TP2(出力ピン2)状態番号変数
+
+int gg_tp1_no = -1;				// TP1出力ピン番号(-1=なし)	Arduinoピン番号
+int gg_tp2_no = -1;				// TP2出力ピン番号(-1=なし)	Arduinoピン番号
+
 void gg_tp1_set(int flag)		// TP1(出力ピン1)出力(GG_for_Arduino.cpp)
 {
 	if (gg_tp1_no>=0) {
@@ -67,3 +72,31 @@ void gg_tp2_set(int flag)		// TP2(出力ピン2)出力(GG_for_Arduino.cpp)
 		digitalWrite(gg_tp2_no, flag);
 	}
 }
+
+static int C_tp(int argc, char**argv)					// TP設定
+{
+	if (argc<=4) {
+		if (argc>1) GG_TP1	 = gg_asc2int(argv[1]);
+		if (argc>2) GG_TP2	 = gg_asc2int(argv[2]);
+		gg_printf("<TP status number(The specified status number appears in TP)>\n");
+		gg_printf("TP1 = %3d (-1=do nothing)\n", GG_TP1);
+		gg_printf("TP2 = %3d (-1=do nothing)\n", GG_TP2);
+	} else {
+		gg_con_CmdHelp(argv[0]);
+	}
+	return 0;
+}
+
+int gg_tp_start(int tp1_no, int tp2_no)		// TP機能スタート(出力ピン初期化とコマンド登録)
+{
+	// TP出力の初期化(セットされてれば出力に初期化)
+	gg_tp1_no = tp1_no;
+	gg_tp2_no = tp2_no;
+	if (gg_tp1_no>=0) pinMode(gg_tp1_no, OUTPUT);
+	if (gg_tp2_no>=0) pinMode(gg_tp2_no, OUTPUT);
+
+	// コマンド登録
+	GG_CON_CMDMRK("-- TP command --");		// 区切り行（helpでコマンド一覧のときに表示）
+	GG_CON_CMDADD(C_tp,		"tp",		"[#1 [#2]]",			"TP(test point) select"	);		//
+	return 0;
+}

src/GG_for_Arduino.h

@@ -11,11 +11,55 @@
 #include "ggbase.h"
 
 //	gg_start()時の変更可能パラメータ(事前にデフォルト値が入っている)(Arduino専用)
-extern int gg_tp1_no;				// TP1出力ピン番号(-1=なし)
-extern int gg_tp2_no;				// TP2出力ピン番号(-1=なし)
 extern long gg_con_baud;			// コンソール用シリアル(Serial)のボーレート(負数ならgg_start()で初期化しない)
 
 int gg_start(const char *title);	// Arduino用GGの処理開始
 
+//------------------
+//	テストポイント(TP機能)
+//------------------
+//	以下のテストポイント(TP機能)設定が必要
+//	GG_TP_NOCODE		テストポイント(TP機能)コードの非生成(なければコード生成する)
+//	GG_TP1_ON/OFF		TP1(出力ピン1)制御
+//	GG_TP2_ON/OFF		TP2(出力ピン2)制御
+
+extern void gg_tp1_set(int flag);		// TP1(出力ピン1)出力(GG_for_Arduino.cpp)
+extern void gg_tp2_set(int flag);		// TP2(出力ピン2)出力(GG_for_Arduino.cpp)
+#define GG_TP1_ON()		(gg_tp1_set(1))	// TP1(出力ピン1)をON
+#define GG_TP1_OFF()	(gg_tp1_set(0))	// TP1(出力ピン1)をOFF
+#define GG_TP2_ON()		(gg_tp2_set(1))	// TP2(出力ピン2)をON
+#define GG_TP2_OFF()	(gg_tp2_set(0))	// TP2(出力ピン2)をOFF
+
+//	GG_TP_ON(x)
+//		GG_TP1==xならTP1(出力ピン1)をON
+//		GG_TP2==xならTP2(出力ピン2)をON
+//	GG_TP_OFF(x)
+//		GG_TP1==xならTP1(出力ピン1)をOFF
+//		GG_TP2==xならTP2(出力ピン2)をOFF
+//
+extern int gg_tp1_sel;		// TP1(出力ピン1)に出力する状態番号変数
+extern int gg_tp2_sel;		// TP2(出力ピン2)に出力する状態番号変数
+#ifndef GG_TP1
+#define GG_TP1			(gg_tp1_sel)	// TP1(出力ピン1)に出力する状態番号
+#endif
+#ifndef GG_TP2
+#define GG_TP2			(gg_tp2_sel)	// TP2(出力ピン2)に出力する状態番号
+#endif
+#ifndef GG_TP_NOCODE		// テストポイント(TP機能)を使用する場合
+	#define GG_TP_ON(x)		{if (GG_TP1==(x)) GG_TP1_ON();  if (GG_TP2==(x)) GG_TP2_ON();  }
+	#define GG_TP_OFF(x)	{if (GG_TP1==(x)) GG_TP1_OFF(); if (GG_TP2==(x)) GG_TP2_OFF(); }
+#else						// テストポイント(TP機能)を使用しない場合
+	#define GG_TP_ON(x)		// 無効
+	#define GG_TP_OFF(x)	// 無効
+#endif
+
+// TP機能出力ピン番号
+//	旧v1.0.x対応のため公開している(本来は公開不要,GG_tp.inoサンプル参照)
+//	gg_start()前にセットすれば自動的にgg_tp_start()が呼ばれる
+extern int gg_tp1_no;		// TP1出力ピン番号(-1=なし)
+extern int gg_tp2_no;		// TP2出力ピン番号(-1=なし)
+
+int gg_tp_start(int tp1_no, int tp2_no);		// TP機能スタート(出力ピン初期化とコマンド登録)
+
 
 #endif	//	__GG_FOR_ARDUINO_H__