Bibliotheksverwaltung in CODESYS Katarina Heining Automatisierungstreff IT & Automation 2015

Transkript

1 Bibliotheksverwaltung in CODESYS Katarina Heining Automatisierungstreff IT & Automation 2015 CODESYS a trademark of 3S-Smart Software Solutions GmbH

2 Agenda 1 Was ist Bibliotheksmanagement? 2 Allgemeine Richtlinien für die Bibliothekserzeugung 3 Allgemeine Richtlinien für die Bibliotheksdokumentation 4 Dokumentation in CODESYS erste Schritte 5 Zusammenfassung & Fragen 2

3 Was ist Bibliotheksmanagement? Bibliotheken sind Sammlungen wiederverwendbarer Objekte: Bausteine, z. B. Funktionsblöcke und Funktionen Schnittstellen und deren Methoden und Properties Data Unit Types, z. B. Aufzählungen, Strukturen, Alias, Unions Globale Variablen, Konstanten, Parameterlisten Textlisten, Bilderpools, Visualisierungen, Visualisierungselemente Externe Dateien (z. B. Beispielbilder) Kurvenscheibentabellen Bibliotheken sind Standardobjekte in einem Projekt Wenige Anwender Siehe auch CODESYS Online-Hilfe 3

4 Eine Bibliothek in ein Projekt einbinden Bibliotheksmodule können in gleicher Weise verwendet werden wie die anderen definierten Bausteine und Variablen Bibliotheken können auf andere Bibliotheken verweisen, um die Auswahl verfügbarer Objekte zu erhöhen. Der Bibliotheksmanager verwaltet die Bibliotheken in einem Projekt. Sie werden mit Hilfe des "Library Repository Dialogs" auf dem System installiert. Der grundlegende Bibliothekstyp ist ".library*". Was ist Bibliotheksmanagement? Bibliotheken sind Sammlungen wiederverwendbarer Objekte wie z. B.: 4

5 Was ist Bibliotheksmanagement? Geschützte Bibliothekstypen sind aufgrund des Quellcodes nicht länger zugänglich: Schnittstellenbibliotheken (*._Itfs.library) dürfen keinen Quellcode generieren Container-Bibliotheken (*_Cnt.library) können nur Dokumentation und Bibliotheksmanager enthalten (Funktion: Übersetzung anderer Bibliotheken) *.compiled-library Verteilungs-/Verwendungstyp für Bibliotheken 5

6 Vorteile durch die Verwendung von Bibliotheken: Möglichkeit, den Code zu schützen Möglichkeit, den Code mit anderen Nutzern zu teilen Möglichkeit, mit mehreren Entwicklern am selben Projekt zu arbeiten Reduktion wiederkehrender Aufgaben durch die gemeinsame Behandlung von Problemen in Projekten Zeitersparnis Für Bibliotheksentwickler: Was ist Bibliotheksmanagement? Vorteile guter Dokumentation und effizienten Bibliotheksmanagements Zur Sicherung der Konsistenz und für optimalen Anwendersupport ist es wichtig, bestimmte Regeln zu beachten! Bitte wenden Sie die folgenden Regeln bei der Erzeugung, Referenzierung, Codierung und beim Schutz von Bibliotheken und von Dokumentation an. Siehe auch CODESYS Online-Hilfe 6

7 Agenda 1 Was ist Bibliotheksmanagement? 2 Allgemeine Richtlinien für die Bibliothekserzeugung 3 Allgemeine Richtlinien für die Bibliotheksdokumentation 4 Dokumentation in CODESYS erste Schritte 5 Zusammenfassung & Fragen 7

8 Allgemeine Richtlinien für die Bibliothekserzeugung Um Kompatibilitätsprobleme zu vermeiden, müssen Bibliotheken bestimmten Richtlinien folgen. Die Hauptpunkte: Definition eines nachvollziehbaren Bibliotheksnamens (notwendig) Hinweis: (.) in den Namen verhindern sonst->projekt statt Library Nutzung von Vorlagen zur Sicherung der Konsistenz (opt.) Nutzung einer gewohnten und möglichst konsistenten Projektstruktur (opt.) Registrierung eines weltweit einzigartigen Namensraums für die Bibliothek Eintrag in der Registry Ausfüllen der Projektinformation: Obligatorisch: Titel, Version, Firma Definition einer Kategorie zum Sortieren des Bibliotheksmanagers - sonst automatische Benennung mit Sonstige 8

