View source for ISY Developers:API:V5:Appendix:Editors

<!--
   ** DO NOT EDIT ON THE WIKI WEBSITE - Source file is v5.appendix.editors.wiki.txt **
 -->

[[ISY_Developers]] : [[ISY_Developers:API | API]] : [[ISY_Developers:API:V5 | V5]] : [[ISY_Developers:API:V5:Appendix | Appendix]] : Editors

== Editors ==
  <editors>
     <editor id="I_OL">
        <range uom="51" subset="0-100" />
        <range uom="56" subset="0-255" />
     </editor>
     <editor id="TEMP_C">
        <range uom="4" min="4.5" max="32" step="0.5" prec="1" />
     </editor>
     <editor id="I_RR">
        <range uom="25" subset="0-32" nls="IX_I_RR_" />
     </editor>
  </editors>

{| border="1" style="border-collapse:collapse" cellpadding="10"
|- style="vertical-align:top;"
|'''''editor'''''
|id
|The name of the editor

Note: Name must not begin with '_' (reserved for encoded Editor IDs)
|- style="vertical-align:top;"
| rowspan="2" | '''''range'''''
|uom
|The unit of measure of the value (See Units of Measure)
<br>''Note: Must be unique for each range entry in an editor''
|- style="vertical-align:top;"
|nls
|Used for percent (51) and  index (25) units of measure only.  The NLS prefix to use for the name of value.

e.g. for nls="IX_I_RR" value 5, the NLS entry would be:
IX_I_RR-5 = 8 seconds
|- style="vertical-align:top;"
|'''''range&nbsp;(1)'''''
|subset
|The subset of values supported is defined as a set of ranges and individual values.  They must be in increasing value with no duplicates or overlap. Ranges are separated by a '-', individual digits are separated by a ','.
<br>e.g. subset="0-5,7,9,11-14" means these numbers:
::0,1,2,3,4,5,7,9,11,12,13,14
<br>e.g. subset="-50--48,-2-3" means -50 to -48, -2 to 3
::-50,-49,-48,-2,-1,0,1,2,3
|- style="vertical-align:top;"
| rowspan="4" | '''''range&nbsp;(2)'''''
|min
|The minimum value (inclusive)
|- style="vertical-align:top;"
| max   || The maximum value (inclusive)
|- style="vertical-align:top;"
| step  || The number to increment with each step (e.g. in a spinner type widget)
|- style="vertical-align:top;"
| prec  || The number of decimal places to keep for the value
|- style="vertical-align:top;"
|}

== Encoded Editor ID ==
For simple editors, rather than referencing an editor defined within an xml file, the ID itself can be encoded in a way that fully defines the editor.  The following describes the supported encodings.  An encoded editor ID may be used anywhere an editor is referenced (e.g. status, command parameters, etc.)

<span style="font-family: courier;">&nbsp;&nbsp;&nbsp;&nbsp;e.g. <st id="CLITEMP" editor="_17_1_N_IXN" /></span>
<br>
<br>
{| border="1" style="border-collapse:collapse; font-family: courier; vertical-align: top;" cellpadding="10"
! style="font-family: initial;" | Editor ID Encoded Format
! style="font-family: initial;" | Implied XML (by example)
|- style="vertical-align:top;"
| style="font-family: courier;" | _<uom>_<prec>
|
  <editor id="_17_1">
      <range uom="17" prec="1"
             min="-2147483647"
             max="2147483647" />
  </editor>
|- style="vertical-align:top;"
| style="font-family: courier;" |_<uom>_<prec>_N_<nls>
|
  <editor id="_17_1_N_IXN">
      <range uom="17" prec="1"
             min="-2147483647"
             max="2147483647"
             nls="IXN" />
  </editor>
|- style="vertical-align:top;"
| style="font-family: courier;" |_<uom>_<prec>_R_<min>_<max>
<br>
Note: '<span style="background-color: yellow;">m</span>' is used to indicate a negative<br>
min/max value
| style="font-family: courier;" |
  <editor id="_17_2_R_<span style="background-color: yellow;">m</span>5_10">
     <range uom="17" prec="2"
            min="<span style="background-color: yellow;">-5</span>" max="10" />
  </editor>
|- style="vertical-align:top;"
| style="font-family: courier;" |_<uom>_<prec>_R_<min>_<max>_N_<nls>
<br>
Note: 'm' is used to indicate a negative<br>
min/max value
|
  <editor id="_17_0_R_0_10_N_IXRR">
     <range uom="17" prec="0"
            min="0" max="10"
            nls="IXRR" />
  </editor>
|- style="vertical-align:top;"
| style="font-family: courier;" |_<uom>_<prec>_S_<lowMask>
|
  <editor id="_17_1_S_FF00FF00">
     <range uom="17" subset="8-15,24-31" />
  </editor>
|- style="vertical-align:top;"
| style="font-family: courier;" |_<uom>_<prec>_S_<lowMask>_N_<nls>
|
  <editor id="_17_1_S_FF00FF00_N_IXN">
     <range uom="17" subset="8-15,24-31" nls="IXN" />
  </editor>
|- style="vertical-align:top;"
| style="font-family: courier;" |_<uom>_<prec>_S_<lowMask>_<highMask>
|
  <editor id="_17_1_S_FF00FF00_03E">
     <range uom="17" subset="8-15,24-31,33-37" />
  </editor>
|- style="vertical-align:top;"
| style="font-family: courier;" |_<uom>_<prec>_S_<lowMask>_<highMask>_N_<nls>
|
  <editor id="_17_1_S_FF00FF00_03E_N_IXN">
     <range uom="17" subset="8-15,24-31,33-37" nls="IXN" />
  </editor>
|}