
User Guide
CheckUPSII Basic Software V2.0
For UNIX and Similar Operating Systems
supporting a Best Power UPS
     
Copyright 1997 Best Power. All rights reserved.
LTM-0391A v2.1  

Best Power
The answer in power protection
                                                     


                            CONTENTS
                                
License Agreement . . . . . . . . . . . . . . . . . . . . . . . . ii
Introduction  . . . . . . . . . . . . . . . . . . . . . . . . . . 1
100: Overview of CheckUPS II Operation. . . . . . . . . . . . . . 2
200: Getting Started. . . . . . . . . . . . . . . . . . . . . . . 3
210: Before Installing the Interface Cable  . . . . . . . . . . . 3
220: Connecting to a BEST Single-Phase UPS or Signal Splitter Box 3
230: Connecting to the Computer . . . . . . . . . . . . . . . . . 3
240: Installing the Software  . . . . . . . . . . . . . . . . . . 4
245: Supported UNIX Platforms . . . . . . . . . . . . . . . . . . 4
250: Compiling the Programs . . . . . . . . . . . . . . . . . . . 5
300: Testing the Shutdown Procedure . . . . . . . . . . . . . . . 5
400: Running CheckUPS II. . . . . . . . . . . . . . . . . . . . . 6
500: Command Line Options . . . . . . . . . . . . . . . . . . . . 7
Placing a Service Call. . . . . . . . . . . . . . . . . . . . . . 10
Reader Comment Form . . . . . . . . . . . . . . . . . . . . . . . 10
Offices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
  


LTM-0391A v.2.0
Copyright 1995, 1996 
Best Power 


*******License Agreement*******

YOU SHOULD CAREFULLY READ THE FOLLOWING TERMS AND CONDITIONS BEFORE OPENING
THE SOFTWARE PACKAGE. YOUR USE OF THE MEDIA ON WHICH THE PROGRAM IS RECORDED
INDICATES YOUR ACCEPTANCE OF THESE TERMS AND CONDITIONS. IF YOU DO NOT AGREE
WITH THEM, YOU SHOULD IMMEDIATELY RETURN THIS PACKAGE, AND ANY MONEY PAID FOR
THE SOFTWARE PACKAGE WILL BE REFUNDED.

***LICENSE***

You may:

  1. Use the program on a single computer.

  2. Merge other programs with the program as specified in the enclosed
     materials for your use on a computer. The program merged with another will
     continue to be subject to the terms and conditions of this agreement.
  3. Transfer the program and license to another party if the other party agrees to accept the terms and
     conditions of this agreement.

EXCEPT AS EXPRESSLY PROVIDED IN THIS LICENSE AGREEMENT, YOU MAY NOT TRANSFER,
MERGE, COPY OR MODIFY THE PROGRAM. 

***TERM***

This License Agreement is effective upon your opening of this package and
shall continue until terminated. Best Power may terminate upon your breach of
any term hereof. You may terminate at any time by destroying the diskettes or
tape (hereafter known as "media") contained in this package. Terminating the
license does not eliminate any prior failure on your part to comply with any
term or condition of this agreement. You agree further upon termination to
destroy the program together with any copies, modifications and/or merged
portions in any form.

***LIMITED WARRANTY***

To the original purchaser only, BEST POWER, a division of General Signal Power
Systems, Inc. (hereinafter called BEST POWER) warrants the media on which the
program was recorded to be free from defects in materials and faulty
workmanship under normal use and service for a period of thirty (30) days from
the date of purchase. If, during such period, a defect occurs, the media will
be replaced without charge to you provided that the defective diskette is
returned to Best Power. Contact BEST POWER Worldwide Service for an RMA number
and instructions.

EXCEPT FOR THE WARRANTY SET FORTH ABOVE, THE PROGRAM IS LICENSED "AS IS," AND
BEST POWER DISCLAIMS ANY AND ALL OTHER WARRANTIES, WHETHER EXPRESSED OR
IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

***LIMITATION OF REMEDIES***

The entire liability of Best Power and your exclusive remedy shall be
replacement of the media if you have met the conditions as described under
"Limited Warranty."

In no event will Best Power be liable to you for any indirect, incidental,
consequential, special, or exemplary damages or lost profits, even if advised
of the possibility of such damages.

***OTHER***

