Info.json file documentation

Integrated since version 3.0 from Jeedom, the file info.json is mandatory for the proper functioning of plugins, and their proper deployment on the Jeedom Market.

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

List of file variables info.json

Fields marked with * are mandatory fields.

Exemple

Plugin-template file / plugin_info / info.json

CATEGORY NOMENCLATURE

SpecialAttributes

These attributes make it possible to ask users for additional parameters, on each object (object in the Jeedom sense : Tools / Objects menu; typically this represents the rooms in our home automation) or for each user.

Utilisation

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

user : $user->getOptions(‹ plugin::Plugin_id::key ›)
object : $jeeObject->getConfiguration(‹ plugin::Plugin_id::key ›)

• ID_plugin is the ID of your plugin
• clef is the key in your json configuration (in the example: foo, foo 2 …)

Object Attributes

The syntax is as follows to propose 2 specific parameters per object :

	"specialAttributes" : {
		"object" : {
			"toto" : {"name" : {"fr_FR" : "Plop I'm a special attribute"},"type" : "input"},
			"toto2" : {"name" : {"fr_FR" : "Plop I have a special attribute number"},"type" : "number"}
		}
	}

The user will be able to define these 2 parameters for each object in the object configuration menu (Tools / Objects menu). Here a free text, and a digital.

User attributes

	"specialAttributes" : {
		"user" : {
			"toto" : {"name" : {"fr_FR" : "Plop I am a special attribute users"},"type" : "select","values" : [{"value" : "1", "name" : "value 1"},{"value" : "plop", "name" : "plop value"}]}
		}
	}

Here, this attribute allows each user to define a parameter of their own (in the Settings / Preferences menu)