OS/2 Shareware BBS: 11 Util/11-Util.zip/upsmon12.zip/upsminst.exe/upsmons.hlp

OS/2 Help File | 2002-01-24 | 61KB | 1,045 lines

ΓòÉΓòÉΓòÉ 1. Description ΓòÉΓòÉΓòÉ

UPS Monitor is a series of utility programs to monitor the status of
Uninterruptible Power Sources (UPS) for the OS/2 and eComStation platforms. UPS
Monitor provides shutdown services to the operating system. Included are two
programs optimized for most APC-brand UPS models and one program for most
contact closure UPS models. UPS Monitor programs are designed for single
workstation environment.

UPS Monitor is shareware and registration is available through BMT Micro at
www.bmtmicro.com or through Lone Peak Automation directly. See the section How
To Register UPS Monitor for details.

Which UPS Monitor do I use?

There are three versions of the UPS Monitor program available:

UPSMONS.EXE supports the smart signaling interface of the Smart-UPS, Smart-UPS
v/s and the Back-UPS Pro. Matrix-UPS may also be supported, but is untested.
UPS's with smart signaling interfaces allow data transfer of line voltage,
battery voltage, battery capacity etc. This program provides support for the
features common to all these models. Exceptions are restart capabilities and
UPS Turn Off Delay which are only available on the Back-UPS Pro and Smart-UPS
models. This program requires the cable number 940-0024B or 940-0024C to be
connect to the UPS. UPSMONS.EXE will not work with the Back-UPS models.

UPSMONB.EXE, also referred to as UPS Monitor B, is designed for the Back-UPS
and Back-UPS Office models only (non-Pro version) and uses simple signaling.
Simple signaling interfaces only indicate if line power is on or off. This
program requires the cable number 940-0020B to be connect to all the UPS model.
UPSMONB.EXE will not work with other models.

UPSMONC.EXE, also referred to as UPS Monitor C, is designed for contact closure
models from manufacturers like Tripplite, IBM, Best Power, etc. Contact closure
models generally only indicate line power on or off and battery on or off. This
program uses the cable provided by the UPS manufacturer. UPSMONC.EXE will not
work with any APC models.

See the Lone Peak Automation website at
http://home.att.net/~ASchw/upsmonitor.html for all the UPS Monitor versions.


ΓòÉΓòÉΓòÉ 2. General Program Operation ΓòÉΓòÉΓòÉ

Program Configuration.

Once the program is installed, you must first select the com port the UPS is
connected to. Select Options - Settings and select the com port and UPS model
from the controls. Save the settings and select Options - Connect. Once
connected properly, UPS Monitor will indicate that it is online. If it did not
recognize the UPS, see the section on Troubleshooting for information.

If you want UPS Monitor to start automatically when your system powers up, then
place a shadow of the executable into the Startup folder (it's located under
the System folder).

You must also provide the command line parameters to UPSMONS.EXE for automatic
operation. The commands are -Con to automatically connect to the UPS and -Min
to minimize on start-up. You must provide these commands on the Parameters line
in the Properties page of Warp 4.0 or Settings page of Warp 3.0. To get to that
page, right-click on the UPSMONS executable object and click Properties or
Settings.

Program Operation.

Please note: This program provides support for the features common to all these
models: Smart-UPS, Smart-UPS v/s and Back-UPS Pro. If you have the Smart-UPS or
Back-UPS Pro, all UPS operating parameters can be set by UPS Monitor starting
with version 1.1.

To minimize the CPU load, UPS Monitor will check the UPS every 4 seconds for
status. All time settings therefore have a resolution of 4 seconds as well. For
example, a UPS on Battery alarm in the worst case, may not be detected until 4
seconds after the actual power failure. If Measure is enabled, the UPS
parameters are also measured every 4 seconds.

The UPS Monitor background color changes according to events and settings. If
UPS Monitor is not connected to the UPS, the background color is light yellow.

During normal operation when the UPS is on-line and no scheduled shutdowns have
been enabled, the background is light green.

If one or more of the scheduled shutdowns have been enabled, then the
background is light blue.

If a power failure is detected and the UPS is on battery, the background
changes to light red.

If UPS Monitor detects a power failure and after the Message Delay expired, or
a schedule shutdown has been started, the program will give itself focus and it
will be restored to screen if it had been minimized. This will alert you of a
possible shutdown. Popup to screen can be disabled in the Settings window if so
desired.

Scheduled shutdowns can be aborted if enough time has been set to announce the
shutdown. Select Options - Abort Sched. Shutdown or press the ESC key when UPS
Monitor has focus.

The UPS Monitor icon and title change according to UPS events detected.

 This is normal operation with line power on and UPS Monitor connected.

 This is line power out and UPS running on a fully charged battery. The icon
title displays the count down time to shutdown.

 This is line power out, battery is low and shutdown is imminent. The icon
title displays the count down time to shutdown.

This is faulty battery indication detected by the UPS Self-Test.

This icon displays if the connection to the UPS could not be made.

The UPS Monitor window can be sized and positioned anywhere on the desktop.
Size and position are saved.

To bring up Help, simply press F1. Help is context sensitive, so if you have
the Settings window open, help for the settings will pop up.

When UPS Monitor shuts down your system, it will not save any data of the
applications that are running or save any current changes to the desktop. It is
the applications responsibility to save any data. Set your application to auto
or timed save if this option is available.

Technical Details

