info.json File Documentation

Included since version 3.0 of Jeedom, the file info.json is required for the plugins to function properly and to be deployed correctly on the Jeedom Market.

The info.json file is saved in the folder /plugin_info/ for your plugin.

List of variables in the file info.json

Fields marked with an * are required.

Example

File plugin-template/plugin_info/info.json

CATEGORY LIST

SpecialAttributes

These attributes allow you to request additional settings from users for each object (objet as defined by Jeedom: Tools / Objects menu; typically, this represents the rooms in our home automation system) or for each user.

Usage

In your code, you can retrieve the values of these parameters using the object User for a User attribute, or the object jeeObject for an object attribute:

user : $user->getOptions(‹ plugin::ID_plugin::clef ›)
object : $jeeObject->getConfiguration(‹ plugin::ID_plugin::clef ›)

• ID_plugin is your plugin’s ID
• “key” is the key in your JSON configuration (in the example: toto, toto 2, etc.)

Object Attributes

The syntax for specifying two specific parameters per object is as follows:

	"specialAttributes" : {
		"object" : {
			"toto" : {"name" : {"fr_FR" : "Plop je suis un attribut spécial"},"type" : "input"},
			"toto2" : {"name" : {"fr_FR" : "Plop je suis un attribut spécial number"},"type" : "number"}
		}
	}

Users will be able to set these two parameters for each object in the object configuration menu (Tools / Objects menu). Here is some free-form text and a digital one.

User Attributes

	"specialAttributes" : {
		"user" : {
			"toto" : {"name" : {"fr_FR" : "Plop je suis un attribut spécial users"},"type" : "select","values" : [{"value" : "1", "name" : "valeur 1"},{"value" : "plop", "name" : "valeur plop"}]}
		}
	}

Here, this attribute allows each user to set their own preference (in the Settings / Preferences menu)

EqLogic Attributes

	"specialAttributes": {
        "eqLogic": {
            "mqttTranmit": {
                "type": "checkbox",
                "name": {
                    "fr_FR": "Transmettre l'équipement en MQTT"
                }
            }
        }
    }

Here, this attribute allows you to set a parameter for each Jeedom device (in the device’s advanced settings). You can find it in the device’s settings under plugin::mqtt2::mqttTranmit (plugin::id_plugin::key)