Defines names updates

J-Rios · J-Rios · commit 5f14fbfdbc90 · 2022-02-10T15:07:40.000+01:00
diff --git a/examples/arduino/basic_usage/basic_usage.ino b/examples/arduino/basic_usage/basic_usage.ino
@@ -6,7 +6,7 @@
  *
  * @section DESCRIPTION
  *
- * SIMPLECLI library basic usage example for Arduino Framework.
+ * MINBASECLI library basic usage example for Arduino Framework.
  *
  * @section LICENSE
  *
diff --git a/examples/espidf/basic_usage/main.cpp b/examples/espidf/basic_usage/main.cpp
@@ -6,7 +6,7 @@
  *
  * @section DESCRIPTION
  *
- * SIMPLECLI library basic usage example for ESP-IDF Framework.
+ * MINBASECLI library basic usage example for ESP-IDF Framework.
  *
  * @section LICENSE
  *
@@ -157,7 +157,7 @@ void th_cli_interpreter(void* arg)
     bool command_received = false;
 
     // Setup Command Line Interface
-    Cli.setup(SIMPLECLI_DEFAULT_IFACE, SIMPLECLI_DEFAULT_BAUDS);
+    Cli.setup(MINBASECLI_DEFAULT_IFACE, MINBASECLI_DEFAULT_BAUDS);
     ESP_LOGI(TAG, "Command Line Interface is ready");
     printf("\n\n");
 
diff --git a/examples/linux/basic_usage/src/main.cpp b/examples/linux/basic_usage/src/main.cpp
@@ -6,7 +6,7 @@
  *
  * @section DESCRIPTION
  *
- * SIMPLECLI library basic usage example for Linux OS system.
+ * MINBASECLI library basic usage example for Linux OS system.
  *
  * @section LICENSE
  *
@@ -62,7 +62,7 @@ int main()
     bool exit = false;
 
     // Setup Command Line Interface
-    Cli.setup(SIMPLECLI_DEFAULT_IFACE, SIMPLECLI_DEFAULT_BAUDS);
+    Cli.setup(MINBASECLI_DEFAULT_IFACE, MINBASECLI_DEFAULT_BAUDS);
     printf("\nCommand Line Interface is ready\n\n");
 
     while(1)
diff --git a/examples/windows/basic_usage/main.cpp b/examples/windows/basic_usage/main.cpp
@@ -6,7 +6,7 @@
  *
  * @section DESCRIPTION
  *
- * SIMPLECLI library basic usage example for Windows OS system.
+ * MINBASECLI library basic usage example for Windows OS system.
  *
  * @section LICENSE
  *
@@ -65,7 +65,7 @@ int main()
     bool exit = false;
 
     // Setup Command Line Interface
-    Cli.setup(SIMPLECLI_DEFAULT_IFACE, SIMPLECLI_DEFAULT_BAUDS);
+    Cli.setup(MINBASECLI_DEFAULT_IFACE, MINBASECLI_DEFAULT_BAUDS);
     printf("\nCommand Line Interface is ready\n\n");
 
     while(1)
diff --git a/src/hal/avr/minbasecli_avr.h b/src/hal/avr/minbasecli_avr.h
@@ -51,8 +51,8 @@
 
 /* Constants & Defines */
 
-#if !defined(SIMPLECLI_UART)
-    #define SIMPLECLI_UART 0
+#if !defined(MINBASECLI_UART)
+    #define MINBASECLI_UART 0
 #endif
 
 /*****************************************************************************/
diff --git a/src/hal/espidf/minbasecli_espidf.cpp b/src/hal/espidf/minbasecli_espidf.cpp
@@ -59,7 +59,7 @@
 /* Constants & Defines */
 
 // UART Read Task Stack Size
-static const uint16_t SIMPLECLI_TASK_STACK = 2048;
+static const uint16_t MINBASECLI_TASK_STACK = 2048;
 
 // Logging Tag
 static const char TAG[] = "MinBaseCLI";
@@ -120,7 +120,7 @@ uint8_t MINBASECLI_ESPIDF::hal_iface_read()
 
     // Return read bytes
     this->th_rx_read_tail = (this->th_rx_read_tail + 1) %
-            SIMPLECLI_MAX_READ_SIZE;
+            MINBASECLI_MAX_READ_SIZE;
     return th_rx_read[this->th_rx_read_tail];
 }
 
