Monitoring the Battery of a UPS

Scenario: You can configure Desigo CC to monitor the battery status of a connected uninterruptible supply (UPS) using the WMI (Windows Management Instrumentation) service.

 

Reference: For background information, see the reference section.

 

Workflow diagram:

 

 

Prerequisites:

  • Desigo CC is connected to an uninterruptible power supply (UPS) that supports the WMI Windows Management Instrumentation (WMI) protocol.
  • System Manager is in Engineering mode.
  • System Browser is in Management View.

 

Steps:

1 – Create the WMI UPS Object
  1. Select the station that you want to use to monitor the UPS using WMI at one of the following paths:
  • Project > Management System > Servers > Main Server
  • Project > Management System > Clients > [Client station]
  • Project > Management System > FEPs > [FEP station]
  • The System Management tab displays.
  1. Click New and select New WMI UPS.
  1. In the New Object dialog box, enter a name and description.
  1. Click OK.
  • The new WMI UPS object is added to System Browser.

 

2 – Configure the WMI UPS

Method 1 – Import UPS Configuration Settings from a File

  • An XML file containing the configuration data for this UPS is available in the following project folder: [Installation Drive]:\[Installation Folder]\[Project Name]\devices.
    For details on how to create such a file, see step 4 – Export a WMI UPS Configuration to a File, below.
  1. Under one of the following paths, select the WMI UPS object that you want to configure:
  • Project > Management System > Servers > Main Server > [WMI UPS]
  • Project > Management System > Clients > [Client station] > [WMI UPS]
  • Project > Management System > FEPs > [FEP station] > [WMI UPS]
  • The System Management tab displays.
  1. Click Import .
  1. In the Select device to import dialog box, select the XML file that corresponds to the appropriate device version. Then, click Import.
    NOTE: If the properties names in the XML file do not match those of the WMI UPS object, the Combines the properties dialog box displays and asks you to align them:
    - Select the correct matching, and click Import.
  • The configuration data is copied from the file to the WMI UPS object.

 

Method 2 – Manually Enter the UPS Configuration Settings

  1. Under one of the following paths, select the WMI UPS object that you want to configure:
  • Project > Management System > Servers > Main Server > [WMI UPS]
  • Project > Management System > Clients > [Client station] > [WMI UPS]
  • Project > Management System > FEPs > [FEP station] > [WMI UPS]
  • The System Management tab displays.
  1. Open the General Settings expander, and complete the following fields:
  • Class name
    NOTE:
    If you do this configuration from a station that is not the Desigo CC server station (for example, from a client or FEP station), when you select the class name, the Server parameters dialog box displays.
    Enter username and password of the Windows user who has the rights for the computer where the WMI UPS is configured and then click OK.
  • Device ID
  • Vendor and type
  • Version
  • (Optional) Enter your remarks in the Notes field.
  1. Click Save.
WMI UPS Device: General Settings
  1. Open the Properties expander.
  1. For each property in the list:
    a. Select it and configure the Property name.
    b. (Optional) Select the Matching values option, and enter the appropriate numeric value.
    c. Click Save.
WMI UPS Device: Properties

 

3 – Check the Battery Status of a Monitored UPS

Once Desigo CC is configured to monitor a UPS, you can check the status information of the monitored peripheral.

  • Select the WMI UPS object whose battery status you want to check. It will be located at one of the following paths:
  • Project > Management System > Servers > Main Server > [WMI UPS]
  • Project > Management System > Clients > [Client station] > [WMI UPS]
  • Project > Management System > FEPs > [FEP station] > [WMI UPS]
  • The Operation tab displays the battery status information of the monitored UPS. (For example, Battery Status, Battery Capacity, Battery Temperature, Battery Runtime Remaining).

 

4 – Export a WMI UPS Configuration to a File

Once Desigo CC is configured to monitor a UPS, you can export the configuration data for this UPS to a file for later reuse.

  1. Under one of the following paths, select the WMI UPS object whose configuration you want to export:
  • Project > Management System > Servers > Main Server > [WMI UPS]
  • Project > Management System > Clients > [Client station] > [WMI UPS]
  • Project > Management System > FEPs > [FEP station] > [WMI UPS]
  • The System Management tab displays.
  1. Click Export .
  • The configuration data is exported to an XML file which is saved in the [Installation Drive]:\[Installation Folder]\[Project Name]\devices folder.
    The naming convention for the exported file is: [class name].[Vendor And Type].[Version].[Device Type].