Auftraggeber und Betreuer: Franz Meyer. Realisiert von: Stefan Käser I3SE, Erich Buri I3SE,

Transkript

1 Projekthandbuch Das Ziel vom Projekt Poncho ist es, ein Framework zu entwickeln, das eingesetzte werden kann um Überwachungs- und Steuerungsanwedungen zu entwickeln. Das vorliegende Dokument ist das Projekthandbuch. Es dient als einheitliche Handlungsgrundlage für alle Projektbeteiligten und legt damit den allgemeingültigen technischen und organisatorischen Rahmen fest.

2 Auftraggeber und Betreuer: Franz Meyer Realisiert von: Stefan Käser I3SE, Erich Buri I3SE, Datum: 25. Oktober 2004 Schule: Berner Fachhochschule BFH Hochschule für Technik und Informatik HTI Quellgasse 21 Postfach 1180 CH-2501 Biel/Bienne Ablage: CVS: cvs.hta-bi.bfh.ch:/var/cvsreps/projects/poncho

3 Datum Status Author Visum Erster Entwurf Erich Buri burie Überarbeitung Stefan Käser kases Überarbeitung nach Review Erich Buri burie Überarbeitung nach Voranalyse Erich Buri burie Überarbeitung nach Konzept Erich Buri burie Design Anpassung Erich Buri burie Anpassung für Diplomarbeit Erich Buri burie Tabelle 1: Änderungsprotokoll

4 Inhaltsverzeichnis 1 Allgemeines Zweck des Dokumentes Projektbeschreibung Ausgangssituation Ziele Erwartete Ergebnisse und Projektziele Meilensteine 7 4 Vorgehensstrategie Allgemein Phasenmodell Zeitliche Aufteilung Methoden und Werkzeuge 8 6 Standards und Richtlinien Allgemein Sourcecode CVS Richtlinien

5 1 Allgemeines 1.1 Zweck des Dokumentes Das Projekthandbuch dient als einheitliche Handlungsgrundlage für alle Projektbeteiligten und legt damit den allgemeingültigen technischen und organisatorischen Rahmen fest. Es kann als Ausschreibungsunterlage (bei Offerteneinholungen), als Angebotsbestandteil (bei Offertenreichungen) oder als Vertragsbestandteil verwendet werden. Das Projekthandbuch ist soweit wie möglich als statisches Dokument zu führen. Dennoch ist es zu Beginn und am Schluss jeder Phase zu überprüfen und an die neuen Erkenntnisse anzupassen. Änderungen im Projekthandbuch müssen durch den Projekt-Auftraggeber genehmigt werden. 2 Projektbeschreibung 2.1 Ausgangssituation In der heutigen Zeit besteht immer mehr das Bedürfnis Geräte und Applikationen dezentral zu überwachen und zu steuern. Vorausgehende Projekte wie Polyphemus I und Polyphemus II haben dieses Bedürfnis für eine Türsteuerung realisiert. Dieser Anwendungsfall ist aber sehr spezifisch und nicht leicht erweiterbar. Möchte man nun ein anderes Objekt als eine Türe überwachen, ist dies momentan nicht ohne weiteres möglich. Daraus ergibt sich das Bedürfnis nach einem flexibleren und leichter ausbaubaren Produkt, dass auch weitere Anwendungsfälle (z.b. Chalet Überwachung, Netzwerkadministration,... siehe auch Projektantrag) ohne Probleme abdecken kann. 2.2 Ziele Ziel ist es eine Framework zu entwickeln, auf dem ein System wie Polyphemus aufgebaut werden kann. Gleichzeitig soll durch einen flexiblen und modularen Aufbau sichergestellt werden, dass damit neue Anwendungsgebiete und dadurch neue Märkte erschlossen werden können. Das System soll sowohl auf einem PC, als auch auf einem embedded Device laufen. Es soll daher auf der Serverseite auf Linux gesetzt werden. Dies hat sich in jüngster Vergangenheit als äusserts Portierbar erwiesen. Zudem ist mit embedded Linux, der Weg zu kleinen, Industriell verwendbaren Geräten offen. Diese Möglichkeit soll auch genutzt werden. Somit ist die Erarbeitung von Know-How in diesem Bereich ein wichtiger Teil des Projektes. 5

