Entwicklungsumgebung einrichten

1. Befolgen Sie die Schritte beschrieben in Ausführung mit Python um den Collectu Core lokal bereitzustellen.

2. Wir empfehlen die Verwendung eines Versionskontrollsystems wie z.B. GitHub, GitLab, oder Bitbucket zur Verwaltung Ihrer benutzerdefinierten Module. Erstellen Sie dazu ein Repository und fügen Sie es zu Collectu hinzu. Navigieren Sie dazu zu:

   cd collectu-core/src/modules

   und fügen Sie dann Ihr Repository als Submodul hinzu, durch:

   git submodule add https://github.com/my_repo.git

   Wenn Sie kein Versionskontrollsystem verwenden, erstellen Sie einfach einen neuen Ordner in collectu-core/src/modules.

3. Alle Module in Ihrem benutzerdefinierten Modulordner müssen sich in einem der folgenden Ordner befinden: inputs, outputs, oder processors.

   Die Ordnerstruktur sieht dann etwa so aus:

   collectu-core/src/modules/            # The modules folder from collectu-core.
   │
   └── my_modules/                       # The folder for your modules.
       │
       ├── ...                           # Optional files like gitignore or readme.
       │
       ├── inputs/                       # Directory for input modules.
       │   │
       │   ├── __init__.py               # Initialization file.
       │   │
       │   └── topic/                    # A directory for grouping modules e.g. mqtt.
       │       ├── __init__.py
       │       └── my_first_module_1.py  # A module.
       │
       ├── outputs/                      # Directory for output modules.
       │   │
       │   ├── __init__.py
       │   │
       │   └── topic/
       │       ├── __init__.py
       │       └── my_second_module_1.py
       │
       └── processors/                   # Directory for processing modules.
           │
           ├── __init__.py
           │
           └── topic/
               ├── __init__.py
               └── my_third_module_1.py

4. Tragen Sie den Namen des neu erstellten Ordners, der Ihre Module enthält, in die settings.ini Datei ein, z. B. custom_module_folder=my_modules.

5. Jetzt können Sie mit der Erstellung Ihrer eigenen Module und deren Versionierung über Ihr eigenes Git-Repository beginnen.

   Wenn Sie ihre Module mit Collectu Hub synchronisieren möchten, verwenden Sie:

   python src/main.py --send_modules

   , um sie zu senden (es werden nur Module in Ihrem benutzerdefinierten Modulordner gesendet) und

   python src/main.py --update_modules

   , um sie herunterzuladen (alle Module werden aktualisiert).

   Um Module herunterzuladen, die lokal nicht verfügbar sind, gehen Sie wie folgt vor:

   python src/main.py --download_modules all

   Warnung

   Das Attribut __version__ wird automatisch durch den Collectu Hub gesetzt!
   Info

   Wenn Sie die Modulversionen bestehender Konfigurationen aktualisieren möchten, öffnen Sie die Konfiguration auf dem Collectu Hub und klicken Sie auf die folgende Schaltfläche: