Arduino lib basics.

Author: dani007200964

keywords.txt

@@ -0,0 +1,38 @@
+#######################################
+# Colors for Commander-API
+#######################################
+# Class
+#######################################
+
+Commander	                    KEYWORD1
+commandResponse                 KEYWORD1
+commandResponseSerial           KEYWORD1
+commandResponseArduinoSerial    KEYWORD1
+commandResponseWiFiClient       KEYWORD1
+
+#######################################
+# Methods and Functions
+#######################################
+
+apiElement          KEYWORD2
+attachTree          KEYWORD2
+attachTreeFunction  KEYWORD2
+init                KEYWORD2
+execute             KEYWORD2
+attachDebugChannel  KEYWORD2
+enableDebug         KEYWORD2
+disableDebug        KEYWORD2
+
+
+#######################################
+# Structures
+#######################################
+
+API_t               KEYWORD2
+
+#######################################
+# Constants
+#######################################
+
+COMMANDER_MAX_COMMAND_SIZE      LITERAL1
+COMMAND_PRINTF_BUFF_LEN         LITERAL1

library.properties

@@ -0,0 +1,9 @@
+name=Commander-API
+version=2.0.1
+author=Daniel Hajnal <[email protected]>
+maintainer=Daniel Hajnal <[email protected]>
+sentence=This library can be used to create a simple command parser.
+paragraph=It simply parses text based commands and find the corresponding functions for them.
+category=Data Processing
+url=https://github.com/dani007200964/Commander-API
+architectures=*

src/commander.cpp renamed to src/Commander-API.cpp

@@ -32,7 +32,7 @@ SOFTWARE.
 */
 
 
-#include "commander.hpp"
+#include "Commander-API.hpp"
 
 
 void Commander::attachTreeFunction( API_t *API_tree_p, uint32_t API_tree_size_p ){

src/commander.hpp renamed to src/Commander-API.hpp

@@ -38,8 +38,8 @@ SOFTWARE.
 #include "stdint.h"
 #include "string.h"
 
-#include "commander_settings.hpp"
-#include "commander_io.hpp"
+#include "Commander-Settings.hpp"
+#include "Commander-IO.hpp"
 
 /// Like STM32 Class Factory
 #ifdef COMMANDER_USE_SERIAL_RESPONSE

src/commander_io.cpp renamed to src/Commander-IO.cpp

@@ -32,7 +32,7 @@ SOFTWARE.
 */
 
 
-#include "commander_io.hpp"
+#include "Commander-IO.hpp"
 
 #ifdef COMMANDER_USE_SERIAL_RESPONSE
 

src/commander_io.hpp renamed to src/Commander-IO.hpp

@@ -38,7 +38,7 @@ SOFTWARE.
 #include <stdint.h>
 #include <stddef.h>
 
-#include "commander_settings.hpp"
+#include "Commander-Settings.hpp"
 
 #ifdef COMMANDER_USE_SERIAL_RESPONSE
 #include "Serial.hpp"

src/commander_settings.hpp renamed to src/Commander-Settings.hpp

@@ -47,13 +47,19 @@ SOFTWARE.
 #endif
 #endif
 
-//#define COMMANDER_USE_SERIAL_RESPONSE
-//#define COMMANDER_USE_WIFI_CLIENT_RESPONSE
-
 /// Maximum length of the terminal command.
+#ifndef COMMANDER_MAX_COMMAND_SIZE
 #define COMMANDER_MAX_COMMAND_SIZE 30
+#endif
 
+/// printf function buffer length
+///
+/// If you use printf function the maximumlength
+/// of the message( including the termination '\0' character )
+/// must be less or equal with COMMAND_PRINTF_BUFF_LEN.
+#ifndef COMMAND_PRINTF_BUFF_LEN
 #define COMMAND_PRINTF_BUFF_LEN 100
+#endif
 
 
 #endif /* COMMANDER_API_SRC_COMMANDER_SETTINGS_HPP_ */