User Tools

Site Tools


pluginapi:infojson

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
pluginapi:infojson [2023/06/07 17:07] James Sentmanpluginapi:infojson [2023/06/07 17:35] (current) – [Required Fields:] James Sentman
Line 17: Line 17:
  
 >**tag** String - Every plugin must have a custom “tag” value. This is how the plugin will be referenced internally even if the name changes. This must be unique. Xtension reserves all strings starting with “xt.” you should create a short string that contains something that sets yours apart from others thaat might make a similar plugin. For example “zwave” is a bad tag for an interface, consider instead something like “james.zwave.lutron” or something more specific. Don’t get too flowery. There is no limit to the length of the tag, but it will be stored many times in the database potentially and used in indexing and other things. >**tag** String - Every plugin must have a custom “tag” value. This is how the plugin will be referenced internally even if the name changes. This must be unique. Xtension reserves all strings starting with “xt.” you should create a short string that contains something that sets yours apart from others thaat might make a similar plugin. For example “zwave” is a bad tag for an interface, consider instead something like “james.zwave.lutron” or something more specific. Don’t get too flowery. There is no limit to the length of the tag, but it will be stored many times in the database potentially and used in indexing and other things.
-  “tag”:”jamie.weather.control”,+  “tag”:”jamie.weather.vengence”,
  
  
Line 37: Line 37:
  
  
->**module** String - The name of the actual plugin code file to run with the python interperter, or in the case of a binary plugin the name of the binary application to be run. This can only be in the root level of the plugin folder and must not contain any path information+>**module** String - The name of the actual plugin script file to run with the python interperter. If you are running a binary plugin program use the “binaryName” field below.
   “module”:”weatherslam.py"   “module”:”weatherslam.py"
 +
 +
 +>**binaryName** String - If not using a python or other scripting system and running a binary application use this to give the name of the application inside the isf folder. You may specify either the module key or the binaryName key but it makes no sense to include both.
 +  “binaryName”:”weatherslam.app”,
 +
  
  
Line 47: Line 52:
  
  
-NEXT: [[pluginapi:portpopup|Controlling The Port Popup]]+NEXT: [[pluginapi:portpopup]]
  
pluginapi/infojson.1686157647.txt.gz · Last modified: 2023/06/07 17:07 by James Sentman