# Network UPS Tools: variable and command descriptions
# 
# This file is optional.  You may delete it to save resources, but
# clients will receive "Unavailable" for any description requests.

VARDESC ups.alarm "UPS alarms"
VARDESC ups.status "UPS status"
VARDESC ups.model "UPS model"
VARDESC ups.mfr "UPS manufacturer"
VARDESC ups.mfr.date "UPS manufacturing date"
VARDESC ups.serial "UPS serial number"
VARDESC ups.firmware "UPS firmware"
VARDESC ups.firmware.aux "Auxiliary device firmware"
VARDESC ups.temperature "UPS temperature"
VARDESC ups.load "Load on UPS (% of full)"
VARDESC ups.id "UPS system identifier"
VARDESC ups.delay.start "Interval to wait before (re)starting the load (seconds)"
VARDESC ups.delay.reboot "Interval to wait before rebooting the UPS (seconds)"
VARDESC ups.delay.shutdown "Interval to wait after shutdown with delay command (seconds)"
VARDESC ups.test.interval "Interval between self tests (seconds)"
VARDESC ups.test.result "Results of last self test"
VARDESC ups.display.language "Language to use on front panel"
VARDESC ups.contacts "UPS external contact sensors"

VARDESC input.voltage "Input voltage"
VARDESC input.voltage.maximum "Maximum incoming voltage seen"
VARDESC input.voltage.minimum "Minimum incoming voltage seen"
VARDESC input.voltage.nominal "Nominal input voltage"
VARDESC input.transfer.reason "Reason for last transfer to battery"
VARDESC input.transfer.low "Low voltage transfer point"
VARDESC input.transfer.high "High voltage transfer point"
VARDESC input.sensitivity "Input power sensitivity"
VARDESC input.quality "Input power quality"
VARDESC input.frequency "Input line frequency (Hz)"
VARDESC input.transfer.boost.low "Low voltage boosting transfer point"
VARDESC input.transfer.boost.high "High voltage boosting transfer point"
VARDESC input.transfer.trim.low "Low voltage trimming transfer point"
VARDESC input.transfer.trim.high "High voltage trimming transfer point"

VARDESC output.voltage "Output voltage"
VARDESC output.frequency "Output frequency (Hz)"
VARDESC output.voltage.target.line "Target output voltage when on line"
VARDESC output.voltage.target.battery "Target output voltage when on battery"
VARDESC output.current "Output current"

VARDESC battery.charge "Battery charge (% of full)"
VARDESC battery.charge.low "Remaining battery level when UPS switches to LB"
VARDESC battery.charge.restart "Minimum battery level for restart after power off"
VARDESC battery.voltage "Battery voltage"
VARDESC battery.current "Battery current"
VARDESC battery.temperature "Battery temperature"
VARDESC battery.voltage.nominal "Nominal battery voltage"
VARDESC battery.runtime "Battery runtime (seconds)"
VARDESC battery.runtime.low "Remaining battery runtime when UPS switches to LB"
VARDESC battery.alarm.threshold "Battery alarm threshold"
VARDESC battery.date "Battery change date"
VARDESC battery.packs "Number of battery packs"
VARDESC battery.packs.bad "Number of bad battery packs"
	
VARDESC ambient.temperature "Ambient temperature"
VARDESC ambient.temperature.alarm "Ambient temperature alarm is active"
VARDESC ambient.temperature.alarm.maximum "Maximum allowed ambient temperature"
VARDESC ambient.temperature.alarm.minimum "Minimum allowed ambient temperature"
VARDESC ambient.temperature.alarm.enable "Enable ambient temperature alarm"
VARDESC ambient.humidity "Ambient humidity"
VARDESC ambient.humidity.alarm "Ambient humidity alarm is active"
VARDESC ambient.humidity.alarm.maximum "Maximum allowed ambient humidity"
VARDESC ambient.humidity.alarm.minimum "Minimum allowed ambient humidity"
VARDESC ambient.humidity.alarm.enable "Enable ambient humidity alarm"

# FIXME: the outlet collection is indexed - solve with regexs?
#
# VARDESC outlet.[[:digit:]]+.id "Outlet system identifier (<index>)"

VARDESC driver.name "Driver name"
VARDESC driver.version "Driver version - NUT release"
VARDESC driver.version.internal "Internal driver version"

# FIXME: driver.parameter and driver.flag can have many possible members
#
# VARDESC driver.parameter.[[:alpha:]]+ "Driver parameter: <name>"
# VARDESC driver.flag.[[:alpha:]]+ "Driver flag: <name>"

VARDESC server.info "Server information"
VARDESC server.version "Server version"

CMDDESC load.off "Turn off the load immediately"
CMDDESC load.on "Turn on the load immediately"
CMDDESC shutdown.return "Turn off the load and return when power is back"
CMDDESC shutdown.stayoff "Turn off the load and remain off"
CMDDESC shutdown.stop "Stop a shutdown in progress"
CMDDESC shutdown.reboot "Shut down the load briefly while rebooting the UPS"
CMDDESC shutdown.reboot.graceful "Delay briefly then shut down the load while rebooting the UPS"
CMDDESC test.panel.start "Start testing the UPS panel"
CMDDESC test.panel.stop "Stop a UPS panel test"
CMDDESC test.failure.start "Start a simulated power failure"
CMDDESC test.failure.stop "Stop simulating a power failure"
CMDDESC test.battery.start "Start a battery test"
CMDDESC test.battery.stop "Stop the battery test"
CMDDESC calibrate.start "Start run time calibration"
CMDDESC calibrate.stop "Stop run time calibration"
CMDDESC bypass.start "Put the UPS in bypass mode"
CMDDESC bypass.stop "Take the UPS out of bypass mode"
CMDDESC reset.input.minmax "Reset minimum and maximum input voltage status"
CMDDESC reset.watchdog "Reset watchdog timer"
CMDDESC beeper.on "Enable the UPS beeper"
CMDDESC beeper.off "Disable the UPS beeper"