@@ -143,7 +143,7 @@ void MINBASECLI_ESPIDF::hal_iface_print(const uint8_t data_byte)
   */
 bool MINBASECLI_ESPIDF::launch_stdin_read_thread()
 {
-    if (xTaskCreate(&th_read_stdin, "th_read_stdin", SIMPLECLI_TASK_STACK,
+    if (xTaskCreate(&th_read_stdin, "th_read_stdin", MINBASECLI_TASK_STACK,
                    (void*)(this), tskIDLE_PRIORITY+5, NULL) != pdPASS)
     {
         ESP_LOGE(TAG, "Fail to create STDIN read thread");
@@ -230,7 +230,7 @@ void th_read_stdin(void* arg)
         ch = getc(stdin);
         if (ch != EOF)
         {
-            _this->th_rx_read_head = (_this->th_rx_read_head + 1) % SIMPLECLI_MAX_READ_SIZE;
+            _this->th_rx_read_head = (_this->th_rx_read_head + 1) % MINBASECLI_MAX_READ_SIZE;
             _this->th_rx_read[_this->th_rx_read_head] = ch;
         }
         else
diff --git a/src/hal/espidf/minbasecli_espidf.h b/src/hal/espidf/minbasecli_espidf.h
@@ -51,7 +51,7 @@
 
 /* Constants & Defines */
 
-#define SIMPLECLI_MAX_READ_SIZE 64
+#define MINBASECLI_MAX_READ_SIZE 64
 
 /*****************************************************************************/
 
@@ -60,7 +60,7 @@
 class MINBASECLI_ESPIDF
 {
     public:
-        char th_rx_read[SIMPLECLI_MAX_READ_SIZE];
+        char th_rx_read[MINBASECLI_MAX_READ_SIZE];
         uint32_t th_rx_read_head, th_rx_read_tail;
 
         MINBASECLI_ESPIDF();
diff --git a/src/hal/linux/minbasecli_linux.cpp b/src/hal/linux/minbasecli_linux.cpp
@@ -103,7 +103,7 @@ uint8_t MINBASECLI_LINUX::hal_iface_read()
 
     // Return read bytes
     this->th_rx_read_tail = (this->th_rx_read_tail + 1) %
-            SIMPLECLI_MAX_READ_SIZE;
+            MINBASECLI_MAX_READ_SIZE;
     return th_rx_read[this->th_rx_read_tail];
 }
 
@@ -153,7 +153,7 @@ void* th_read_stdin(void* arg)
 
     while (true)
     {
-        new_head = (_this->th_rx_read_head + 1) % SIMPLECLI_MAX_READ_SIZE;
+        new_head = (_this->th_rx_read_head + 1) % MINBASECLI_MAX_READ_SIZE;
         _this->th_rx_read[new_head] = getc(stdin);
         _this->th_rx_read_head = new_head;
     }
diff --git a/src/hal/linux/minbasecli_linux.h b/src/hal/linux/minbasecli_linux.h
@@ -51,7 +51,7 @@
 
 /* Constants & Defines */
 
-#define SIMPLECLI_MAX_READ_SIZE 64
+#define MINBASECLI_MAX_READ_SIZE 64
 
 /*****************************************************************************/
 
@@ -61,7 +61,7 @@ class MINBASECLI_LINUX
 {
     public:
         uint32_t th_rx_read_head, th_rx_read_tail;
-        char th_rx_read[SIMPLECLI_MAX_READ_SIZE];
+        char th_rx_read[MINBASECLI_MAX_READ_SIZE];
 
         MINBASECLI_LINUX();
 
diff --git a/src/hal/stm32/minbasecli_stm32.cpp b/src/hal/stm32/minbasecli_stm32.cpp
@@ -118,7 +118,7 @@ static uint8_t rx_read_head = 0;
 static uint8_t rx_read_tail = 0;
 
 // Received bytes buffer
-static uint8_t rx_buffer[SIMPLECLI_MAX_READ_SIZE];
+static uint8_t rx_buffer[MINBASECLI_MAX_READ_SIZE];
 
 /*****************************************************************************/
 
@@ -168,7 +168,7 @@ uint8_t MINBASECLI_STM32::hal_iface_read()
         return 0;
 
     // Return read bytes
-    rx_read_tail = (rx_read_tail + 1) % SIMPLECLI_MAX_READ_SIZE;
+    rx_read_tail = (rx_read_tail + 1) % MINBASECLI_MAX_READ_SIZE;
     return rx_buffer[rx_read_tail];
 }
 
@@ -258,7 +258,7 @@ bool MINBASECLI_STM32::uart_setup(const uint32_t baud_rate,
 static void HAL_UART_RxCpltCallback(UART_HandleTypeDef* UartHandle)
 {
     // Increase number of received bytes
-    rx_read_head = (rx_read_head + 1) % SIMPLECLI_MAX_READ_SIZE;
+    rx_read_head = (rx_read_head + 1) % MINBASECLI_MAX_READ_SIZE;
     rx_buffer[rx_read_head] = rx_byte[0];
 
     // Reload Async Reception
diff --git a/src/hal/windows/minbasecli_windows.cpp b/src/hal/windows/minbasecli_windows.cpp
@@ -108,7 +108,7 @@ uint8_t MINBASECLI_WINDOWS::hal_iface_read()
 
     // Return read bytes
     this->th_rx_read_tail = (this->th_rx_read_tail + 1) %
-            SIMPLECLI_MAX_READ_SIZE;
+            MINBASECLI_MAX_READ_SIZE;
     return th_rx_read[this->th_rx_read_tail];
 }
 
@@ -156,7 +156,7 @@ DWORD WINAPI th_read_stdin(LPVOID lpParam)
 
     while (true)
     {
-        new_head = (_this->th_rx_read_head + 1) % SIMPLECLI_MAX_READ_SIZE;
+        new_head = (_this->th_rx_read_head + 1) % MINBASECLI_MAX_READ_SIZE;
         _this->th_rx_read[new_head] = getc(stdin);
         _this->th_rx_read_head = new_head;
     }
diff --git a/src/hal/windows/minbasecli_windows.h b/src/hal/windows/minbasecli_windows.h
@@ -51,7 +51,7 @@
 
 /* Constants & Defines */
 
-#define SIMPLECLI_MAX_READ_SIZE 64
+#define MINBASECLI_MAX_READ_SIZE 64
 
 /*****************************************************************************/
 
@@ -61,7 +61,7 @@ class MINBASECLI_WINDOWS
 {
     public:
         uint32_t th_rx_read_head, th_rx_read_tail;
-        char th_rx_read[SIMPLECLI_MAX_READ_SIZE];
+        char th_rx_read[MINBASECLI_MAX_READ_SIZE];
 
         MINBASECLI_WINDOWS();
 
diff --git a/src/minbasecli.cpp b/src/minbasecli.cpp
@@ -93,14 +93,14 @@ bool MINBASECLI::manage(t_cli_result* cli_result)
         return false;
 
     // Check if any command has been received
-    if (iface_read_data(this->rx_read, SIMPLECLI_MAX_READ_SIZE) == false)
+    if (iface_read_data(this->rx_read, MINBASECLI_MAX_READ_SIZE) == false)
         return false;
     received_bytes = get_received_bytes();
     this->received_bytes = 0;
 
     // Get the command
     str_read_until_char(this->rx_read, received_bytes, ' ',
-            cli_result->cmd, SIMPLECLI_MAX_CMD_LEN);
+            cli_result->cmd, MINBASECLI_MAX_CMD_LEN);
 
     // Shows the received command
     print("# ");
@@ -116,8 +116,8 @@ bool MINBASECLI::manage(t_cli_result* cli_result)
     cli_result->argc = cli_result->argc - 1;
 
     // Limit number of arguments to check
-    if (cli_result->argc > SIMPLECLI_MAX_ARGV)
-        cli_result->argc = SIMPLECLI_MAX_ARGV;
+    if (cli_result->argc > MINBASECLI_MAX_ARGV)
+        cli_result->argc = MINBASECLI_MAX_ARGV;
 
     // Get Arguments
     char* ptr_data = this->rx_read;
@@ -129,18 +129,18 @@ bool MINBASECLI::manage(t_cli_result* cli_result)
         if (ptr_argv == NULL)
         {
             // No ' ' character found, so it is last command, lets get it
-            //hal_snprintf(cli_result->argv[i], SIMPLECLI_MAX_ARGV_LEN,
+            //hal_snprintf(cli_result->argv[i], MINBASECLI_MAX_ARGV_LEN,
             //        "%s", ptr_data);
             strncpy(cli_result->argv[i], ptr_data, strlen(ptr_data));
-            cli_result->argv[i][SIMPLECLI_MAX_ARGV_LEN-1] = '\0';
+            cli_result->argv[i][MINBASECLI_MAX_ARGV_LEN-1] = '\0';
             break;
         }
         ptr_data = ptr_data + (ptr_argv - ptr_data) + 1;
         ptr_argv = ptr_argv + 1;
 
         // Get the argument
         str_read_until_char(ptr_argv, strlen(ptr_argv), ' ',
-                cli_result->argv[i], SIMPLECLI_MAX_ARGV_LEN);
+                cli_result->argv[i], MINBASECLI_MAX_ARGV_LEN);
     }
 
     return true;
@@ -180,7 +180,7 @@ void MINBASECLI::println(const char* str)
 void MINBASECLI::set_default_result(t_cli_result* cli_result)
 {
     cli_result->cmd[0] = '\0';
-    for (uint8_t i = 0; i < SIMPLECLI_MAX_ARGV; i++)
+    for (uint8_t i = 0; i < MINBASECLI_MAX_ARGV; i++)
         cli_result->argv[i][0] = '\0';
     cli_result->argc = 0;
 }
diff --git a/src/minbasecli.h b/src/minbasecli.h
@@ -83,35 +83,60 @@
 
 /* Constants & Defines */
 
-#define SIMPLECLI_DEFAULT_IFACE 0
-#define SIMPLECLI_DEFAULT_BAUDS 115200
+// Default CLI Interface to use if not provided
+#if !defined(MINBASECLI_DEFAULT_IFACE)
+    #define MINBASECLI_DEFAULT_IFACE 0
+#endif
+
+// Default CLI Baud Rate Speed to use if not provided
+#if !defined(MINBASECLI_DEFAULT_BAUDS)
+    #define MINBASECLI_DEFAULT_BAUDS 115200
+#endif
 
-#define SIMPLECLI_READ_TIMEOUT_MS 100
-#define SIMPLECLI_READ_INTERCHAR_TIMEOUT_MS 10
-#define SIMPLECLI_MAX_READ_SIZE 64
-#define SIMPLECLI_MAX_CMD_LEN 24
-#define SIMPLECLI_MAX_ARGV_LEN 32
-#define SIMPLECLI_MAX_ARGV 4
+// Maximum CLI read buffer size
+#if !defined(MINBASECLI_MAX_READ_SIZE)
+    #define MINBASECLI_MAX_READ_SIZE 64
+#endif
+
+// Maximum CLI Command length
+#if !defined(MINBASECLI_MAX_CMD_LEN)
+    #define MINBASECLI_MAX_CMD_LEN 24
+#endif
+
+// Maximum CLI Command Argument length
+#if !defined(MINBASECLI_MAX_ARGV_LEN)
+    #define MINBASECLI_MAX_ARGV_LEN 32
+#endif
+
+// Maximum number of arguments to check on a received CLI command
+#if !defined(MINBASECLI_MAX_ARGV)
+    #define MINBASECLI_MAX_ARGV 4
+#endif
 
 /*****************************************************************************/
 
 /* Data Types */
 
+// CLI manage result data
 typedef struct t_cli_result
 {
-    char cmd[SIMPLECLI_MAX_CMD_LEN];
-    char argv[SIMPLECLI_MAX_ARGV][SIMPLECLI_MAX_ARGV_LEN];
+    char cmd[MINBASECLI_MAX_CMD_LEN];
+    char argv[MINBASECLI_MAX_ARGV][MINBASECLI_MAX_ARGV_LEN];
     uint8_t argc;
 } t_cli_result;
 
 /*****************************************************************************/
 
+/* MinBaseCLI Class Interface */
+
+// Inherit from corresponding HAL
 class MINBASECLI : public MINBASECLI_HAL
 {
     public:
         MINBASECLI();
 
-        bool setup(void* iface, const uint32_t baud_rate=SIMPLECLI_DEFAULT_BAUDS);
+        bool setup(void* iface,
+                const uint32_t baud_rate=MINBASECLI_DEFAULT_BAUDS);
         bool manage(t_cli_result* cli_result);
         uint32_t get_received_bytes();
         void print(const char* str);
@@ -120,7 +145,7 @@ class MINBASECLI : public MINBASECLI_HAL
     private:
         bool initialized;
         uint32_t received_bytes;
-        char rx_read[SIMPLECLI_MAX_READ_SIZE];
+        char rx_read[MINBASECLI_MAX_READ_SIZE];
 
         void set_default_result(t_cli_result* cli_result);
         bool iface_is_not_initialized();

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`*`
`7`	`7`	`* @section DESCRIPTION`
`8`	`8`	`*`
`9`		`- * SIMPLECLI library basic usage example for Arduino Framework.`
	`9`	`+ * MINBASECLI library basic usage example for Arduino Framework.`
`10`	`10`	`*`
`11`	`11`	`* @section LICENSE`
`12`	`12`	`*`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@`
`59`	`59`	`/* Constants & Defines */`
`60`	`60`
`61`	`61`	`// UART Read Task Stack Size`
`62`		`-static const uint16_t SIMPLECLI_TASK_STACK = 2048;`
	`62`	`+static const uint16_t MINBASECLI_TASK_STACK = 2048;`
`63`	`63`
`64`	`64`	`// Logging Tag`
`65`	`65`	`static const char TAG[] = "MinBaseCLI";`
`@@ -120,7 +120,7 @@ uint8_t MINBASECLI_ESPIDF::hal_iface_read()`
`120`	`120`
`121`	`121`	`// Return read bytes`
`122`	`122`	`this->th_rx_read_tail = (this->th_rx_read_tail + 1) %`
`123`		`- SIMPLECLI_MAX_READ_SIZE;`
	`123`	`+ MINBASECLI_MAX_READ_SIZE;`
`124`	`124`	`return th_rx_read[this->th_rx_read_tail];`
`125`	`125`	`}`
`126`	`126`
`@@ -143,7 +143,7 @@ void MINBASECLI_ESPIDF::hal_iface_print(const uint8_t data_byte)`
`143`	`143`	`*/`
`144`	`144`	`bool MINBASECLI_ESPIDF::launch_stdin_read_thread()`
`145`	`145`	`{`
`146`		`- if (xTaskCreate(&th_read_stdin, "th_read_stdin", SIMPLECLI_TASK_STACK,`
	`146`	`+ if (xTaskCreate(&th_read_stdin, "th_read_stdin", MINBASECLI_TASK_STACK,`
`147`	`147`	`(void*)(this), tskIDLE_PRIORITY+5, NULL) != pdPASS)`
`148`	`148`	`{`
`149`	`149`	`ESP_LOGE(TAG, "Fail to create STDIN read thread");`
`@@ -230,7 +230,7 @@ void th_read_stdin(void* arg)`
`230`	`230`	`ch = getc(stdin);`
`231`	`231`	`if (ch != EOF)`
`232`	`232`	`{`
`233`		`- _this->th_rx_read_head = (_this->th_rx_read_head + 1) % SIMPLECLI_MAX_READ_SIZE;`
	`233`	`+ _this->th_rx_read_head = (_this->th_rx_read_head + 1) % MINBASECLI_MAX_READ_SIZE;`
`234`	`234`	`_this->th_rx_read[_this->th_rx_read_head] = ch;`
`235`	`235`	`}`
`236`	`236`	`else`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ uint8_t MINBASECLI_LINUX::hal_iface_read()`
`103`	`103`
`104`	`104`	`// Return read bytes`
`105`	`105`	`this->th_rx_read_tail = (this->th_rx_read_tail + 1) %`
`106`		`- SIMPLECLI_MAX_READ_SIZE;`
	`106`	`+ MINBASECLI_MAX_READ_SIZE;`
`107`	`107`	`return th_rx_read[this->th_rx_read_tail];`
`108`	`108`	`}`
`109`	`109`
`@@ -153,7 +153,7 @@ void* th_read_stdin(void* arg)`
`153`	`153`
`154`	`154`	`while (true)`
`155`	`155`	`{`
`156`		`- new_head = (_this->th_rx_read_head + 1) % SIMPLECLI_MAX_READ_SIZE;`
	`156`	`+ new_head = (_this->th_rx_read_head + 1) % MINBASECLI_MAX_READ_SIZE;`
`157`	`157`	`_this->th_rx_read[new_head] = getc(stdin);`
`158`	`158`	`_this->th_rx_read_head = new_head;`
`159`	`159`	`}`