In a power fail situation, UPS Monitor will send out a command to the UPS to
turn itself off if a low battery command has been received or the fixed
shutdown time has expired. The turn-off time is adjustable for the Smart-UPS
and Back-UPS Pro model. The Smart-UPS v/s has a fixed delay of 20 seconds. If
you have a Smart-UPS v/s model, make sure shutdown is possible in less than 20
seconds. UPS Monitor uses the DOSShutdown API call to perform the internal
shutdown. This call will only secure the file system and is therefore quicker
than the regular shutdown. Note that this API call was selected to guarantee
that the system will secure the file system and shutdown in unattended mode,
even if some irate process would prevent a regular shutdown. This call will
secure the file system and the system will reboot cleanly the next time.

If you use the external shutdown script, UPS Monitor will arm the UPS to turn
itself off within the specified turn off time, call UPSMONS.CMD and then close
itself. UPSMONS.CMD must then shutdown the system. You must make sure that
UPSMONS.CMD is set to shutdown the operating system within the UPS turn off
time. See inside the file UPSMONS.CMD for sample code to perform a shutdown. An
additional shutdown script (XSDWN.CMD) is included as an example how a system
can be shutdown using Extended Shutdown and APM PowerOff included in
XWorkplace.

CAUTION

During shutdown and while the system is waiting for the UPS to turn off, the
screen will display a full size message in black and white. First it displays:
UPS Monitor is shutting system down. Please wait...

Then it will display: Shutdown has completed. The UPS has been armed and will
turn off your computer after the set turn-off delay. Do NOT use Ctrl-Alt-Del to
restart. To restart the system in this state, turn the UPS off manually and
then restart.

The UPS has been armed at this point and will turn itself off after the turn
off time reaches the set value.

DO NOT restart the computer with Ctrl-Alt-Del at this point, even if power is
restored. If you want to restart, you must first reset the UPS by turning it
off and on again.

If you do not follow these instructions, the UPS timer will continue to count
down and will turn itself off as the operating system is starting up again.

It is possible on some systems that the second message will not get displayed.
Nonetheless, the file system is secured and you may restart the system as soon
as there is no disk activity.

If desktop lockup or screen saver was activated when the system shut down, you
will not see the above mentioned message. If the system has shutdown and the
UPS is armed and waiting for turn off, your computer will appear locked up. The
UPS is armed and set to turn off. If you want to use the system immediately,
turn off the UPS first to reset the armed count-down and then restart your
system.


ΓòÉΓòÉΓòÉ 3. Command Line Options ΓòÉΓòÉΓòÉ

If you want UPS Monitor to start automatically when your system powers up, then
place a shadow of the executable into the Startup folder (it's located under
the System folder).

You must also provide the command line parameters to UPSMONS.EXE for automatic
operation. The commands are -Con to automatically connect to the UPS and -Min
to minimize on start-up. You must provide these commands on the Parameters line
in the Properties page of Warp 4.0 or Settings page of Warp 3.0. To get to that
page, right-click on the UPSMONS executable object and click Properties or
Settings.

An additional command line parameter exists to allow to redirect the
UPSMONS.INI file to another drive, directory or ini file name. Simply add -i
d:\directory\inifile.ini on the command line and UPS Monitor will use this
information to store the settings. This is useful if UPS Monitor is run on a
network from a write-protected drive.

By default, the shutdown parameters for low and high transfer voltages are
selected for the 120 VAC input voltage models. An attempt is made to
automatically select these parameters for the 240VAC input models. Should it
fail and select the wrong parameters, then simply add -240 as a command line
parameter to force selection of high and low transfer voltages for the 240VAC
input voltage models.


ΓòÉΓòÉΓòÉ 4. UPS Status Report to External Programs ΓòÉΓòÉΓòÉ

UPS Monitor uses a small amount of named shared memory to make the status of
the UPS available to external programs. This is useful for programs like
XCenter (part of XWorkplace available at www.xworkplace.org) if one likes to
display UPS status in a small area of the desktop.

The shared memory area is available by the name \SHAREMEM\UPSMON\UPSSTATUS.MEM
on the computer where UPS Monitor is running on and can be made available over
a network with additional programming.

A sample REXX script (file UPSSTAT.CMD) is included with UPS Monitor to show
how to access and display UPS status in a command window.

A sample script (file XCENTER.SCR) for XCenter is also included and can be
added to an XCenter REXX Gauge Widget. The sample script places the UPS status
on the main text of the widget. If the mouse pointer is placed over the widget,
the UPS voltage and capacity values are displayed. Double-click action is set
to show the actual UPS Monitor application. Follow the instructions in XCenter
and the REXX Gauge Widget library on how to add scripts.

A total of 75 characters provide the status of the UPS. The first 25 characters
are english-like descriptions of the current status. Any unused positions are
always filled with spaces to make 25 characters. The possible status
descriptions are:

UPSMon - Disconnected
UPSMon - Bad Batt.
UPSMon - Error
UPSMon - Normal
UPSMon - Power Fail
UPSMon - Shutting Down
UPSMon - Off on Low Batt.
UPSMon - Off in xxx sec.

Character position 26 through 75 display line voltage, UPS load percentage,
battery voltage and remaining battery capacity provided that the Measure
feature is enabled. The last two characters displays the UPS Status in form of
a hex value of 0-FF. The format of this value is as follows:

