All posts by Jacques Eilers

Git aufräumen und ReadMe schreiben

Nachdem alle wichtigen Dateien in die Repository gepusht wurden, fingen das schreiben der ReadMe an. Dies ist eine Anleitung zur Inbetriebnahme des Projekts, die beschreibt, welche Teile man braucht, welche Dinge installiert werden müssen und eine Beschreibung der genutzten Technologien, was in diesem Fall die Auflistung der genutzten C++ Librarys und deren Version war.

Als die Anleitung fertig geschrieben war, ging es an das Aufräumen der Repository. Dies bestand daraus, die ReadMe auf Fehler zu Überprüfen, bereits gepushte Dateien in sinnvolle Ordner zu packen und den Code auf vernünftige Kommentare zu prüfen. Außerdem war es gerade in diesem Fall wichtig den Code darauf zu überprüfen, ob noch private Daten, wie z.B. das Passwort des eigenen Netzwerkes im Code sind, da mit IoT Technologien gearbeitet wurde.

Repository erstellen und MQ135

Nach der Erstellung der Repository auf Github, startete die erste Ideensammlung für die Strukturierung der readMe. Hierbei ging es hauptsächlich um eine grobe Aufteilung der Themen, aus welcher eine solche Datei meist aufgebaut ist. Die ersten Bausteine waren ein TOC oder auch Table of Contents was eine Art Inhaltsverzeichnis ist, eine generelle Beschreibung der Inbetriebnahme der Projekts, sowie einer Erklärung der genutzten Bibliotheken und da das ganze wie ein echtes Produkt behandelt werden sollte, eine Lizenz.

Danach ging an die ersten Versuche mit dem MQ135 Sensor. Hierfür wurde ein simpler Test-Code geschrieben. Jedoch hat der Sensor unpassende Werte geliefert. Selbst nach der Kalibrierung und testen, wo der Sensor hoher Rauchkonzentration ausgesetzt wurde, lieferte dieser keinen richtigen Werte. Da die Fehlerquelle bis zuletzt nicht gefunden werden konnte, wurde der MQ135 Sensor aus dem Projekt gestrichen.