io-package.json

Jeder Adapter enthält neben der package.json für npm noch eine io-package.json. Hier werden sämtliche Meta-Informationen für den Adpater hinterlegt.

Beispiel

Hier eine Beispiel-Datei aus dem Luftdaten-Adapter. Eine Beschreibung der einzelnen Eigenschaften folgt weiter unten.

{
    "common": {
        "name": "luftdaten",
        "version": "2.1.1",
        "news": {
            "2.0.3": {
                "en": "Fixed error logging",
                "de": "Fehler-Logging behoben"
            },
            "2.0.2": {
                "en": "Added timeout option",
                "de": "Option für Timeout-Limit hinzugefügt"
            },
            "2.0.1": {
                "en": "Minor bug fixes",
                "de": "Kleinere Bugfixes"
            },
            "2.0.0": {
                "en": "Updated admin interface to maintain multiple sensors in one instance",
                "de": "Benutzeroberfläche angepasst, um mehrere Sensoren in einer Instanz verwalten zu können"
            }
        },
        "title": "Luftdaten.info",
        "titleLang": {
            "en": "Luftdaten.info",
            "de": "Luftdaten.info"
        },
        "desc": {
            "en": "Loads current air quality data from a local or remote sensor",
            "de": "Lädt aktuelle Luftqualitätsdaten eines lokalen oder Cloud-Sensors"
        },
        "authors": [
            "Matthias Kleine <info@haus-automatisierung.com>"
        ],
        "keywords": [
            "web",
            "weather",
            "air",
            "quality"
        ],
        "license": "MIT",
        "platform": "Javascript/Node.js",
        "icon": "luftdaten.png",
        "extIcon": "https://raw.githubusercontent.com/klein0r/ioBroker.luftdaten/master/admin/luftdaten.png",
        "enabled": true,
        "readme": "https://github.com/klein0r/ioBroker.luftdaten/blob/master/README.md",
        "loglevel": "info",
        "mode": "schedule",
        "allowInit": true,
        "schedule": "*/30 * * * *",
        "type": "weather",
        "compact": true,
        "connectionType": "cloud",
        "dataSource": "poll",
        "adminUI": {
            "config": "json"
        },
        "dependencies": [
            {
                "js-controller": ">=3.3.0"
            }
        ],
        "globalDependencies": [
            {
                "admin": ">=5.1.19"
            }
        ],
        "plugins": {
            "sentry": {
                "dsn": "https://baf35e4e423d409bbec94cb01b55257e@sentry.iobroker.net/103"
            }
        }
    },
    "native": {
        "requestTimeout": 10
    },
    "objects": [
    ]
}

Eigenschaften (erforderlich)

common.name

Name des Adapters (darf nicht ioBroker enthalten)

Type

string

common.version

Aktuelle Version des Adapters (muss mit der Version der package.json übereinstimmen)

Type

string

common.platform

Die Plattform, auf welcher der Adapter programmiert wurde

Type

string

Default

Javascript/Node.js

common.titleLang

Titel des Adapters (übersetzt in mehrere Sprachen)

"titleLang": {
    "en": "Luftdaten.info",
    "de": "Luftdaten.info",
    "ru": "Luftdaten.info",
    "pt": "Luftdaten.info",
    "nl": "Luftdaten.info",
    "fr": "Luftdaten.info",
    "it": "Luftdaten.info",
    "es": "Luftdaten.info",
    "pl": "Luftdaten.info",
    "zh-cn": "Luftdaten.info"
}
Type

object

common.news

Liste mit Infos zu den verschiedenen Versionen (Updatehistorie / Changelog). Darf nicht mehr als 20 Einträge enthalten! (übersetzt in mehrere Sprachen)

Wird in der Regel automatisch vom Release-Script von AlCalzone gefüllt (aus Changelog).