THIS AGREEMENT WILL BE GOVERNED BY THE LAWS OF THE STATE OF WISCONSIN.

YOU ACKNOWLEDGE THAT YOU HAVE READ THIS AGREEMENT, UNDERSTAND IT AND AGREE TO
BE BOUND BY ITS TERMS AND CONDITIONS.  YOU FURTHER AGREE THAT THIS IS THE
SOLE AGREEMENT BETWEEN US AND SUPERSEDES ANY PROPOSAL OR AGREEMENT ORAL OR
WRITTEN BETWEEN US RELATING TO THE SUBJECT MATTER.

SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR
CONSEQUENTIAL OR INCIDENTAL DAMAGES, SO THE ABOVE LIMITATIONS MAY NOT APPLY
TO YOU.


U.S. GOVERNMENT RESTRICTED RIGHTS

The Software and accompanying materials are provided with RESTRICTED RIGHTS.
Use, duplication, or disclosure by the government is subject to restrictions
as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and
Computer Software clause DFARS 252.227-7013 or the Commercial Computer
Software Restricted Rights clause at FAR 52.227-19 subdivision (c)(1) and (2),
as applicable. Contractor is Best Power, P.O. Box 280, Necedah, WI 54646. 


*****Trademarks*****

CheckUPS is a registered trademark of Best Power. 
All other brand and product names are trademarks or registered trademarks of
their respective holders.



****************Conventions Used in this Guide***********************

This guide uses these type style conventions:

Italic print indicates chapter or section names in this guide, window or
dialog box names, or is used for emphasis.

Bold italic print indicates field names or menu items in the software, or is
used for emphasis. Words separated by a | vertical bar indicate a series of
menu items that must be selected. For example: File|Exit

Bold print indicates filenames, directories, or items to be typed exactly as
they appear.

Italic print words or letters in braces { } indicate values that must be
supplied by the user. For example: {drive}:\install. 

Italic print words or letters in brackets < > indicate keys to press. If two
keys are separated by a + plus symbol, then the first key should be pressed
and held down while pressing the second key. For example: <alt + enter>

Note:          Notes contain important information set off from the text. 

Caution:  Caution messages alert you to a specific procedure or practice,
which, if not followed correctly, could cause personal injury, equipment
damage, or loss of data. 



************************INTRODUCTION*******************************

CheckUPS  II software does an automatic shutdown of a computer or computers
protected by a UPS when an extended power outage occurs. This manual describes
CheckUPS II software for UNIX and similar operating systems. 

Best Power has tested CheckUPS II software on various UNIX systems and will
make reasonable efforts to assist you in setting up the software to work on
your system. However, the wide variety of UNIX systems and the varied use of
the software prevents BEST from guaranteeing successful use of the software
on your system.

The source code for the CheckUPS II program is provided. Compiled code is
provided for SUN, HP, IBM, DEC AXP/Digital, and SCO UNIX systems. If you do
not have one of these five systems, you must have a "C" compiler on your
system so that you can compile the programs. The software includes sample
shutdown scripts for System V and BSD systems.
 


Included in this package you will find:

1 - CheckUPS II CD-ROM (SFT-543)
1 - Interface Cable
1 - CheckUPS II Software Manual (this manual)
1 - Cable Adapter

 
To find information about a specific topic, refer to the Table of Contents.
We encourage you to read the entire manual. It contains useful information
about the software.

If you have a question concerning CheckUPS II software, call BEST Power
Worldwide Service at 1-800-356-5737 (U.S.A. and Canada) or 1-608-565-2100.



***100: Overview of CheckUPS II Operation

CheckUPS II is a background process that monitors the UPS status at predefined
timed intervals (default = 30 seconds). The program responds to an AC power
loss by notifying the user that the UPS is on inverter (battery power). If the
UPS remains on inverter for an extended period of time and the cutoff timer
reaches the value set for cutoff (default = 2 minutes), CheckUPS II
automatically shuts down the computer. 



***200: Getting Started

This section tells how to set up the serial port on the computer, connect the
computer to the UPS, and install the software.

NOTE:   Compiled code is provided for SunOS, HP-UX, AIX/6000, DEC AXP/Digital,
        and SCO UNIX systems. If you do not have one of these five systems,
        the software installation involves some general and systems level
        programming; you must be familiar with the operating system and have
        some knowledge of the "C" language and its compiler. 



