OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Describe addon.xml new `keywords` element (#2662) 

Signed-off-by: Andrew Fiddian-Green <software@whitebear.ch>
pull/2677/head
Andrew Fiddian-Green 2026-03-16 17:30:27 +00:00 committed by GitHub
parent c0e1c0ec00
commit 7c4e18141c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
developers/addons/addon.md
View File

@ -29,6 +29,9 @@ If the add-on consists of more than one bundle, only one `addon.xml` is allowed
<type>String</type>
<name>String</name>
<description>String</description>
<keywords>String,String,String</keywords>
<connection>String</connection>
<countries>String,String,String</countries>
<service-id>String</service-id>
@ -51,8 +54,9 @@ If the add-on consists of more than one bundle, only one `addon.xml` is allowed
| type | Either `automation`, `binding`, `misc`, `persistence`, `transform`, `ui` or `voice` | mandatory |
| name | A human-readable name for the add-on | mandatory |
| description | A human-readable description for the add-on | optional |
| keywords | A comma separated list of keywords that are used by the UI search function. e.g. `AwTrixLight,ESPMilight,FalconPlayerFPP,RuuviGateway`. Note that `id`, `name` and `description` are also used by the search function, so duplication is not required here. | optional |
| connection | `none` for add-ons that have no interactions with external systems at all, `local` for add-ons that only interact locally without internet access, `hybrid` for add-ons that interact locally without internet access, but can optionally use a cloud connection for extended functionality (such as discovery), `cloud` for add-ons that require a cloud connection | optional |
| countries | List of two-letter ISO country codes (ISO 3166-1 alpha-2) that are supported (all countries if empty). Must be in lowercase | optional |
| countries | List of two-letter ISO country codes (ISO 3166-1 alpha-2) that are supported (all countries if empty). Must be in lowercase. e.g. `de,nl,dk` | optional |
| service-id | The ID (service.pid or component.name) of the main binding service, which can be configured through OSGi configuration admin service. Should only be used in combination with a config description definition | optional |
| config-description | The configuration description for the binding within the ConfigDescriptionRegistry (cf. [Configuration Description](config-xml.html)) | optional |
| config-description-ref | The reference to a configuration description for the binding within the ConfigDescriptionRegistry | optional |