Bit  Meaning
0    not used
1    1 = SmartTrim active
2    1 = SmartBoost active
3    1 = Line Power Online

4    1 = On Battery (Line Power Off)
5    1 = UPS Output Overloaded
6    1 = Battery Low
7    1 = Replace Battery

Some possible values are:

08 = Line Power Online, Battery OK
10 = On Battery, Battery OK
50 = On Battery, Battery Low

Sample memory contents of UPS status:

UPSMon - Normal      Line: 118.0V Load: 46.8% Batt: 13.77V 75.0%   08

To access shared memory with REXX, the RXU.DLL library is necessary. This
library can be downloaded from
http://hobbes.nmsu.edu/pub/os2/dev/rexx/rxu1a.zip. To install RXU, simply put
the file RXU.DLL into a directory that is listed in the LIBPATH statement in
CONFIG.SYS. An appropriate directory could be D:\OS2\APP\DLL

After accessing the shared memory, it is essential that the memory be freed to
make it accessible to other programs or to release it to the system should UPS
Monitor be closed.

Sample REXX script to display UPS Monitor status in a command line window:

/* Load RXU.DLL */
call rxfuncadd 'rxuinit','rxu','rxuinit'
call rxuinit

UPSText = 'UPSMon n/a'
UPSParam = ''

/* To get named shared memory, read-only */
getrc = RxGetNamedSharedMem('pointer', '\SHAREMEM\UPSMON\UPSSTATUS.MEM', 'r')

IF getrc = 0 THEN
 DO
  /* get all 75 characters from memory */
  UPSText = RxStorage( pointer, 75)
  /* get status only and strip off extra spaces */
  UPSText =  STRIP(LEFT(UPSText, 25))
  /* get parameters only */
  UPSParam = RIGHT(UPSText, LENGTH(UPSText) - 25)
 END

SAY UPSText
SAY UPSParam

/* free named shared memory */
freerc = RxFreeMem(pointer)

EXIT


ΓòÉΓòÉΓòÉ 5. Menu Description ΓòÉΓòÉΓòÉ

Describes all menu items available for this program.

Note: The Diagnostics menu is only enabled when the UPS Monitor is connected to
the UPS.


ΓòÉΓòÉΓòÉ 5.1. FILE - Open Log ΓòÉΓòÉΓòÉ

You can also use the F2 key to open this window.

Opens the UPS Monitor event or parameter log files for viewing. These log files
are regular text files and can also be opened with any text editor or word
processor.

After a log file has been selected, it will show the log in a separate window.
From this window, you can print or open another log file. You can reposition or
resize the View Log window. Size and position will be remembered the next time
you open this window.

Printing is done with the font 6.Helvetica.

Note: The main UPS Monitor window displays the last 10 to 20 events only. If
more than 20 events are displayed, the oldest 10 events are cut. You can use
Open Log to view all previous log events.


ΓòÉΓòÉΓòÉ 5.2. FILE - Exit ΓòÉΓòÉΓòÉ

Exit the program. If the program is still connected to the UPS, the connection
is terminated. This event is logged.


ΓòÉΓòÉΓòÉ 5.3. OPTIONS - Save Window Size and Position ΓòÉΓòÉΓòÉ

You can also use the F4 key to activate save.

This selection saves the program window size and position. Size and position of
the program are automatically saved when the program is terminated from the
menu commands but not when terminated through the window list.


ΓòÉΓòÉΓòÉ 5.4. OPTIONS - Settings ΓòÉΓòÉΓòÉ

You can also use the F5 key to open this window.

Opens the UPS Monitor settings window. Set the Com Port (COM1 - COM9, OTHER)
where the UPS is connected to, Enable Logging to a file, set the maximum Log
File Size and set the location and name of the log file. If the com port is
selected as OTHER, then a text box will appear where you can enter the name of
any non-standard labeled serial port.

The log file will be kept approximately within the file size specified. If the
log file exceeds the selected size, then it is renamed for backup to the same
name with the extension .000 and a new log is started. If the backup file with
the extension .000 already existed, then it is replaced. This way it keeps at
least one log full of data.

Select your UPS model from the selection box. This will tell UPS Monitor what
features to support. If you select the wrong model and one of the unsupported
features is accessed, then unpredictable results may occur.

Note that com port and UPS model selection is only possible when the UPS
Monitor is offline.

The Bypass Self Test check box allows to enable or disable automatic self test
when UPS Monitor connects to the UPS.

The Beep check box enables or disables the audible alarm during program
operation. The audible alarm will activate whenever a power failure is detected
and at every subsequent shutdown message interval. The alarm is a short, low to
high tone beep. An audible alarm is also activated whenever a scheduled
shutdown is announced. The alarm is a short, high to low tone beep for that
situation.

The Measure check box enables the measurement of line voltage, load capacity
(in percent), battery voltage and battery capacity (in percent). These values
are displayed on the bottom portion of the main window and updated every 4
seconds. If power fails and the UPS Monitor shuts down, then the last measured
parameters are logged to the event log file. Measure is not available for the
Smart-UPS v/s models.

If Measure is enabled, parameter logging can be done to a separate log file. In
the Parameter Logging group box you can enable parameter logging, select the
log file name and set the maximum parameter log size. The frequency of
parameter logging can also be set from 0 to 96 hours. If set to zero, parameter
logging will occur approximately every 4 seconds. You may enter fractions of
hours in the Freq. input box, i.e. 0.1 would correspond to logging every 6
minutes. Default frequency is 1 hour, default log size is 10 kbytes and the
default file name is UPSPARM.LOG. Parameter logging is only possible with the
Smart-UPS and Back-UPS Pro models.

