Dokumentation zur Datei „info.json“

Seit Version 3.0 von Jeedom integriert, die Datei info.json ist für den ordnungsgemäßen Betrieb der Plugins und deren korrekte Bereitstellung im Jeedom Market zwingend erforderlich.

Die Datei „info.json“ wird im Ordner gespeichert /plugin_info/ Ihres Plugins.

Liste der Variablen in der Datei info.json

Die mit einem * gekennzeichneten Felder sind Pflichtfelder.

Beispiel

Datei „plugin-template/plugin_info/info.json“

KATEGORIENÜBERSICHT

Sonderattribute

Mit diesen Attributen können von den Benutzern zusätzliche Parameter für jedes Objekt abgefragt werden (objet im Sinne von Jeedom: Menü „Extras“ / „Objekte“; typischerweise handelt es sich dabei um die Räume in unserem Hausautomationssystem) oder für jeden Benutzer.

Verwendung

In Ihrem Code können Sie den Wert dieser Parameter mithilfe des Objekts abrufen User für ein User-Attribut oder das Objekt jeeObject für ein Objektattribut:

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

• ID_plugin ist die ID Ihres Plugins
• „clef“ ist der Schlüssel in Ihrer JSON-Konfiguration (im Beispiel: toto, toto 2 …)

Objektattribute

Die Syntax lautet wie folgt, um zwei spezifische Parameter pro Objekt anzugeben:

	"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"}
		}
	}

Der Benutzer kann diese beiden Parameter somit für jedes Objekt im Konfigurationsmenü der Objekte festlegen (Menü „Extras“ / „Objekte“). Hier ein freier Text und eine digitale Version.

Benutzerattribute

	"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"}]}
		}
	}

Mit diesem Attribut kann jeder Benutzer hier eine eigene Einstellung festlegen (im Menü „Einstellungen“ / „Präferenzen“).

EqLogic-Attribute

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

Mit diesem Attribut können Sie hier für jedes Jeedom-Gerät einen Parameter festlegen (in der erweiterten Konfiguration des Geräts). Sie finden es in der Gerätekonfiguration unter plugin::mqtt2::mqttTranmit (plugin::id_plugin::key)