Die io-package.json im ioBroker
Suchergebnisse
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"
],
"licenseInformation": {
"license": "MIT",
"type": "free"
},
"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 string
Name des Adapters (darf nicht ioBroker enthalten)
common.version string
Aktuelle Version des Adapters (muss mit der Version der package.json übereinstimmen)
common.platform string Default: Javascript/Node.js
Die Plattform, auf welcher der Adapter programmiert wurde
common.titleLang object
Titel des Adapters (übersetzt in mehrere Sprachen) .. code:: json "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", "uk": "Luftdaten.info", "zh-cn": "Luftdaten.info" }
common.news object
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). .. code:: json "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" } }
common.desc object
Kurze Beschreibung, was der Adapter macht (übersetzt in mehrere Sprachen) .. code:: json "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", "uk": "Поточні дані про якість повітря з локального або віддаленого датчика", "zh-cn": "从本地或远程传感器加载当前的空气质量数据" }
common.mode string
Modus des Adapters - none - Der Adapter wird nicht gestartet - daemon - Separat laufender Prozess - schedule - Wird nach dem in common.schedule festgelegten Zeitplan automatisch gestartet - once - Wird jedes Mal automatisch gestartet, wenn das system.adater.-Objekt geändert wird - extension - ???
Eigenschaften (Allgemein)
common.enabled boolean Default: true
Legt fest, ob eine neue Instanz direkt gestartet werden soll, oder nicht
common.tier number Default: 3
Legt fest, in welcher Reihenfolge die Adapter gestartet werden - 1 - Logik - 2 - API und andere Daten - 3 - alle anderen
common.messagebox boolean Default: false
true wenn Nachrichten per sendTo() an den Adapter erlaubt sind. Siehe Messagebox Ab js-controller 5.x sollte common.supportedMessages.custom verwendet werden!
common.blockedVersions array
Diese Information wird in die Repositories (Adapter-Listen) aufgenommen, um zu verhindern dass bestimmte Versionen von Adaptern gestartet werden können (falls gravierende Fehler oder Sicherheitslücken enthalten sind). Dies sort dafür, dass die Version nicht mehr installiert werden kann und dass laufende Instanzen (mit diesen Versionen) bei den Nutzern gestoppt werden! Beispiel vom Alexa2-Adapter: .. code:: json "blockedVersions": [ "~3.14.0", "~3.15.0", "~3.16.0", "3.17.0", "3.17.1", "3.17.2", "3.17.3" ]
common.supportedMessages object
Siehe Messagebox
common.readme string
URL zur Readme-Datei (z.B. HTTP-URL zur README.md auf GitHub) .. code:: json "readme": "https://github.com/klein0r/ioBroker.luftdaten/blob/master/README.md"
common.docs object
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 .. code:: json "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", "uk": "docs/uk/admin.md", "zh-cn": "docs/zh-cn/admin.md" }
common.authors string oder array
Liste mit Entwicklern des Adapters .. code:: json "authors": [ "Matthias Kleine
common.licenseInformation object
Lizenz des Adapters (z.B. MIT). Gültige Werte sind im Schema zu finden (Link siehe unten). Kann auch genutzt werden, um kostenpflichtige Adapter zu kennzeichnen und Nutzer über Folgekosten zu informieren. - free - Komplett kostenlos - limited - Abhängig von der Nutzung ggf. kostenpflichtig (ab x Datenpunkte, ab x Geräte) - commercial - Nur für kommerzielle Nutzer kostenpflichtig (Privatnutzung kostenlos - z.B. VIS-Adapter) - paid - Generell kostenpflichtig / lizenzpflichtig .. code:: json "licenseInformation": { "license": "MIT", "type": "free" }
common.type string
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 history, mySQL oder InfluxDB - siehe Datenbank-Adapter - 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
common.unsafePerm boolean
Legt fest, ob das Adapter-Paket mit dem `--unsafe-perm`` Parameter für npm installiert werden muss. Siehe `npm Dokumentation
common.plugins object
Liste von Plugins (z.B. Sentry)
common.plugins.sentry object
Konfiguration des Sentry-Plugins. Siehe Sentry .. code:: json "plugins": { "sentry": { "dsn": "https://xxx@sentry.iobroker.net/xxx" } }
common.availableModes array
Werte für common.mode (falls mehr als ein Wert erlaubt ist) .. code:: json "availableModes": [ "schedule", "once" ]
common.blockly boolean Default: false
Legt fest, ob der Adapter eigene Blockly-Bausteine mitbringt (admin/blockly.js erforderlich)
common.connectionType string
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.
common.dataSource string
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
common.compact boolean Default: false
Legt fest, ob der Adapter im Compact-Mode gestartet werden kann
common.dataFolder string
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. .. code:: json "dataFolder": "octoprint.%INSTANCE%"
common.dependencies array
Liste von Abhängigkeiten (auf dem gleichen Host), welche für diesen Adapter notwendig sind. Entweder mit genauer Versionsangabe, oder als String. .. code:: json "dependencies": [ "admin", { "js-controller": ">=3.3.0" } ]
common.globalDependencies array
Liste von Abhängigkeiten im gesamten ioBroker-System (Multihost-Betrieb). Entweder mit genauer Versionsangabe, oder als String. Siehe Multihost .. code:: json "globalDependencies": [ { "admin": ">=5.1.19" } ]
common.eraseOnUpload boolean
Löscht alle existierenden Daten im Adapter-Verzeichnis vor einem Upload
common.extIcon string
URL zur Icon-Datei für die Admin-Übersicht (z.B. PNG-Datei auf GitHub). Wird genutzt, wenn der Adapter noch nicht installiert ist. .. code:: json "extIcon": "https://raw.githubusercontent.com/klein0r/ioBroker.luftdaten/master/admin/luftdaten.png"
common.getHistory boolean
Legt fest, ob der Adapter den getHistory Befehl unterstützt (siehe z.B. InfluxDB-Adapter) Ab js-controller 5.x sollte common.supportedMessages.getHistory verwendet werden!
common.icon string
Pfad zum lokalen Icon des Adapters (nach Installation). Relativer Pfad zum Unterverzeichnis admin/ .. code:: json "icon": "luftdaten.png"
common.keywords array
Liste von Schlüsselwörtern, um den Adapter über die Suche im Admin-Adapter (besser) finden zu können .. code:: json "keywords": [ "web", "weather", "air", "quality" ]
common.localLinks object
Konfiguration für Intro-Tab und Instanz-Übersicht (Direktlink). Hier können Links für verschiedene Dienste o.ä. hinterlegt werden (auch externe Links). Die Instanz muss aktiv sein common.enabled: true damit diese Links angezeigt werden! Eigenschaften: - link (string, erforderlich!) - color (string) - pro (boolean) .. code:: json "localLinks": { "_default": { "link": "https://haus-automatisierung.com", "color": "#fc8326" } } Ist der Standard-Name nicht `_default`, wird dieser Name ebenfalls in der Kachel im Intro-Tab angezeigt: .. code:: json "localLinks": { "iobroker-kurs": { "link": "https://haus-automatisierung.com/iobroker-kurs/", "color": "#fc8326" } } In diesen Links können verschiedene Platzhalter verwendet werden, welche automatisch ersetzt werden: - %ip% - %protocol% - %instance% - %objects% - %hostname% - %port% - %hosts% - %adminInstance% .. code:: json "localLinks": { "_default": { "link": "%protocol%://%bind%:%port%" } }
common.loglevel string
Standard Log-Level neuer Instanzen. Empfohlen: info - silly - Alles - debug - Debug-Nachrichten - info - Informationen - warn - Warnungen - error - Fehler
common.logTransporter boolean
Legt fest, ob der Adapter die Log-Einträge von anderen Adaptern entgegen nehmen kann (um sie z.B. wo anders zu speichern)
common.noIntro boolean
.. todo:: Explain common.noIntro
common.noRepository boolean
.. todo:: Explain common.noRepository
common.nogit boolean
Legt fest, ob eine Installation direkt von GitHub verboten werden soll
common.nondeletable boolean Default: false
Legt fest, ob ein Adapter gelöscht oder aktualisiert werden kann. Falls true, kümmert sich der js-controller um diese Aufgaben
common.onlyWWW boolean
Legt fest, ob der Adapter nur weitere HTML-Dateien bereitstellt und keine Logik enthält (wie zum Beispiel Widget-Adapter für VIS)
common.osDependencies object
Abhängigkeiten für verschiedene Betriebssysteme
common.osDependencies.darwin array
Liste mit erforderlichen MacOS-Paketen für diesen Adapter
common.osDependencies.linux array
Liste mit erforderlichen Linux-Paketen für diesen Adapter
common.osDependencies.win32 array
Aktuell nicht genutzt, da Linux keinen Paket-Manager hat
common.os string|array
Liste mit unterstützten Betriebssystemen - darwin - Mac OS X - linux - Linux - win32 - Windows
common.preserveSettings string|array
Liste mit Attributen, welche nicht automatisch gelöscht werden sollen (z.B. history)
common.restartAdapters array
Liste mit Adaptern, welche neugestartet werden sollen, nachdem dieser Adapter installiert wurde (z.B. ["vis"])
common.serviceStates string|boolean
.. todo:: Explain common.serviceStates
common.singletonHost boolean Default: false
Legt fest, ob es nur eine einzelne Instanz pro Host geben darf
common.singleton boolean Default: false
Legt fest, ob es nur eine einzelne Instanz im gesamten ioBroker-System geben darf (Multihost-Betrieb). Siehe Multihost
common.stopBeforeUpdate boolean
Legt fest, ob die Instanzen vor einem Update gestoppt werden müssen
common.stopTimeout number Default: 500
Wartezeit in Millisekunden, bis der Adapter angehalten wird
common.subscribable boolean
Legt fest, ob dieser Adapter von anderen Adaptern automatisch abonniert werden soll
common.supportCustoms boolean
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
common.supportStopInstance boolean
Legt fest, ob der Adapter das stopInstance Signal unterstützt. Siehe Messagebox Ab js-controller 5.x sollte common.supportedMessages.stopInstance verwendet werden!
common.webservers array
Liste mit Webservern, welche Inhalte aus dem www-Verzeichnis des Adapters liefern
common.welcomeScreen array
.. todo:: Explain common.welcomeScreen
common.welcomeScreenPro object
Identisch zu common.welcomeScreen, allerdings für Zugriff über die ioBroker-Cloud .. code:: json "welcomeScreenPro": { "link": "admin/index.html", "name": "Admin", "img": "admin/img/admin.png", "color": "pink", "order": 5, "localLinks": "_default", "localLink": true }
common.messages array
Wichtige Informationen/Warnungen/Gefahren, welche im Admin-Adapter als Hinweis 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) .. code:: json "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!", "uk": "Погода!", "zh-cn": "重要通知!" }, "text": { "en": "Do not update to this version if you are scared", "de": "Aktualisieren Sie nicht auf diese Version, wenn Sie Angst haben", "ru": "Не обновляйте эту версию, если вам страшно", "pt": "Não atualize para esta versão se estiver com medo", "nl": "Vertaling:", "fr": "Ne pas mettre à jour cette version si vous avez peur", "it": "Non aggiornare a questa versione se hai paura", "es": "No actualice a esta versión si tiene miedo", "pl": "Nie uaktualniasz tej wersji, jeśli nie będziesz straszony", "uk": "Чи не оновлюється в цю версію, якщо ви рубати", "zh-cn": "如果你遇难,不要更新本版本。" }, "level": "warn", "buttons": [ "ok", "cancel" ] } ]
objects array
Liste von Objekten, welche für den Adapter erstellt werden sollen
instanceObjects array
Liste von Objekten, welche für jede Instanz erstellt werden sollen
protectedNative array
Liste von native Attributen, welche nur vom Adapter / der jeweiligen Instanz selbst lesbar sind (z.B. ["password"]). Siehe Daten-Verschlüsselung
encryptedNative array
Liste von automatisch verschlüsselten native Attributen. Siehe Daten-Verschlüsselung
native object
Liste von vordefinierten Attributen, welche z.B. in der Instanz-Konfiguration überschrieben werden können .. code:: json "native": { "port": 12345, "apiPassword: "xxx", "requestTimeout": 10 }
notifications array
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) Hier ein Beispiel aus dem Admin-Adapter, welche Notifications für News erlaubt. Diese werden dann im Admin-Adapter dargestellt. .. code:: json "notifications": [ { "scope": "news", "name": { "en": "News", "de": "Nachrichten", "ru": "Новости", "pt": "Notícias", "nl": "Nieuws", "fr": "Actualités", "it": "Notizie", "es": "Noticias", "pl": "News", "uk": "Новини", "zh-cn": "新闻" }, "description": { "en": "These notifications represent news regarding installed adapters or general ioBroker information.", "de": "Diese Benachrichtigungen enthalten Neuigkeiten zu installierten Adaptern oder allgemeine ioBroker-Informationen.", "ru": "Эти уведомления представляют новости о установленных адаптерах или общей информации ioBroker.", "pt": "Estas notificações representam notícias sobre adaptadores instalados ou informações gerais do ioBroker.", "nl": "Deze berichten zijn nieuws over geïnstalleerde adapters of algemene ioBroker informatie.", "fr": "Ces notifications représentent des nouvelles concernant les adaptateurs installés ou les informations générales ioBroker.", "it": "Queste notifiche rappresentano notizie riguardanti adattatori installati o informazioni generali su ioBroker.", "es": "Estas notificaciones representan noticias sobre adaptadores instalados o información general ioBroker.", "pl": "Noty te reprezentują informacje dotyczące zainstalowanych adapterów lub ogólnie dostępnych informacji ioBrokera.", "uk": "Ці повідомлення представляють новини про встановлені адаптери або загальні відомості про ioBroker.", "zh-cn": "这些通知是有关安装的适应器或一般的气箱信息的新闻。." }, "categories": [ { "category": "info", "name": { "en": "General news", "de": "Allgemeine Nachrichten", "ru": "Общие новости", "pt": "Notícia geral", "nl": "Generaal", "fr": "Nouvelles générales", "it": "Notizie generali", "es": "Noticias generales", "pl": "Strona oficjalna", "uk": "Новини", "zh-cn": "新闻" }, "severity": "notify", "description": { "en": "These messages represent general news, which just have informal purpose and do not need to be read immediately.", "de": "Diese Nachrichten stellen allgemeine Nachrichten dar, die nur informellen Zweck haben und nicht sofort gelesen werden müssen.", "ru": "Эти сообщения представляют собой общие новости, которые просто имеют неформальную цель и не нужно читать немедленно.", "pt": "Essas mensagens representam notícias gerais, que apenas têm um propósito informal e não precisam ser lidas imediatamente.", "nl": "Deze berichten vertegenwoordigen algemene nieuws, wat informeel doel heeft en niet onmiddellijk hoeft te worden gelezen.", "fr": "Ces messages représentent des nouvelles générales, qui ont juste un but informel et ne doivent pas être lus immédiatement.", "it": "Questi messaggi rappresentano notizie generali, che hanno solo scopo informale e non devono essere letti immediatamente.", "es": "Estos mensajes representan noticias generales, que sólo tienen un propósito informal y no necesitan ser leídos inmediatamente.", "pl": "Wiadomości te reprezentują ogólnokrajowe wiadomości, które tylko mają nieformalny cel i nie muszą być odczytane natychmiast.", "uk": "Ці повідомлення представляють загальні новини, які просто мають неформальне призначення і не потрібно негайно прочитати.", "zh-cn": "这些信息是一般新闻,这只是非正式目的,不需要立即阅读。." }, "regex": [], "limit": 10 }, { "category": "warning", "name": { "en": "Important news", "de": "Wichtige Nachrichten", "ru": "Важные новости", "pt": "Notícia importante", "nl": "Belangrijk nieuws", "fr": "Nouvelles importantes", "it": "Notizie importanti", "es": "Noticias importantes", "pl": "Important news", "uk": "Новини", "zh-cn": "重要的新闻" }, "severity": "info", "description": { "en": "These messages represent adapter warnings and important changes in the near future.", "de": "Diese Nachrichten stellen Adapterwarnungen und wichtige Veränderungen in der nahen Zukunft dar.", "ru": "Эти сообщения представляют предупреждение о адаптере и важные изменения в ближайшем будущем.", "pt": "Estas mensagens representam avisos de adaptadores e mudanças importantes no futuro próximo.", "nl": "Deze berichten vertegenwoordigen adapter waarschuwingen en belangrijke veranderingen in de nabije toekomst.", "fr": "Ces messages représentent des avertissements d'adaptateur et des changements importants dans un proche avenir.", "it": "Questi messaggi rappresentano avvisi di adattatore e cambiamenti importanti nel prossimo futuro.", "es": "Estos mensajes representan advertencias de adaptador y cambios importantes en el futuro cercano.", "pl": "Wiadomości te reprezentują ostrzeżenia adaptatora i ważne zmiany w najbliższej przyszłości.", "uk": "Ці повідомлення представляють попередження та важливі зміни в найближчому майбутньому.", "zh-cn": "这些信息是适应的预警和近期的重要变化。." }, "regex": [], "limit": 10 }, { "category": "danger", "name": { "en": "Very important news", "de": "Sehr wichtige Nachrichten", "ru": "Очень важные новости", "pt": "Notícia muito importante", "nl": "Heel belangrijk", "fr": "Nouvelles très importantes", "it": "Notizie molto importanti", "es": "Noticias muy importantes", "pl": "Ważne wiadomości", "uk": "Останні новини", "zh-cn": "非常重要的新闻" }, "severity": "alert", "description": { "en": "These notifications are very important. They may give you a hint that an adapter upgrade is required right now to maintain functionality.", "de": "Diese Benachrichtigungen sind sehr wichtig. Sie können Ihnen einen Hinweis geben, dass ein Adapter-Upgrade jetzt erforderlich ist, um die Funktionalität zu erhalten.", "ru": "Эти уведомления очень важны. Они могут дать вам подсказку, что обновление адаптера требуется прямо сейчас для поддержания функциональности.", "pt": "Estas notificações são muito importantes. Eles podem lhe dar uma dica de que uma atualização do adaptador é necessária agora para manter a funcionalidade.", "nl": "Deze berichten zijn heel belangrijk. Ze kunnen je een hint geven dat een adapter upgrade nu nodig is om functionaliteit te behouden.", "fr": "Ces notifications sont très importantes. Ils peuvent vous donner un indice qu'une mise à niveau d'adaptateur est nécessaire pour maintenir la fonctionnalité.", "it": "Queste notifiche sono molto importanti. Essi possono dare un suggerimento che un aggiornamento adattatore è necessario in questo momento per mantenere la funzionalità.", "es": "Estas notificaciones son muy importantes. Pueden darle una pista de que se requiere una actualización del adaptador ahora mismo para mantener la funcionalidad.", "pl": "Te informacje są bardzo ważne. Mogą dać wskazówki, że ulepszanie adapteru jest niezbędne do utrzymania funkcji.", "uk": "Ці повідомлення дуже важливі. Вони можуть надати вам підказку, що оновлення адаптера потрібно прямо зараз для підтримки функціональності.", "zh-cn": "这些通知非常重要。 他们可以向你说明,适应人员升级现在需要保持功能。." }, "regex": [], "limit": 10 } ] } ]
common.automaticUpgrade string
Ermöglicht es, automatisch Upgrades von Adaptern zu erlauben. Definition nach semver. Mögliche Werte: - none - Keine automatischen Updates - patch - Nur Patches (letzte Stelle ändert sich) - minor - Nur Minior-Versionen (mittlere Stelle ändert sich) - major - Alle neuen Versionen automatisch installieren .. code:: json "automaticUpgrade": "patch"
Eigenschaften (Schedule)
common.schedule string
CRON-Definition, wann die Instanzen gestartet werden sollen (kann vom Benutzer angepasst werden) .. code:: json "schedule": "/30 *"
common.allowInit boolean
Legt fest, ob ein Adapter auch außerhalb des definierten Zeitplanes gestartet wird (z.B. nach Änderung der Instanz-Konfiguration)
Eigenschaften (Daemon)
common.restartSchedule string
CRON-Definition, wann die laufenden Instanzen neugestartet werden sollen (kann vom Benutzer angepasst werden)
Eigenschaften (Web-Adapter)
common.webByVersion boolean
.. todo:: Explain common.webByVersion
common.webExtendable boolean
Legt fest, ob dieser Adapters mit Web-Plugins erweitert werden kann (z.B. `web`` Adapter). Adapter mit diesem Attribut: - `ioBroker.web
common.webExtension string
Relativer Pfad zur Web-Extension des Web-Servers Adapter mit diesem Attribut: - ioBroker.simple-api - ioBroker.proxy - ioBroker.cameras - ioBroker.lametric - ioBroker.gira-iot .. code:: json "webExtension": "lib/web.js"
common.webPreSettings object
Die hier definierten Attribute werden als JavaScript-Variablen im Window-Scope (window.${attr}) deklariert
Eigenschaften (Admin-Adapter)
common.adminColumns array
Eigene Attribute, welche im Admin als Spalten verfügbar werden sollen. .. code:: json [ { "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" ] } ]
common.adminTab object
.. code:: json "adminTab": { "name": { "en": "Zigbee", "de": "Zigbee", "ru": "Zigbee", "pt": "Zigbee", "nl": "Zigbee", "fr": "Zigbee", "it": "Zigbee", "es": "Zigbee", "pl": "Zigbee", "uk": "Zigbee", "zh-cn": "Zigbee" }, "singleton": true, "fa-icon": "" }
common.adminTab.fa-icon string
Font-Awesome Icon für das Tab
common.adminTab.ignoreConfigUpdate boolean
.. todo:: Explain common.adminTab.ignoreConfigUpdate
common.adminTab.link string
Link für den iFrame im Admin-Tab. Unterstützt zu ersetzende Platzhalter wie %ip% oder %port%.
common.adminTab.name object
Titel des Tabs (übersetzt in mehrere Sprachen)
common.adminTab.singleton boolean
Legt fest, ob nur ein Tab für alle Instanzen angezeigt werden soll
common.adminUI object
Legt fest, wie die Konfiguration im Admin erfolgen soll (für die Instanz-Konfiguration, Admin-Tabs und eigene Objekt-Eigenschaften) - siehe Admin-Konfiguration
common.adminUI.config string
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)
common.adminUI.custom string
- 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)
common.adminUI.tab string
- html - materialize
Eigenschaften (VIS-Adapter)
common.visWidgets object
Definiert die verfügbaren VIS-Widgets im Adapter. Beispiel im offiziellen Template-Repository. .. code:: json "visWidgets": { "DemoWidget": { "name": "DemoWidget", "url": "vis-widgets-react-template/customWidgets.js", "components": [ "DemoWidget" ] } }
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 4common.npmLibs- Ersetzt durch Abhängigkeiten in derpackage.jsoncommon.main- Ersetzt durchmainin derpackage.jsoncommon.license- Ersetzt durchcommon.licenseInformationcommon.localLink- Ersetzt durchcommon.localLinkscommon.engineTypes- Ersetzt durchenginein derpackage.jsoncommon.config.height- Standard-Höhe für den Konfigurations-Dialog für Admin 2common.config.minHeight- Mindest-Höhe für den Konfigurations-Dialog für Admin 2common.config.width- Standard-Breite für den Konfigurations-Dialog für Admin 2common.config.minWidth- Mindest-Breite für den Konfigurations-Dialog für Admin 2common.materialize(boolean) - Legt fest, ob der Adapter die Admin-Oberfläche für Admin-Version 3 und 4 bereitstellt (ab Admin 5 solltecommon.adminUI.configverwendet werden) - siehe Admin-Konfigurationcommon.materializeTab(boolean) - Legt fest, ob der Adapter ein eigenes Tab für Admin-Version 3 und 4 bereitstellt (ab Admin 5 solltecommon.adminUI.tabverwendet werden) - siehe Admin-Konfigurationcommon.noConfig(boolean) - Definiert, ob Instanzen konfiguriert werden können (ab Admin 5 solltecommon.adminUI.config = noneverwendet werden) - siehe Admin-Konfigurationcommon.subscribe(string) - Definiert die Objekt-ID, welche zu einem Start der Instanz führen sollcommon.wakeup(boolean) - Legt fest, ob die Instanz gestartet werden soll, wenn ein Wert insystem.adapter.geschrieben wird. .wakeup