CLI setup null default interface

J-Rios · J-Rios · commit 277ba891428e · 2023-03-04T17:20:18.000+01:00
diff --git a/examples/espidf/basic_usage/src/main.cpp b/examples/espidf/basic_usage/src/main.cpp
@@ -157,7 +157,7 @@ void th_cli_interpreter(void* arg)
     bool command_received = false;
 
     // Setup Command Line Interface
-    Cli.setup(MINBASECLI_DEFAULT_IFACE, MINBASECLI_DEFAULT_BAUDS);
+    Cli.setup();
     ESP_LOGI(TAG, "Command Line Interface is ready");
     printf("\n\n");
 
diff --git a/examples/espidf/basic_usage_callbacks/src/main.cpp b/examples/espidf/basic_usage_callbacks/src/main.cpp
@@ -168,7 +168,7 @@ bool launch_threads(void)
 void th_cli_interpreter(void* arg)
 {
     // Setup Command Line Interface
-    Cli.setup(MINBASECLI_DEFAULT_IFACE, MINBASECLI_DEFAULT_BAUDS);
+    Cli.setup();
 
     // Add commands and bind callbacks to them
     Cli.add_cmd("heap", &cmd_heap, "Show available HEAP memory.");
diff --git a/examples/linux/basic_usage/src/main.cpp b/examples/linux/basic_usage/src/main.cpp
@@ -62,7 +62,7 @@ int main()
     bool exit = false;
 
     // Setup Command Line Interface
-    Cli.setup(MINBASECLI_DEFAULT_IFACE, MINBASECLI_DEFAULT_BAUDS);
+    Cli.setup();
     Cli.printf("\nCommand Line Interface is ready\n\n");
 
     while(1)
diff --git a/examples/linux/basic_usage_callbacks/src/main.cpp b/examples/linux/basic_usage_callbacks/src/main.cpp
@@ -82,7 +82,7 @@ void cmd_exit(int argc, char* argv[]);
 int main()
 {
     // Initialize Command Line Interface
-    Cli.setup(MINBASECLI_DEFAULT_IFACE, MINBASECLI_DEFAULT_BAUDS);
+    Cli.setup();
 
     // Add commands and bind callbacks to them
     Cli.add_cmd("test", &cmd_test, "test [on/off] - Turn test mode ON or OFF.");
diff --git a/examples/windows/basic_usage/main.cpp b/examples/windows/basic_usage/main.cpp
@@ -65,7 +65,7 @@ int main()
     bool exit = false;
 
     // Setup Command Line Interface
-    Cli.setup(MINBASECLI_DEFAULT_IFACE, MINBASECLI_DEFAULT_BAUDS);
+    Cli.setup();
     Cli.printf("\nCommand Line Interface is ready\n\n");
 
     while(1)
diff --git a/examples/windows/basic_usage_callbacks/main.cpp b/examples/windows/basic_usage_callbacks/main.cpp
@@ -84,7 +84,7 @@ void cmd_exit(int argc, char* argv[]);
 int main()
 {
     // Setup Command Line Interface
-    Cli.setup(MINBASECLI_DEFAULT_IFACE, MINBASECLI_DEFAULT_BAUDS);
+    Cli.setup();
 
     // Add commands and bind callbacks to them
     Cli.add_cmd("test", &cmd_test, "test [on/off] - Turn test mode ON or OFF.");
diff --git a/src/hal/arduino/minbasecli_arduino.cpp b/src/hal/arduino/minbasecli_arduino.cpp
@@ -65,7 +65,7 @@
 
 /**
  * @details
- * This constructor initializes all attributtes of the CLI class.
+ * This constructor initializes all attributes of the CLI class.
  */
 MINBASECLI_ARDUINO::MINBASECLI_ARDUINO()
 {
@@ -83,9 +83,13 @@ MINBASECLI_ARDUINO::MINBASECLI_ARDUINO()
  */
 bool MINBASECLI_ARDUINO::hal_setup(void* iface, const uint32_t baud_rate)
 {
+    if (iface == NULL)
+        { return false; }
+
     this->iface = iface;
     _IFACE* _Serial = (_IFACE*) this->iface;
     _Serial->begin(baud_rate);
+
     return true;
 }
 
diff --git a/src/hal/arduino/minbasecli_arduino.h b/src/hal/arduino/minbasecli_arduino.h
@@ -88,7 +88,7 @@ class MINBASECLI_ARDUINO
         bool hal_setup(void* iface, const uint32_t baud_rate);
 
         /**
-         * @brief Get the number of bytes that the interface has recevived and
+         * @brief Get the number of bytes that the interface has received and
          * are available in the current interface buffer to be read.
          * @return size_t The number of bytes available to be read.
          */
@@ -113,7 +113,7 @@ class MINBASECLI_ARDUINO
     private:
 
         /**
-         * @brief Pointer to interfce used.
+         * @brief Pointer to interface used.
          */
         void* iface;
 };
diff --git a/src/hal/avr/minbasecli_avr.cpp b/src/hal/avr/minbasecli_avr.cpp
@@ -61,7 +61,7 @@
 
 /**
  * @details
- * This constructor initializes all attributtes of the CLI class.
+ * This constructor initializes all attributes of the CLI class.
  */
 MINBASECLI_AVR::MINBASECLI_AVR()
 {
@@ -79,9 +79,13 @@ MINBASECLI_AVR::MINBASECLI_AVR()
  */
 bool MINBASECLI_AVR::hal_setup(void* iface, const uint32_t baud_rate)
 {
+    if (iface == NULL)
+        { return false; }
+
     this->iface = iface;
     _IFACE* _Serial = (_IFACE*) this->iface;
     _Serial->setup(baud_rate);
+
     return true;
 }
 
diff --git a/src/hal/avr/minbasecli_avr.h b/src/hal/avr/minbasecli_avr.h
@@ -7,8 +7,8 @@
  *
  * @section DESCRIPTION
  *
- * A simple Command Line Interface C++ library implementation with HAL emphasis
- * to be used in different kind of devices and frameworks.
+ * A simple Command Line Interface C++ library implementation with HAL
+ * emphasis to be used in different kind of devices and frameworks.
  *
  * @section LICENSE
  *
@@ -93,7 +93,7 @@ class MINBASECLI_AVR
         bool hal_setup(void* iface, const uint32_t baud_rate);
 
         /**
-         * @brief Get the number of bytes that the interface has recevived and
+         * @brief Get the number of bytes that the interface has received and
          * are available in the current interface buffer to be read.
          * @return size_t The number of bytes available to be read.
          */
@@ -118,7 +118,7 @@ class MINBASECLI_AVR
     private:
 
         /**
-         * @brief Pointer to interfce used.
+         * @brief Pointer to interface used.
          */
         void* iface;
 };
diff --git a/src/hal/espidf/minbasecli_espidf.cpp b/src/hal/espidf/minbasecli_espidf.cpp
@@ -69,7 +69,8 @@ static const char TAG[] = "MinBaseCLI";
 /* Read STDIN Stream Thread Prototype */
 
 /**
- * @brief FreeRTOS Task handler function to read STDIN data from the interface.
+ * @brief FreeRTOS Task handler function to read STDIN data from the
+ * interface.
  * @param arg FreeRTOS Task arguments.
  */
 void th_read_stdin(void* arg);
@@ -80,7 +81,7 @@ void th_read_stdin(void* arg);
 
 /**
  * @details
- * This constructor initializes all attributtes of the CLI class.
+ * This constructor initializes all attributes of the CLI class.
  */
 MINBASECLI_ESPIDF::MINBASECLI_ESPIDF()
 {
@@ -101,11 +102,15 @@ MINBASECLI_ESPIDF::MINBASECLI_ESPIDF()
  */
 bool MINBASECLI_ESPIDF::hal_setup(void* iface, const uint32_t baud_rate)
 {
+    if (iface == NULL)
+        { return false; }
+
     this->iface = iface;
     if (uart_setup(baud_rate) == false)
-        return false;
+        { return false; }
     if (launch_stdin_read_thread() == false)
-        return false;
+        { return false; }
+
     return true;
 }
 
@@ -121,9 +126,9 @@ size_t MINBASECLI_ESPIDF::hal_iface_available()
 
 /**
  * @details
- * This function returns a received byte from the interface. It checks if there
- * is any byte avaliable to be read and increase the read circular buffer tail
- * index to "pop" this element from the buffer and return it.
+ * This function returns a received byte from the interface. It checks if
+ * there is any byte available to be read and increase the read circular
+ * buffer tail index to "pop" this element from the buffer and return it.
  */
 uint8_t MINBASECLI_ESPIDF::hal_iface_read()
 {
@@ -170,10 +175,11 @@ bool MINBASECLI_ESPIDF::launch_stdin_read_thread()
 /**
  * @details
  * This function configure and initialize the UART for the given baud rate
- * communication speed. It fush the STDOUT, disable the buffering of the STDIN,
- * configure the Serial communication parameters, setup the ESP-IDF UART driver
- * to manage the UART peripheral, apply the configuration, set the reception
- * and transmission line endings and bind a virtual file system to the UART.
+ * communication speed. It fush the STDOUT, disable the buffering of the
+ * STDIN, configure the Serial communication parameters, setup the ESP-IDF
+ * UART driver to manage the UART peripheral, apply the configuration, set the
+ * reception and transmission line endings and bind a virtual file system to
+ * the UART.
  */
 bool MINBASECLI_ESPIDF::uart_setup(const uint32_t baud_rate)
 {
@@ -237,9 +243,9 @@ bool MINBASECLI_ESPIDF::uart_setup(const uint32_t baud_rate)
 
 /**
  * @details
- * This function is the FreeRTOS Task that manages the STDIN data read. It gets
- * each new byte received from the interface and store them in the read buffer
- * (increasing the circular buffer head index).
+ * This function is the FreeRTOS Task that manages the STDIN data read.
+ * It gets each new byte received from the interface and store them in the
+ * read buffer (increasing the circular buffer head index).
  */
 void th_read_stdin(void* arg)
 {
diff --git a/src/hal/espidf/minbasecli_espidf.h b/src/hal/espidf/minbasecli_espidf.h
@@ -112,7 +112,7 @@ class MINBASECLI_ESPIDF
         bool hal_setup(void* iface, const uint32_t baud_rate);
 
         /**
-         * @brief Get the number of bytes that the interface has recevived and
+         * @brief Get the number of bytes that the interface has received and
          * are available in the current interface buffer to be read.
          * @return size_t The number of bytes available to be read.
          */
@@ -137,7 +137,7 @@ class MINBASECLI_ESPIDF
     private:
 
         /**
-         * @brief Pointer to interfce used.
+         * @brief Pointer to interface used.
          */
         void* iface;
 
diff --git a/src/hal/linux/minbasecli_linux.cpp b/src/hal/linux/minbasecli_linux.cpp
@@ -67,7 +67,7 @@ void* th_read_stdin(void* arg);
 
 /**
  * @details
- * This constructor initializes all attributtes of the CLI class.
+ * This constructor initializes all attributes of the CLI class.
  */
 MINBASECLI_LINUX::MINBASECLI_LINUX()
 {
@@ -104,9 +104,9 @@ size_t MINBASECLI_LINUX::hal_iface_available()
 
 /**
  * @details
- * This function returns a received byte from the interface. It checks if there
- * is any byte avaliable to be read and increase the read circular buffer tail
- * index to "pop" this element from the buffer and return it.
+ * This function returns a received byte from the interface. It checks if
+ * there is any byte available to be read and increase the read circular
+ * buffer tail index to "pop" this element from the buffer and return it.
  */
 uint8_t MINBASECLI_LINUX::hal_iface_read()
 {
diff --git a/src/hal/linux/minbasecli_linux.h b/src/hal/linux/minbasecli_linux.h
@@ -112,7 +112,7 @@ class MINBASECLI_LINUX
         bool hal_setup(void* iface, const uint32_t baud_rate);
 
         /**
-         * @brief Get the number of bytes that the interface has recevived and
+         * @brief Get the number of bytes that the interface has received and
          * are available in the current interface buffer to be read.
          * @return size_t The number of bytes available to be read.
          */
@@ -137,7 +137,7 @@ class MINBASECLI_LINUX
     private:
 
         /**
-         * @brief Pointer to interfce used.
+         * @brief Pointer to interface used.
          */
         void* iface;
 
diff --git a/src/hal/none/minbasecli_none.cpp b/src/hal/none/minbasecli_none.cpp
@@ -66,7 +66,7 @@
 
 /**
  * @details
- * This constructor initializes all attributtes of the CLI class.
+ * This constructor initializes all attributes of the CLI class.
  */
 MINBASECLI_NONE::MINBASECLI_NONE()
 {
@@ -82,10 +82,9 @@ MINBASECLI_NONE::MINBASECLI_NONE()
  * This function should get and initialize the interface element that is going
  * to be used by the CLI.
  */
-bool MINBASECLI_LINUX::hal_setup(void* iface, const uint32_t baud_rate)
+bool MINBASECLI_NONE::hal_setup(void* iface, const uint32_t baud_rate)
 {
-    this->iface = iface;
-    return launch_stdin_read_thread();
+    return true;
 }
 
 /**
diff --git a/src/hal/none/minbasecli_none.h b/src/hal/none/minbasecli_none.h
@@ -7,8 +7,8 @@
  *
  * @section DESCRIPTION
  *
- * A simple Command Line Interface C++ library implementation with HAL emphasis
- * to be used in different kind of devices and frameworks.
+ * A simple Command Line Interface C++ library implementation with HAL
+ * emphasis to be used in different kind of devices and frameworks.
  *
  * @section LICENSE
  *
@@ -98,7 +98,7 @@ class MINBASECLI_NONE
         bool hal_setup(void* iface, const uint32_t baud_rate);
 
         /**
-         * @brief Get the number of bytes that the interface has recevived and
+         * @brief Get the number of bytes that the interface has received and
          * are available in the current interface buffer to be read.
          * @return size_t The number of bytes available to be read.
          */
@@ -123,7 +123,7 @@ class MINBASECLI_NONE
     private:
 
         /**
-         * @brief Pointer to interfce used.
+         * @brief Pointer to interface used.
          */
         void* iface;
 
diff --git a/src/hal/stm32/minbasecli_stm32.cpp b/src/hal/stm32/minbasecli_stm32.cpp
@@ -154,7 +154,7 @@ static void HAL_UART_ErrorCallback(UART_HandleTypeDef* UartHandle);
 
 /**
  * @details
- * This constructor initializes all attributtes of the CLI class.
+ * This constructor initializes all attributes of the CLI class.
  */
 MINBASECLI_STM32::MINBASECLI_STM32()
 {
@@ -172,9 +172,13 @@ MINBASECLI_STM32::MINBASECLI_STM32()
  */
 bool MINBASECLI_STM32::hal_setup(void* iface, const uint32_t baud_rate)
 {
+    if (iface == NULL)
+        { return false; }
+
     this->iface = iface;
     if (!uart_setup(baud_rate, true))
-        return false;
+        { return false; }
+
     return true;
 }
 
@@ -190,9 +194,9 @@ size_t MINBASECLI_STM32::hal_iface_available()
 
 /**
  * @details
- * This function returns a received byte from the interface. It checks if there
- * is any byte avaliable to be read and increase the read circular buffer tail
- * index to "pop" this element from the buffer and return it.
+ * This function returns a received byte from the interface. It checks if
+ * there is any byte available to be read and increase the read circular
+ * buffer tail index to "pop" this element from the buffer and return it.
  */
 uint8_t MINBASECLI_STM32::hal_iface_read()
 {
@@ -288,9 +292,9 @@ bool MINBASECLI_STM32::uart_setup(const uint32_t baud_rate,
 
 /**
  * @details
- * This function fires on each UART Rx reception. It get the last received byte
- * and store it into the circular buffer, and set again the interrupt for next
- * detections.
+ * This function fires on each UART Rx reception. It get the last received
+ * byte and store it into the circular buffer, and set again the interrupt for
+ * next detections.
  */
 static void HAL_UART_RxCpltCallback(UART_HandleTypeDef* UartHandle)
 {
diff --git a/src/hal/stm32/minbasecli_stm32.h b/src/hal/stm32/minbasecli_stm32.h
diff --git a/src/hal/windows/minbasecli_windows.cpp b/src/hal/windows/minbasecli_windows.cpp
diff --git a/src/hal/windows/minbasecli_windows.h b/src/hal/windows/minbasecli_windows.h
diff --git a/src/minbasecli.cpp b/src/minbasecli.cpp
diff --git a/src/minbasecli.h b/src/minbasecli.h

Original file line number	Diff line number	Diff line change
`@@ -168,7 +168,7 @@ bool launch_threads(void)`
`168`	`168`	`void th_cli_interpreter(void* arg)`
`169`	`169`	`{`
`170`	`170`	`// Setup Command Line Interface`
`171`		`- Cli.setup(MINBASECLI_DEFAULT_IFACE, MINBASECLI_DEFAULT_BAUDS);`
	`171`	`+ Cli.setup();`
`172`	`172`
`173`	`173`	`// Add commands and bind callbacks to them`
`174`	`174`	`Cli.add_cmd("heap", &cmd_heap, "Show available HEAP memory.");`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ void cmd_exit(int argc, char* argv[]);`
`82`	`82`	`int main()`
`83`	`83`	`{`
`84`	`84`	`// Initialize Command Line Interface`
`85`		`- Cli.setup(MINBASECLI_DEFAULT_IFACE, MINBASECLI_DEFAULT_BAUDS);`
	`85`	`+ Cli.setup();`
`86`	`86`
`87`	`87`	`// Add commands and bind callbacks to them`
`88`	`88`	`Cli.add_cmd("test", &cmd_test, "test [on/off] - Turn test mode ON or OFF.");`
Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ void cmd_exit(int argc, char* argv[]);`
`84`	`84`	`int main()`
`85`	`85`	`{`
`86`	`86`	`// Setup Command Line Interface`
`87`		`- Cli.setup(MINBASECLI_DEFAULT_IFACE, MINBASECLI_DEFAULT_BAUDS);`
	`87`	`+ Cli.setup();`
`88`	`88`
`89`	`89`	`// Add commands and bind callbacks to them`
`90`	`90`	`Cli.add_cmd("test", &cmd_test, "test [on/off] - Turn test mode ON or OFF.");`