The 24Hrs check box selects AM/PM or 24 Hour format for the Scheduled Shutdown
settings.

The Don't Show check box disables the program popup to screen if a power
failure is detected and UPS Monitor was minimized or located behind another
window. You may want to disable UPS Monitor from being restored to screen if
you prefer to be notified with the status indication given by icon and title
changes.


ΓòÉΓòÉΓòÉ 5.5. OPTIONS - Shutdown Parameters ΓòÉΓòÉΓòÉ

You can also use the F6 key to open this window.

The Shutdown Now Menu option controls the behavior of the Shutdown Now menu. By
default, the two options are turned off and when operating Shutdown Now, the
regular system shutdown is activated after a prompt confirmed shutdown. The
prompt can be bypassed by checking No prompt for Shutdown Now. The regular
system shutdown can be replaced by using the APM (Advanced Power Management)
shutdown by checking the Use APM for Shutdown Now option. This will shutdown
the system and turn the computer power off. APM version and if APM shutdown is
supported for your system is indicated on this window. If there is no support
for APM detected, then the Use APM for Shutdown Now option is not available.

Note: For APM to work properly, all of the following items must be present:


 1. Power management option must be installed. Look for these two statements in your config.sys

    DEVICE=D:\OS2\BOOT\APM.SYS
    DEVICE=D:\OS2\MDOS\VAPM.SYS

 2. The system board and BIOS must be APM compliant.

 3. The power supply must be an ATX model.

Even with all these items present, APM shutdown may not work properly. Test APM
shutdown on your system and if chkdsk does not activate during the reboot, it
works properly.

Set the UPS on Battery message delay (0-99 secs.) and message interval (0-999
secs.). These are the delay and interval at which the UPS Monitor is brought to
the foreground to indicate that the UPS is running on battery. Select a range
that matches your UPS capacity in order to get notified on time when the UPS
shuts down. Default values are 10 second delay and 30 second intervals.

Set Wait for Low Battery Signal or Fixed Duration shutdown after a UPS on
Battery signal. If Fixed Duration is selected, then the UPS Monitor will
shutdown the system when a low battery signal is received or after the set time
has expired (whichever comes first). If Wait for Low Battery is selected, then
the UPS Monitor will shutdown the system when the UPS signals low battery.

Note: If the communication to the UPS is lost during a power failure, UPS
Monitor will switch over to a fixed duration shutdown of 60 seconds. If the
power and communications do not restore, the system will shutdown within these
60 seconds.

The Resume after Power Failure check box, when checked, gives you the option to
have the UPS restart after power is restored. If this box is unchecked, then
the UPS is turned off and must be manually restarted.

The Ext. Shutdown Script checkbox allows to execute an external script (the
file UPSMONS.CMD) for shutting the system down. You can customize this file to
your own liking. Remember to keep the process short and well within the
shutdown delay range of the UPS. When UPSMONS.CMD is executed, the UPS is armed
and has begun countdown of the UPS turn off. You must use UPSMONS.CMD to
shutdown your operating system. As shipped, UPSMONS.CMD does not contain any
code to do that. See inside that file for sample code.

An additional shutdown script (XSDWN.CMD) is included as an example how a
system can be shutdown using APM PowerOff included in XWorkPlace.

Please read General Program Operation for more information on how UPS Monitor
shuts down the UPS.

The XWorkplace Shutdown check box executes an external script (the file
XSDWN.CMD) to activate shutdown using XWorkplace. You must make sure XWorkplace
is installed and the extended shutdown options properly selected to allow a
shutdown. Testing is always a good way to convince yourself of proper
operation. XWorkplace can be found at www.xworkplace.org.

Only one of these options can be selected at one time: Ext. Shutdown Script or
XWorkplace Shutdown.


ΓòÉΓòÉΓòÉ 5.6. OPTIONS - UPS Shutdown Parameters ΓòÉΓòÉΓòÉ

These settings are only accessible if the UPS Monitor is online to a Back-UPS
Pro or Smart-UPS model UPS. All parameters on this page are stored to and
retrieved from the UPS. When this window is open, UPS polling for power status
is temporarly suspended. If this window is left open for longer than two
minutes and no activitity is detected, it will close automatically.

The UPS Lo Bat. Signal Time is the amount of battery run time remaining before
there is a low battery condition. A setting of 2 minutes will cause a shutdown
when there is 2 minutes of battery run time left. Possible values are 2, 5, 7
or 10 minutes. Default is 2 minutes.

The UPS Turn Off Delay parameter is the delay between when the UPS receives the
shutdown command and the actual turn-off of the UPS. Possible settings are 20,
180, 300 and 600 seconds. Default is 20 seconds.

You must select a UPS Turn Off Delay value long enough to allow your operating
system to shutdown. Depending on processor speed, amount of memory, or open
programs, the default 20 seconds may not be long enough to allow the operating
system to shutdown. Instead, the UPS will turn itself off while the operating
system shutdown is still in progress. Not a very favorable situation. A setting
of 180 seconds is therefore a better choice.

The UPS Wakeup Time is the UPS turn-on delay after power has failed. When line
power return, the UPS will wait for the set time, then check if battery
capacity is greater than the set UPS Wakeup Capacity. It will then turn on it's
output receptacles. This delay is helpful if several systems need to be started
up in sequence.  Possible values are 0, 60, 180 or 300 seconds. Default is 0.

