|
Note
|
PySignalduino ist noch in Entwicklung. Es gibt bisher keine stabile Version – nutzen Sie die Software mit entsprechender Vorsicht. |
-
Python 3.8 oder höher
-
pip (Python Package Installer)
-
Ein SIGNALDuino-Gerät mit serieller oder TCP-Verbindung
-
Optional: Ein MQTT-Broker (z.B. Mosquitto) für die MQTT-Integration
PySignalduino benötigt folgende Python-Pakete:
-
pyserial– Serielle Kommunikation -
pyserial-asyncio– Asynchrone serielle Unterstützung -
aiomqtt– Asynchroner MQTT-Client (ersetztpaho-mqttin der asynchronen Version) -
python-dotenv– Laden von Umgebungsvariablen aus.env-Dateien -
requests– HTTP-Anfragen (für Firmware-Download)
Diese Abhängigkeiten werden automatisch installiert, wenn Sie das Paket mit pip install -e . installieren.
Die einfachste Methode ist die Installation aus dem geklonten Repository im Entwicklermodus:
git clone https://github.com/Ein-Einfaches-Beispiel/PySignalduino.git
cd PySignalduino
pip install -e .Dadurch wird das Paket signalduino-mqtt in Ihrer Python-Umgebung installiert und alle Runtime-Abhängigkeiten werden erfüllt.
Falls Sie das Paket nicht installieren, sondern nur die Abhängigkeiten nutzen möchten (z.B. für Skripte im Projektverzeichnis):
pip install -r requirements.txtDie Datei requirements.txt enthält die gleichen Pakete wie oben aufgelistet.
Für Beiträge zum Projekt oder zum Ausführen der Tests installieren Sie zusätzlich die Entwicklungsabhängigkeiten:
pip install -r requirements-dev.txtDies installiert:
-
pytest– Testframework -
pytest-mock– Mocking-Unterstützung -
pytest-asyncio– Asynchrone Testunterstützung -
pytest-cov– Coverage-Berichte
Überprüfen Sie, ob die Installation erfolgreich war, indem Sie die Hilfe des Hauptprogramms aufrufen:
python3 main.py --helpSie sollten eine Ausgabe mit allen verfügbaren Kommandozeilenoptionen sehen.
Für eine konsistente Entwicklungsumgebung steht eine DevContainer-Konfiguration bereit. Öffnen Sie das Projekt in Visual Studio Code mit der Remote-Containers-Erweiterung, um automatisch alle Abhängigkeiten in einem isolierten Container zu installieren.
Details finden Sie in der [DevContainer-Dokumentation](devcontainer_env.md).
Nach der Installation können Sie:
-
Die Schnellstart-Anleitung befolgen.
-
Die Konfiguration über Umgebungsvariablen einrichten.
-
Die MQTT-Integration testen.