Your Apps in Action

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


{{repoTitle.MainEntity}}

.common
_

.common.titleLang
_

.common.news
_

.common.desc
_

.common.adminUI
_

.common.docs
_

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.name
_

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.osDependencies
_

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.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}}.
{{repoTitle.MainEntity}}

objTypes objTypes

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

{{repoTitle.MainEntity}}

{{repoTitle.MainEntity}}


{{message}}