The UPS Wakeup Capacity is the total battery capacity that needs to be reached
before the UPS will turn on the power outlets after line power is restored.
This ensures that the battery capacity is sufficient to power the equipment
should another power failure occur. Possible values are 0, 10, 25 or 90 percent
for most models. Some models like the Smart-UPS 2200 have values of 0, 15, 50
and 90 percent. Should you get an error indicating parameter can't be set,
simply select another and try saving it again. The two groups of parameters in
question are: 10 and 25 percent or 15 and 50 percent. Default value is 0. This
parameter is not available on the Matrix-UPS models.

The UPS Audible Warning can be set to turn on at Power Fail,  Power Fail + 30
(seconds),  At Low Battery or Never Beep. Default is Power Fail.

Pressing SAVE will save all changed parameters to the UPS and close the window.
CANCEL will abort the settings and close the window.

Note: Only those UPS parameters that are changed will be stored to the UPS
memory. Depending on the number of parameters to save, it may take several
seconds to upload the data.


ΓòÉΓòÉΓòÉ 5.7. OPTIONS - UPS Operating Parameters ΓòÉΓòÉΓòÉ

These settings are only accessible if the UPS Monitor is online to a Back-UPS
Pro or Smart-UPS model UPS. All parameters on this page are stored to and
retrieved from the UPS. When this window is open, UPS polling for power status
is temporarly suspended. If this window is left open for longer than two
minutes and no activitity is detected, it will close automatically.

The Firmware Revision is indicated with a three character code and is a string
stored in the UPS. It can not be changed.

The High Transfer Point is the high line voltage at which the UPS will switch
over to battery operation. Possible values are: 127, 130, 133 or 136 Volts AC
for 110V models. Default is 127 VAC. For 240V models, the parameters are 253,
257, 261 or 265 Volts AC. Parameter detection for 110 or 240V models is
automatic.

The Low Transfer Point is the low line voltage at which the UPS will switch
over to battery operation. Possible values are: 97, 100, 103, 106 Volts AC for
110V models. Default is 106 VAC. For 240V models, the parameters are 196, 200,
204 or 208 Volts AC. Parameter detection for 110 or 240V models is automatic.
The Low Transfer Point cannot be changed on the Matrix-UPS.

The Sensitivity is the amount of incoming line voltage distortion the UPS can
tolerate before it switches to battery operation. Possible values are High,
Medium or Low. Default value is High. If UPS Monitor indicates frequent, very
short power failures, you may want to decrease the sensitivity to prevent
unnecessary switching.

The UPS Identification is an 8 character ID that can be used to give the UPS a
unique name. You can edit the ID and when saved, it will be stored in the UPS.

The Last Battery Replacement is used to store the date when the UPS battery was
last changed. The date format is MM/DD/YY. You can change the date and it will
be stored in the UPS.

UPS Serial No. and UPS Manufacture Date are strings stored in the UPS and can
not be changed.

Pressing SAVE will save all changed parameters to the UPS and close the window.
CANCEL will abort the settings and close the window.

Note: Only those UPS parameters that are changed will be stored to the UPS
memory. Depending on the number of parameters to save, it may take several
seconds to upload the data.


ΓòÉΓòÉΓòÉ 5.8. OPTIONS - Event Scripts ΓòÉΓòÉΓòÉ

You can also use the F7 key to open this window.

Execute your own programs when Line Power On or Line Power Off events are
detected and reported by the UPS.

Each event script can be Enabled by checking the corresponding box.  A script
can be selected by either typing a program name into the text box or by using
the Browse button to point to the program. Any executable program may be
selected. No check for a valid executable file or the existence of the file
(*.CMD, *.EXE, *.COM, *.BAT) is made when the script is executed. You may
precede any start options ahead of the program name by simply typing them in.
For example, a REXX CMD script may be started with the option /C such that the
session closes as the REXX program has finished. You would enter /C MYREXX.CMD
in the text field. To start a REXX program minimized you would enter /MIN /C
MYREXX.CMD. A presentation manager program is started with the /PM option. The
/MIN option will not work with PM applications. Remember to keep each option
separated by spaces. To find more information about these optional start
commands, simply type HELP START at a command prompt.

If a program requires to be started with optional parameters after the program
name, then use a REXX CMD file to start it.

The event script is executed when the following criteria is met:

  - Script is enabled.
  - A UPS event exactly as defined is detected by UPS Monitor.

The Test button can be used to test launch the event script. A prompt will ask
for confirmation and the existence of the script will be checked.

The Cancel button will close the Event Script window and any changes made to
the settings are ignored.

The Save button will close the Event Script window and any changes made to the
settings are saved.

Here are some examples how you can apply the Event Script feature.

Dial a pager when Line Power turns off.

Send an email when Line Power turns on.


ΓòÉΓòÉΓòÉ 5.9. OPTIONS - Scheduled Shutdown ΓòÉΓòÉΓòÉ

This window allows you to schedule system shutdown at a daily, weekly or
one-time basis. You also have the option to restart or not restart the UPS. No
restart can be viewed as the system pulling it's own plug.

Note that the restart option is not available on the Smart-UPS v/s models.