9 Allgemeine Richtlinien für die Bibliothekserzeugung Referenzieren Sie andere Bibliotheken korrekt. (notwendig) Richten Sie externe und interne Schnittstellen anwendungsgerecht ein. (notwendig) Implementieren Sie ein benutzerfreundliches Fehlerhandling. (notwendig) Wenden Sie die korrekte Methode bei der Lieferung an. (notwendig) Folgen Sie einer Namenskonvention, um clean code zu erhalten. (optional) Achten Sie bei der Arbeit an einer bestehenden Bibliothek auf die Schnittstellenkompatibilität zu Vorgängerversionen. Verwenden Sie bei der Bearbeitung eines Projekts unterschiedliche Versionsnummern für jede Bibliothek. Siehe auch CODESYS Online-Hilfe 9

10 Allgemeine Richtlinien für die Bibliothekserzeugung Übung 1: Erzeugen eines neuen Bibliotheksprojekts 10

11 Agenda 1 Was ist Bibliotheksmanagement? 2 Allgemeine Richtlinien für die Bibliothekserzeugung 3 Allgemeine Richtlinien für die Bibliotheksdokumentation 4 Dokumentation in CODESYS erste Schritte 5 Zusammenfassung & Fragen 11

12 Vorbeugend: weniger Supportbedarf dank genauer Dokumentation Zeitsparend: Verkürzung der Entwicklungszeiten Redundanz: kein Know-How-Verlust bei Personalwechsel schnelle Einarbeitung von Nachfolgern Überblick über das Konzept einer bestimmten Bibliothek Zeit- und Ressourcenersparnis durch korrekte Funktionsbeschreibungen in einer Applikation Fehlerhandling und -meldungen helfen bei der Ursachenanalyse... Allgemeine Richtlinien für die Bibliotheksdokumentation Warum sollte man Zeit und Mühe in die Dokumentation investieren? 12

13 Allgemeine Richtlinien für die Bibliotheksdokumentation Jede Bibliothek sollte mit einer Dokumentation ausgeliefert werden. Fortgeschritten: Gestaltung der Dokumentation so, dass die kontextsensitive Online-Hilfe (F1) in der Applikation funktioniert und dass im Bibliotheksmanager eine vollständige, genaue Darstellung der Schnittstellen, Parameter usw. und deren Beschreibungen verfügbar sind. 13

14 Agenda 1 Was ist Bibliotheksmanagement? 2 Allgemeine Richtlinien für die Bibliothekserzeugung 3 Allgemeine Richtlinien für die Bibliotheksdokumentation 4 Dokumentation in CODESYS erste Schritte 5 Zusammenfassung & Fragen 14

15 Dokumentation in CODESYS Erste Schritte Übung 2: Hinzufügen einer Tabelle und eines Bildes 15

16 Agenda 1 Was ist Bibliotheksmanagement? 2 Allgemeine Richtlinien für die Bibliothekserzeugung 3 Allgemeine Richtlinien für die Bibliotheksdokumentation 4 Dokumentation in CODESYS erste Schritte 5 Zusammenfassung & Fragen 16

17 Zusammenfassung & Fragen Zusammenfassung Bibliotheken sind Sammlungen wiederverwendbarer Objekte. Halten Sie sich bei der Erstellung von Bibliotheken an die Regeln und helfen Sie so anderen Anwendern. Liefern Sie jede Bibliothek mit dazugehöriger Dokumentation aus. Beachten Sie bei der Erstellung Ihrer Dokumentation die Standard- Richtlinien. Vorteile: Zeitersparnis, reduzierter Supportbedarf und -aufwand. CODESYS enthält alle Bausteine für erfolgreiches Bibliotheksmanagement, inklusive Online-Dokumentation. 17

18 Zusammenfassung & Fragen Geplant für den 28. April 2015: Webinar (deutsch/englisch) zum Thema Bibliotheksmanagement in CODESYS für Fortgeschrittene Veröffentlichung der Webinare auf Youtube clips.codesys.com Standardschulung für Bibliotheksentwicklung Juni 2015 Weitere Informationen: 18

19 Inspiring Automation Solutions Vielen Dank für Ihre Aufmerksamkeit! CODESYS ist ein eingetragenes Warenzeichen der 3S-Smart Software Solutions GmbH. Druckfehler, Irrtümer und technische Änderungen vorbehalten. Vervielfältigung (auch nur auszugsweise) und Weitergabe nur nach vorheriger Genehmigung. 19