Desc: New naming scheme
File: new-names.txt
Date: 26 November 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     |
   |----------+--------------------+-----------------+-------------+--------|
   |n/a       |ups.alarm           |UPS alarms       |OVERHEAT     |n/a     |
   |----------+--------------------+-----------------+-------------+--------|
   |n/a       |ups.time            |Internal UPS     |n/a          |        |
   |          |                    |clock time       |             |        |
   |----------+--------------------+-----------------+-------------|        |
   |n/a       |ups.date            |Internal UPS     |n/a          |        |
   |          |                    |clock date       |             |        |
   |----------+--------------------+-----------------+-------------+--------|
   |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     |
   |-----------+-------------------------+----------------+--------+--------|
   |MAXUTIL    |input.voltage.maximum    |Maximum incoming|130     |yes     |
   |           |                         |voltage seen    |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |MINUTIL    |input.voltage.minimum    |Minimum incoming|100     |yes     |
   |           |                         |voltage seen    |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |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     |        |        |
   |-----------+-------------------------+----------------+--------+--------|
   |           |                         |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                      |
   |------------------------------------------------------------------------|
   |BATTPCT     |battery.charge         |Battery charge   |100.0        |yes|
   |            |                       |(percent)        |             |   |
   |------------+-----------------------+-----------------+-------------+---|
   |            |                       |Remaining battery|             |   |
   |LOBATTPCT   |battery.charge.low     |level when UPS   |20           |yes|
   |            |                       |switches to LB   |             |   |
   |            |                       |(percent)        |             |   |
   |------------+-----------------------+-----------------+-------------+---|
   |            |                       |Minimum battery  |             |   |
   |WAKETHRSH   |battery.charge.restart |level for UPS    |20           |yes|
   |RTHRESH     |                       |restart after    |             |   |
   |            |                       |power-off        |             |   |
   |------------+-----------------------+-----------------+-------------+---|
   |BATTVOLT    |battery.voltage        |Battery charge   |24.84        |yes|
   |            |                       |(volts)          |             |   |
   |------------+-----------------------+-----------------+-------------+---|
   |BATT_CURRENT|battery.current        |Battery current  |1.19         |yes|
   |            |                       |(amps)           |             |   |
   |------------+-----------------------+-----------------+-------------+---|
   |            |                       |Battery          |             |   |
   |BATT_TEMP   |battery.temperature    |temperature      |050.7        |yes|
   |            |                       |(degrees C)      |             |   |
   |------------+-----------------------+-----------------+-------------+---|
   |NOMBATVLT   |battery.voltage.nominal|Nominal battery  |024          |yes|
   |            |                       |voltage          |             |   |
   |------------+-----------------------+-----------------+-------------+---|
   |BATT_RUNTIME|battery.runtime        |Battery runtime  |1080         |yes|
   |RUNTIME     |                       |(seconds)        |             |   |
   |------------+-----------------------+-----------------+-------------+---|
   |            |                       |Remaining battery|             |   |
   |LOBATTIME   |battery.runtime.low    |runtime when UPS |180          |yes|
   |            |                       |switches to LB   |             |   |
   |            |                       |(seconds)        |             |   |
   |------------+-----------------------+-----------------+-------------+---|
   |ALRMDELAY   |battery.alarm.threshold|Battery alarm    |0 (immediate)|yes|
   |ALRMDEL     |                       |threshold        |             |   |
   |------------+-----------------------+-----------------+-------------+---|
   |            |                       |Battery change   |             |   |
   |BATTDATE    |battery.date           |date (opaque     |11/14/00     |yes|
   |            |                       |string)          |             |   |
   |------------+-----------------------+-----------------+-------------+---|
   |BATTPACKS   |battery.packs          |Number of battery|001          |yes|
   |            |                       |packs            |             |   |
   |------------+-----------------------+-----------------+-------------+---|
   |BADPACKS    |battery.packs.bad      |Number of 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    |       |        |
   +------------------------------------------------------------------------+

   +------------------------------------------------------------------------+
   |      outlet - Smart outlet management (smart on/off switch, ...)       |
   |------------------------------------------------------------------------|
   |Old |           New name           |    Description    |Typical|   In   |
   |name|                              |                   | value |var_map?|
   |----+------------------------------+-------------------+-------+--------|
   |    |                              |Outlet system      |       |        |
   |n/a |outlet.n.id                   |identifier (opaque |1      |no      |
   |    |                              |string)            |       |        |
   |----+------------------------------+-------------------+-------+--------|
   |n/a |outlet.n.desc                 |Outlet description |Main   |no      |
   |    |                              |(opaque string)    |outlet |        |
   |----+------------------------------+-------------------+-------+--------|
   |n/a |outlet.n.switch               |Outlet switch      |on     |no      |
   |    |                              |control (on/off)   |       |        |
   |----+------------------------------+-------------------+-------+--------|
   |n/a |outlet.n.status               |Outlet switch      |on     |no      |
   |    |                              |status (on/off)    |       |        |
   |----+------------------------------+-------------------+-------+--------|
   |n/a |outlet.n.switchable           |Outlet switch      |yes    |no      |
   |    |                              |ability (yes/no)   |       |        |
   |----+------------------------------+-------------------+-------+--------|
   |    |                              |Remaining battery  |       |        |
   |n/a |outlet.n.autoswitch.charge.low|level to power off |90     |no      |
   |    |                              |this outlet        |       |        |
   |    |                              |(percent)          |       |        |
   |----+------------------------------+-------------------+-------+--------|
   |    |                              |Interval to wait   |       |        |
   |n/a |outlet.n.delay.shutdown       |before shutting    |180    |no      |
   |    |                              |down this outlet   |       |        |
   |    |                              |(seconds)          |       |        |
   |----+------------------------------+-------------------+-------+--------|
   |    |                              |Interval to wait   |       |        |
   |n/a |outlet.n.delay.start          |before restarting  |120    |no      |
   |    |                              |this outlet        |       |        |
   |    |                              |(seconds)          |       |        |
   +------------------------------------------------------------------------+

   +------------------------------------------------------------------------+
   |                  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)     |          |          |
   |------+-------------------------+-----------------+----------+----------|
   |      |                         | Parameter xxx   |          |          |
   | n/a  | driver.parameter.xxx    | (ups.conf or    | (varies) | n/a      |
   |      |                         | cmdline -x)     |          |          |
   |      |                         | setting         |          |          |
   |------+-------------------------+-----------------+----------+----------|
   |      |                         | Flag xxx        | enabled  |          |
   | n/a  | driver.flag.xxx         | (ups.conf or    | (or not  | n/a      |
   |      |                         | cmdline -x)     | present) |          |
   |      |                         | status          |          |          |
   +------------------------------------------------------------------------+

   +------------------------------------------------------------------------+
   |                  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     | yes      |
   |           |                          | delay and return     |          |
   |           |                          | when power is back   |          |
   |-----------+--------------------------+----------------------+----------|
   |           |                          | Turn off the load    |          |
   |           |                          | possibly after a     |          |
   | SHUTDOWN  | shutdown.stayoff         | delay and remain off | yes      |
   |           |                          | even if power        |          |
   |           |                          | returns              |          |
   |-----------+--------------------------+----------------------+----------|
   | STOPSHUTD | shutdown.stop            | Stop a shutdown in   | yes      |
   |           |                          | progress             |          |
   |-----------+--------------------------+----------------------+----------|
   |           |                          | Shut down the load   |          |
   | n/a       | shutdown.reboot          | briefly while        | yes      |
   |           |                          | rebooting the UPS    |          |
   |-----------+--------------------------+----------------------+----------|
   |           |                          | After a delay, shut  |          |
   | n/a       | shutdown.reboot.graceful | down the load        | yes      |
   |           |                          | briefly while        |          |
   |           |                          | rebooting the UPS    |          |
   |-----------+--------------------------+----------------------+----------|
   | FPTEST    | test.panel.start         | Start testing the    | yes      |
   |           |                          | UPS panel            |          |
   |-----------+--------------------------+----------------------+----------|
   | n/a       | test.panel.stop          | Stop a UPS panel     | n/a      |
   |           |                          | test                 |          |
   |-----------+--------------------------+----------------------+----------|
   | SIMPWF    | test.failure.start       | Start a simulated    | yes      |
   |           |                          | power failure        |          |
   |-----------+--------------------------+----------------------+----------|
   | n/a       | test.failure.stop        | Stop simulating a    | n/a      |
   |           |                          | power failure        |          |
   |-----------+--------------------------+----------------------+----------|
   | BTEST1    | test.battery.start       | Start a battery test | yes      |
   |-----------+--------------------------+----------------------+----------|
   | BTEST0    | test.battery.stop        | Stop the battery     | yes      |
   |           |                          | test                 |          |
   |-----------+--------------------------+----------------------+----------|
   | CAL1      | calibrate.start          | Start runtime        | yes      |
   |           |                          | calibration          |          |
   |-----------+--------------------------+----------------------+----------|
   | CAL0      | calibrate.stop           | Stop runtime         | yes      |
   |           |                          | calibration          |          |
   |-----------+--------------------------+----------------------+----------|
   | BYPASS    | bypass.start             | Put the UPS in       | yes      |
   |           |                          | bypass mode          |          |
   |-----------+--------------------------+----------------------+----------|
   | n/a       | bypass.stop              | Take the UPS out of  | n/a      |
   |           |                          | bypass mode          |          |
   |-----------+--------------------------+----------------------+----------|
   |           |                          | Reset minimum and    |          |
   | n/a       | reset.input.minmax       | maximum input        | n/a      |
   |           |                          | voltage status       |          |
   |-----------+--------------------------+----------------------+----------|
   |           |                          | Reset watchdog timer |          |
   | WATCHDOG  | reset.watchdog           | (forced reboot of    | yes      |
   |           |                          | load)                |          |
   |-----------+--------------------------+----------------------+----------|
   | n/a       | beeper.on                | Enable UPS           | n/a      |
   |           |                          | beeper/buzzer        |          |
   |-----------+--------------------------+----------------------+----------|
   | n/a       | beeper.off               | Disable UPS          | n/a      |
   |           |                          | beeper/buzzer        |          |
   +------------------------------------------------------------------------+