Each of the shutdown options can be activated by the enable boxes. Set the
time, weekday or date with the controls provided. The priority of the shutdown
from highest to lowest is as follows: one-time, weekly, daily. You can have the
UPS shutdown daily, but a weekly shutdown will interrupt the daily shutdown
until the UPS restarts again. A one-time shutdown will require a manual restart
of the UPS.

For daily shutdown, note that if the restart time is earlier than the shutdown
time, the restart will actually span into the next day.

The weekly shutdown and restart time span is limited to 99.9 hours. You must
set the restart time within this limit before you can save the settings. Weekly
restart times have a resolution of 6 minutes and is a limitation of the UPS,
not UPS Monitor.

The Announcement xx sec. before Shutdown (0-999 secs.) gives you the time to
abort a scheduled shutdown by selecting Options - Abort Sched. Shutdown from
the menu or by pressing the ESC key when the UPS Monitor program has the focus.

The SAVE button will save all options to disk, the CANCEL will cancel operation
and discard any changes.


ΓòÉΓòÉΓòÉ 5.10. OPTIONS - Abort Sched. Shutdown ΓòÉΓòÉΓòÉ

Aborts the scheduled shutdown in progress. This menu item is only active when a
scheduled shutdown has started and you had set the Announcement xx sec. before
Shutdown delay in the Scheduled Shutdown window. You can also abort a scheduled
shutdown by pressing the ESC key. The UPS Monitor window must have focus for
this key to work.


ΓòÉΓòÉΓòÉ 5.11. OPTIONS - Shutdown and UPS Off Now ΓòÉΓòÉΓòÉ

This selection shuts down your operating system and turns off the UPS. You will
be prompted before shutdown starts. The system pulls it's own plug. The UPS
must be manually restarted after this shutdown.


ΓòÉΓòÉΓòÉ 5.12. OPTIONS - Connect ΓòÉΓòÉΓòÉ

Opens the selected comm port and connects to the UPS. The UPS is first
identified and then a self test is initiated. This event is logged. You can
also use the F8 key to execute a Connect.


ΓòÉΓòÉΓòÉ 5.13. OPTIONS - Disconnect ΓòÉΓòÉΓòÉ

Disconnects from the UPS and closes the comm port. This event is logged. You
can also use the F9 key to execute a Disconnect.


ΓòÉΓòÉΓòÉ 5.14. DIAGNOSTICS - UPS Info ΓòÉΓòÉΓòÉ

Displays the UPS model, serial number and firmware revision on the screen. Must
be connected to the UPS to access this feature.


ΓòÉΓòÉΓòÉ 5.15. DIAGNOSTICS - Test UPS Alarm ΓòÉΓòÉΓòÉ

Activates the UPS alarm. This event is logged.

Must be connected to the UPS to access this feature.


ΓòÉΓòÉΓòÉ 5.16. DIAGNOSTICS - Simulate Power Failure ΓòÉΓòÉΓòÉ

Initiates a Simulate Power Failure and checks the UPS circuitry for proper
operation. This event is logged.

Must be connected to the UPS to access this feature.


ΓòÉΓòÉΓòÉ 5.17. DIAGNOSTICS - Initiate UPS Self Test ΓòÉΓòÉΓòÉ

Initiates a UPS Self Test and checks the UPS circuitry for proper operation.
This event is logged.

Must be connected to the UPS to access this feature.


ΓòÉΓòÉΓòÉ 5.18. HELP - Help Contents ΓòÉΓòÉΓòÉ

Displays this help file (UPSMONS.HLP).


ΓòÉΓòÉΓòÉ 5.19. HELP - Help using NewView ΓòÉΓòÉΓòÉ

Displays this help file (UPSMONS.HLP) using the free third-party HLP and INF
viewer NEWVIEW.EXE. This viewer must be somewhere in the PATH statement for UPS
Monitor to find it. A good place to put it is d:\OS2 as the default help and
inf viewer are located there. NEWVIEW.EXE can be found at hobbes.nmsu.edu.


ΓòÉΓòÉΓòÉ 5.20. HELP - Product Information ΓòÉΓòÉΓòÉ

Product information.


ΓòÉΓòÉΓòÉ 5.21. Shutdown Now ΓòÉΓòÉΓòÉ

This menu selection will shutdown the computer using regular system or APM
shutdown. A prompt will ask the user if shutdown is to proceed. The prompt can
be bypassed which is indicated by a trailing exclamation point, i.e. Shutdown
Now! See OPTIONS - Shutdown Parameters for Shutdown Now settings.


ΓòÉΓòÉΓòÉ 6. Smart Signaling Cable Pinout ΓòÉΓòÉΓòÉ

Below is a connection diagram to connect the APC UPS to a 25 or 9 pin serial
port. This cable requires a UPS supporting smart signaling and the UPSMONS.EXE
program.


ΓòÉΓòÉΓòÉ 7. Troubleshooting ΓòÉΓòÉΓòÉ

