Dokumentation
Bibliotheken
Benötigt: IP-Symcon >= 4.0
Beschreibung
Die Bibliothek ist die Basis für jede Modulentwicklung. Es können auch mehrere Module zu einer Bibliothek zusammengefasst werden. Die benötigte Verzeichnisstruktur kann unter Struktur eingesehen werden.
Diese kann über ein Repository (wir empfehlen Github oder Bitbucket) zur Verfügung gestellt werden.
Einbindung in IP-Symcon
Die Datei library.json muss vorhanden sein, welche im Hauptverzeichnis liegt.
Anhand der Verzeichnisstruktur kann IP-Symcon die gesamte Bibliothek über das "Module Control" einlesen.
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| id | string | Jedes Modul besitzt zur eindeutigen Identifikation eine eigene GUID (siehe unten Infobox). GUID Generator |
| author | string | Unter welchem Namen wurde die Bibliothek entwickelt |
| compatibility (ab 4.3) | array | Überprüft ob die benötigte Version installiert ist. Es kann auf Kernelversion und/oder Datum geprüft werden. (Weitere Beschreibung siehe Tabelle) |
| name | string | Der Name der gesamten Bibliothek. (A-Z, a-z, 0-9, Leerzeichen, Unterstrich sind erlaubte Zeichen. Leerzeichen und Unterstriche dürfen dabei jedoch nicht am Anfang oder Ende sein. Ein leerer Name ist ebenfalls nicht gültig.) |
| url | string | URL zu der Homepage (Muss mit http:// oder https:// beginnen. Darf Alternativ auch leer sein) |
| version | string | Versionsnummer. Diese kann als String beliebig definiert werden. Wir empfehlen eine Darstellung in der Form "Zahl.Zahl". Bsp: "4.2" |
| build | integer | Buildnummer |
| date | integer | Unix-Zeitstempel |
Die GUID ist eine UUID und hat das Format 8-4-4-4-12. Die Zahlen geben die Anzahl der Ziffern an. Die Ziffern bestehen aus Zeichen zwischen 0-9 und A-F. Es müssen immer Bindestriche und geschweifte Klammern vorhanden sein und es dürfen nur Großbuchstaben verwendet werden. (Beispiel: {12345678-90AB-CDEF-1234-567890ABCDEF} )
Compatibility
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| version (optional) | string | Mindest-Version als String. Bsp: "4.2" |
| date (optional) | integer | Datum als UnixTimestamp. Bsp: 1491343200 |
Beispiele
library.json
{
"id": "{F96B257F-85E7-47CF-8340-8FE850AACD10}",
"author": "Symcon GmbH",
"name": "Misc Modules",
"url": "https://www.symcon.de",
"compatibility": {
"version": "4.2",
"date": 1491343200
},
"version": "1.0",
"build": 0,
"date": 0
}