ISY Developers:API:V5:Appendix:Node Definitions

From Universal Devices, Inc. Wiki
Revision as of 18:41, 18 January 2019 by Chris (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


ISY_Developers : API : V5 : Appendix : Node Definitions

 <nodeDefs>
    <nodeDef id="Thermostat" nls="143">
       <sts>
          <st id="ST" editor="I_TEMP_DEG" />
          <st id="CLISPH" editor="I_CLISPH_DEG" />
          <st id="CLISPC" editor="I_CLISPC_DEG" />
          <st id="CLIMD" editor="I_TSTAT_MODE" />
          <st id="CLIHCS" editor="I_TSTAT_HCS" />
          <st id="ERR" editor="I_ERR" hide="T" />
       </sts>
       <cmds>
          <sends>
             <cmd id="DON" />
             <cmd id="DOF" />
          </sends>
          <accepts>
             <cmd id="CLISPH">
                <p id="" editor="CLISPH_DEG" init="CLISPH" />
             </cmd>
             <cmd id="CLISPC">
                <p id="" editor="CLISPC_DEG" init="CLISPC" />
             </cmd>
             <cmd id="CLIMD">
                <p id="" editor="T_MODE" init="CLIMD" optional="T" />
             </cmd>
             <cmd id="QUERY" />
          </accepts>
       </cmds>
    </nodeDef>
 </nodeDefs>
<nodeDef> id Name of this node definition (e.g. "Thermostat")
nls NLS key string used to override names of commands, status and other elements.
<st> id One of the predefined status names e.g. "CLISPH"
editor The id of the editor to use
hide (Optional) Set to "T" or "True", hides status in views but is available in program conditions
<sends> The commands this node can send out. Used for control conditions in ISY programs and scene controllers.
<accepts> The commands this node accepts. Used for buttons etc. in ISY clients, and actions in ISY programs.
<cmd> id Name of a command.
<p> id Name of a command parameter. A command may have one unnamed parameter, all others must be named.
editor The id of the editor to use for this parameter
init (Optional) id of the <st> status value this parameter should be initialized and synchronized with. For example, CLISPH is both a status and a command.
optional (Optional) Set to "T" or "True" if this is an optional parameter
nls (Optional) NLS key string used to override name of parameter.