"news": {
    "2.0.3": {
        "en": "Fixed error logging",
        "de": "Fehler-Logging behoben"
    },
    "2.0.2": {
        "en": "Added timeout option",
        "de": "Option für Timeout-Limit hinzugefügt"
    },
    "2.0.1": {
        "en": "Minor bug fixes",
        "de": "Kleinere Bugfixes"
    },
    "2.0.0": {
        "en": "Updated admin interface to maintain multiple sensors in one instance",
        "de": "Benutzeroberfläche angepasst, um mehrere Sensoren in einer Instanz verwalten zu können"
    }
}
Type

object

common.desc

Kurze Beschreibung, was der Adapter macht (übersetzt in mehrere Sprachen)

"desc": {
    "en": "Loads current air quality data from a local or remote sensor",
    "de": "Lädt aktuelle Luftqualitätsdaten eines lokalen oder Cloud-Sensors",
    "ru": "Загружает текущие данные о качестве воздуха с местного или удаленного датчика",
    "pt": "Carrega dados atuais de qualidade do ar de um sensor local ou remoto",
    "nl": "Laadt huidige luchtkwaliteitsgegevens van een lokale of externe sensor",
    "fr": "Charge les données actuelles sur la qualité de l'air à partir d'un capteur local ou distant",
    "it": "Carica i dati attuali sulla qualità dell'aria da un sensore locale o remoto",
    "es": "Carga datos actuales de la calidad del aire desde un sensor local o remoto",
    "pl": "Ładuje aktualne dane o jakości powietrza z lokalnego lub zdalnego czujnika",
    "zh-cn": "从本地或远程传感器加载当前的空气质量数据"
}
Type

object

common.mode

Modus des Adapters

  • none - Der Adapter wird nicht gestartet

  • daemon - Separat laufender Prozess

  • subscribe - Wird gestartet, wenn der State system.adapter.<adapter-name>.<instanz-nummmer>.alive auf true gesetzt wird. Wird automatisch beendet, wenn der State auf false geändert wird. Der State wird automatisch auf false gesetzt, wenn der Prozess beendet wurde.

  • schedule - Wird nach dem in common.schedule festgelegten Zeitplan automatisch gestartet

  • once - Wird jedes Mal automatisch gestartet, wenn das system.adater.<adapter-name>.<instanz-nummmer>-Objekt geändert wird

  • extension - ???

Type

string

Eigenschaften (Allgemein)

common.enabled

Legt fest, ob eine neue Instanz direkt gestartet werden soll, oder nicht

Type

boolean

Default

true

common.tier

Legt fest, in welcher Reihenfolge die Adapter gestartet werden

  • 1 - Logik

  • 2 - API und andere Daten

  • 3 - alle anderen

Type

number

Default

3

common.messagebox

true wenn Nachrichten per sendTo() an den Adapter erlaubt sind. Siehe Messagebox

Type

boolean

Default

false

common.readme

URL zur Readme-Datei (z.B. HTTP-URL zur README.md auf GitHub)

"readme": "https://github.com/klein0r/ioBroker.luftdaten/blob/master/README.md"
Type

string

common.docs

Eine Liste von Dokumentations-Dateien, welche im Admin zur Verfügung gestellt werden und auch in die offizielle Dokumentation aufgenommen werden sollen

Pro Sprache kann entweder ein Array von Dateien übergeben werden, oder nur ein String

"docs": {
    "en": "docs/en/admin.md",
    "ru": "docs/ru/admin.md",
    "de": [
        "docs/de/admin.md",
        "docs/de/admin/tab-adapters.md",
        "docs/de/admin/tab-instances.md",
        "docs/de/admin/tab-objects.md"
    ],
    "pt": "docs/pt/admin.md",
    "nl": "docs/nl/admin.md",
    "es": "docs/es/admin.md",
    "fr": "docs/fr/admin.md",
    "it": "docs/it/admin.md",
    "pl": "docs/pl/admin.md",
    "zh-cn": "docs/zh-cn/admin.md"
}
Type

object

common.authors

Liste mit Entwicklern des Adapters

"authors": [
    "Matthias Kleine <info@haus-automatisierung.com>"
]

Alternativ

