UserManual-ENG
UserManual-ENG
Figure 1.2.1
Agent is the key component of the software, running as a system service on background.
Agent communicates with UPS, logs the event of UPS, notifies user when the UPS is
abnormal, takes some actions according to the user configuration and shuts down the
system of computer when necessary. User can configure Agent by Monitor.
Monitor is the user interface of the software. User can get real-time status of UPS,
configure the parameters of UPS and set shutdown parameters by monitor.
Tray Icon, shown on the taskbar of Windows system, is the management tool of the
software. Start software from “start” menu of system or login in system when restart system
after installing software, if the software runs normally, a green icon will be shown on the
taskbar of Windows system.
▲ The Tray Icon exists on Windows only.
There are two different statuses of Tray Icon to display the current status of Agent. Refer
to the following figure 1.2.3.
Agent stop
Agent is running
Figure 1.2.2
1.3 Application
1.3.1 Application on individual computer
Refer to figure1.3.1
Figure 1.3.1
Figure 2.2.1.2
2.2.2 Linux
On Linux, copy Linux and InstallerData file, or copy LinuxAMD64 and InstallerData
file, enter Linux or LinuxAMD64 file to start installation, the installation interfaces are
same as section 2.2.1.
The command ./setup.bin is for GUI mode, the command ./setup_console.bin is for
CUI mode.
Please note: Linux is for i386/i586/i686 Linux system, LinuxAMD64 is for
x86_x64 Linux system.
2.2.3 Mac
On Mac OS, for Mac 10.6 or earlier OS, please enter \MacOSX file, double click the
setup.zip to start the installation. For Mac 10.7 and later OS, please enter
\MacOSX10.7andLater file, double click .mpkg file to start the installation.
2.2.4 Other OS
Copy other OS installation file and InstallerData file, enter OS file, and
execute ./setup.bin for GUI mode or setup_console.bin for console mode.
For example, on Unix OS, copy GenericUnix file and InstallerData file, Enter
GenericUnix file, execute ./setup.bin for GUI mode or setup_console.bin for CUI mode to
start the installation.
Figure 2.3.1.1
There will be a green icon shown on the task bar after software starts. That means
the agent is running normally. Please refer to figure 2.3.1.2.
Figure 2.3.1.2
“Start Agent” is to start agent; “Stop Agent” is to stop agent; “Start Monitor” is to start
management interface; “Exit” is to exit agent service.
▲ On Windows 2008, Windows Vista, Windows 7, Windows 8, Windows 10 and
Windows 2012, once you click “Exit”, the agent will exit, if you wants to start software
again, you should restart computer, or act as an administrator to start the service
“UPSmonitor” in the task manager and then start software from “start” menu, the
green icon will be shown on the task bar.
2.3.2 Mac OS
The default installation path is /opt/MonitorSoftware, enter the installation path and then
input the command: sudo ./agent start to start agent, input the command:
sudo ./monitor to start software management interface.
2.3.3 Other OS
The default installation path is /opt/MonitorSoftware, enter the installation path and then
input the command:./agent start to start agent, input the command: ./monitor to start
software management interface.
2.4.1 Windows
Close software management interface, exit software agent from “Exit” menu referring
to in figure 2.3.1.2, and then uninstall software from “start” menu, please refer to figure
2.4.1.1.
Please note: user also can uninstall software from “add or remove programs”
component.
▲ On Windows 2008, Windows Vista, Windows 7, Windows 8 and Windows
2012, user should act as administrator when uninstalling software, select
“Run as administrator” from the pop-up menu. If there is “user account
control” dialog shown, please select “allow”.
Figure 2.4.1.1
Uninstallation interface, please refer to figure 2.4.1.2.
Figure 2.4.1.2
When uninstallation is finished, there will be an interface shown as figure 2.4.1.3.
Please click “Done” to finish software uninstallation.
Figure 2.4.1.3
2.4.2 Mac OS
Close software management interface, enter software installation file, input command:
sudo ./agent stop to stop software agent, and then input command: sudo ./Uninstall to
uninstall software.
2.4.3 Other OS
Close software management interface, enter software installation file, input
command:./agent stop to stop software agent, and then input command:./Uninstall to
uninstall software.
Chapter 3 Main functions introduction
3.1 Software management
3.1.1 Be software administrator and modify password
▲If the user wants to configure software setting, user should be administrator
of the software first. The default right is read-only, can’t configure settings.
Be software administrator: select the agent name (computer name) in the tree view of
software interface, and click the “Act as Administrator” item of “System” menu, there will
be a dialog shown, please refer to figure 3.1.1.1. Input password and click “OK” button.
If the password is not correct, there will be message to inform user; if the password is
correct, user can act as administrator of software, and can configure software settings.
Figure 3.1.1.1
There is no default password, when user acts as administrator of software, user can
change password, click “Modify Administrator Password” item of “System” menu, there
will be a dialog shown, please refer to figure 3.1.1.2. Input new password and double
check, and click “OK” button. User should input new password to act as administrator
next time.
Figure 3.1.1.2
Figure 3.3.2
Figure 3.3.3
Condition 5 should be set on “UPS on/off Manager” dialog, please refer to figure
3.3.4.2. “UPS on/off Manager” dialog can be opened by clicking “UPS on/off Schedule”
item of “Device” menu.
Figure 3.3.4.2
Schedule shutdown and restart UPS output on specific time or weekly
User can set schedule shutdown task on “UPS OnOff Manger” dialog: UPS shutdown
on the specific time and UPS shutdown weekly. The time UPS shutdown can last for
time range from 1 to 9999 seconds. That means the time from UPS output shutdown to
output restart can be set from 1 to 9999 seconds.
The shutdown task list and the calendar are shown on the dialog. On the calendar,
the red point is schedule shutdown task; the green is schedule restart task; the blue
point is schedule battery self-test task. User can add schedule shutdown task by “Add
UPS OnOff” button, and modify or remove schedule shutdown task by “Modify” or
“Remove” button.
▲The time of new task can’t be same as the task that has been added.
When schedule task has been added, software will pop up warning dialog to remind
user that UPS will be shut down. The shutdown warning dialog will pop up at the time
interval, the warning time interval and the time begin to count down can be set in the
“Shutdown Setting” dialog. Please refer to figure 3.3.4.1.
The schedule shutdown task can be shown on “View Schedule” dialog. The dialog
can be opened by “View Schedule” item of “Device” menu. Please refer to figure 3.3.4.3.
Figure 3.3.4.3
Figure 3.3.6.1
Schedule battery self-test
Open “UPS Test Manger” dialog by the “Battery Self-Test Schedule” item of “Device”
menu. Please refer to figure 3.3.6.2.
Figure 3.3.6.2
User can set battery self-test task on “UPS Test Manger” dialog: UPS battery self-
test on the specific time and UPS battery self-test monthly. There are three battery self-
test types selected: self-test for 10 seconds, self-test until battery low, self-test for N
minutes.
The battery self-test task list and the calendar are shown on the dialog. On the
calendar, the blue point is schedule battery self-test task. User can add schedule battery
self-test task by “Add Test” button, and modify or remove battery self-test task by
“Modify” or “Remove” button.
The schedule battery self-test task can be shown on “View Schedule” dialog. The
dialog can be opened by “View Schedule” item of “Device” menu. Please refer to figure
3.3.4.3.
User can cancel the current UPS battery test by “Cancel Current Battery Self-test”
item of “Device” menu.
Figure 3.3.7.2
3.3.7.3 Event log
Click “Event Log” item of “Logs” menu to open “Event Log Viewer” dialog to view
event log, please refer to figure 3.3.7.3. Select the check box of each event log, and
click “Delete” button to delete event log. User can export event log file by “Export” button.
Figure 3.3.7.3
Figure 3.3.9
▲For some UPS, the model can be detected automatically, the model can’t be
renamed. For some UPS, the model can’t be detected automatically, the model
can be renamed.
Figure 3.3.10
If the time for the “Battery self-test to low” is lower than the setting value, software will
log the warning alarm “Battery test to low took less than setting minutes” and attach the
actual battery self-test time, please refer to the below image
3.4 Warning event notification method
When UPS status is abnormal, software will notify user to let user learn UPS status as
soon as possible, and then user can take action according to warning event notification.
1. Pop-up real time warning dialog
2. E-mail message alarm
3. SMS alarm
Figure 3.4.3
Select port that connects with modem. The modem should support GSM function. Select
the baud rate, such as 9600. The value is different depending on different modem model.
Here, attention should be paid: if users have previously used to send short messages with
other software, the software will be the default baud rate into previous baud rates, so you
should test one by one to find proper SMS baud rate.
Select the abnormal event in the event list and select phone number, when the
abnormal event happens, software will send SMS to the phone number. Click “Test” button
to test SMS sent successfully or not.
▲There are 5 phone numbers in the list at most.
Figure 3.5.2.1
Settings of remote computer:
The same software should be installed on remote computer to accept shutdown
command. Click “shutdown parameter” item of “Device” menu to open “shutdown
settings” dialog, and then set “remote shut down by agent” and add remote computer IP
communicating with UPS to accept remote shutdown command. For example: if
computer accepts the remote shutdown command from remote computer (IP address is
172.18.139.33). The setting is as figure 3.5.2.2. User can set the delay time to shut
down computer after receiving shutdown command from remote computer according to
actual condition. The default value of delay time is 0. That means computer will shut
down immediately when receiving shutdown command from remote computer.
Figure 3.5.2.2
Figure 3.6.1.2
The remote computer name will be shown below the WAN node if the remote computer
is added OK, User can select remote UPS node to view the detail information. Please refer
to figure 3.6.1.3.
Figure 3.6.1.3
If software installed on remote computer accepts remote control, the check box of
“accept remote control” is selected. Please refer to figure 3.6.1.4.
If software installed on remote computer doesn’t accept remote control, the check box
of “accept remote control” is not selected. Please refer to figure 3.6.1.5.
Figure 3.6.1.4
Figure 3.6.1.5
If the remote computer accepts remote control, select computer node, click “Act as
Administrator” item of “System” menu to become software administrator, user can view UPS
detail information, and also can configure remote UPS parameter setting, remote computer
shutdown, and notification methods.
If the remote computer doesn’t accept remote control, select the remote computer node,
you will find “Act as Administrator” item of “System” menu is grey, user can’t become
software administrator, only can view UPS detail information, but can’t configure remote UPS
parameter setting, remote computer shutdown, and notification methods.
Figure 3.6.3.1
User also can scan the QR code to download Winpower APP and install it on phone with
Android OS. About the APP QR code, please refer to figure 3.6.3.2.
Figure 3.6.3.2
User can view device status, current alarm, the latest history event, and operate battery
test via mobile phone.
Input the software server address: http://IP address:8888, such as
http://172.18.140.28:8888. UPS list will be shown. Please refer to figure 3.6.3.3. User also
can scan the QR code of server to access to server address with the browser scanning
function. User should click “View Server URL” item of “Monitor” menu to get QR code. Note:
if computer is configured with two or more network card, there will be a IP list displayed after
user click “View Server URL” item of “Monitor” menu. To get the QR code, User should click
every IP and try to get correct QR code.
The default server port is 8888, if the port is in use by other software, user should click
“Web Server Control” item of “Monitor” menu to open “Web Server Control” dialog, and
change port to make sure APP function work normally.
If user sets “Auto Connect” as “ON”, the server address won’t be re-input after the first
time. If “Auto Connect” is “OFF”, the server address should be re-input when user wants to
use APP again.
Click the “Language” item to change the language.
Click UPS name in the UPS list (refer to figure 3.6.3.4), the real-time data about the
UPS will be shown. The detail information includes UPS input, output, battery parameter and
UPS status. Please refer to figure 3.6.3.5. User can click “Load” or “Bat” button for detail
information about load or battery.
Click the “Alarm” item on the bottom, current alarm information will be shown.
Click the “History” item on the bottom, history event will be shown. The number of all the
events is no more than 50 in APP. For more history, user should refer to the event log of
software installed on server.
Click the “Control” item on the bottom to operate battery quick test. Please refer to figure
3.6.3.6. For local UPS, user should input the password of agent and then set battery test,
please refer to section 3.1.1 to get the default password. For SNMP UPS, APP will link to the
SNMP test page for setting battery test.
When the UPS event occurs, there will be APP message notification pushed on user
phone. About APP message notification function, user needs to set the phone to enable
notification message sent and allow the APP software to run in the background.
For example, Huawei mate 8 mobile phone with Android 6.0 OS, users need to set as
the following figures.
3.7 SNMP centralized monitoring
The SNMP centralized monitoring function can monitor the status of UPS with SNMP
card located in different regions. Even if user is thousands of miles away, when the abnormal
event of UPS happens, software will inform user of the abnormal event by sending SMS, E-
mail, pop-up warning dialog. Thus, user can keep abreast of UPS status and prevent the
damage caused by UPS abrupt shutdown.
Notice: software only can monitor the status of UPS with SNMP card, it can’t shut down
UPS output and shut down computer. When user wants to control UPS or protect computer,
please refer to the user manual of SNMP card to learn the setting.
Figure 3.7
Figure 3.7.2
Input geographic location information in “area” text box, where UPS with SNMP card
located at, such as Beijing, Shanghai and other location.
User can select SNMP node, and click right mouse button to select “Add area”. There
will be a dialog box pop-up as figure 3.7.2, so you can make the area added.
After adding area successfully, the area name will be shown below the SNMP node in
the tree diagram. Select area name and click right mouse button, user can modify or delete
area. Of course, user can also select the “Modify area” or “Delete area” item of “SNMP”
menu to modify or delete area.
Figure 3.7.3.1
When the UPS is added successfully, the communication with software is OK. Select the
UPS name, you can see the UPS flow diagram, and the detailed parameter information of
the UPS, please refer to figure 3.7.3.2.
Figure 3.7.3.2
Select the UPS name, and click the right mouse button, user can modify or delete UPS.
Of course, user can also select the “Modify device” or “Delete device” item of “SNMP” menu
to modify or delete UPS.
Click the link in the UPS list, linked to the monitored SNMP Card Web, please refer to
figure 3.7.3.3.
Figure 3.7.3.3
3.7.4 SNMP event log
Act as SNMP Administrator, click “SNMP Event Log” item of “SNMP” Menu, there will
be a dialog box pop-up. Please refer to Figure 3.7.4.1.
Figure 3.7.4.1
Click “Export” button to export all alarm event.
SNMP event record maximum length can be set. Act as SNMP Administrator, Click
“Event Log Setting” item of “SNMP” Menu, there will be a dialog pop-up, as Figure
3.7.4.2. The default value is 5000, Maximum can be set 100000.
When the record exceeds the maximum, Software will delete the oldest event to
record a new event automatically.
Figure 3.7.4.2
3.7.5 SNMP Trap Receiving Port Setting
Click “SNMP Trap Receiving Port Setting” item of “SNMP” Menu to open “SNMP
Trap Receiving Port Setting” dialog. User can set SNMP trap receiving port. The default
port is 162.
Figure 3.7.5
3.8 Preference
3.8.1 Temperature unit
User can select temperature unit according to personal habit, click “Temp” item of
“Preference” menu to select: Centigrade (C) or Fahrenheit (F).
3.9 Language
Software supports three kinds of languages: “Chinese(Traditional)”,
“Chinese(Simplified)”, “English”, user can change language via “Language” menu.
3.10 Help
3.10.1 Online help
Click “Contents” item of “Help” menu to open the description about software, user
can refer to the detail information of software.
3.10.2 Version
Click “About” item of “Help” menu to refer to the software version and released date.
When user has something wrong with the communication between software and UPS,
user can tell customer service engineer about software version and released date.
Chapter 4 Frequent questions
4.1 How to do if software port is in use by other software
Sometimes the software manager interface stops at 9% fail to be started, that means the
RMI port TCP 2099 is in use by other software, so software manager can’t be started
normally. If software manager fails to be started because of port in use by other software,
software will try to use new port to start when port is in use by other software, and write the
new port in portConfig.rmi file. At the same time software will inform user that old port is in
use by other software, please exit software and restart. User should click “OK” button and
wait the software icon disappear, then restart software, software will read new port from
portConfig.rmi and start normally. Another way, user also can modify port by editing
portConfig.rmi file located in c:\Program File\software install file.
▲ These ports software uses are TCP port 2099, UDP port 2198, 2199, 2200,1824,
161 and 162. Http port 8888.TCP port 2099 can be modified manually. Other UDP port
can’t be modified. Port 2198, 2199, 2200 is used for remote management, if these ports
are invalidation or in use by other software, the remote management function will be
invalidation. Port 1824 , 161and 162 is for SNMP management function. Http port 8888
is for webserver function and APP function.
Figure 4.2.1
Figure 4.2.2
For remote computer without communication with UPS: If there are more than one UPS
supplying power to the remote computer with software, you want to safely shut down or
suspend the remote computer before all UPS can’t supply power to the remote computer.
You should configure the software installed on the remote computer to be shut down by
another computer, refer to the following figure 4.2.3, and in the “shutdown settings” dialog of
another computer with software communicating with the two UPS to shut down the remote
computer, the shutdown condition of each UPS should be set separately, refer to the
following figure 4.2.4 and 4.2.5. The remote computer won’t be shut down or in suspend
mode until all the condition of all UPS is met.
Figure 4.2.3
Figure 4.2.4
Figure 4.2.5
4.3 The communication between UPS and software on Debian Etch Stable
Core 2.6 18-5-486
Question:
UPS can’t communicate with software on Debian Etch Stable Core 2.6 18-5-486
Method to fix it:
Here are the procedures to solve this question:
First: Login in Debian as root, the permission of general user is limited to install software.
Debian refuse to login as root, some special settings is needed.
Please note:
a. In the login interface, there are three icons: “Language“, “Session“, “Action“, choose
“Action”
b. Choose the last icon of “configure the login manager” in the dialog pop-up
c. Choose the icon of “security” in the dialog pop-up
d. Choose “allow local system administrator login”
Second: Input the user name of root and the password, and then install monitoring
software manually. Use the command “./agent start” to start software service, and then use
the command “./monitor” to start the monitor interface.
Finally: Copy the document of s99UPS from Linux (attached CD) to /etc/rcS.d,
The file s99UPS is used to start software service automatically. When the computer
reboots, software service will be started automatically, user only need to start the monitor
interface by the command “./monitor”.
Please note:
a. If the third step is executed, no matter what the user login in as root or a general user,
the communication with UPS will be successful.
b. If the third step have not been executed, you should login as root, and use the
command “./agent start” to start software service. If login in as a general user, the
communication with UPS will be failed
4.4 The communication between UPS and software on RedHat Core 2.6 9
Question:
UPS can’t communicate with software on RedHat Core 2.6 9
Method to fix it:
Add the word of “none /proc/bus/usb usbdevfs defaults 0 0” to the document “/etc/fstab”,
software will find the UPS when choose the item of “Auto Search Device”.
4.5 Mac 10.5 with terminal interface opened can be shut down normally
Question:
Mac 10.5 OS with the terminal interface opened can’t be shut down normally by
software. The information is shown as the following figure.
2. Enter the installation path, start the interface of UPS monitoring software
with the command “manager”. Software interface will be shown as
following picture.
Installation
This section provides information about installing and configuring Software on a VMware
server and installing VMware Tools on a guest operating system.
Prerequisites
VMware ESX Server with 125 MB free space for the software.
VMware Infrastructure client must be installed on different machine.
Software Installation
To install the software:
1. Download the software from the Web site or from the CD provided with the UPS.
2. Enter the command to install software:
▲ For the CD installation, enter the command:
mount /dev/cdrom /mnt
cd /mnt/Linux
./setup_console.bin
▲ For the download installation, enter the command:
tar –zxvf Winpower_setup_Linux.tar.gz
cd /mnt/Linux
./setup_console.bin
3 Start the Agent. From the installation path, enter the command:
./agent start
OK indicates that
VMware Tools are
available
Configuration
This section explains configuration for the Software and for the VMware server.
Software Configuration
The VMware server works in console mode and can’t be used for configuration. Use a
remote agent with the same software version to configure the VMware server.
1. Start the manager interface on the remote software Agent in the Microsoft Windows
operating system.
2. If the two Agents are in the same LAN, the VMware server client will be added to the
topology automatically. Otherwise, add the Agent manually (select Monitor Remote Device
from the Monitor menu). The software will auto search the UPS when the Agent starts for the
first time after installation.
If the search fails:
▲ Select the VMware Server Agent from the tree view.
▲ Acting as the Administrator, select “Auto Search Device” from “System” menu. The
UPS connected with VMware server appears in the LAN tree view.
3. Select Shutdown Settings from the Device menu. Set the battery backup time, and
select the Begin Shutdown Immediately if Battery Low check box and the Run Command File
before Shutdown check box (refer to the following figure).
VMware Server Configuration
All hardware elements must have an operational network configuration that allows them
to communicate freely with each other. Software uses TCP and UDP for communication with
UPS.
1. Confirm that the following UDP ports are opened on the ESX server Firewall:
2198, 2199, 2200
2. Confirm that the we following TCP ports are opened on the ESX server Firewall: 2099
For Example:
esxcfg-firewall -o 2198,udp,in,UPSMS
esxcfg-firewall -o 2099,tcp,in,UPSMS
3. If you want to disable the firewall permanently, enter the command: chkconfig iptables
off
4.To disable the firewall temporarily, enter the command: service iptables stop