***210: Before Installing the Interface Cable

Before installing the interface cable, follow the two steps below.

1.   Select a serial port on your computer to monitor the UPS. The port you
     select must be enabled for use but disabled for login.

     NOTE:      The exact procedure to disable a port for login depends on the
                version of UNIX you are using. For example, under most systems,
                getty is turned off on that port. This may be accomplished by
                editing inittab or by using a disable or similar command on some
                systems. Consult your system documentation.

2.   Shut down the UNIX system and any other load equipment connected to the UPS.




***220: Connecting to a BEST Single-Phase UPS or Signal Splitter Box

The steps in this section are for all BEST UPS (excluding UNITY/I Three-Phase
systems).

1.   Follow the instructions in Section 210.

2.   Power down the UPS. Consult your UPS documentation for instructions.

3.   Connect the "UPS" end of the interface cable (INT-0027 or
     INT-0032) to the communication port on the UPS. If connecting to a FERRUPS
     UPS, use the FERRUPS cable adapter (INT-0013). If connecting to a signal
     splitter box, connect to a UPS status port.



***230: Connecting to the Computer

1.   For SUN systems: Connect the other end of the interface cable (INT-0032)
     to a DB25S (female) serial port on your computer.

  For other systems: Connect the other end of the interface cable (INT-0027)
  to a DB9P (male) serial port on your computer. You can use the cable adapter
  (INT-0012) to connect to a DB25P (male) serial port on your computer. The
  cable and adapter will allow connection to most computers. However, some
  computers may require the use of a gender changer or adapter.

2.   Power up the UPS. Consult your UPS documentation for instructions.

3.   Restart the UNIX system and any other UPS load equipment.




***240: Installing the Software
       
The CheckUPS II software is provided on either a CD, a UNIX tar format disk,
or a tape.



***240-1:    Installation from the CheckUPS II CD-Rom
               
          If your UNIX system is capable of reading an ISO9660 CD-Rom: 

               1)   Mount CD-Rom
               2)   Change directory to {mount point} /unix 
               3)   Run UNIXINST
               
          Follow prompts as directed on the screen. 

          If your UNIX system cannot mount and read the CD-Rom please
          copy/transfer from a DOS/Windows system onto your UNIX system: 

               D:\UNIX\BESTUNIX.TAR
               D:\UNIX\UNIXINST

          When you have the files on your UNIX system (preferably in root) run
          UNIXINST.


***240-2:    Installation from the tar formatted tape or diskette

     1)    cd  /    Change directories to root.

     2)   Install the files from the disk or tape and run the installation
          program using the instructions below.

          a)   tar  xvf  /dev/device         where device is the name of your diskette or tape
                                             drive.
  
          Follow prompts as directed on the screen. 

3)   The cusetup program removes all of the files that are not applicable for
     your particular system. If you need to completely remove the CheckUPS II
     software, type curemove.

***245: Supported UNIX Platforms

The following UNIX platforms are currently directly supported by CheckUPSII:

    AIX
    HP-UX
    SCO (UNIX/XENIX/UNIXWARE)
    SunOS/Solaris
    AXP/Digital UNIX
    NCR AT&T UNIX SVR4
    BSDI BSD/OS
    LINUX (x86)
    SGI (IRIX)

If your specific platform is not listed above you may install the
source code only, and follow the compiling instructions in section 250.


***250: Compiling the Programs


    Because of the diversity of UNIX systems, checkups is
    delivered in source form as the file checkups.c.

    To compile these programs on your system using the C compiler, use the
    following commands:

    If your compiler includes a 'make' program, then you can compile CheckUPS
    with the following commands:

                cd /etc/best
                make

    If your compiler does not include a 'make' program, then you can simply
    compile CheckUPS manually with the following commands:

                cd /etc/best
                cc checkups.c -o checkups

***300: Testing the Shutdown Procedure

This section outlines a procedure you can use to test the shutdown cycle
initiated by CheckUPS II. Perform this test procedure to make sure that the
script upsdown functions correctly on your system. The test is especially
important when modifications have been made to upsdown.

BEST Power provides sample script files for the CheckUPS II software. Because
of the diversity of UNIX systems, you may need to modify one of these files
for your system. Generally, upsdown should call the SHUTDOWN script supplied
with your UNIX system. Grace periods and verification requests should be
disabled so that the shutdown will finish within two minutes.