"authors": [
    {
        "name": "Matthias Kleine",
        "email": "info@haus-automatisierung.com"
    }
]
Type

string oder array

common.license

Lizenz des Adapters (z.B. MIT). Gültige Werte sind im Schema zu finden (Link siehe unten)

Type

string

common.type

Typ/Kategorie des Adapters - relevant für die Einsortierung im Admin-Adapter.

  • alarm - Sicherheitssysteme, Alarmanlagen, …

  • climate-control - Klimasteuerung, Heizung, Luftfilter, …

  • communication - Kommunikation mit anderen Adaptern (REST Api)

  • date-and-time - Kalender, Ferien, Feiertage, …

  • energy - PV-Anlage, Verbrauchsdaten, …

  • metering - Energiemessung

  • garden - Rasenmähroboter, Bewässerung, …

  • general - Allgemeine Adapter wie Admin

  • geoposition - Position von Objekten oder Personen

  • hardware - Allgemeine Hardware-Schnittstellen (z.B. für ESP8266, ESP32)

  • health - Gesundheitsdaten wie Blutdruck, Blutzucker, …

  • household - Küchengeräte, Haushaltsgeräte, Staubsaugerroboter, …

  • infrastructure - Netzwerktechnik, Drucker, Scanner, Telefone, …

  • iot-systems - Weitere IoT-Geräte, welche nicht in die anderen Kategorien passen

  • lighting - Beleuchtung

  • logic - Logikmodule für eigene Regeln oder Szenen

  • messaging - Nachrichtendienste wie Telegram oder E-Mail

  • misc-data - Export und Import von Daten

  • multimedia - Fernseher, Receiver, Beamer, …

  • network - Ping, …

  • protocols - Generische Protokolle (wie MQTT)

  • storage - Daten-Speicherung wie mySQL oder InfluxDB

  • utility - Weitere Tools wie Backup-Adapter

  • visualization - Visualisierungs-Adapter

  • visualization-icons - Zusätzliche Icons für die Visualisierung

  • visualization-widgets - Weitere Widgets für die Visualisierung

  • weather - Wetterdaten

Type

string

common.unsafePerm

Legt fest, ob das Adapter-Paket mit dem --unsafe-perm Parameter für npm installiert werden muss. Siehe npm Dokumentation

Type

boolean

common.plugins

Liste von Plugins (z.B. Sentry)

Type

object

common.plugins.sentry

Konfiguration des Sentry-Plugins. Siehe Sentry

"plugins": {
    "sentry": {
        "dsn": "https://xxx@sentry.iobroker.net/xxx"
    }
}
Type

object

common.availableModes

Werte für common.mode (falls mehr als ein Wert erlaubt ist)

"availableModes": [
    "schedule",
    "once"
]
Type

array

common.blockly

Legt fest, ob der Adapter eigene Blockly-Bausteine mitbringt (admin/blockly.js erforderlich)

Type

boolean

Default

false

common.connectionType

Definiert die Qulle der Adapter-Daten. Wird im Admin ab Version 5 dargestellt und dient als Information für den Nutzer

  • none

  • local - Die Kommunikation findet lokal / im eigenen Netzwerk statt (z.B. mit dem Gerät direkt per HTTP)

  • cloud - Für den Adapter ist eine aktive Internetverbindung erforderlich. Die Daten werden z.B. vom Server des Herstellers abgerufen.

Type

string

common.dataSource

Legt fest, wie Daten geholt werden

  • none

  • poll - Die Daten werden regelmäßig abgefragt (z.B. per Zeitplan)

  • push - Das Gerät / der Dienst liefert die Daten selbstständig zum Adapter

  • assumption - Der genaue Status ist nicht definiert

Type

string

common.compact

Unterstützt seit js-controller 2.0.2

Legt fest, ob der Adapter im Compact Mode gestartet werden kann

Type

boolean

Default

false

common.dataFolder

Unterstützt seit js-controller 1.5.1

Verzeichnis-Pfad, in welchem der Adapter seine Daten ablegt (relativ zu /opt/iobroker/iobroker-data). Siehe File Storage

