Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The serial APC UPS (BackUPS Pro or SmartUPS) requires a special serial cable (unless connected with USB). If no cable came with the UPS, a cable may be ordered from APC or one can be made "in-house". Use the following diagram:

Router Side (DB9f)SignalDirectionUPS Side (DB9m)
2ReceiveIN2
3SendOUT1
5Ground
4
7CTSIN6

If using a RouterBOARD device, make sure to set your "RouterBOOT setup key" to Delete instead of the default Any key. This is to avoid accidental opening of the setup menu if the UPS unit sends some data to the serial port during RouterBOARD startup. This can be done in the RouterBOOT options during boot time or via the RouterBoard Settings in Winbox :

Select key which will enter setup on boot:
 * 1 - any key
   2 - <Delete> key only
your choice:


General Properties

PropertyDescription
alarm-setting (delayed | immediate | low-battery | none; Default: immediate)UPS sound alarm setting:
  • delayed - alarm is delayed to the on-battery event
  • immediate - alarm immediately after the on-battery event
  • low-battery - alarm only when the battery is low
  • none - do not alarm
check-capabilities (yes | no; Default: yes)Whether to check UPS capabilities before reading information. Disabling it can fix compatibility issues with some UPS models. (Applies to RouterOS version 6, implemented since v6.17)
min-runtime (time; Default: never)Minimal run time remaining. After a 'utility' failure, the router will monitor the runtime-left value. When the value reaches the min-runtime value, the router will go to hibernate mode.
  • never - the router will go to hibernate mode when the "battery low" signal is sent indicating that the battery power is below 10%
  • 0s - the router will continue to work as long as the battery is supplying sufficient voltage
offline-time (time; Default: 0s)How long to work on batteries. The router waits that amount of time and then goes into hibernate mode until the UPS reports that the 'utility' power is back
  • 0s - the router will go into hibernate mode according to the min-runtime setting. In this case, the router will wait until the UPS reports that the battery power is below 10%
port (string; Default: )Communication port of the router.


Read-only properties:

PropertyDescription
load (percent)The UPS's output load as a percentage of full rated load in Watts. The typical accuracy of this measurement is ±3% of the maximum of 105%
manufacture-date (string)UPS's date of manufacture in the format "mm/dd/yy" (month, day, year).
model (string)Less than 32 ASCII character string consisting of the UPS model name (the words on the front of the UPS itself)
nominal-battery-voltage (integer)UPS's nominal battery voltage rating (this is not the UPS's actual battery voltage)
offline-after (time)When will the router go offline
serial (string)A string of at least 8 characters directly representing the UPS's serial number as set at the factory. Newer SmartUPS models have 12-character serial numbers
version (string)UPS version, consists of three fields: SKU number, firmware revision, country code. The country code may be one of the following:
  • I - 220/230/240 Vac
  • D - 115/120 Vac
  • A - 100 Vac
  • M - 208 Vac
  • J - 200 Vac


Info
Note: In order to enable UPS monitor, the serial port should be available.

...

Command: /system ups monitor <id>


PropertyDescription
battery-charge ()the UPS's remaining battery capacity as a percent of the fully charged condition
battery-voltage ()the UPS's present battery voltage. The typical accuracy of this measurement is ±5% of the maximum value (depending on the UPS's nominal battery voltage)
frequency ()when operating on-line, the UPS's internal operating frequency is synchronized to the line within variations of 3 Hz of the nominal 50 or 60 Hz. The typical accuracy of this measurement is ±1% of the full scale value of 63 Hz
line-voltage ()the in-line utility power voltage
load ()the UPS's output load as a percentage of full rated load in Watts. The typical accuracy of this measurement is ±3% of the maximum of 105%
low-battery (yes | no)only shown when the UPS reports this status
on-battery (yes | no)Whether UPS battery is supplying power
on-line (yes | no)whether power is being provided by the external utility (power company)
output-voltage ()the UPS's output voltage
overloaded-output (yes | no)only shown when the UPS reports this status
replace-battery (yes | no)only shown when the UPS reports this status
runtime-calibration-running (yes | no)only shown when the UPS reports this status
runtime-left (time)the UPS's estimated remaining run time in minutes. You can query the UPS when it is operating in the on-line, bypass, or on-battery modes of operation. The UPS's remaining run time reply is based on available battery capacity and output load
smart-boost-mode (yes | no)only shown when the UPS reports this status
smart-ssdd-mode ()only shown when the UPS reports this status
transfer-cause (string)the reason for the most recent transfer to on-battery operation (only shown when the unit is on-battery)

Example

When running on utility power:

...