If you are having problems connecting to the UPS, then follow these steps
below.

      Γûá  UPS Monitor is only designed and tested for the APC (American Power
      Conversion) models Back-UPS, Smart-UPS, Smart-UPS v/s and Back-UPS Pro.
      See the Lone Peak Automation website for programs that support other
      brand UPS models.

      Γûá  The UPSMONS.EXE executable is only designed to work with models
      supporting smart signaling like the Smart-UPS, Smart-UPS v/s and Back-UPS
      Pro. You must use cable number 940-0095A, 940-0024B or 940-0024C included
      with these UPS for proper operation. It is possible that this program
      will work with other APC models, like the Matrix-UPS, using smart
      signaling. UPS Monitor has not been tested with the Matrix-UPS model.
      UPSMONS.EXE will not work with the model Back-UPS (400, 450 and 600) or
      Office models which use simple signaling.

      Γûá  UPS Monitor will not work with brands other than APC.

      Γûá  Make sure the Com Port in the Settings window matches the com port you
      use for the UPS.

      Γûá  Make sure you have all the included files present in your directory.

      Γûá  If you have Ray Gwinn's SIO comm drivers, use the included PMLM (Poor
      Man's Line Monitor) to monitor data exchange between the computer and
      UPS. PMLM will also display the baudrate the port is set to. If it is not
      2400 then SIO may be locking the port to another baudrate. See below.

      Γûá  If you are using Ray Gwinn's SIO com drivers, check if the baud rate
      is locked for the particular com port you are using with the interface.
      Unlock it so UPS Monitor can change the baud rate to 2400. From the SIO
      reference, it states:


               Locked Baud Rate

               Placing a colon and a baud rate following the communications port, eg
               (COM1:38400,3F8,IRQ4), causes the port to be locked at that baud rate.
               No program, OS2 or DOS, is allowed to change the baud rate.

      Γûá  Try the standard COM1 or COM2 ports if you have problems with any
      other com ports like COM3 - COM8. Also, remove any serial cable
      extensions or adapters and connect the UPS directly to the computer. See
      the section Smart Signaling Cable Pinout for connector pin-outs.

      Γûá  Try using a different computer or different com port to access the
      UPS.

      Γûá  If you are using UPS Monitor on COM3 or COM4, make certain that these
      ports are configured for their own unique IRQ. By standard definition,
      COM1 and COM3 normally share IRQ4 and COM2 and COM4 share IRQ3. OS/2 and
      eCS do not like this configuration and you will get interaction between
      devices connected to COM1 and COM3 or COM2 and COM4 making reliable UPS
      monitoring impossible.


ΓòÉΓòÉΓòÉ 8. Installation ΓòÉΓòÉΓòÉ

Note:  REXX or Object REXX must be installed on your system for this program to
work. REXX is installed by default, but if you did not install it then run Warp
installation again and selectively install REXX support.

UPS Monitor comes with SFX, a self-extracting installer by PillarSoft. Follow
the prompts of the installation program to install UPS Monitor.

You must first configure UPS Monitor to recognize the UPS model and the comm
port it is connected to. Select Options - Settings and select the comm port and
UPS model from the controls. Save the settings and select Options - Connect.
This will connect to the UPS and a message will tell you if it was successful.
You are all set. If it did not recognize the UPS, see the section on
Troubleshooting for information.

If you want UPS Monitor to start automatically when your system powers up, then
place a shadow of the executable into the Startup folder (it's located under
the System folder).

You must also provide the command line parameters to UPSMONS.EXE for automatic
operation. The commands are -Con to automatically connect to the UPS and -Min
to minimize on start-up. You must provide these commands on the Parameters line
in the Properties page of Warp 4.0 or Settings page of Warp 3.0. To get to that
page, right-click on the UPSMON object and click Properties or Settings.

An additional command line parameter has been added to allow to redirect the
UPSMONS.INI file to another drive, directory or ini file name. Simply add -i
d:\directory\inifile.ini on the command line and UPS Monitor will use this
information to store the settings. This is useful if UPS Monitor is run on a
network from a write-protected drive.

UPS Monitor is designed and tested for the APC models Smart-UPS, Smart-UPS v/s
and Back-UPS Pro. For other UPS model types, see Description for information.

The following files belong to this program:

       UPSMONS.EXE       The executable program using smart signaling.

       UPSMONS.HLP       The Help file for UPSMONS.EXE.

       UPSMONS.INI       Settings file for executable. Created by UPSMONS.EXE.

       UPSMONS.LOG       Default log file created by UPSMONS.EXE.

       UPSMONS.CMD       External shutdown script file for UPSMONS.EXE.

       XSDWN.CMD         External shutdown script for use with XWorkPlace.

       UPSMONS.000       Default backup log files if log size exceeds specified
                         size.

       UPSPARM.LOG       Default parameter log file created by UPSMONS.EXE.

       UPSPARM.000       Historical parameter log file created by UPSMONS.EXE.

       UPSPMSD.DLL       Dynamic Link Library required by executables.

       XCENTER.SCR       Script for XCenter REXX Gauge Widget.

       VPOBJ.DLL         Dynamic Link Library required by executables.

       VPUTIL.DLL        Dynamic Link Library required by executables.

       RXSI2.DLL         Dynamic Link Library required by executables.

       RXASYNC.DLL       Dynamic Link Library required for serial
                         communications to the UPS. This library of serial
                         communications routines is included by permission of
                         Crucial Applications (Author: Ian Timms, e-mail:
                         [e-mail]). The entire serial
                         communications package, including the source code for
                         RXASYNC, is available at my home page or other major
                         OS/2 sites by the filename RXASYN20.ZIP. This file has
                         been packed for smaller size using LXWARP.

       README.TXT        Program description and installation instructions.

       BMTORDER.TXT      Order form to register UPS Monitor through BMT Micro.

 To remove this program from your system, close the program and execute
 UNINSTAL.CMD from within the directory where UPS Monitor is installed in.