Der Platzhalter %INSTANCE% kann ebenfalls im Pfad genutzt werden und wird automatisch durch die Instanznummer ersetzt (z.B. 0).

Falls angegeben, wird dieses Verzeichnis automatisch vom js-controller in die Backups mit aufgenommen.

"dataFolder": "octoprint.%INSTANCE%"
Type

string

common.dependencies

Liste von Abhängigkeiten (auf dem gleichen Host), welche für diesen Adapter notwendig sind. Entweder mit genauer Versionsangabe, oder als String.

"dependencies": [
    "admin",
    {
        "js-controller": ">=3.3.0"
    }
]
Type

array

common.globalDependencies

Liste von Abhängigkeiten im gesamten ioBroker-System (Multihost-Betrieb). Entweder mit genauer Versionsangabe, oder als String. Siehe Multihost

"globalDependencies": [
    {
        "admin": ">=5.1.19"
    }
]
Type

array

common.eraseOnUpload

Unterstützt seit js-controller 1.5.1

Löscht alle existierenden Daten im Adapter-Verzeichnis vor einem Upload

Type

boolean

common.extIcon

URL zur Icon-Datei für die Admin-Übersicht (z.B. PNG-Datei auf GitHub). Wird genutzt, wenn der Adapter noch nicht installiert ist.

"extIcon": "https://raw.githubusercontent.com/klein0r/ioBroker.luftdaten/master/admin/luftdaten.png"
Type

string

common.getHistory

Legt fest, ob der Adapter den getHistory Befehl unterstützt (siehe z.B. InfluxDB-Adapter)

Type

boolean

common.icon

Pfad zum lokalen Icon des Adapters (nach Installation). Relativer Pfad zum Unterverzeichnis admin/

"icon": "luftdaten.png"
Type

string

common.keywords

Liste von Schlüsselwörtern, um den Adapter über die Suche im Admin-Adapter (besser) finden zu können

"keywords": [
    "web",
    "weather",
    "air",
    "quality"
]
Type

array

Konfiguration für Intro-Tab

Eigenschaften:

  • link (string, erforderlich!)

  • color (string)

  • pro (boolean)

  • icon (string)

In diesen Links können verschiedene Platzhalter verwendet werden, welche automatisch ersetzt werden:

  • %objects%

  • %hostname%

  • %protocol%

  • %port%

  • %hosts%

  • %adminInstance%

"localLinks": {
    "_default": {
        "link": "%protocol%://%bind%:%port%"
    }
}
Type

object

common.loglevel

Standard Log-Level neuer Instanzen. Empfohlen: info

  • silly - Alles

  • debug - Debug-Nachrichten

  • info - Informationen

  • warn - Warnungen

  • error - Fehler

Type

string

common.logTransporter

Legt fest, ob der Adapter die Log-Einträge von anderen Adaptern entgegen nehmen kann (um sie z.B. wo anders zu speichern)

Type

boolean

common.noIntro
Type

boolean

common.noRepository
Type

boolean

common.nogit

Legt fest, ob eine Installation direkt von GitHub verboten werden soll

Type

boolean

common.nondeletable

Legt fest, ob ein Adapter gelöscht oder aktualisiert werden kann. Falls true, kümmert sich der js-controller um diese Aufgaben

Type

boolean

Default

false

common.onlyWWW

Legt fest, ob der Adapter nur weitere HTML-Dateien bereitstellt und keine Logik enthält (wie zum Beispiel Widget-Adapter für VIS)

Type

boolean

common.osDependencies

Abhängigkeiten für verschiedene Betriebssysteme

Type

object

common.osDependencies.darwin

Liste mit erforderlichen MacOS-Paketen für diesen Adapter

Type

array

common.osDependencies.linux

Liste mit erforderlichen Linux-Paketen für diesen Adapter

Type

array

common.osDependencies.win32

Aktuell nicht genutzt, da Linux keinen Paket-Manager hat

Type

array

common.os

