Added Version 1.0

Author: je-s

.gitignore

@@ -0,0 +1,41 @@
+# ---> C++
+# Prerequisites
+*.d
+
+# Compiled Object files
+*.slo
+*.lo
+*.o
+*.obj
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Compiled Dynamic libraries
+*.so
+*.dylib
+*.dll
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+*.la
+*.a
+*.lib
+
+# Executables
+*.exe
+*.out
+*.app
+
+# ---> VisualStudioCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2019 Jan-Eric Schober
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

README.md

@@ -1,2 +1,13 @@
 # ArduinoStreamCommander-MessageTypes
-ArduinoStreamCommander-MessageTypes contains a set of standard message types used by the ArduinoStreamCommander.
+ArduinoStreamCommander-MessageTypes contains a set of standard message types used by the [https://github.com/je-s/ArduinoStreamCommander](ArduinoStreamCommander).
+
+The `MessageType`-Class can be resused in other software written in C++, since it is also compatible to ISO-C++'s `std::string`-container.
+# Folder structure
+* `src`  contains the source code.
+# Installing and using ArduinoStreamCommander-MessageTypes with the Arduino IDE
+* To install the library either clone and ZIP the folder, or download one of the releases. After that follow the instructions [https://www.arduino.cc/en/Guide/Libraries#toc2](here).
+* In order to use ArduinoStreamCommander-MessageTypes, `<MessageTypes.hpp>` needs to be included.
+# Usage
+The name (as `String` [Arduino Environment] or as `std::string` [in ISO-C++]) of a particular message type can be accessed by (for example): `MessageType::PING`.
+
+For further information regarding the meanings/intentions of the different message types, please see the [https://github.com/je-s/ArduinoStreamCommander](ArduinoStreamCommander) README file.

keywords.txt

@@ -0,0 +1,21 @@
+# Syntax Coloring Map For StreamCommander
+
+# Datatypes (KEYWORD1)
+MessageType KEYWORD1
+
+# Methods and Functions (KEYWORD2)
+# none
+
+# Instances (KEYWORD2)
+# none
+
+# Constants (LITERAL1)
+RESPONSE LITERAL1
+INFO LITERAL1
+ERROR LITERAL1
+STATUS LITERAL1
+ID LITERAL1
+ACTIVE LITERAL1
+ECHO LITERAL1
+COMMANDS LITERAL1
+COMMAND LITERAL1

library.properties

@@ -0,0 +1,9 @@
+name=StreamCommander-MessageTypes
+version=1.0.0
+author=Jan-Eric Schober <je@schober.industries>
+maintainer=Jan-Eric Schober <je@schober.industries>
+sentence=A class containing all standard message types of the StreamCommander.
+paragraph=A class containing all standard message types of the StreamCommander.
+category=Communication
+url=https://je.schober.industries.com/
+includes=MessageTypes.hpp

src/MessageTypes.cpp

@@ -0,0 +1,12 @@
+#include "MessageTypes.hpp"
+
+const T_STRING MessageType::RESPONSE = "response";
+const T_STRING MessageType::INFO = "info";
+const T_STRING MessageType::ERROR = "error";
+const T_STRING MessageType::PING = "ping";
+const T_STRING MessageType::STATUS = "status";
+const T_STRING MessageType::ID = "id";
+const T_STRING MessageType::ACTIVE = "active";
+const T_STRING MessageType::ECHO = "echo";
+const T_STRING MessageType::COMMANDS = "commands";
+const T_STRING MessageType::COMMAND = "command";

src/MessageTypes.hpp

@@ -0,0 +1,28 @@
+#ifndef MESSAGETYPES_HPP
+#define MESSAGETYPES_HPP
+
+// Check whether we're in an Arduino-Environment or not
+#ifdef ARDUINO
+#include "WString.h"
+#define T_STRING String
+#else
+#include <string>
+#define T_STRING std::string
+#endif
+
+class MessageType
+{
+public:
+    static const T_STRING RESPONSE;
+    static const T_STRING INFO;
+    static const T_STRING ERROR;
+    static const T_STRING PING;
+    static const T_STRING STATUS;
+    static const T_STRING ID;
+    static const T_STRING ACTIVE;
+    static const T_STRING ECHO;
+    static const T_STRING COMMANDS;
+    static const T_STRING COMMAND;
+};
+
+#endif // MESSAGETYPES_HPP