NOTE:  The shutdown test procedure should only be done when the system is not
in use.

  1. The compiled program checkups should be in the /etc/best directory. As
     superuser, enter the following command line at the root prompt:

                     checkups -c1 /dev/ttynn&

     where /dev/ttynn is the device name of the serial port connected to the
     UPS.

     NOTE:  The c command line option specifies a 1-minute cutoff point instead
            of the default 2-minute cutoff point. In other words, for this
            test, we will force the shutdown to start after one minute of
            running on battery power (inverter).

       The & directs the system to run the program in the background. If you
       were to omit the &, the console or terminal would become dedicated to
       the checkups program. Since the checkups program does not direct any
       output to the screen, you would not see anything displayed. If you
       inadvertently forget the ampersand and have the program running in the
       foreground, type a <Ctrl-C> to stop it.

  2. Put the UPS on battery power.

      For all BEST UPS except UNITY/I Three-Phase: Simulate a power outage
       by switching off the AC input power to the UPS. This can be done at
       the circuit breaker which feeds the UPS.
  
  3. Within 30 seconds (default), you should see the following message on your
     computer:

     The system is running on UPS power. UPS runtime remaining is xx
     minutes and xx seconds.

     After the cutoff timer has expired (you set this to one minute in step 1),
     you should see a message requesting immediate logoff by all users.

     One minute later, the upsdown script should execute. You should observe
     the return of the system to the single user (maintenance) mode. If not,
     upsdown has failed. Also, any error messages seen at the console should
     be accounted for.

  4. Put the UPS back on normal operation.

      Restore AC input power to the UPS.

  5. Reboot your system.

***400: Running CheckUPS II

To automatically start CheckUPS II when your system is booted, use one of the
methods below:

Method 1

  Enter the line:

  nohup /etc/best/checkups /dev/ttynn&

  into your rc file in the rc local section or at the end of the file;  ttynn
  is the device name of the serial port connected to the UPS.

  For SUN, insert the line into the /etc/best/rc.local file.
  For AIX, insert the line into the /etc/best/rc file.
  For HP-UX, insert the line into the local rc ( ) section of the
  /etc/best/rc file.

Method 2

  1. Create a command script file called S99CheckUPS containing the line:

     nohup /etc/best/checkups /dev/ttynn&

     where /dev/ttynn is the device name of the serial port connected to the
     UPS.

  NOTE:   Give the file executable rights.
  NOTE:   The & directs the system to run the program in the background. If
          you omit this ampersand, the console or terminal would be dedicated
          to the checkups program.

  2. For SCO, move the file S99CheckUPS to  /etc/rc2.d/S99CheckUPS so that
     the program can start automatically the next time the system is restarted.
     
     NOTE:  Other UNIX systems may have different rc file structures. Consult
            your system documentation.



CAUTION

While checkups is running, do not run any other program that
must use the port assigned to the UPS without first killing
checkups. Running another program will cause checkups to
lose communication with the UPS and thus issue incorrect
warnings to users on the system.



***500: Command Line Options

The following options can be specified on the command line:

  -a#  Allow time: At startup, the checkups program waits # seconds before
       becoming activated.
       Range = 5 to 600 seconds. Default = 5 seconds.

  -c#  Cutoff time: The UPS will run on inverter (battery power) for # minutes
       before a shutdown is issued.
       Range = 1 to 99 minutes. Default = 2 minutes.

  -s#  Sleep time: The checkups program polls the UPS every # seconds.
       Range = 5 to 60 seconds. Default = 30 seconds.

  -k   Background: Runs the upsdown script file as a background application.
       Default = shutdown script (upsdown) runs in foreground.

  -l   Low Battery Alarm: DO NOT Shutdown of Operating System upon UPS Low Battery alarm
       condition. Default = Shutdown based on Low Battery Alarm.

  -o   UPS shutdown: The UPS will shut down. This command is not supported by
       all UNIX systems. Default = UPS shutoff signal is NOT sent.

Here is a sample command line:

  /etc/best/checkups -c3 -s60 /dev/tty01&

In this example, the cutoff timer is set for 3 minutes (-c3). This allows the
UPS to run on inverter (battery power) for three minutes before a shutdown is
executed. The sleep time is set for 60 seconds (-s60). This causes checkups to
poll the UPS every 60 seconds.



