Addons.cfg: Proper way to discover the name of an addon

Setup, Configuration and Use Runtime
3

Hey Rich,

It is fairly simple: On the console, you can do a:

feature:list | grep ^openhab

Which will give you a list of all available add-ons (including the full name in the last column).

...
openhab-transformation-xslt               | 0.9.0.SNAPSHOT   |          | Uninstalled | openhab-aggregate-xml   | XSLT Transformation
openhab-voice-mactts                      | 0.9.0.SNAPSHOT   |          | Uninstalled | openhab-aggregate-xml   | MacOS Text-to-Speech
openhab-binding-amazondashbutton          | 2.0.0.SNAPSHOT   |          | Uninstalled | openhab-aggregate-xml   | Amazon Dash Button Binding
openhab-binding-astro                     | 2.0.0.SNAPSHOT   |          | Uninstalled | openhab-aggregate-xml   | Astro Binding
openhab-binding-autelis                   | 2.0.0.SNAPSHOT   |          | Uninstalled | openhab-aggregate-xml   | Autelis Binding
openhab-binding-avmfritz                  | 2.0.0.SNAPSHOT   |          | Uninstalled | openhab-aggregate-xml   | AVM Fritz!Box Binding
...

This corresponds to what you also see in the Paper UI.

The naming convention is this:

<prefix>-<type>-<id>

where

  • prefix is ALWAYS “openhab” (this makes it easy to identify the features in Karaf, because there are also other non-openHAB related ones that can be ignored by the normal user)
  • type is the add-on type, e.g. “binding” or “ui”. You need this to decide where to put it in your addons.cfg. This is also used by the Paper UI to sort the add-ons on different tabs.
  • id is the identifier that you would have to use in addons.cfg, e.g. “hue”, “map”, etc.

Hope this helps!
Kai

2 Likes