Desc: New naming scheme
File: new-names.txt
Date: 19 May 2003
Auth: Russell Kroll <rkroll@exploits.org>

This is a dump of the planning page for the variable and instant 
command renaming effort.  Don't use a name with any of the dstate
functions unless it exists here.

If you need a new variable or command name, contact me first.

                                   Variables

   +------------------------------------------------------------------------+
   |                     ups - General unit information                     |
   |------------------------------------------------------------------------|
   | Old name |      New name      |   Description   |Typical value|   In   |
   |          |                    |                 |             |var_map?|
   |----------+--------------------+-----------------+-------------+--------|
   |STATUS    |ups.status          |UPS status       |OL           |yes     |
   |----------+--------------------+-----------------+-------------+--------|
   |MODEL     |ups.model           |UPS model        |SMART-UPS 700|yes     |
   |----------+--------------------+-----------------+-------------+--------|
   |MFR       |ups.mfr             |UPS manufacturer |APC          |yes     |
   |----------+--------------------+-----------------+-------------+--------|
   |          |                    |UPS manufacturing|             |        |
   |MFRDATE   |ups.mfr.date        |date (opaque     |10/17/96     |yes     |
   |          |                    |string)          |             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |SERIAL    |ups.serial          |UPS serial number|WS9643050926 |yes     |
   |          |                    |(opaque string)  |             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |FIRMREV   |ups.firmware        |UPS firmware     |50.9.D       |yes     |
   |          |                    |(opaque string)  |             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |FIRMREV2  |ups.firmware.aux    |Auxiliary device |4Kx          |yes     |
   |          |                    |firmware         |             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |UPSTEMP   |ups.temperature     |UPS temperature  |042.7        |yes     |
   |          |                    |(degrees C)      |             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |LOADPCT   |ups.load            |Load on UPS      |023.4        |yes     |
   |          |                    |(percent)        |             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |          |                    |UPS system       |             |        |
   |UPSIDENT  |ups.id              |identifier       |Sierra       |yes     |
   |          |                    |(opaque string)  |             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |          |                    |Interval to wait |             |        |
   |WAKEDELAY |ups.delay.start     |before restarting|0            |yes     |
   |          |                    |the load         |             |        |
   |          |                    |(seconds)        |             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |          |                    |Interval to wait |             |        |
   |n/a       |ups.delay.reboot    |before rebooting |60           |n/a     |
   |          |                    |the UPS (seconds)|             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |          |                    |Interval to wait |             |        |
   |PDNGRACE  |ups.delay.shutdown  |after shutdown   |20           |yes     |
   |GRACEDELAY|                    |with delay       |             |        |
   |          |                    |command (seconds)|             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |          |                    |Interval between |1209600 (two |        |
   |SLFTSTINT |ups.test.interval   |self tests       |weeks)       |yes     |
   |          |                    |(seconds)        |             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |          |                    |Results of last  |Bad battery  |        |
   |SLFTSTRES |ups.test.result     |self test (opaque|pack         |yes     |
   |          |                    |string)          |             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |          |                    |Language to use  |             |        |
   |LANGUAGE  |ups.display.language|on front panel   |E            |yes     |
   |          |                    |(*** opaque)     |             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |          |                    |UPS external     |             |        |
   |CONTACTS  |ups.contacts        |contact sensors  |F0           |yes     |
   |          |                    |(*** opaque)     |             |        |
   +------------------------------------------------------------------------+

   +------------------------------------------------------------------------+
   |                input - Incoming line/power information                 |
   |------------------------------------------------------------------------|
   | Old name  |        New name         |  Description   |Typical |   In   |
   |           |                         |                | value  |var_map?|
   |-----------+-------------------------+----------------+--------+--------|
   |UTILITY    |input.voltage            |Input voltage   |121.5   |yes     |
   |-----------+-------------------------+----------------+--------+--------|
   |n/a        |input.voltage.nominal    |Nominal input   |120     |n/a     |
   |           |                         |voltage         |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |           |                         |Reason for last |        |        |
   |XFERWHY    |input.transfer.reason    |transfer to     |T       |yes     |
   |           |                         |battery (***    |        |        |
   |           |                         |opaque)         |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |LOWXFER    |input.transfer.low       |Low voltage     |103     |yes     |
   |           |                         |transfer point  |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |HIGHXFER   |input.transfer.high      |High voltage    |132     |yes     |
   |           |                         |transfer point  |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |LINESENS   |input.sensitivity        |Input power     |H (high)|yes     |
   |           |                         |sensitivity     |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |MAXUTIL    |input.maximum            |Maximum incoming|130     |yes     |
   |           |                         |voltage seen    |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |MINUTIL    |input.minimum            |Minimum incoming|100     |yes     |
   |           |                         |voltage seen    |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |           |                         |Input power     |        |        |
   |LINEQUAL   |input.quality            |quality (***    |FF      |yes     |
   |           |                         |opaque)         |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |ACFREQ     |input.frequency          |Input line      |60.00   |yes     |
   |           |                         |frequency (Hz)  |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |           |                         |Low voltage     |        |        |
   |LOBOOSTXFER|input.transfer.boost.low |boosting        |190     |yes     |
   |           |                         |transfer point  |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |           |                         |High voltage    |        |        |
   |HIBOOSTXFER|input.transfer.boost.high|boosting        |210     |yes     |
   |           |                         |transfer point  |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |           |                         |Low voltage     |        |        |
   |LOTRIMXFER |input.transfer.trim.low  |trimming        |230     |yes     |
   |           |                         |transfer point  |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |           |                         |High voltage    |        |        |
   |HITRIMXFER |input.transfer.trim.high |trimming        |240     |yes     |
   |           |                         |transfer point  |        |        |
   +------------------------------------------------------------------------+

   +------------------------------------------------------------------------+
   |              output - Outgoing power/inverter information              |
   |------------------------------------------------------------------------|
   |Old name |          New name           |  Description  |Typical|   In   |
   |         |                             |               | value |var_map?|
   |---------+-----------------------------+---------------+-------+--------|
   |OUTVOLT  |output.voltage               |Output voltage |120.9  |yes     |
   |---------+-----------------------------+---------------+-------+--------|
   |n/a      |output.frequency             |Output         |60     |n/a     |
   |         |                             |frequency (Hz) |       |        |
   |---------+-----------------------------+---------------+-------+--------|
   |         |                             |Target output  |       |        |
   |OUTVLTSEL|output.voltage.target.line   |voltage when on|120    |yes     |
   |         |                             |line           |       |        |
   |---------+-----------------------------+---------------+-------+--------|
   |         |                             |Target output  |       |        |
   |REQVOLT  |output.voltage.target.battery|voltage when on|120    |yes     |
   |         |                             |battery        |       |        |
   |---------+-----------------------------+---------------+-------+--------|
   |CURRENT  |output.current               |Output current |4.25   |yes     |
   |         |                             |(amps)         |       |        |
   +------------------------------------------------------------------------+

   +------------------------------------------------------------------------+
   |                     battery - Any battery details                      |
   |------------------------------------------------------------------------|
   |              |                         | Battery   |             |     |
   | BATTPCT      | battery.charge          | charge    | 100.0       | yes |
   |              |                         | (percent) |             |     |
   |--------------+-------------------------+-----------+-------------+-----|
   |              |                         | Remaining |             |     |
   |              |                         | battery   |             |     |
   |              |                         | level     |             |     |
   | LOBATTPCT    | battery.charge.low      | when UPS  | 20          | yes |
   |              |                         | switches  |             |     |
   |              |                         | to LB     |             |     |
   |              |                         | (percent) |             |     |
   |--------------+-------------------------+-----------+-------------+-----|
   |              |                         | Minimum   |             |     |
   |              |                         | battery   |             |     |
   | WAKETHRSH    |                         | level for |             |     |
   | RTHRESH      | battery.charge.restart  | UPS       | 20          | yes |
   |              |                         | restart   |             |     |
   |              |                         | after     |             |     |
   |              |                         | power-off |             |     |
   |--------------+-------------------------+-----------+-------------+-----|
   |              |                         | Battery   |             |     |
   | BATTVOLT     | battery.voltage         | charge    | 24.84       | yes |
   |              |                         | (volts)   |             |     |
   |--------------+-------------------------+-----------+-------------+-----|
   |              |                         | Nominal   |             |     |
   | NOMBATVLT    | battery.voltage.nominal | battery   | 024         | yes |
   |              |                         | voltage   |             |     |
   |--------------+-------------------------+-----------+-------------+-----|
   | BATT_RUNTIME |                         | Battery   |             |     |
   | RUNTIME      | battery.runtime         | runtime   | 1080        | yes |
   |              |                         | (seconds) |             |     |
   |--------------+-------------------------+-----------+-------------+-----|
   |              |                         | Remaining |             |     |
   |              |                         | battery   |             |     |
   |              |                         | runtime   |             |     |
   | LOBATTIME    | battery.runtime.low     | when UPS  | 180         | yes |
   |              |                         | switches  |             |     |
   |              |                         | to LB     |             |     |
   |              |                         | (seconds) |             |     |
   |--------------+-------------------------+-----------+-------------+-----|
   | ALRMDELAY    |                         | Battery   | 0           |     |
   | ALRMDEL      | battery.alarm.threshold | alarm     | (immediate) | yes |
   |              |                         | threshold |             |     |
   |--------------+-------------------------+-----------+-------------+-----|
   |              |                         | Battery   |             |     |
   |              |                         | change    |             |     |
   | BATTDATE     | battery.date            | date      | 11/14/00    | yes |
   |              |                         | (opaque   |             |     |
   |              |                         | string)   |             |     |
   |--------------+-------------------------+-----------+-------------+-----|
   |              |                         | Number of |             |     |
   | BATTPACKS    | battery.packs           | battery   | 001         | yes |
   |              |                         | packs     |             |     |
   |--------------+-------------------------+-----------+-------------+-----|
   |              |                         | Number of |             |     |
   | BADPACKS     | battery.packs.bad       | bad       | 000         | yes |
   |              |                         | battery   |             |     |
   |              |                         | packs     |             |     |
   +------------------------------------------------------------------------+

   +------------------------------------------------------------------------+
   |           ambient - Conditions from external probe equipment           |
   |------------------------------------------------------------------------|
   |Old name|            New name             |Description |Typical|   In   |
   |        |                                 |            | value |var_map?|
   |--------+---------------------------------+------------+-------+--------|
   |        |                                 |Ambient     |       |        |
   |AMBTEMP |ambient.temperature              |temperature |25.40  |yes     |
   |        |                                 |(degrees C) |       |        |
   |--------+---------------------------------+------------+-------+--------|
   |        |                                 |Set if      |       |        |
   |        |                                 |ambient     |       |        |
   |n/a     |ambient.temperature.alarm        |temperature |0      |n/a     |
   |        |                                 |alarm is    |       |        |
   |        |                                 |active      |       |        |
   |--------+---------------------------------+------------+-------+--------|
   |        |                                 |Maximum     |       |        |
   |TEMPMAX |ambient.temperature.alarm.maximum|allowed     |NO,NO  |yes     |
   |        |                                 |temperature |       |        |
   |        |                                 |(*** opaque)|       |        |
   |--------+---------------------------------+------------+-------+--------|
   |        |                                 |Minimum     |       |        |
   |TEMPMIN |ambient.temperature.alarm.minimum|allowed     |NO,NO  |yes     |
   |        |                                 |temperature |       |        |
   |        |                                 |(*** opaque)|       |        |
   |--------+---------------------------------+------------+-------+--------|
   |        |                                 |Enable alarm|       |        |
   |n/a     |ambient.temperature.alarm.enable |for ambient |1      |n/a     |
   |        |                                 |temperature |       |        |
   |--------+---------------------------------+------------+-------+--------|
   |        |                                 |Ambient     |       |        |
   |AMBHUMID|ambient.humidity                 |relative    |038.8  |yes     |
   |        |                                 |humidity    |       |        |
   |        |                                 |(percent)   |       |        |
   |--------+---------------------------------+------------+-------+--------|
   |        |                                 |Set if      |       |        |
   |        |                                 |ambient     |       |        |
   |n/a     |ambient.humidity.alarm           |humidity    |0      |n/a     |
   |        |                                 |alarm is    |       |        |
   |        |                                 |active      |       |        |
   |--------+---------------------------------+------------+-------+--------|
   |        |                                 |Maximum     |       |        |
   |HUMDMAX |ambient.humidity.alarm.maximum   |allowed     |NO,NO  |yes     |
   |        |                                 |humidity    |       |        |
   |        |                                 |(*** opaque)|       |        |
   |--------+---------------------------------+------------+-------+--------|
   |        |                                 |Minimum     |       |        |
   |HUMDMIN |ambient.humidity.alarm.minimum   |allowed     |NO,NO  |yes     |
   |        |                                 |humidity    |       |        |
   |        |                                 |(*** opaque)|       |        |
   |--------+---------------------------------+------------+-------+--------|
   |        |                                 |Enable alarm|       |        |
   |n/a     |ambient.humidity.alarm.enable    |for ambient |1      |n/a     |
   |        |                                 |humidity    |       |        |
   +------------------------------------------------------------------------+

   +------------------------------------------------------------------------+
   |                  driver - Internal driver information                  |
   |------------------------------------------------------------------------|
   | Old  |        New name         |   Description   | Typical  |    In    |
   | name |                         |                 |  value   | var_map? |
   |------+-------------------------+-----------------+----------+----------|
   | n/a  | driver.name             | Driver name     | apcsmart | n/a      |
   |------+-------------------------+-----------------+----------+----------|
   | n/a  | driver.version          | Driver version  | X.Y.Z    | n/a      |
   |      |                         | (NUT release)   |          |          |
   |------+-------------------------+-----------------+----------+----------|
   |      |                         | Internal driver |          |          |
   | n/a  | driver.version.internal | version (if     | 1.23.45  | n/a      |
   |      |                         | tracked         |          |          |
   |      |                         | separately)     |          |          |
   +------------------------------------------------------------------------+

   +------------------------------------------------------------------------+
   |                  server - Internal server information                  |
   |------------------------------------------------------------------------|
   |Old |   New name   |Description|         Typical value         |   In   |
   |name|              |           |                               |var_map?|
   |----+--------------+-----------+-------------------------------+--------|
   |n/a |server.info   |Server     |Network UPS Tools upsd vX.Y.Z -|n/a     |
   |    |              |information|http://www.exploits.org/nut/   |        |
   |----+--------------+-----------+-------------------------------+--------|
   |n/a |server.version|Server     |X.Y.Z                          |n/a     |
   |    |              |version    |                               |        |
   +------------------------------------------------------------------------+

                                Instant commands

   +------------------------------------------------------------------------+
   | Old name  |      New name      |       Description       | In cmd_map? |
   |-----------+--------------------+-------------------------+-------------|
   | OFF       | load.off           | Turn off the load       | yes         |
   |           |                    | immediately             |             |
   |-----------+--------------------+-------------------------+-------------|
   | ON        | load.on            | Turn on the load        | yes         |
   |           |                    | immediately             |             |
   |-----------+--------------------+-------------------------+-------------|
   |           |                    | Turn off the load       |             |
   | SOFTDOWN  | shutdown.return    | possibly after a delay  | yes         |
   |           |                    | and return when power   |             |
   |           |                    | is back                 |             |
   |-----------+--------------------+-------------------------+-------------|
   |           |                    | Turn off the load       |             |
   | SHUTDOWN  | shutdown.stayoff   | possibly after a delay  | yes         |
   |           |                    | and remain off even if  |             |
   |           |                    | power returns           |             |
   |-----------+--------------------+-------------------------+-------------|
   | STOPSHUTD | shutdown.stop      | Stop a shutdown in      | yes         |
   |           |                    | progress                |             |
   |-----------+--------------------+-------------------------+-------------|
   | FPTEST    | test.panel.start   | Start testing the UPS   | yes         |
   |           |                    | panel                   |             |
   |-----------+--------------------+-------------------------+-------------|
   | n/a       | test.panel.stop    | Stop a UPS panel test   | n/a         |
   |-----------+--------------------+-------------------------+-------------|
   | SIMPWF    | test.failure.start | Start a simulated power | yes         |
   |           |                    | failure                 |             |
   |-----------+--------------------+-------------------------+-------------|
   | n/a       | test.failure.stop  | Stop simulating a power | n/a         |
   |           |                    | failure                 |             |
   |-----------+--------------------+-------------------------+-------------|
   | BTEST1    | test.battery.start | Start a battery test    | yes         |
   |-----------+--------------------+-------------------------+-------------|
   | BTEST0    | test.battery.stop  | Stop the battery test   | yes         |
   |-----------+--------------------+-------------------------+-------------|
   | CAL1      | calibrate.start    | Start runtime           | yes         |
   |           |                    | calibration             |             |
   |-----------+--------------------+-------------------------+-------------|
   | CAL0      | calibrate.stop     | Stop runtime            | yes         |
   |           |                    | calibration             |             |
   |-----------+--------------------+-------------------------+-------------|
   | BYPASS    | bypass.start       | Put the UPS in bypass   | yes         |
   |           |                    | mode                    |             |
   |-----------+--------------------+-------------------------+-------------|
   | n/a       | bypass.stop        | Take the UPS out of     | n/a         |
   |           |                    | bypass mode             |             |
   |-----------+--------------------+-------------------------+-------------|
   |           |                    | Reset minimum and       |             |
   | n/a       | reset.input.minmax | maximum input voltage   | n/a         |
   |           |                    | status                  |             |
   +------------------------------------------------------------------------+
