API-Test.md

@@ -3,3 +3,36 @@
 HomeBot main module with core functionality.
 
 ## Description
+
+Defines maximum length for a Readingname (MAXLEN\_RN) and for a Device name (MAXLEN\_DN).
+
+# Functions Reference
+
+- **goodDeviceName** (positional)
+- **goodReadingName** (positional)
+
+    This function checks if Readingname  is a valid format which
+    means up to MAXLEN:RN and consisting of any UTF-8 character except
+
+    whitespace (\s)
+
+    If the identifier starts with a dot ., it's considered to be an
+    internal identifier and is treated differently in visualization,
+    i.e. hidden. The leading . is not included in MAXLEN\_RN length
+    considerations.
+
+    For valid identifiers a true value is returned, false otherwise. This
+    function can be used in if-constructs directly to test whether a
+    Readingname is valid or not.
+
+- **makeDeviceName** (positional)
+- **makeReadingName** (positional)
+
+# AUTHOR
+
+    maintenance, refactoring:
+      RichardCZ @ forum.fhem.de
+
+# COPYRIGHT
+
+Copyright (c) 2020-present RichardCZ @ forum.fhem.de
\ No newline at end of file