Schema for ioBroker adapters io-package file Json Format

$schema - JSON schema for validation

.common

_

common.name - Name of the adapter without ioBroker

common.version - Current adapter version

common.platform - Platform, normally Javascript/Node.js

common.title - Longer name of adapter DEPRECATED: For admin version >= 5 this property is no longer required

.common.titleLang

_

.common.news

_

.common.desc

_

common.messagebox - true if messagebox supported. If yes, the object system.adapter.<instance>.messagebox will be created to send messages to adapter

common.readme - Url of the ReadMe file

.common.adminUI

_

common.adminUI.custom - UI type of custom tab inside admin UI

common.adminUI.config - UI type of config page inside admin UI

common.adminUI.tab - UI type of tab inside admin UI

.common.docs

_

common.license - License of the software

common.type - Type of the adapter

common.unsafePerm - if the package must be installed with "npm --unsafe-perm" parameter

common.authors Array of authors as string

#	Actions
{{$index+1}}.

.common.plugins

_

common.adminColumns Custom attributes, that must be shown in admin in the object browser. Like: [{"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 is a type of the attribute (e.g. string, number, boolean) and only needed if edit is enabled. objTypes is a list of the object types, that could have such attribute. Used only in edit mode too.

#	path	width	align	type	edit	Actions
{{$index+1}}.	{{row.path}}	{{row.width}}	{{row.align}}	{{row.type}}	{{row.editSelected.DisplayText}}

.common.adminTab

_

common.adminTab.fa-icon - Font-Awesome icon name for TAB

common.adminTab.ignoreConfigUpdate - Do not update config TAB if configuration changed (to enable configure settings in TAB)

common.adminTab.link - Link for iframe in the TAB. You can use parameters replacement like this: "https://%ip%:%port%". IP will be replaced with host IP. "port" will be extracted from native.port.

.common.adminTab.name

_

common.adminTab.singleton - If true, only one TAB for all instances will be shown.

common.controller - Only used by js-controller

common.allowInit - allow for "scheduled" adapter to be called "not in the time schedule", if settings changed or adapter started. Or allow scheduled adapter start once after configuration changed and then by schedule.

common.blockly - if adapter has custom blocks for blockly (admin/blockly.js required)

common.connectionType - Type of connection to device

common.compact - If compact mode supported

common.dataFolder - Folder relative to iobroker-data where the adapter stores the data. This folder will be backed up and restored automatically. You can use variable '%INSTANCE%' in it

common.dataSource - How the data will be received from device

common.enabled - Value should be false so new instances are disabled by default

common.eraseOnUpload - erase all previous data in the directory before upload

common.extIcon - Link to external icon for uninstalled adapters. Normally on GitHub

common.getHistory - if adapter supports getHistory message

common.icon - name of the local icon (should be located in subdirectory "admin")

common.availableModes values for common.mode if more than one mode is possible

#	Values	Actions
{{$index+1}}.

common.dependencies Array like [{"js-controller": ">=2.0.0"}] that describes which ioBroker modules are required for this adapter on the same host

#	Values	Actions
{{$index+1}}.

common.globalDependencies Array like [{"admin": ">=2.0.0"}] that describes which ioBroker modules are required for this adapter on one of the hosts

#	Values	Actions
{{$index+1}}.

common.keywords Similar to keywords in package.json, but can be defined in many languages.

#	Values	Actions
{{$index+1}}.

.common.localLinks

_

common.loglevel - Default Loglevel after instance creation

common.logTransporter - If this adapter receives logs from other hosts and adapters (e.g. to store them somewhere)

common.main - Name of the start file. DEPRECATED: For controller >= 3.3 please use package.json main.

common.materialize - If adapter supports > admin3 (materialize style) DEPRECATED: For admin version >= 5 please use the property 'adminUI'

common.materializeTab - If adapter supports > admin3 for tab (materialize style) DEPRECATED: For admin version >= 5 please use the property 'adminUI'

common.mode - Execution mode of the adapter

common.noConfig - Do not show configuration dialog for instance DEPRECATED: For admin version >= 5 please use adminUI.config = "none"

common.noIntro - never show instances of this adapter on Intro/Overview screen in admin (like icons, widgets)

common.noRepository - If adapter delivered with initial installation or has own repository

common.nogit - If true, no install from github directly is possible

common.nondeletable - This adapter cannot be deleted or updated. It will be updated together with controller.

common.onlyWWW - Say to controller, that adapter has only html files and no main.js, like rickshaw

.common.osDependencies

_

common.preserveSettings - String (or array) with names of attributes in common of instance, which will not be deleted. E.g. "history", so by setState('system.adapter.mqtt.0", {..}) the field common.history will not be deleted even if new object does not have this field. To delete the attribute it must be explicitly done with common:{history: null}.

common.restartSchedule - CRON schedule to restart mode daemon adapters

common.schedule - CRON schedule if adapter runs in mode schedule

common.serviceStates - If adapter can deliver additional states. If true, the path adapter/lib/states.js (or given path as string) will be called and it give following parameters function (objects, states, instance, config, callback). The function must deliver the array of points with values like function (err, result) { result = [{id: 'id1', val: 1}, {id: 'id2', val: 2}]}

common.singletonHost - Adapter can be installed only once on one host

common.singleton - Adapter can be installed only once in whole system

common.stopBeforeUpdate - If adapter must be stopped before update

common.stopTimeout - timeout in ms to wait, till adapter shut down

common.subscribable - Variables of this adapter must be subscribed with sendTo to enable updates

common.subscribe - Name of variable, that is subscribed automatically

common.supportCustoms - If the adapter support settings for every state. It has to have custom.html file in admin. Sample can be found in ioBroker.history

common.wakeup - Adapter will be started if some value is written into system.adapter.NAME.x.wakeup. Normally the adapter should stop after processing of event.

common.webByVersion - Show version as prefix in web adapter (usually - ip:port/material, webByVersion - ip:port/1.2.3/material)

common.webExtendable - If web server in this adapter can be extended with plugin/extensions like proxy, simple-api

common.webExtension - Relative filename to connect the web extension. E.g. in simple-api "lib/simpleapi.js" relative to the adapter root directory. Additionally is native.webInstance required to say where this extension will be included. Empty means, it must run as own web service. "*" means every web server must include it.

common.restartAdapters Array with names of adapter that must be restarted after this adapter is installed, e.g. ["vis"]

#	Values	Actions
{{$index+1}}.

.common.webPreSettings

_

common.wwwDontUpload - Do not upload the www directory into DB. Used only for admin.

common.tier - Lower tiers are started before higher tiers instances, TIER 1: LOGIC, TIER 2: APIs & other data, TIER 3: not fastly needed data, like BackItUp, Visualization, etc.

common.webservers Array of web server's instances that should serve content from the adapters www folder

#	Values	Actions
{{$index+1}}.

common.welcomeScreen Array of pages, that should be shown on the "web" index.html page. ["vis/edit.html", "vis/index.html"] or [{"link": "vis/edit.html", "name": "Vis editor", "img": "vis/img/edit.png", "color": "blue"}, "vis/index.html"]

#	Values	Actions
{{$index+1}}.

common.welcomeScreenPro Array of pages used on access via ioBroker cloud, that should be shown on the "web" index.html page. ["vis/edit.html", "vis/index.html"] or [{"link": "vis/edit.html", "name": "Vis editor", "img": "vis/img/edit.png", "color": "blue"}, "vis/index.html"]

#	Values	Actions
{{$index+1}}.

objects Objects which will be created for the adapter

#	_id	Actions
{{$index+1}}.

instanceObjects Objects which will be created for each instance

#	_id	Actions
{{$index+1}}.

notifications Register notifications for the built-in notification system

#	Actions
{{$index+1}}.

.native

_

protectedNative Array of config attributes which will only be accessible by the own adapter, e.g. ["password"]

#	Values	Actions
{{$index+1}}.

encryptedNative Array of config attributes which will be automatically encrypted when stored via Admin configuration page and automatically decrypted at adapter runtime, e.g. ["password", "token"]

#	Values	Actions
{{$index+1}}.

ToolMatter

Your Apps in Action

Use this form to visualize Schema for ioBroker adapters io-package file.

{{repoTitle.MainEntity}}

_

_

_

_

_

_

common.authors Array of authors as string

_

_

_

common.availableModes values for common.mode if more than one mode is possible

common.dependencies Array like [{"js-controller": ">=2.0.0"}] that describes which ioBroker modules are required for this adapter on the same host

common.globalDependencies Array like [{"admin": ">=2.0.0"}] that describes which ioBroker modules are required for this adapter on one of the hosts

common.keywords Similar to keywords in package.json, but can be defined in many languages.

_

_

common.restartAdapters Array with names of adapter that must be restarted after this adapter is installed, e.g. ["vis"]

_

common.webservers Array of web server's instances that should serve content from the adapters www folder

common.welcomeScreen Array of pages, that should be shown on the "web" index.html page. ["vis/edit.html", "vis/index.html"] or [{"link": "vis/edit.html", "name": "Vis editor", "img": "vis/img/edit.png", "color": "blue"}, "vis/index.html"]

common.welcomeScreenPro Array of pages used on access via ioBroker cloud, that should be shown on the "web" index.html page. ["vis/edit.html", "vis/index.html"] or [{"link": "vis/edit.html", "name": "Vis editor", "img": "vis/img/edit.png", "color": "blue"}, "vis/index.html"]

objects Objects which will be created for the adapter

instanceObjects Objects which will be created for each instance

notifications Register notifications for the built-in notification system

_

protectedNative Array of config attributes which will only be accessible by the own adapter, e.g. ["password"]

encryptedNative Array of config attributes which will be automatically encrypted when stored via Admin configuration page and automatically decrypted at adapter runtime, e.g. ["password", "token"]

{{repoTitle.MainEntity}}

objTypes objTypes

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}