6 Im Client-Bereich, insbesondere für die Entwicklung von Benutzerinterfaces, soll eine Java- Implementation zur Verfügung stehen. Das Java Interface soll aber die gleiche Funktionalität bieten wie auch das embedded Interface. Somit können auch Devices für normale PC s mit Java entwickelt werden. Ziel Beschreibung 1 Evaluation von Lösungsvorschlägen und Möglichkeiten 2 Know-How aufbauen im Bereich embedded Linux Systeme 3 Erarbeiten einer Systemarchitektur 4 Konzept und Design des Frameworks und der Interfaces 5 Implementation eines einfach erweiterbaren Frameworks 6 Proof-of-Concept anhand der Polyphemusaufgabenstellung 7 Integration weiterer Geräte Tabelle 2: Projektziele 2.3 Erwartete Ergebnisse und Projektziele 1. Ein effizientes, flexibles, modulares, leicht erweiterbares Framework zur Kommunikation, Überwachung und Steuerung von und zwischen Device s erarbeiten. 2. Eine Schnittstelle für standard Devices (TriggerDevice, SwitchDevice), sowie für neue Device s (z.b. Rolladensteuerung, Temperaturfühler), 3. eine entsprechende Schnittstelle für die Kontrolle bzw. zur Darstellung in einem GUI (JAVA) 4. und eine Schnittstelle zur Administration (erfassen von Usern und zuordung von Devices). 5. Die Kern-Software muss auf einem Embedded Board unter embedded linux lauffähig sein. 6. Als Kommunikationsplatform und als Benutzerverwaltung soll Jabber geprüft und wenn möglich verwendet werden. Das Framework soll jedoch die Möglichkeit bieten die Kommunikationsplattform auszutauschen. 7. Verschlüsselung und Authentifizierung, von Messages die zwischen den Devices übertragen werden, soll möglich sein. 8. Wo immer möglich soll Free- und Open Source Software verwendet werden. 9. Das Projekt selber soll unter einer Open Source Lizenz freigegeben werden. 10. Erste spezielle Devices (Audio, Video via Webcam, etc.) sollen implementiert und integriert werden. 6

7 3 Meilensteine Im folgenden sind die wichtigsten Meilensteine des Projektes aufgeführt. Die ersten drei Meilensteine sind fix. Die darauf folgenden Meilensteine sind abhängig von der Zusammenarbeit mit der Cerberus-Projektgruppe. Wr haben die Hoffnung das GUI des Cerberus Projektes integrieren zu können. Unser weiteres Vorgehen wird vom Funktionsumfang dieses GUIs abhängig sein. 6. Nov. 04: Framework und Interfaces implementiert. Das während der Semesterarbeit entworfene Framework ist implementiert. Das JabberPeer und das JabberNetCtrl sind implementiert so das alle Devices getestet werden können. Das JabberNetDevice muss noch nicht vollständig implementiert sein. Alle Komponenten des Frameworks sind getestet. 9. Nov. 04: Integration Jabber Server. Die Umsetzung des Poncho Frameworks auf Basis des Jabber Servers ist abgeschlossen. Alle Funktionenen des NetDevices sind vollständig implementiert und gestestet. 16. Nov. 04: Integration Embedded Device. Embedded Linux Konfiguration ist abgeschlossen und dokumentiert. Jabber Server läuft auf embedded Linux. Die Installation des Poncho Framworks unter Linux und embedded Linux ist dokumentiert. 2. Dez. 04: Realisierung spezieller Devices abgeschlossen. Ein spezielles Device zum Logging ist implementiert und getestet. Ein spezielles Device das mind. das capturen von Einzelbildern erlaubt ist implementiert und getestet. Ein spezielles Device das eine Audioverbindung zwischen zwei Devices ermöglicht ist implementiert und getestet. 2. Dez. 04: Realisierung eines Administartions Frontend. Ein Eclipse Plugin zum administrieren von Poncho Netzwerken ist implementiert und geteste. Mit dem GUI können Benutzer erfasst werden. Mit dem GUI könen Konfigurationsdateien für Devices erstellt und bearbeitet werden. Mit dem GUI könen die Verbindungen zwischen den Devices konfiguriert werden. Mit dem GUI kann die aktuelle Konfiguration eines Poncho Netzwerkes untersucht und angepasst werden. 7

