Systemdoku Webplattform Dokumentenversion: 0.3 http://www.kyoto4u.de 2009 bei Janek Winz
Inhaltsverzeichnis K APIT E L / THE M A: SEIT E: 1 Das Kyoto4u Projekt...3 2 Systemanforderungen...3 3 Installation...6 3.1 Servlet-Container...6 3.2 Java VM...6 3.3 SQL Datenbank...6 3.4 Installation Kyoto4u Webplattform (Windows)...7 3.5 Installation Kyoto4u Webplattform (Nicht-Windows Plattformen)...7 3.6 Datenbankeinstellungen...8 3.7 Erzeugen der Datenbank und des Admin Kontos...8 4 Starten des Systems...9 4.1 Anmelden am System...10 4.2 Ändern des Admin Kennwortes...11 4.3 Anlegen Arbeitsplätzen...13 4.4 Anlegen von Geräten...14 4.5 Anlegen von Benutzern...16 4.6 Schaltzeiten festlegen...18 5 Datensicherung...19 6 Technische Unterstützung...21 Seite 2 von 21 http://www.kyoto4u.de
1 Das Kyoto4u Projekt Das freie Closed-Source-Projekt Kyoto4u ist eine IT basierte Lösung zur Optimierung des Energieverbrauches von mittelständische Unternehmen, kleinen Konzernen und Privathaushalten. Unnötiger Energieverbrauch wird verhindert und der CO2-Ausstoß der Energielieferanten verringert. Eine weltweite Verbreitung von Kyoto4u wird zu maßgeblichen CO2-Einsparungen führen. 2 Systemanforderungen Kyoto4u wurde möglichst Systemressourcen schonend entwickelt, d.h. es ist möglich die Kyoto4u Plattform auf einem bereits in der Firma bestehenden Server zu installieren: der Prozessor und Speicher des Servers wird dabei kaum durch die Kyoto4u Plattform Software belastet. Bei 1-10 Kyoto4u Benutzern muss Ihr Server dabei lediglich Leistungsreserven frei haben, die ca. der Leistung eines Pentium III mit 500 MHz entsprechen. Wenn Sie einen neuen Server für diesen Zweck anschaffen möchten, können Sie ein Gerät mit Atom Prozessor anschaffen. Die Rechenleistung eines solchen verbrauchsoptimierten Systems reicht für Kyoto4u vollkommen aus. Folgende Technologien sind für den Betrieb der Kyoto4u Plattform erforderlich:
Software: Server: theoretisch überall, wo Java läuft, also z.b. Windows 98 Windows Vista, Windows Server, Linux und Mac OS (bislang erfolgreich getestet unter: Windows 2000 Prof. Sp4, XP SP2/SP3, Vista 32 Bit SP2, Vista 64 Bit Sp2 und Open Suse Linux 10.0 bitte andere Plattformen testen und Erfahrungen melden!) ServletContainer: Tomcat 5.5.x VM: Java 1.50 oder neuer, (bei X10 Java Comm. API 2.0) Datenbank: MySQL 5 oder andere von Hibernate unterstützte SQL Datenbank Smart Home Netzwerke: PLC Powerline: X10 433M Hz Funk: Intertechno Für das Steuern von Verbrauchern (=Geräte, die Energie verbrauchen) wird ein Smart Home Netzwerk benötigt. Derzeit unterstützt Kyoto4u das X10- und Intertechno-Protokoll. Beide Systeme erlauben eine kabellose Installation von fernsteuerbaren RelaisModulen. Bei X10 wird die vorhandene Stromleitung zur Datenübertragung verwendet. Intertechno arbeitet per Funk im 433 MHz Band. Die Kombination beider Systeme ist möglich.
Beispiel einer Kyoto4u Installation: Hardware (Server): Prozes s or: Intel Pentium III, vergleichbar oder besser Taktrate: 500MHz oder besser RA M: 512MB oder besser Festplatte: 1 GB frei oder besser Bei Eins atz von X10 : CM11 oder CM11 USB PC Interface Einsatz von Intertechno: Allnet ALL3000RF Mk2 PC Interface
3 Installation 3.1 Servlet-Container Downloaden Sie von http://tomcat.apache.org/download-55.cgi den aktuellen Tomcat 5.5.x Servlet Container. Entpacken Sie dieses Archiv in ein beliebiges Verzeichnis auf dem Server. 3.2 Java VM Wenn Ihr Server noch über kein installiertes Java oder es älter als Version 1.50 (5.0) ist, laden Sie das Java Runtime Environment (JRE) Version 5.0 von http://java.sun.com/javase/downloads/index_jdk5.jsp herunter und installieren Sie sie auf dem Server in ein beliebiges Verzeichnis. 3.3 SQL Datenbank Wenn auf Ihrem Server keine Hibernate kompatible SQL Datenbank läuft, benötigen Sie eine entsprechende Datenbank. Wir empfehlen Ihnen die kostenlose SQL Datenbank MySQL Community Server 5.0. Ihr Leistungsumfang genügt den Anforderungen der Kyoto4u Plattform völlig und die Community Edition ist kostenfrei verfügbar. Sie können MySQL 5 unter http://dev.mysql.com/downloads/mysql/5.0.html#downloads herunterladen. Installieren Sie anschließend MySQL in ein beliebiges Verzeichnis und starten Sie die Datenbank. Achtun g: Falls der Server über eine lokale Firewall verfügt, achten Sie darauf, dass die Kyoto4u Plattform Zugriff auf den SQL Server Port erhält. Tip: Es ist auch möglich, die SQL Datenbank auf einem anderen Server, als dem Kyoto4u Server laufen zu lassen. In dem Fall ist ebenfalls sicherzustellen, dass die Firewalls des Kyoto4u Servers und des SQL Datenbank Servers eine Kommunikation zulassen.
3.4 Installation Kyoto4u Webplattform(Windows) Rufen Sie den Installer der Kyoto4u Plattform auf. Kyoto4u Installation Bei der Installation werden Sie zum Pfad Ihrer Tomcat Installation befragt. Während der Installation wird im webapps -Verzeichnis Ihrer Tomcat Installation das Verzeichnis kyoto4u angelegt, in dem die Plattform Dateien gespeichert werden. Bitte beachten: die Datenbank muss vor dem Start der Plattform laufen! 3.5 Installation Kyoto4u Webplattform(Nicht-Windows Plattformen) Kopieren Sie aus dem heruntergeladenen ZIP-Archiv die WAR- Datei in das Webapps Verzeichnis Ihres Tomcats. Starten Sie einmal den Tomcat und beenden Sie ihn wieder. Das WAR Archiv sollte automatisch entpackt und ein Verzeichnis kyoto4u im Webapps Verzeichnis angelegt worden sein. Damit Sie Kyoto4u nutzen können, muß vor einem erneuten Tomcat-Start die Datenbank eingerichtet werden (s. Nächstes Kapitel).
3.6 Datenbankeinstellungen Öffnen Sie die Datei hibernate.cfg.xml im Unterverzeichnis \WEB-INF\classes des Verzeichnisses kyoto4u mit einem Texteditor (z.b. Notepad unter Windows oder z.b. vi unter Linux). In dieser Datei tragen Sie den Pfad zur Datenbank, den Benutzernamen und das Passwort für den Datenbankzugriff, den Datenbankdialekt und den Datenbanktreiber der zu verwendenden Datenbank ein. Hier ein Beispiel für den Einsatz mit einer MySQL Datenbank: Hibernate Konfiguration anpa s s en 3.7 Erzeugen der Datenbank und des Admin Kontos Starten Sie die Datenbank. Rufen Sie einmalig die Datei makeconfig.bat im Verzeichnis \WEB-INF\classes auf. Es wird automatisch ein Standard-Benutzerkonto angelegt. Achten Sie beim Ablauf dieses Programmes, ob Fehlermeldungen auftreten. Sollten Sie eine Fehlermeldung erhalten, müssen Sie den Fehler beheben und diesen Vorgang wiederholen. Lief das Program m ohne Fehlermeldun g durch, löschen Sie diese Datei aus Sicherheits gründen nach der ersten Anmeldung am Sy ste m.
4 Starten des Systems Die Kyoto4u Plattform besteht aus zwei Teilen: Der Webplattform und der SchedulerAnwendung. Dieses Handbuch beschreibt nur die Webanwendung. Informationen zum Scheduler erhalten Sie in der Systemdokumentation des Schedulers (http://www.kyoto4u.de/download). Die Webplattform starten Sie durch den Start des Tomcat-Servers : tomcat-verzeichnis\bin\startup.bat (Windows) bzw. tomcat-verzeichnis/bin/startup.sh (Linux) Bitte beachten: die Datenbank muss vor dem Start der Kyoto4u Web-Plattform + dem Scheduler laufen und eingerichtet worden sein! Für die Kommunikation über das Netzwerk müssen für den Scheduler der Ports 7000 und für die Webanwendung / den Tomcat Port 8080 geöffnet sein.
4.1 Anmelden am System Wenn Sie sich direkt oder per Remotedesktop auf dem Server befinden, starten Sie einen Browser und geben in der Adresszeile http://127.0.0.1:8080/kyoto4u ein. Wenn Sie von einem anderen Rechner über das Netzwerk (LAN) oder Internat (WAN) auf den Server zugreifen, geben Sie in der Adresszeile des Browsers http://<ip des Servers>:8080/kyoto4u ein. Kyoto4u Anmeldebilds chirm Es erscheint der Anmeldebildschirm, wo Sie sich mit dem Benutzernamen admin@kyoto4u.de und dem Passwort admin anmelden. Achtun g: das Admin Kennwort sofort ändern!
4.2 Ändern des Admin Kennwortes Melden Sie sich am System an. Sie gelangen in die Übersicht. Dort klicken Sie auf den Button Benutzer. Es wird eine Auflistung der eingerichteten Benutzerkonten angezeigt. Kyoto4u Benutzerverwaltung Wählen Sie dort den Benutzer Admin durch einen Mausklick auf die ID. Es werden daraufhin die Einstellungen für diesen Benutzer angezeigt. Sie können nun ein neues Kennwort für den Admin festlegen.
Kyoto4u Benutzerdaten ändern Verlassen Sie diese Ansicht durch Klick auf den Speichern -Button. Das neue Kennwort wird daraufhin in der Datenbank gespeichert und ist sofort gültig. Möchten Sie hingegen keine Änderungen vornehmen, klicken Sie auf den Zurück Button. In dem Fall werden die hier vorgenommenen Änderungen verworfen.
4.3 Anlegen Arbeitsplätzen Arbeitsplatzverwaltung Schaltzeiten werden nach Arbeitsplätzen sortiert. Es ist sinnvoll, Räume als Arbeitsplätze im System zu hinterlegen, um den Überblick zu behalten. Allerdings ist es Ihnen freigestellt, Schaltzeiten hier nach einem anderen System zu gruppieren. Zum Anlegen von neuen Arbeitsplätzen klicken Sie in dieser Ansicht auf den Hinzufügen-Button. Möchten Sie hingegen einen bestehenden Platz ändern, klicken Sie in dieser Ansicht auf seine ID.
4.4 Anlegen von Geräten Kyoto4u Geräteverwaltung Klicken Sie in der Hauptansicht auf den Geräte -Button. Sie gelangen in die Übersicht der installierten Geräte. Dort klicken Sie unten auf den Hinzufügen Button. Es erscheint eine neue Ansicht, in der Sie die Parameter eines neuen Gerätes eingeben können:
Kyoto4u Anlegen von Geräten Bedeutung der Einträge: Übertragungsmedium: Es können unterschiedliche Übertragungsmedien gewählt werden. Es ist sogar möglich, diese Medien kombiniert einzusetzen (z.b. um Reichweitenprobleme zu begegnen oder aus Kostengründen). Wählen Sie hier das Übertragungsmedium, dass zum Ansteuern des Empfängers (Schalters/Dimmers) dieses Gerätes Hauscode: verwendet wird. Der Hauscode ist Teil der Adresse des Empfängers. Die Kombination aus Hauscode und Gerätecode muss bei der gesamten Installation eindeutig sein, um Gerätecode: diesen Empfänger einzeln zu schalten. Der Gerätecode ist der zweite Teil der Typ: Adresse des Empfängers. Typ des eingesetzten Empfängers
(Relais, Dimmer,..). Ist ein Computer angeschlossen, der vor einer Abschaltung seiner Stromzufuhr automatisch heruntergefahren werden Beschreibung: soll, muss hier PC gewählt werden. Geben Sie hier eine eindeutige Beschreibung des Gerätes an, anhand IP / Port: der Sie das Gerät gut zuordnen können. Handelt es sich bei dem zu steuernden Gerät um einen PC, geben Sie hier seine IP Adresse ein und den Port (Standard: Port 7000). Ansonsten bleiben diese Feld Benutzerreaktion: leer Hier geben Sie die Zeit (in Min.) an, die einem PC Benutzer bleibt, auf eine Abschaltwarnung zu reagieren. Nach Ablauf dieser Zeit wird sein PC Abschaltzeit: automatisch herunter gefahren. Dies ist die Zeit, die ein PC zum herunterfahren benötigt. Bedenken Sie auch das gelegentliche Einspielen von Systemupdates. Diese können zeitweise den Herunterfahrvorgang verlängern. Wenn Sie alle Angaben vorgenommen haben, können Sie die Einstellungen durch einen Klick auf den Speichern -Button sichern. Möchten Sie die Daten doch verwerfen, klicken Sie auf den Abbruch -Button. Im Falle von Eingabefehlern, wird die Ansicht nicht geschlossen, sondern Sie erhalten einen Hinweis vom System in roter Schrift. Nach der Korrektur der Eingabe, können Sie die Daten speichern. 4.5 Anlegen von Benutzern Klicken Sie in der Hauptansicht auf den Button Benutzer. Sie gelangen in eine Übersicht der bereits eingerichteten Benutzerkoten.
Klicken Sie dort unten auf den Hinzufügen -Button. Kyoto4u neuen Benutzer anlegen Es erscheint eine neue Ansicht, in der Sie die Parameter eines neuen Benutzers angeben können. Während der Vor- und Nachname im System mehrfach aufkommen dürfen, muss die eingegebene Email-Adresse eindeutig sein. Sie ist später der Anmeldename für das System. ACH T U N G: Wählen Sie ein sichere s Pas s w ort, wa s kein Wort aus dem Wörterbuch ist, und möglich st zufällig verteilt aus Zahlen, Sonderzeichen und Buch st ab en besteht und möglich st lang ist (z.b. 10 Zeichen). So erschweren Sie Hackern den Zugriff auf das Syste m.
Bedenken Sie, das s ein Hack er son st unerwün s chte Schaltun gen vornehmen kann! 4.6 Schaltzeitenfestlegen Kyoto4u Schaltzeiten In der Übersicht klicken Sie unten auf den Hinzufügen -Button. Es erscheint eine neue Ansicht, in der Sie die Parameter einer neuen Schaltzeit festlegen können.
neue Schaltzeiten hinzufügen Geben Sie den Wochentag und die Uhrzeit an, wann der Schaltbefehl ausgeführt werden soll. Wählen Sie dann das zu schaltende Gerät und den auszuführenden Befehl. Mit einem Klick auf den Speichern -Button wird die neue Schaltzeit in der Datenbank gesichert und ist ab sofort gültig. 5 Datensicherung Dieses Verfahren gilt nur für die Datenbank MySQL. Die Kyoto4u Datenbank befindet sich komplett im Verzeichnis \data\kyoto4u unterhalb des MySQL Verzeichnisses:
Speicherort Datenbank Fahren Sie die Kyoto4u Plattform regelmäßig herunter und sichern Sie dieses Verzeichnis komplett auf einen externen Datenträger (z.b. DVD RAM- Medium oder USB Stick). Im Falle eines Datenbankschadens können Sie dieses Verzeichnis vom BackupMedium zurückkopieren und haben die Datenbank wieder im Zustand vom Sicherungsdatum. Bei größeren Datenbanken sind ggf. differentielle Backupverfahren einzusetzen.
6 Technische Unterstützung D ie Kyoto4u Software wird kostenfrei angeboten. Wenden Sie sich daher bitte bei Fragen zuerst an Ihren Systemadministrator oder geeignete Foren im Internet. Für Anregungen, konstruktive Kritik und Verbesserungsvorschläge können Sie sich wenden an: development ät kyoto4u punkt de Während der Beta-Phase können Sie auch Support über diese Email-Adresse erhalten. Ein Anspruch darauf besteht aber nicht! Weiterführende Informationen zu Kyoto4u erhalten Sie unter: Download: http://www.kyoto4u.de/download Web: http://www.kyoto4u.de 2009 bei Janek Winz http://www.winz-it.de