Liste mit unterstützten Betriebssystemen

  • darwin - Mac OS X

  • linux - Linux

  • win32 - Windows

Type

string|array

common.preserveSettings

Liste mit Attributen, welche nicht automatisch gelöscht werden sollen (z.B. history)

Type

string|array

common.restartAdapters

Liste mit Adaptern, welche neugestartet werden sollen, nachdem dieser Adapter installiert wurde (z.B. ["vis"])

Type

array

common.serviceStates
Type

string|boolean

common.singletonHost

Legt fest, ob es nur eine einzelne Instanz pro Host geben darf

Type

boolean

Default

false

common.singleton

Legt fest, ob es nur eine einzelne Instanz im gesamten ioBroker-System geben darf (Multihost-Betrieb). Siehe Multihost

Type

boolean

Default

false

common.stopBeforeUpdate

Legt fest, ob die Instanzen vor einem Update gestoppt werden müssen

Type

boolean

common.stopTimeout

Wartezeit in Millisekunden, bis der Adapter angehalten wird

Type

number

Default

500

common.subscribable

Legt fest, ob dieser Adapter von anderen Adaptern automatisch abonniert werden soll

type

boolean

common.subscribe
Type

string

common.supportCustoms

Legt fest, ob es zusätzliche Einstellungen für jeden Datenpunkt gibt

  • admin/custom.html erforderlich - ab Admin Version 3

  • admin/custom_m.html erforderlich - ab Admin Version 4

  • admin/jsonCustom.json erforderlich - ab Admin Version 5

Type

boolean

common.supportStopInstance

Legt fest, ob der Adapter das stopInstance Signal unterstützt. Siehe Messagebox

Type

boolean

common.wakeup

Legt fest, ob die Instanz gestartet werden soll, wenn ein Wert in system.adapter.<adapter-name>.<instanz-nummmer>.wakeup geschrieben wird.

Type

boolean

common.webByVersion
common.webExtendable

Legt fest, ob der Webserver dieses Adapters mit Plugins erweitert werden kann (z.B. simple-api)

Type

boolean

common.webExtension

Relativer Pfad der Web-Extension (z.B. lib/simpleapi.js)

Type

string

common.webPreSettings
Type

object

common.webservers

Liste mit Webservern, welche Inhalte aus dem www-Verzeichnis des Adapters liefern

Type

array

common.welcomeScreen
Type

array

common.welcomeScreenPro

Identisch zu common.welcomeScreen, allerdings für Zugriff über die ioBroker-Cloud

"welcomeScreenPro": {
    "link": "admin/index.html",
    "name": "Admin",
    "img": "admin/img/admin.png",
    "color": "pink",
    "order": 5,
    "localLinks": "_default",
    "localLink": true
}
Type

object

common.messages

Informationen, welche bei der Adapter-Installation angezeigt werden sollen.

Mögliche Eigenschaften pro Nachricht:

  • title (erforderlich) - sollte in alle Sprachen übersetzt werden

  • text (erforderlich) - sollte in alle Sprachen übersetzt werden

  • buttons (erforderlich) - ok, agree oder cancel

  • condition

  • link

  • linkText - sollte in alle Sprachen übersetzt werden

  • level (info, warn oder error)