8 4 Vorgehensstrategie 4.1 Allgemein Die Diplomarbeit basiert auf dem Konzept aus der Semesterarbeit. Initialisierung, Voranalyse und Konzept wurden während der Semesterarbeit erstellt und abgeschlossen. Mit der Diplomarbeit beginnt nun die Phase der Realisierung. Sobald die Phase Realisierung abgeschlossen ist beginnt die Integrationsphase. 4.2 Phasenmodell Während der Initialisierung werden Dokumente für das Projektmanagement erarbeitet und die Organisation geregelt. In der Phase Voranalyse werden verschiedene Lösungsansätze und Technologien geprüft und erstes Know-How erarbeitet. In der Phase Konzept soll ein detailierts Konzept erarbeitet und dokumentiert werden. Die zu verwendenden Technologien und die später zu erstellenden Systemteile werden im Konzept definiert. In der Phase Realisierung wird das Poncho Framework erstellt, getestet und dokumentiert. Das in dieser Phase implementierte Framework enthält alle in der Systemarchitektur beschribenen Komponenten. In der Phase Integration wird die Polyphemus Aufgabenstellung (Türüberwachung) mit Hilfe des Poncho Frameworks umgesetzt. Zudem soll das GUI der Cerberus-Gruppe mit dem Poncho Framework zusammengeführt werden. 4.3 Zeitliche Aufteilung Die Phasen Initalisierung, Voranalyse und Konzept wurden im Rahmen der Semesterarbeit durchlaufen. Die Diplomarbeit umfasst die Phasen Realisierung und Integration. 5 Methoden und Werkzeuge Das Projektmanagement für die Semesterarbeit erfolgte nach Hermes 95. Für alle offiziellen Dokumente wird L A TEXverwendet. Die Generierung der Dokumente in HTML und PDF wird vom CVS Server automatisch bei jedem Check-In durchgeführt. Zum editieren der L A TEX Dokumente kann ein beliebiger Editor verwendet werden. 8

9 Für den Projektplan ist MS Projectöder Planerßu verwenden. Über folgende Fragen sollten sämtliche Projektteilnehmer immer informiert sein: Was machen wir? Wer weiss was? Wer hat was gemacht? Wie machen wir es? Wann wird es fertig sein? Damit dies mögliche ist werden wir die im folgenden aufgelisteten Werkzeuge einsetzen: Frage Methode Werkzeug Was machen wir? Liste der aktuellen Aktivitäten Wiki Wer weiss was? Liste der aktuell Bearbeiteten Items Sourceforge Item Tracking System Wer hat was gemacht? Aktivitäten History CVS Wie machen wir es? Konzept und aktuelle Dokumentation Wiki, Homepage Wann wird es fertig sein? Balkendiagram auf der Webseite MS Project, Webseite Tabelle 3: Methoden und Werkzeuge Die Projekt Homepage findet man unter folgender Adersse: 6 Standards und Richtlinien 6.1 Allgemein Alle Dokumente die fürs Projekt relevant sind müssen im CVS abgelegt werden. Wenn ein neues Dokument hinzugefügt wird, muss zudem die Homepage um einen Link auf dieses Dokument erweitert werden. 6.2 Sourcecode Alle Sourcen werden unter der GPL veröffentlicht. Aus diesem Grund muss die GPL im Kopf jedes Sourcefiles enthalten sein. Weiter muss beim Programmieren darauf geachtet werden das nur Bibliotheken verwendet werden, die selber unter einer Open Source Lizenz veröffentlicht wurden. Im Kopf jedes Sourcefiles muss ausserdem mindestens eine kurze Beschreibung des entsprechenden Programmteils oder der Beschriebenen Klasse vorhanden sein. Für das Programmieren in C++ wird die GNU Toolchain verwendet. Die IDE kann frei gewählt werden. Das kompilieren muss mit Hilfe von Makefiles erfolgen. Dabei ist es wichtig 9

10 das alle Teilsysteme die später auch auf der embedded Plattform laufen sollen cross-compiliert werden können. 6.3 CVS Richtlinien Im Folgenden wird die grobe Struktur des CVS Repository erklärt. Ordner Funktion doc/ Enthält die gesamte Dokumentation. Jedes Dokument muss in einem eigenen Unterverzeichnis abgelegt werden. doc/latex Enthält Dokumentationen und templates zum erstellen von L A TEX Dokumenten doc/www/ Enthält die Dateien der Homepage build/ src/ Enthält Scripts und Daten die zum kompilieren benötigt werden Enthält alle Sourcen. Die finale Struktur muss noch festgelegt werden Tabelle 4: CVS Repository Organisation 10