*********Placing a Service Call

In order to diagnose the problem, our technicians need the following
information from you:

Installation Site: __________________________________________________________
Company Name: _______________________________________________________________
Address: ____________________________________________________________________
City:____________________    State:_________________ ZIP code: ______________

Installation Site Contact:___________________________________________________
Full Name:  _________________________________________________________________
Phone Number:____________________________Fax Number: ________________________

If you are a consultant,
Consultant Name: ____________________________________________________________
Phone Number:    ____________________________Fax Number: ____________________ 

Computer System:
Operating System and version:________________________________________________
System Manufacturer: ________________________________________________________
System Model Number: ________________________________________________________
NMS name and revision number: _______________________________________________

UPS: ________________________________________________________________________
Manufacturer: _______________________________________________________________
Model Name/Number:___________________________________________________________
Type of Port Connector (How many pins, male or female.): ____________________

What are the symptoms?
_____________________________________________________________________________
_____________________________________________________________________________
_____________________________________________________________________________


Reader Comment Form

Do you have any comments or suggestions for improving this manual or product?
If so, please fill out the information below and mail or fax it to: 

Connectivity
Best Power
P.O. Box 280
Necedah, WI 54656

FAX: 1-608-565-2221

Please print:

Name ________________________________________________   Date_________________

Address______________________________________________________________________



Daytime Phone (     ) _______________________________________________________

Product _____________________________________________________________________


Comments/Suggestions










Email comments to:                                      bestpower.com
North America

Corporate Headquarters
Best Power 
P.O. Box 280
Necedah, Wisconsin 54646 U.S.A.
Telephone: 1-608-565-7200
Toll-free: 1-800-356-5794 (U.S. and Canada)
FAX: 1-608-565-2221
International FAX: 1-608-565-7675
FAX on Demand: 1-800-487-6813
BBS: 1-608-565-2901
http://www.bestpower.com
E-mail: bestpower.com 

Best Power Worldwide Service 
N9246 Highway 80 / P.O. Box 11
Necedah, Wisconsin 54646 U.S.A.
Telephone: 1-608-565-2100
Toll-free: 1-800-356-5737 (U.S. and Canada)
Fax: 1-608-565-2509
International Service FAX:  1-608-565-2799

Best Power Technology of Canada Limited
1555 Bonhill Road, Unit 11
Mississauga, Ontario L5T 1Y5
CANADA
Telephone: 1-905-564-7655
Fax: 1-905-564-7657

Asia

Best Asia Trading Co., Ltd.
12F, 77 Keelung Road, Sec.2
Taipei, TAIWAN R.O.C 110
Telephone: 886-2-736-2933
FAX: 886-2-733-4403

Best Power Technology, Pte. Ltd.
PICO Creative Centre, Level 5
20 Kallang Avenue
SINGAPORE 339411
Telephone: 65-2938122
FAX: 65-2968766

Australia 

Sola Australia Ltd.
13 Healey Road
Dandenong Victoria 3175
AUSTRALIA
Telephone: 61-3-9706-5022
FAX: 61-3-9794-9150




Latin America 

Best Power Technology Mexico, S.A. de C.V.
Golfo de Riga, 34
Colonia Tacuba
Mxico D.F. 11410
MXICO
Telephone: (52)(5) 399-0369
Fax: (52)(5) 399-1320

Europe 

Best Power Technology, Limited
BEST House
Wykeham Industrial Estate
Moorside Road
Winchester
Hampshire
SO23 7RX
ENGLAND
Telephone: (44) 1962 844414
FREEPHONE: 0800 378444
Fax: (44) 1962 841846

Best Power Technology GmbH
Am Weichselgarten 23
D-91058 Erlangen, Deutschland
GERMANY
Telephone: +49/9131/77700
Gebhrenfrei (Deutschland): 0130/84/7712
Fax: +49/9131/777050

Borri Elettronica Industriale Srl
Via de Lavoratori, 124
20092 CINISELLO BALSAMO (Mi)
Milan, ITALY
Telephone (39) 2-6600661-2
FAX: (39) 2-6122481

Sola Electric AG
Postfach, CH-5412 Gebenstorf
SWITZERLAND
Telephone: 41/56/2019595
FAX: 41/56/2019555