"messages": [
    {
        "condition": {
            "operand": "and",
            "rules": [
                "oldVersion<4.0.0",
                "newVersion>=4.0.0"
            ]
        },
        "title": {
            "en": "Important notice!",
            "de": "Wichtiger Hinweis!",
            "ru": "Важное замечание!",
            "pt": "Notícia importante!",
            "nl": "Belangrijke mededeling!",
            "fr": "Avis important!",
            "it": "Avviso IMPORTANTE!",
            "es": "Noticia importante!",
            "pl": "Ważna uwaga!",
            "zh-cn": "重要通知!"
        },
        "text": {
            "en": "Do not update to this version if you use ioBroker.vis android app or some applications, that works only with old socket.io library, like Minuvis",
            "de": "Aktualisieren Sie nicht auf diese Version, wenn Sie die Android-App ioBroker.vis oder einige Anwendungen verwenden, die nur mit der alten socket.io-Bibliothek funktionieren, wie Minuvis",
            "ru": "Не обновляйтесь до этой версии, если вы используете приложение ioBroker.vis для Android или некоторые приложения, которые работают только со старой библиотекой socket.io, например Minuvis.",
            "pt": "Não atualize para esta versão se você usa o aplicativo Android ioBroker.vis ou alguns aplicativos que funcionam apenas com a biblioteca socket.io antiga, como Minuvis",
            "nl": "Werk niet bij naar deze versie als u de Android-app ioBroker.vis of sommige toepassingen gebruikt, die alleen werken met de oude socket.io-bibliotheek, zoals Minuvis",
            "fr": "Ne mettez pas à jour cette version si vous utilisez l'application Android ioBroker.vis ou certaines applications, qui ne fonctionnent qu'avec l'ancienne bibliothèque socket.io, comme Minuvis",
            "it": "Non aggiornare a questa versione se usi l'app ioBroker.vis per Android o alcune applicazioni, che funzionano solo con la vecchia libreria socket.io, come Minuvis",
            "es": "No actualice a esta versión si usa la aplicación de Android ioBroker.vis o algunas aplicaciones, que solo funcionan con la antigua biblioteca socket.io, como Minuvis",
            "pl": "Nie aktualizuj do tej wersji, jeśli używasz aplikacji na Androida ioBroker.vis lub niektórych aplikacji, które działają tylko ze starą biblioteką socket.io, taką jak Minuvis",
            "zh-cn": "如果您使用 ioBroker.vis android 应用程序或某些仅适用于旧 socket.io 库的应用程序,请不要更新到此版本,例如 Minuvis"
        },
        "level": "warn",
        "buttons": [
            "ok",
            "cancel"
        ]
    }
]
Type

array

objects

Liste von Objekten, welche für den Adapter erstellt werden sollen

Type

array

instanceObjects

Liste von Objekten, welche für jede Instanz erstellt werden sollen

Type

array

protectedNative

Unterstützt seit js-controller Version 2.0.2

Liste von native Attributen, welche nur vom Adapter / der jeweiligen Instanz selbst lesbar sind (z.B. ["password"]). Siehe Daten-Verschlüsselung

Type

array

encryptedNative

Unterstützt seit js-controller Version 3.0.3

Liste von automatisch verschlüsselten native Attributen. Siehe Daten-Verschlüsselung

Type

array

native

Liste von vordefinierten Attributen, welche z.B. in der Instanz-Konfiguration überschrieben werden können

"native": {
    "port": 12345,
    "apiPassword: "xxx",
    "requestTimeout": 10
}
Type

object

notifications

Unterstützt seit js-controller Version 3.2.0

Liste von Objekten zur Konfiguration zur Konfiguration des internen Notification-Systems. Siehe Notifications

  • scope (erforderlich)

  • name (erforderlich) - sollte in alle Sprachen übersetzt werden

  • description (erforderlich) - sollte in alle Sprachen übersetzt werden

  • categories (erforderlich)

Type

array

Eigenschaften (Schedule)

common.schedule

CRON-Definition, wann die Instanzen gestartet werden sollen (kann vom Benutzer angepasst werden)

"schedule": "*/30 * * * *"
Type

string

common.allowInit

Legt fest, ob ein Adapter auch außerhalb des definierten Zeitplanes gestartet wird (z.B. nach Änderung der Instanz-Konfiguration)

Type

boolean

Eigenschaften (Daemon)

common.restartSchedule

CRON-Definition, wann die laufenden Instanzen neugestartet werden sollen (kann vom Benutzer angepasst werden)

Type

string

Eigenschaften (Admin)

common.adminColumns

Eigene Attribute, welche im Admin als Spalten verfügbar werden sollen.

