Was können wir verbessern?

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 Einmalige GUID zur eindeutigen Identifikation. 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
url string URL zu der Homepage
version string Versionsnummer. Diese muss als String in der Form "Zahl.Zahl" dargestellt werden. Bsp: "4.2"
build integer Buildnummer
date integer Unix-Zeitstempel

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": "www.symcon.de",
    "compatibility": {
        "version": "4.2",
        "date": 1491343200
    },
    "version": "1.0",
    "build": 0,
    "date": 0
}