ΓòÉΓòÉΓòÉ 9. License Agreement ΓòÉΓòÉΓòÉ

UPS Monitor is not public domain software, nor is it free software, it is user
supported.

Non-registered users are granted a limited license to use UPS Monitor on a
trial basis for the purpose of determining whether it is suitable for their
needs. Use of UPS Monitor, except for this limited purpose, requires
registration. See How To Register section on ways to register.

Use of non-registered copies of UPS Monitor beyond a 30 day evaluation period
by any person, business, corporation, governmental agency or other entity or
institution is strictly forbidden.

Use of registered copies of UPS Monitor by any business, corporation,
governmental agency or other entity or institution is strictly forbidden
without prior licensing arrangements and written consent of Lone Peak
Automation, LLC.

Registration grants a user the right to use UPS Monitor only on a single
computer unless prior arrangements are made with Lone Peak Automation, LLC. A
registered user may use UPS Monitor on a different computer, but may not use
the program on more than one computer at the same time.

You may not modify UPS Monitor in any way, including but not limited to,
decompiling, disassembling or otherwise reverse engineering the program.

No part of the UPS Monitor documentation may be reproduced, in any form or by
any means, without permission in writing form from Lone Peak Automation, LLC.

The unregistered version of UPS Monitor can be recognized by containing the
word "Unregistered" in the window title bar of the program.

All users are granted a limited license to copy the unregistered version of UPS
Monitor only for the trial use of others subject to the above limitations. The
following limitations apply for copying unregistered versions:

  UPS Monitor must be copied in unmodified form,
  complete with the file containing license and
  ordering information.

  The full documentation for UPS Monitor must be
  included in the archive.

  No fee, charge or other compensation may be
  accepted or requested by any licensee beyond a
  reasonable price for the media UPS Monitor is
  transferred on.

  Operators of electronic bulletin board systems and
  internet web/ftp sites may post the unregistered
  version of UPS Monitor for downloading by their users
  as long as the above conditions are met.

  Distributors of public domain or user supported
  software may distribute copies of the unregistered
  version of UPS Monitor subject to the above conditions.

DISCLAIMER

Lone Peak Automation, LLC accepts no responsibility for damages to property or
personal injury that may be caused by the use of UPS Monitor. UPS Monitor is
provided "AS IS" and you as its user assumes the entire risk when you use it.

Lone Peak Automation, LLC is not connected to any companies mentioned nor do
they endorse any of the products mentioned.

All product names mentioned herein are the trademarks of their respective
owners.

CREDITS

RXASYNC.DLL required for serial communications to the UPS, is a library of
serial communications routines and is included by permission of Crucial
Applications (Author: Ian Timms, e-mail: [e-mail]). The
entire serial communications package, including the source code for RXASYNC, is
available at the Lone Peak Automation home page or major OS/2 sites by the file
name RXASYN20.ZIP

UPS Monitor is a shareware product and can be registered through BMT Micro at
www.bmtmicro.com for $15.00 or through Lone Peak Automation directly.

UPS Monitor is copyright (C) 1998-2002 by Lone Peak Automation, LLC.

TRADEMARKS

APC stands for American Power Conversion.

APC, Back-UPS, Smart-UPS, Smart-UPS v/s, Back-UPS Pro and Matrix-UPS are
registered trademarks of American Power Conversion.


ΓòÉΓòÉΓòÉ 10. How to Register UPS Monitor ΓòÉΓòÉΓòÉ

With one single registration you will receive a license to run all three UPS
Monitor programs: UPSMONS.EXE, UPSMONB.EXE and UPSMONC.EXE

All registered users of UPS Monitor will receive a registration key to fully
unlock the program. Registration of UPS Monitor is for life-time and any new
versions of UPS Monitor will not require any re-registration. A registered user
may not make registration key information public nor pass it on to third
parties.

There are two ways you can register UPS Monitor:

Goto to the Lone Peak Automation website at
http://home.att.net/~ASchw/register.html and find the PayPal logo of the
product you want to register. Pricing is given at that webpage. Click on the
PayPal logo and you will be asked to enter name, address, quantity and credit
card information. Visa and Master Card are accepted. You will NOT be charged
any fees by PayPal for registering products. You will receive a confirming
email of your purchase and the registration key will usually be sent to you
within 24hrs of the purchase.

Register through BMT Micro at www.bmtmicro.com. BMT Micro offers a variety of
purchasing methods, see the file BMTORDER.TXT for details. You will receive the
registration code usually within one day. The cost is $15.00 for this option.

Quantity discounts are available. Please e-mail Lone Peak Automation for
details.

Registration key and instructions on how to enter the key to enable the
registered features will be given out at registration time.


ΓòÉΓòÉΓòÉ 11. Support ΓòÉΓòÉΓòÉ

The HOUSE/2 series of programs, UPS Monitor and other practical applications
are written by Lone Peak Automation, LLC of Sandy, Utah, USA.

For general inquiry, contact Lone Peak Automation, LLC via e-mail at:

  [e-mail]

For support contact Lone Peak Automation, LLC directly via e-mail at:

  [e-mail]

Visit the Lone Peak Automation, LLC home page at:

  http://home.att.net/~ASchw

for other information and applications. Monitor this website regularly for
future upgrades.

Lone Peak Automation programs are also available at the following sites:

   http://www.bmtmicro.com
  http://hobbes.nmsu.edu