[
    {
        "name": {
            "en": "KNX address"
        },
        "path": "native.address",
        "width": 100,
        "align": "left"
    },
    {
        "name": "DPT",
        "path": "native.dpt",
        "width": 100,
        "align": "right",
        "type": "number",
        "edit": true,
        "objTypes": [
            "state",
            "channel"
        ]
    }
]
Type

array

common.adminTab
"adminTab": {
    "name": {
        "en": "Zigbee",
        "de": "Zigbee",
        "ru": "Zigbee",
        "pt": "Zigbee",
        "nl": "Zigbee",
        "fr": "Zigbee",
        "it": "Zigbee",
        "es": "Zigbee",
        "pl": "Zigbee",
        "zh-cn": "Zigbee"
    },
    "singleton": true,
    "fa-icon": "</i><img style='width:24px;margin-bottom:-6px;' src='/adapter/zigbee/zigbee.svg'><i>"
}
Type

object

common.adminTab.fa-icon

Font-Awesome Icon für das Tab

Type

string

common.adminTab.ignoreConfigUpdate
Type

boolean

Link für den iFrame im Admin-Tab. Unterstützt zu ersetzende Platzhalter wie %ip% oder %port%.

Type

string

common.adminTab.name

Titel des Tabs (übersetzt in mehrere Sprachen)

Type

object

common.adminTab.singleton

Legt fest, ob nur ein Tab für alle Instanzen angezeigt werden soll

Type

boolean

common.adminUI

Legt fest, wie die Konfiguration im Admin erfolgen soll (für die Instanz-Konfiguration, Tabs und eigene Objekt-Eigenschaften)

Type

object

common.adminUI.config

Legt fest, wie die Konfiguration für die Admin-Oberfläche aufgebaut ist

  • none

  • html (admin/index.html - ab Admin Version 3)

  • materialize (admin/index_m.html - ab Admin Version 4)

  • json (admin/jsonConfig.json - ab Admin Version 5)

Type

string

common.adminUI.custom
  • none

  • html (admin/custom.html - ab Admin Version 3)

  • materialize (admin/custom_m.html - ab Admin Version 4)

  • json (admin/jsonCustom.json - ab Admin Version 5)

Type

string

common.adminUI.tab
  • html

  • materialize

Type

string

Eigenschaften (VIS)

common.visWidgets

Unterstützt seit vis 2.0.0

Definiert die verfügbaren VIS-Widgets im Adapter. Beispiel im offiziellen Template-Repository.

"visWidgets": {
    "DemoWidget": {
        "name": "DemoWidget",
        "url": "vis-widgets-react-template/customWidgets.js",
        "components": [
            "DemoWidget"
        ]
    }
}
Type

object

Eigenschaften (deprecated)

Diese Eigenschaften sind für aktuelle Adapter mit dem Admin 5 nicht mehr relevant

  • common.title - Langer Name des Adapters für Admin-Version 2, 3 und 4

  • common.npmLibs - Ersetzt durch Abhängigkeiten in der package.json

  • common.main - Ersetzt durch main in der package.json

  • common.localLink - Ersetzt durch common.localLinks

  • common.engineTypes - Ersetzt durch engine in der package.json

  • common.config.height - Standard-Höhe für den Konfigurations-Dialog für Admin 2

  • common.config.minHeight - Mindest-Höhe für den Konfigurations-Dialog für Admin 2

  • common.config.width - Standard-Breite für den Konfigurations-Dialog für Admin 2

  • common.config.minWidth - Mindest-Breite für den Konfigurations-Dialog für Admin 2

  • common.materialize (boolean) - Legt fest, ob der Adapter die Admin-Oberfläche für Admin-Version 3 und 4 bereitstellt (ab Admin 5 sollte common.adminUI.config verwendet werden)

  • common.materializeTab (boolean) - Legt fest, ob der Adapter ein eigenes Tab für Admin-Version 3 und 4 bereitstellt (ab Admin 5 sollte common.adminUI.tab verwendet werden)

  • common.noConfig (boolean) - Definiert, ob Instanzen konfiguriert werden können (ab Admin 5 sollte common.adminUI.config = none verwendet werden)