
|
LetzKey I/O-UPS Event Monitoring Software This software is guaranteed Adware, Spyware and Malware-free. Online Manual Table of contents : 1. Introduction to LetzKey I/O-UPS Event Monitoring Software 1.1 What is this software ? 1.2 How does this software work ? 1.3 This software can be used as a subscription license or as freeware. 2. Who can benefit from this Software ? 3. Configuration requirements. 4. Installation. 5. The I/O-UPS Event Manager. 5.1. Registered Mode (full functions). 5.1.1 Login. 5.1.2. Emergency Screens. 5.1.3. USB and/or Serial Port Configuration. 5.1.4. I/O Card Settings and Weather Device. 5.1.5. The Embedded Dedicated Web Server. 5.1.6. Remote Configuration : View and Edit functions. 5.2. Remark concerning the Weather data logging. 5.2.1. Explanation of Averages display. 5.3. Freeware Mode (limited functions). 6. How to customize the software configuration. 6.1. The main configuration file. 6.2. The Emergency Process file. 6.3. The Restart Process file.
1. Introduction to LetzKey I/O-UPS Event Monitoring Software. 1.1 What is this software ? This software allows to monitor locally or remotely one I/O card, one Trust Uninterruptible Power Supply (UPS), one Oregon Weather Device and other devices as a webcam. This product permits configurable responses to status changes. Users can connect one or several of the described devices, allowing to make a full configuration with these devices, a " mix " of these devices, or only one of them. For example, if users connect only a UPS to this software, it will only check the UPS states. If users connect only a weather device with anemometer and thermometer, the software will act only as a weather station monitor. Other example : users can connect a weather device and an I/O card which allows to drive external devices as cooling systems, etc. Other simple case : users can also connect only an I/O card. In this case, the software will allow to remotely set ON/OFF some functions. The full configuration allows interaction between all connected devices in order to provide many applications. 1.2 How does this software work ? This software on a host computer communicates with a Trust UPS using its USB or RS-232 serial port to detect power failures. It can also communicate with a VM110 USB Input/Output card from Velleman and with a Oregon Weather Station connected to the computer via USB. The software can also use pictures taken by a camera for remote visual monitoring of any process or place. Users can define an appropriate emergency process in case of a power failure and an adapted restart process that will be launched after a user-defined delay allowing to make sure that the power situation is stable again. Users also can, if an I/O card is available, define different alarms/actions according to temperature, humidity and wind speed user-defined values. The I/O card allows to add emergency and restart switches allowing to activate the emergency and restart processes instantaneously, thus avoiding to switch to a specific screen, move the mouse, etc. This function is provided on top of the automatic user-defined power failure processes supported by the software. For example, imagine you have been warned that a power cut (of any kind) is going to happen and you consequently wish to launch your defined emergency process without waiting for the power cut to occur. You then have the possibility to use the switches via the I/O card (and their replicates everywhere you installed them) or you can go to the screen where the I/O-UPS Event Monitoring Software is available and click the " Emergency " button in the Windows application. This low-cost VM110 I/O card is a very interesting add-on in our monitoring concept. We very strongly advise to use it whenever it is possible. We also invite you to connect to the software a low-cost Oregon Weather Device (for example a WMR100 - all versions) having a USB port. This Weather Station can be used in order to monitor temperature and humidity values in your computer room or in different rooms, since up to 10 sensors can be added. In this case, the software will use the temperature and humidity as environmental data but if you add the available Oregon anemometer in order to measure the wind speed, the software will use Oregon Weather Device data as real weather data. Moreover, the data are logged everytime, day by day, for later reuse. All these possibilities, when assembled according to your needs, allow a full remote environmental, power and visual monitoring which includes many information, up to the wind direction or the humidity of a specific spot. The UPS can then be used to guarantee access to the weather device data, which is another way to look at our monitoring concept. In the same context, the environmental data as temperature or humidity can allow to supervise the UPS and its connected PCs. Indeed, for example, in case of superheating in your computer room, the I/O card can start a fan or any cooling device. Then, this software allows multiple configuration possibilities, inside your computer room or outside your office, in other remote sites where the data are collected. You can connect one out of the 4 described devices, or all of them, according to your specific needs, and this for a very low investment. This software can perform cross-monitoring between the devices, the offered monitoring is then open and easily configurable. It is very difficult to imagine all possibilities which can be covered by this event monitoring software, but let’s take another example : you have to monitor your own windmill producing electricity. You wish to know the weather conditions as outdoor temperature and humidity, and wind speed (thanks to an anemometer) but you also need to check if there is no superheating of the rotor or other parts of your windmill. Install any (up to 10) low-cost temperature sensor you want, all of this being connected to a PC having an Internet access. Our software will allow you to access these data remotely, it provides you with security actions to take according to your definition, and the low-cost UPS will be used in order to guarantee an uninterrupted functioning of the installation. This example is totally different from another possible application, which is to supervize computers in a rack, acting as web servers, where anemometers are unnecessary... Though... in this last case, without kidding, you can put an anemometer in front of a fan in order to check if it is functioning. Security prevails... Since a whole range of parameters are available, as below a minimum value or above a maximum value, you are able to drive any external device as again for example an electric fan, in a room that has to be ventilated. The fan can be set ON when " natural " ventilation is unsufficient. In this case again, the anemometer can be used in relation with the Weather_Wind_Min_Alarm threshold parameter (see below, paragraph 6.1). 1.3 This software can be used as a subscription license or as freeware. If you want to try this software before you subscribe, or if you intend to use it as freeware with only limited functions, just install it on your PC, connect your UPS, the optional camera or I/O card, and one optional Oregon Weather Device, and you are ready. You even do not have to configure the software, since default parameters are there to start quickly. If you choose to subscribe and to become a registered user, all software functionalities will be at your disposal and you will be able to manage several configurations thanks to LetzKey’s Bridge Web Server application which is an application allowing to supervise multiple configurations in your network. All functions available in this software can be reached : - From within the software itself - Via the Internet Browser of your choice (Internet Explorer strongly advised) running on the PC where you installed the software (not available in Freeware mode) - Through a remote Web Browser (Internet Explorer strongly advised) running inside or outside of your private network. In this case, the included Dedicated Web Server must be accessible from the Internet (not available in Freeware mode). The Freeware mode does not allow to use the included Dedicated Web Server and the user-defined Restart process must be launched manually, while the Emergency process starts automatically in case of power failure. In this mode, the LetzKey Bridge Web Server cannot be used since unregistered users may not be supervised by this software. 2. Who can benefit from this software ? Any computer user, from the person with a single computer to the business with a multiple network system or the data center, can protect valuable data using a Trust UPS and/or an Oregon Weather Device, and this program to monitor them and define different and independent actions to perform in the event of status changes. The LetzKey supervision function (LetzKey Bridge Web Server) allows an IT person to supervise remotely, from everywhere (as soon as an Internet access is available allowing to reach LetzKey Bridge Web Server), all the disseminated configurations. The provided programs allow to check locally and remotely the devices’states from time to time and even to take action when necessary. Events or weather data are continuously logged. 3. Configuration requirements. Software : Windows 2000 minimum or later version Internet Explorer 5.0 minimum or later version An Internet access for login/logout (not mandatory but strongly recommended ; otherwise, only freeware mode is allowed) Hardware : A free USB or serial Port (RS-232) on your PC where a UPS can be connected (see below) One, two or three additional USB ports where the I/O card, the camera and the Oregon Weather Device will be connected An optional Trust PowerMaster UPS PW-4120M 1200 VA or other models having an USB or RS-232 interface A USB-VM110 I/O card from Velleman (optional) An optional Oregon Weather Device (for example, WMR100 – all versions) 4. Installation. You can download the software from LetzKey’s web site. There are two available versions : one being a .ZIP file, the other being an auto-extractible file which is a .EXE file. If you download the .ZIP file, you can unzip it in the directory of your choice (for example C:\UPS). It is provided with a subdirectory structure that you also have to install. If you download the .EXE file, save it in the directory of your choice (for example C:\UPS) and start the .EXE file afterwards. The installation will happen automatically with the creation of necessary subdirectories. In both cases, the provided default parameters allows to start the application from within any disk and directory where the software has been installed. To customize the software according to your needs, please refer to part 6 of this manual : How to customize the software configuration. When the software is installed, you can start the application by launching the file named WS_IO_UPS_Check.exe The K8055d.dll is a file used by the I/O card, and delay.exe is a simple program that can optionally be used in the emergency and restart procedures.
5. The I/O-UPS Event Manager. 5.1. Registered Mode (full functions). 5.1.1 Login. First of all, the software can be used in two modes : the first one is the registered mode, which will be explained here below, and the second one is the freeware mode which is explained in chapter 5.2 of this manual. If you choose to use this software as a registered user, you must first of all subscribe in order to obtain your User-ID and Password allowing you to log in. After your registration, when you start the software for the first time, it will suggest you to start with the User-ID and Password being both " FREEWARE ". Then, simply replace them by your own User-ID and Password that you obtained from us. You can click on the " Login " button or let the software start automatically after a 2-minute delay (autostart mode). The Autostart/Autologin mode will be automatically selected by the software everytime the software starts as soon as the User-ID and Password are different from " Freeware ". This possibility allows to let the software start automatically and log in without any intervention. After this first step, the application terminates its initialization and starts communicating with the UPS, the optional Oregon Weather Station and the optional I/O card if they are connected. You will see the following screens appearing one after another after your login. Depending on the defined parameters, the application will hide or not after your login. The software will then be minimized in the Windows tray, but it will pop up in case of emergency in order to show you that a problem was detected.
Depending on the settings you chose, the software will ask you or not to enter your User-ID and Password if you try to log manually. No User-ID and Password will be asked when the software starts and during the automatic login which is launched immediately if the User-ID and Password are different from " Freeware ".
5.1.2. Emergency Screens. Here follow the screens that appear in case of UPS Emergency, before and after it. There are several possibilities for the Emergency process to start : - When a power failure occurs - When the user clicks on the " Launch Emergency Application " button on the bottom of the screen - From the included browser using the button reserved for this action - From the Internet with a browser thanks to the Dedicated Web Server included in this application
On the left part of this split screen, you can see the Event Log if something occured. You can clear the Log File using the " Clear Log File " button. At any time the software will show its States. Alarms are clearly explained and when you see one on the screen, the emergency process has already been launched by the software. During " normal " functioning time, the software will show the States of the UPS and other connected devices. Attention : in this case, the information displayed is not real-time. You must refresh the screen using the button dedicated to this task, you can also ask the software to refresh this information automatically every 2 minutes. Please note that when an environment/weather alarm occurs, it is also displayed on the left side of the first screen. If an I/O card is connected, the outputs will be set On or Off according to these alarms and their associated parameters.
5.1.3. USB and/or Serial Port Configuration The software must know on what communication port you have connected your UPS. The Serial Port Configuration dialog box will appear automatically the first time you will run the application, even if you have connected your UPS to the PC via USB. The software gives priority to the USB interface, which means that if you connect your UPS to the USB port of your PC, the software will detect it as a " Plug and Play " device and will immediately start to communicate using this USB port. If you disconnect the USB port while still having connected the UPS via the RS-232 port, the software will then switch to this alternative configuration. After this, if you reconnect the USB UPS port to the PC, the software will switch again, and so on. If possible, we advise you to use preferably the RS-232 port, since it leaves the USB port free for another device as the I/O card, the weather device and the Web camera. Anyway, we have designed the possibility to switch automatically from USB to RS-232 and vice versa. Do not hesitate to use this feature where possible. We strongly advise to use both connections at the same time, RS-232 and USB, but this is of course not mandatory. You can choose the connection you want. If there are not enough USB ports, we invite you to use the RS-232 port for the UPS. If the detection of the USB port connection to the UPS and Oregon weather device is automatic, there isn’t any setting for this since it is a Plug and Play interface. You just have to plug the USB cable to the PC. However, the RS-232 port where the UPS is connected is not detected automatically, then at any time you can define the COM port by clicking on the " Setting " button in the bottom left of the screen. Do not modify the communication parameters (Baudrate, etc.) in case of a Trust UPS since the default parameters correspond to this UPS device. Even if you do not want to connect your UPS via RS-232, you still have to define a default COM port. In this case, we invite you to select the first COM port available as the default one. In order to connect your UPS and the other supported devices to your PC, please refer to the manual provided by their respective manufacturers.
5.1.4. I/O Card Settings and Weather Device. Concerning the Oregon Weather Station, just plug the USB cable of the device into your PC and it will be automatically detected as a plug and play device. You will still have to define several parameters as the number of sensors available, your weather alarm thresholds, etc. Please refer to paragraph 6.1 of this online manual. Concerning the optional VM110 I/O card from Velleman, there is a special dialog box which can be reached by clicking on the " USB I/O Board Setting " button on the bottom of the screen. For more information about this card, please refer to the VM110 manual provided by Velleman. The I/O card must be properly connected through the USB interface using a USB cable between your PC and the I/O card.
The first thing to do is to select the card address using the SK5 – SK6 check boxes which must be identical to the setting on the I/O card. When the address is selected in the dialog box, click the " Connect " button. At this time, you can use the Inputs/Outputs. Input 1 is reserved for launching the emergency process. You can put a switch connected to this Input in order to start the emergency process as explained above. Input 2 is reserved for launching the restart process. You can also put a switch connected to this Input in order to start this process. Input 1 and Input 2 are connected to the Counter 1 and Counter 2 of this card. These Counters are used as Debouncers. The 2 milliseconds delay selected by default is a good choice in most cases. You possibly can select 10ms but not above. Do not select the 0ms delay. Concerning these 2 switches, we invite you to refer to the VM110 I/O card manual in order to know how to proceed. In this version of LetzKey software, analog Inputs are not used in order to launch any process. This possibility will be studied in the future.
Outputs 1 to 6 can be used at will if no UPS and/or weather device is connected. You can check them all or only one in order to define another external process as " System ON " or " System OFF ". If a UPS and/or a weather device is connected, Outputs 1 to 8 are programmable for these devices. Output 6 is normally reserved for the UPS. Please refer to the 6.1. The main configuration file paragraph for the definition of these Outputs. Normally, Outputs 6 up to 8 are reserved by the software in order to blink in case of emergency. There are two blinking modes allowing to discriminate between a manually launched emergency and a power failure emergency. In this last case, all 3 Outputs are blinking simultaneously. In the other case, they blink alternatively. If you use the weather alarm features and program an Output to set ON in case of alarm, you can program the Output you want to use according to the weather alarm type. You can program any Output (1 to 8) for a specific alarm, because the weather alarms have the priority over all other functions. This means that if you program, for a weather alarm, the Output 6, there is no available alarm for the UPS which is able to use only this particular Output. In the same context, if you use Outputs 7 and 8, the blinking modes will not be available anymore. You can put any device (as a burglar alarm or a light for example) on Output 6, normally reserved for the UPS, but you can define any Output to switch ON any external device corresponding to the selected alarm matching your requirements. To do this, we invite you to refer to the VM110 I/O card manual in order to know how to proceed. Outputs 7 and 8 are used as described hereafter. There is another option called " Digital Output Test " with a dedicated button on the left. If you select this option you will see that Outputs 7 and 8 will blink one after another, from left to right. Again, this option allows to see if the software is up and running because this feature is a special task in the application. This option can be used as a visual " Watchdog ". If you use Outputs 7 or 8 for an external device, only the free one, or none of them, will blink according to this option. Remember that the weather device alarms have the priority over this function. For all weather alarms, you also can program their duration (timeout) after alarm conditions disappear. This I/O card is a very interesting option which cleverly completes the security of this software solution. Moreover, this card is very affordable.
5.1.5. The Embedded Dedicated Web Server. If you are a registered user, one of the features offered by this software is a Dedicated Web Server available directly from within the application or from other parts of your network using a browser or from the Internet if this Dedicated Web Server has a published Internet name pointing to the IP address and Port of this Web Server. The Main Menu allows to make nearly everything that is allowed by the software, but remotely (from another PC in your network or from the Internet). From this main menu, you cannot access to the settings of the application. However, there is an option allowing to modify the I/O card settings remotely (see below for explanations). As you can see on the screenshots below, this Main Menu allows you to log in or log out. You can also view the log file and clear it. You can acess the status of the UPS, Weather Device, Camera and I/O card from the place where you are using your browser. Depending on the settings you chose, the software will ask you or not to enter your User-ID and Password if you are using the included access to the Dedicated Web Server. However, the software will always ask you to enter your User-ID and Password if you access the application through the Dedicated Web Server from another place of your network or from the Internet. We strongly advise you to use the Microsoft Internet Explorer browser to access this Dedicated Web Server because the generated web pages use HTML tags which are not always supported by other browsers. For example, we have noticed that the Main Menu here below does not display the same way when using the Mozilla FireFox browser. Then, you can use another browser than IE but at your own risks.
As you can see, nearly all the software functions are available remotely in the registered mode. Important remark about this Dedicated Web Server : this function can also be used as a real web server since you can add your own or customized HTML pages with pictures, forms, etc. Indeed, there is a directory used by the software where you can put your web documents. For example, you can customize a page named states.html which will allow you to show the UPS states, Weather Device states, I/O card states and pictures (taken by the camera) another way than the default one. This included Web Server can also do more than just publish HTML pages on the web. It is also compatible with the CGI-WIN definition which allows to add and use CGI-WIN programs. We provide at the installation an example.html file which is placed in the ...\WebServDir\Doc\ subdirectory and a file named state._html which is a base allowing you to create your own state.html page (attention, you must use exactly the same syntax as the one included in this file, otherwise the software will not understand this file). We also provide at installation time in the ...\WebServDir\cgi-win\ subdirectory a file named WebSrvCGI._exe which is a demo CGI-WIN program. If you want to use it, you must rename it to remove the underscore and get the name as follows : WebSrvCGI.exe. This is to avoid use of this file without your agreement. In the example.html page, there is a link to use the demo CGI-WIN program. In order to use it, you must edit the example.html file and add the URL to your Dedicated Web Server. Otherwise, you will get the 404 cannot find server message... As you can see, this software also offers the possibility to make your own basic Web Server which is also dedicated to the supervision of your UPS device(s) and/or Environment Data/Weather Station.
5.1.6. Remote Configuration : View and Edit functions. Through the included Dedicated Web Server, you also can view the different parameters of the software. In this framework, it is possible to see the configuration file which is used at login time, the I/O Card settings and the Emergency and Restart procedures files. You can also remotely view the different login and initialization steps. It is very interesting to be able to check remotely what is the current state of this application. Moreover, we have added the possibility to remotely modify these parameters, but you must use this option very carefully to avoid any misuse or abuse of this feature. We advise you not to use this option, except for a very short maintenance delay (a few minutes). In all cases, somebody must be available locally to allow and disable this function as soon as possible. You will then use this option at your own risks. This option also allows to modify remotely the Emergency and Restart processes which are DOS batch files where you can put your own Emergency and Restart procedures. This is where the risk exists if someone with bad intentions could access these files. Indeed, it is possible to put any DOS command as delete etc. in these batch files and this could damage your Windows configuration.In order to avoid this risk, you can set the emergency.bat and restart.bat batch files in read only mode. In this case, nobody will be able to modify them remotely after the definition of the tasks to perform in case of power problems. We strongly advise you to setup the application locally and not remotely, but the remote setup option exists. Its use is not mandatory at all. You will take all responsibilities when using this options. If you want to use this remote setup option in spite of our warning, we have designed a special password-protected access. In order to view and edit the setup, you have to enter " view " as the User-ID and as Password exactly what follows : yourpassword+machinename:webport where yourpassword is your registration password where machinename is the Windows name of the PC where the software is running where webport is the Web Port where the software is listening for connection For example, you will have to enter " view " and " t23xyz51mypcname:90 ". After the edition of the configuration files, you will have to enter another password if you try to save remotely any modification. The User-ID will be " update " followed by a password exactly as follows : machinename:webport+yourpassword where all elements are the same as explained above. This way, the protection to access and modify remotely the settings is higher because nobody other than you knows both your registered password and the Windows name of your PC. The person who knows this information could only get it from you. The same way, the URL address of this Dedicated Web Server is defined and known by you. This makes an unwanted access very complicated and then at low-risk while keeping in mind that this remote edit and save option must be carefully used. Here follow screenshots of these remote View and Edit-Save possibilities :
You can also access this Online Manual and the License Agreement from the included browser.
5.2. Remark concerning the Weather data logging.
When the program starts, it begins to log the data coming from the Weather device after a maximum delay of 2 minutes. The generation of the HTML Averages pages will also start after this delay. Then, alarms concerning weather events will be functional after the same delay. After this starting sequence, logging of weather data will be done day after day in different files. There are 2 types of logging files : " LOG " files : These files contain all elements sent from the Weather device as soon as they differ from each other (this allows to keep files as small as possible while the weather device continuously sends identical data). For example, if the current temperature is of 19°C at T=0 and remains the same until half an hour later (T=1), and if at T=1 the weather device indicates that the temperature is of 10,2 °C, only this new event will be logged since there is a difference between these values. The same concept applies for all other weather data. The values in these files are not averages but ‘real-time’ ones. This allows to retrieve a specific event at a specific hour / day / year, manually by displaying the file contents, or via another application of your choice able to ‘understand’ the format of these files. " STA " files : These files contain average values (only temperature, humidity and barometry are concerned). They are used as a basis for the HTML Averages pages, but the format of this file is not real HTML. Indeed, there are different tags which are not HTML compatible. These files can be used only by means of this application. The averages are calculated on a five-minute basis, which represents a sample containing the averages of all events received over this period of time. Then, for one hour, there are 12 average samples. Averages are re-calculated hour by hour, so that 24 samples are available for a specific day. Important remark : do not modify the contents of the STA files or the display of these files through this application or averages can be damaged and unusable ! You can backup these files for security purposes. See the Weather_Log_Path parameter for files location. The different alarms available use real-time values and not the average ones, because average values move slowlier. Then, an alarm can start even if the average is below the defined alarm threshold. The different LOG files are only generated if you are a registered subscriber, which means that under the Freeware mode, only ‘real-time’ weather data are displayed on the main window of this application. 5.2.1. Explanation of Averages display. Average results can be displayed using your web site thanks to the Embedded Web Server included in this application. Moreover, the average results can also be displayed directly within this application. To reach these average results, go to the main menu of this application in your browser, for example, click first on the ‘UPS I/O Card States and Weather Data’ button. After that, in the ‘Environment/Weather Data’ box, click on the ‘Averages’ button. By default, the displayed average is the current one, but you can select another day as soon as weather data exist for this day. You can do the same by selecting another month or even another year. You can also define which data you want to see by selecting or not the temperature, humidity and barometry. Last but not least, you can choose to display all sensors data on the same page or only a specific one. The application also allows to look back on all averages of a specific month or the current one. The same possibility exists to display, month by month, all data of a specific year. Functions ‘all days’ and ‘all months’ bypass the day and month selection. In order to ease this selection, you can access directly the current weather data of a specific device by clicking on one of the yellow boxes in the ‘Current Weather Data’ window. For example, if you click on the yellow box named ‘Indoor Barometer’, you will see only the current average of this device. There is also a self-refresh function which is launched automatically every 6 minutes as soon as current day is selected. This self-refresh function is not available if you select the ‘all days’ or ‘all months’ option. This function is practical to overview the weather evolution over the current day.
5.3. Freeware mode (limited functions).
If you choose to use this software as Freeware, its use is then more " basic " since you do not have to log in. When you start the software for the first time, it will suggest you to start with the User-ID and Password being both " FREEWARE ". You can click on the " Login " button or let the software start automatically after a 2-minute delay (autostart mode). After this first step, the application terminates its initialization and starts communicating with the UPS, the optional Weather Device, the optional camera and the optional USB card if they are connected. In Freeware mode, the application does not display the I/O card states nor the environment/weather data in the right part of the split screen. Also, the included Web Server is not available. Last but not least, after a power failure, the restart process must be launched manually. However, in case of power failure the emergency process will start automatically. The software will show advertising in this Freeware mode. However, this application is guaranteed Adware, Spyware and Malware-free. The advertising is banner displaying in the bottom left part of the screen application. If you do not want to see advertising, you must subscribe and you will then be able to use this software as a registered user (see above).
Here above you can see the main application screens in Freeware mode.
After the login, the software will be operational and detect power trouble, and if a power failure occurs the protections will start. For more details on how to configure the application, please refer to the " configuration " chapter above.
You can see in the bottom left corner the place where advertising will be displayed. You can register at any time using the " Subscribe Now " button.
The screens here below show the other parts of the application in Freeware mode. You can see the Event Log if something occured. You can clear the Log File.
The screenshot on the right shows the Web site header page in Freeware mode. The only allowed action is to log in as a subscriber. It is possible to subscribe from this screen, to see the License Agreement and the Online Manual.
For connection of your UPS and other supported devices to your PC, please refer to the paragraph " 5.1.3. USB and/or Serial Port Configuration " of this manual. In order to connect your UPS and other supported devices to your PC, please refer to the manuals provided by their respective manufacturers.
Concerning the optional VM110 I/O card from Velleman, there is a special dialog box which can be reached by clicking on the " USB I/O Board Setting " button on the bottom of the screen. The explanation of this dialog can be found in the chapter " Configure the I/O Card Board " above.
As you can see, the software is easy to use and runs as a background application while being iconized in the Windows tray.
6. How to customize the software configuration. 6.1. The main configuration file. The main configuration file is named : WS_IO_UPS_Check.CF. It must be located in the same directory as the one where you have installed the software. If this file does not exist, the software uses its default parameters. Here is the default contents of this file : === Beginning of this file === # <-- This character indicates a line in comment! Start_At_Boot=Yes Icon_To_Tray=Yes Minimizing_Delay=5 Local_Login_Password_Required=No Allow_Remote_Config=No WS_IO_UPS_Check_Number=1 Config_Comments=My Comment Alarm_Type=2;email:myname@mycompany.com UPS_Query_String=Q1 UPS_Query_Delay=5 Restart_Process_Delay_After_Emergency=300 Emergency_Application=emergency.bat Restart_Application=restart.bat Weather_Sensor_Number=2 #Weather_Temp_In_Fahrenheit=Yes # In the next lines, syntax must be : # Weather_Type_Min/Max_Alarm=A/Sensor=X/TimeOut=Y/Output=Z # where : # A = MANDATORY; value depending on "Type" # X = MANDATORY for Type=Temp and Type=Humi, NOT existing for other Types; Sensor Number, 1 to 11; # Y = Timeout in seconds, default=60 seconds # Z = I/O card output number, 1 to 8 (6,7,8 are normally reserved for Power Failure Alarm and Watchdog), NO default # Parameters can be avoided, for example : # Weather_Temp_Max_Alarm=22/Sensor=3 (alarm set ON @ T>22° for 60 seconds, NO I/O card output set) # Weather_Baro_Min_Alarm=990/Output=4 (alarm set ON @ Baro=<90mb, I/O card output 4 set ON for 60 seconds) # Weather_Wind_Max_Alarm=5/TimeOut=10 (alarm set ON @ Wind>5m/s for 10 seconds, NO I/O card output set) # IMPORTANT REMARK : # The parameter "/Output=Z" (if used) must be the last parameter without any additional character after it! Weather_Temp_Min_Alarm (°; -50 up to 100)=16/Sensor=1/TimeOut=30/Output=1 #Weather_Temp_Min_Alarm (°; -50 up to 100)=5/Sensor=2/TimeOut=90/Output=1 # ... #Weather_Temp_Min_Alarm (°; -50 up to 100)=5/Sensor=11/TimeOut=300/Output=1 Weather_Temp_Max_Alarm (°; -50 up to 100)=18/Sensor=1/TimeOut=30/Output=2 #Weather_Temp_Max_Alarm (°; -50 up to 100)=15/Sensor=2/TimeOut=90/Output=2 # ... #Weather_Temp_Max_Alarm (°; -50 up to 100)=15/Sensor=11/TimeOut=300/Output=2 Weather_Humi_Min_Alarm (%; 0 up to 100)=35/Sensor=1/TimeOut=30/Output=3 #Weather_Humi_Min_Alarm (%; 0 up to 100)=40/Sensor=2/TimeOut=90/Output=3 # ... #Weather_Humi_Min_Alarm (%; 0 up to 100)=40/Sensor=11/TimeOut=300/Output=3 #Weather_Humi_Max_Alarm (%; 0 up to 100)=65/Sensor=1/TimeOut=30/Output=3 #Weather_Humi_Max_Alarm (%; 0 up to 100)=90/Sensor=2/TimeOut=90/Output=3 # ... #Weather_Humi_Max_Alarm (%; 0 up to 100)=90/Sensor=11/TimeOut=300/Output=3 #Weather_Baro_Min_Alarm (mb; 0 up to 2000)=1000/TimeOut=90/Output=4 #Weather_Baro_Max_Alarm (mb; 0 up to 2000)=1020/TimeOut=90/Output=4 #Weather_Wind_Min_Alarm (m/s; 0 up to 100; ex: 1m/s --> 3.6km/h)=0/TimeOut=90/Output=5 Weather_Wind_Max_Alarm (m/s; 0 up to 100; ex: 15m/s --> 54km/h)=15/TimeOut=90/Output=5 # In the next lines, "[Path:]\YourDir" can be c:\ups_check\.. or \\MyServer\MySharedDisk\.. for example : Weather_Log_Path=[Path:]\YourDir\WeatherDir\ Doc_Path=[Path:]\YourDir\WebServDir\Doc\ Cgi-Win_Temp_Path=[Path:]\YourDir\WebServDir\cgi-win\ Cgi-Win_Exe_Path=[Path:]\YourDir\WebServDir\cgi-temp\ # If you want to display webcam pictures, please select one of the following lines #Visual_Mon_Bottom_Text=<FONT COLOR="#000080"><I>My Comment</I></FONT> #Visual_Mon_Bottom_Text=#INSERT_HTML_FILE:Doc_Path+webcam.html # Next line is an example of Internet URL where your LetzKey Dedicated Web Server can be reached : #Internet_URL=http://myaddress.dyndns.org === End of this file ===
Remarks : - All lines starting by the " # " character are considered as comments. - The software reads the contents of this file as upper case characters only.
Here follows the explanation of each parameter : Start_At_Boot=Yes (Value can be Yes or No) This parameter allows or not the automatic launching of the software at boot. If this option is selected, the software creates a link and icon in the Windows startup menu. Please note that the software does not put anything in the registry. Icon_To_Tray=Yes (Value can be Yes or No) This option allows to iconize the application in the tray or not. Minimizing_Delay=5 (Value must be an integer starting from 0, it is a delay in seconds) This option allows to minimize the application after its start, and after the defined delay. If the parameter is set to 0, the software never minimizes and the user must do it manually. The use of this parameter is to allow the software to show itself at starting and login time and to work in the background afterwards when minimized after the defined delay. Please note that the software will automatically show itself (when minimized) if a power failure happens. This warns the user about a problem. Local_Login_Password_Required=No (Value can be Yes or No) This parameter allows to ask for a password or not when the user tries to log in the software. Please note that the software will always ask for a password when remote logins are requested. Allow_Remote_Config=No (Value can be Yes or No) First of all, we invite you to carefully read the 5.1.6. paragraph concerning remote configuration and its warning about this option, which is critical. This parameter allows to authorize or not the remote modification of the different configurations and emergency/restart procedures. WS_IO_UPS_Check_Number=1 (Value can be any character, alpha-numeric or numeric) This parameter allows to give a short name to each configuration, which is useful when there are many of them. This parameter is used in conjunction with the Bridge Web Server from LetzKey. This Bridge allows to manage remotely all your configurations. This parameter must be used as an ID. We suggest to choose very short names and to privilege numeric values. Config_Comments=My Comment (Value is a string) You can put any string that will define the name of the current configuration. You can define any name you want, as server 1, remote site 2 or whatever name you need. This parameter is used in conjunction with the Bridge Web Server from LetzKey. This Bridge allows to manage remotely all your configurations. We suggest you to choose names as short as possible. Alarm_Type=2;email:myname@mycompany.com (Alarm Type can be 0, 1 or 2) This parameter allows to ask to send an event to an e-mail address if the Alarm_Type parameter is : 0 : no e-mail sent ever (selected by default in Freeware Mode or if there is no Internet connection) 1 : e-mail is sent in case of an emergency process 2 : e-mails are sent in case of emergency and restart processes After email: you must enter the e-mail address where the LetzKey software will send the message. UPS_Query_String=Q1 (Value must be Q1 for Trust UPSs) This parameter doesn’t have to be modified if you are using Trust UPSs. Please note that the Trust UPSs do not answer any other queries as Q1. UPS_Query_Delay=5 (Value is a delay in seconds) This parameter indicates the delay between two data requests sent to the UPS. We invite you not to modify this 5-second delay, which is sufficient in all cases. However, you can adapt it to your own use, but do not choose a too short delay which will not increase the security of the software. On the contrary, do not select too long delays between 2 requests sent to the UPS, because this could lower the security. Indeed, if you define a too long delay, if a power failure event occurs, the software will detect this event only after the end of this delay. Restart_Process_Delay_After_Emergency=300 (Value is a delay in seconds) This parameter allows to define the delay after which the Restart process will be launched when the power is restored after a power failure. We invite you to wait for at least 30 seconds after a power failure / power restoration event in order to make sure that the power situation is stable again. We advise to wait for a 300-second delay. Emergency_Application=emergency.bat (Name must be an existing file) The software will execute the file whose name is given by this parameter in case of Emergency. This file must be located in the directory where the software is installed for security purposes. Any path at the front of the file name will be erased by the software. In the remote view/edition option of this file, only .BAT files are accepted, but you can introduce the file name you want as soon as it is executable by the application as a child process. Then, .EXE and .BAT files are authorized. Please refer to part 6.2. of this on-line manual for complete explanations. The emergency process can be started manually from the software itself, by using a browser (locally or remotely), or by a switch on the I/O card, or of course automatically when a power failure is detected. Restart_Application=restart.bat (Name must be an existing file) The software will execute the file whose name is given by this parameter at restart time after an emergency. This file must be located in the directory where the software is installed for security purposes. Any path at the front of the file name will be erased by the software. In the remote view/edition option of this file, only .BAT files are accepted, but you can introduce the file name you want as soon as it is executable by the application as a child process. Then, .EXE and .BAT files are authorized. Please refer to part 6.3. of this on-line manual for complete explanations. The Restart Process will be launched automatically after a power failure and the delay defined in the Restart_Process_Delay_After_Emergency parameter. It can also be launched manually the same way than the Emergency Process (see above). Please note that you can choose to only restart the process manually by using the software’s check box named " Manual restart only ". In this case, in the event of a power failure, a human intervention is always necessary to launch the Restart Process. Weather_Sensor_Number=x If you have connected a USB weather device to your PC, this parameter allows to define the number of available sensors. For example, in the case of an Oregon WMR100, up to 10 sensors (temperature, humidity) are possible + the sensor integrated in the WMR100. Values for this parameter are included between 1 and 11. Weather_Temp_In_Fahrenheit=Yes This parameter allows to choose to display temperatures in degree Fahrenheit. Important remark : if you choose this option, you must adapt the different alarms below to values in Fahrenheit. Important remark concerning Weather Alarms parameters listed below, here follows the syntax to use : Weather_Type_Min/Max_Alarm=x/Sensor=X/TimeOut=Y/Output=Z x = MANDATORY; value depending on "Type" Remark : values indicated between brackets are in °C and must be converted in °F if you wish so. X = MANDATORY for Type=Temp and Type=Humi, NOT existing for other Types; Sensor Number, 1 to 11; Y = Timeout in seconds, default=60 seconds Z = I/O card output number, 1 to 8 (6,7,8 are normally reserved for Power Failure Alarm and Watchdog), NO default Weather_Temp_Min_Alarm (° ; -50 up to 100)=x/Sensor=X/TimeOut=Y/Output=Z This is the alarm threshold for low temperature. Set it at the low temperature value you want the software to react to. The action in case of low temperature, if you have connected an I/O card, is to set ON the Z output of the I/O card for as long as (+ timeout) the temperature is low according to your threshold. Value for this parameter is between –50 and 100 (-60 and 160 °F). With this function, you can start a heating device for example, which will be driven by this I/O card output. Please refer to the I/O card manual to do this. Weather_Temp_Max_Alarm (°; -50 up to 100)=x/Sensor=X/TimeOut=Y/Output=Z This is the alarm threshold for high temperature. Set it at the high temperature value you want the software to react to. The action in case of high temperature, if you have connected an I/O card, is to set ON the Z output of the I/O card for as long as (+ timeout) the temperature is high according to your threshold. Value for this parameter is between –50 and 100. With this function, you can start a fan or air conditioning device for example, which will be driven by this I/O card output. Please refer to the I/O card manual to do this. Weather_Humi_Min_Alarm (%; 0 up to 100)=x/Sensor=X/TimeOut=Y/Output=Z This is the alarm threshold for low humidity. Set it at the low humidity value you want the software to react to. The action in case of low humidity, if you have connected an I/O card, is to set ON the Z output of the I/O card for as long as (+ timeout) the humidity is low according to your threshold. Value for this parameter is between 0 and 100. With this function, you can start a humidifier for example, which will be driven by this I/O card output. Please refer to the I/O card manual to do this. Weather_Humi_Max_Alarm (%; 0 up to 100)=x/Sensor=X/TimeOut=Y/Output=Z This is the alarm threshold for high humidity. Set it at the high humidity value you want the software to react to. The action in case of high humidity, if you have connected an I/O card, is to set ON the Z output of the I/O card for as long as (+ timeout) the humidity is high according to your threshold. Value for this parameter is between 0 and 100. With this function, you can start a de-humidifier for example, which will be driven by this I/O card output. Please refer to the I/O card manual to do this. Weather_Baro_Min_Alarm (mb; 0 up to 2000)=x/TimeOut=Y/Output=Z This is the alarm threshold for low pressure. Set it at the low pressure value you want the software to react to. The action in case of low pressure, if you have connected an I/O card, is to set ON the Z output of the I/O card for as long as (+ timeout) the pressure is low according to your threshold. Value for this parameter is between 0 and 2000. With this function, you can start any protecting device which will be driven by this I/O card output. Please refer to the I/O card manual to do this. Weather_Baro_Max_Alarm (mb; 0 up to 2000)=x/TimeOut=Y/Output=Z This is the alarm threshold for high pressure. Set it at the high pressure value you want the software to react to. The action in case of high pressure, if you have connected an I/O card, is to set ON the Z output of the I/O card for as long as (+ timeout) the pressure is high according to your threshold. Value for this parameter is between 0 and 2000. With this function, you can start any protecting device which will be driven by this I/O card output. Please refer to the I/O card manual to do this. Weather_Wind_Min_Alarm (m/s; 0 up to 100; ex: 1m/s --> 3,6km/h)=x/TimeOut=Y/Output=Z This is the alarm threshold for low wind speed. Set it at the low wind speed value you want the software to react to. The action in case of low wind speed, if you have connected an I/O card, is to set ON the Z output of the I/O card for as long as (+ timeout) the wind speed is low according to your threshold. Value for this parameter is between 0 and 100. With this function, you can start any protecting device which will be driven by this I/O card output. Please refer to the I/O card manual to do this. Weather_Wind_Max_Alarm (m/s; 0 up to 100; ex: 15m/s --> 54km/h)=x/TimeOut=Y/Output=Z This is the alarm threshold for high wind speed. Set it at the high wind speed value you want the software to react to. The action in case of high wind speed, if you have connected an I/O card, is to set ON the Z output of the I/O card for as long as (+ timeout) the wind speed is high according to your threshold. Value for this parameter is between 0 and 100. With this function, you can start any protecting device which will be driven by this I/O card output. Please refer to the I/O card manual to do this. Weather_Log_Path=[Path:]\YourDir\WeatherDir\ You can define the directory where you can save the weather device data for later use. The software will save the differences between successive values in order to minimize the size of these files. At program start, the weather device data will be completely saved, while afterwards and at each minute, only the values different from the preceding minute will be saved. Then, for example, if the temperature remains stable for 3 or even 10 minutes, no additional log of this temperature will be saved. Doc_Path=[Path:]\YourDir\WebServDir\Doc\ (This parameter is a path to a directory) You can define the directory where you can put your HTML pages available from everywhere thanks to the Embedded Dedicated Web Server included in the software. By default, the software has a directory for such use, but you can define another path if you wish so. For example, if you use a RAM disk or if you want to put this directory on your LAN server, you can modify this path according to your needs. However, do not forget that this path must be Windows compatible. Please refer to the 5.1.5. paragraph of this on-line manual for more information and an example of use. Cgi-Win_Temp_Path=[Path:]\YourDir\WebServDir\cgi-win\ (This parameter is a path to a directory) You can define the directory where you can put your WIN-CGI compatible programs which will be available through forms in HTML pages, and this from everywhere, thanks to the Embedded Dedicated Web Server included in the software. By default, the software has a directory for such use, but you can define another path if you wish so. For example, if you use a RAM disk or if you want to put this directory on your LAN server, you can modify this path according to your needs. However, do not forget that this path must be Windows compatible. Please refer to the 5.1.5. paragraph of this on-line manual for more information and an example of use. Cgi-Win_Exe_Path=[Path:]\YourDir\WebServDir\cgi-temp\ (This parameter is a path to a directory) You can define the directory where the WIN-CGI temporary definition and output files will be exchanged between the Embedded Dedicated Web Server included in the software and your WIN-CGI programs. By default, the software has a directory for such use, but you can define another path if you wish so. For example, if you use a RAM disk or if you want to put this directory on your LAN server, you can modify this path according to your needs. However, do not forget that this path must be Windows compatible. Please refer to the 5.1.5. paragraph of this on-line manual for more information and an example of use. If you want to display webcam pictures, please use one of the following parameters : Visual_Mon_Bottom_Text=< any HTML tag>text</any HTML tag > or Visual_Mon_Bottom_Text=#INSERT_HTML_FILE:Path+file.xyz (example : Doc_Path+webcam.html or C:\HTML\mysubpage.html) The first parameter must be used if you connect a Web Camera to the PC, this software can use it if the saved pictures are located in the WebServDir\doc directory (see below Doc_Path parameter). The name of the pictures in this directory must be webcam.jpg. To do this, we suggest you to visit the web page : http://lundi.ca/fwink/ where you can find a nice piece of freeware named Fwink. You can download and install it. Inside this freeware, you can define the path where pictures taken by your web cam will be saved, according to the Doc_Path parameter. Then, the software will be able to show any room part, or equipment, that you want to monitor remotely through the software Embedded Web Site. If this Visual_Mon_Bottom_Text parameter is put in comment, it means that no visual monitoring will be done. This parameter allows to add a custom text of your choice, describing the visually monitored process, just below the picture. There is another possibility, using the second parameter instead of the HTML tag one. You can ask the software to insert an HTML file that you can put in the directory of your choice. The HTML file name is free. There is an example of this file in the default Doc_Path directory at the installation time. You can modify this file according to your needs, but you can also create a different one in another directory, and even in another PC in your network. If you use the second parameter with the syntax Doc_Path+filename, the software will replace Doc_Path by the value given for this parameter. You can, in this file, add the necessary HTML code to fetch any picture or what you need to be inserted in this area of the state.HTML page. This means that you can insert pictures, text, gifs. You can also add <iframe></iframe> code to insert full external pages from other web sites or not, etc, as long as you use HTML code. Look at the given example, you will notice that there are no <HTML></HTML>, <BODY></BODY>, and other starting and ending HTML tags, because this HTML file will be inserted in an HTML page where these tags are already present. You can bypass this by using <iframe></iframe>. Internet_URL=http://myaddress.dyndns.org This parameter allows, if necessary, to give to the software the published Internet name that you have selected. This name or URL is an option for the Bridge Web Server which allows to manage multiple configurations, but this parameter allows to access your Dedicated Web Server if necessary without our Bridge application as follows. By default, this line is put as a comment because you must optionally define the URL you want to be used according or not with your web site URL.You can choose to use third party services as dyndns (http://www.dyndns.com) which allow to have a human-readable hostname (in comparison with an IP address). This service is very interesting if you do not have any available URL address or if you have a dynamic IP address which can be modified at anytime by your provider. When you will have linked your Dedicated Web Server to a URL using for example the dyndns service, you will be able to access the UPS data remotely from any Web browser connected to the Internet. For example, you will be able to reach this service by using a URL address like http://ups1.anyname.net:90. The :90 value is the port whereto your Dedicated Web Server will listen for connection. You must parameter your router according to this requirement by using for example the NAT options of your router. Please refer to the documentation of your router for complete explanations about NAT. In all cases, you can use the Dedicated Web Server inside your LAN without any predefined Internet URL. Indeed, each PC connected to your network has its own name, which can be used by the Dedicated Web Server as a local Web name. For example, if the PC where the software is installed is named database-room3 (as the LAN name), by default the local Web server name will be http://database-room3:90 where 90 is the port defined as explained above. This Web name is not accessible from the Internet since is it not a published address but an internal one. Then, from a browser on a PC connected to your network where there is another PC running the Dedicated Web Server, you will be able to reach this Web Server as soon as you introduce in your browser the explained Web address as URL 6.2. The Emergency Process file. By default, the name of this process is defined as emergency.bat. An emergency.bat file is given at installation time, but it doesn’t do anything. You have to add your own DOS commands or call any outside Windows program according to the emergency process you want to be executed. We advise you to keep the DOS .BAT concept since it allows many editable possibilities, but you can replace the emergency.bat file name by any other process which must be an executable one. Please refer to the Windows possibilities or third party software available for process creation. You also can create your own program, using your favorite compilers, that will launch the desired procedures and functions. You also can simply shut down the PC, but in this case the restart will be manual, with a physical intervention on site, if there is no automatic PC boot. This can be your choice or correspond to your needs, but smarter possibilites exist as described below. The Emergency Process must be understood as a process which stops all ongoing tasks as write on hard disk (or for example web server access close to put the web server down), and waits for power restoration. After this, your Restart Process will restart all applications that have been stopped, and this automatically. If the power failure lasts too long, PCs will be shut down in a safe way since all running processes will have been closed properly thanks to your own Emergency process. As a comparison, when you shut down Windows manually, this operating system closes any open process and shuts down afterwards. You have to define your Emergency process to set Windows in a pre-shutdown state, just before effective shutdown, allowing to restart without rebooting. However, you could imagine a process where the PC shuts down when a power failure occurs and program an automatic PC restart 5 minutes after power restoration, for example, such power situation being detected by the PC BIOS. Or else, the PC could be configured to boot automatically when the power is back. Many possibilities are available to save your data. Please note that when the Emergency process has been launched, it is logged as a state in the IO_card.CF file. This event is logged in the DigitalBlinking=ON item. You must set this parameter to OFF by editing this file and modifying this parameter manually or automatically via your own Emergency process. You can simply have a backup copy of the file under another name and copy this file to the IO_card.CF file, using DOS copy command. Indeed, imagine that you want to shut down the PC after a power failure and let it boot automatically when power is back again. LetzKey software will still have the event in its log, and will not be in a normal mode. You could unlog this event manually by using the Manual Restart option, but in this case the Restart process will be launched while being maybe unnecessary because the PC has already rebooted and all applications are running. Once again, you can see that you can customize the Emergency and Restart processes at will, but we advise you to deeply think about the best way to use these explained Emergency and Restart processes according to your own configuration. The power of this software will the best according to your process definition. If you do not know how to define a batch file or a process, do not hesitate to call us, or your favorite dealer, in order to define with you which is the best procedure in your case. The price of such intervention is peanuts in comparison with loss of precious work and data created over months or years... 6.3. The Restart Process file. By default, the name of this process is defined as restart.bat. A restart.bat file is given at installation time, but it doesn’t do anything. You have to add your own DOS commands or call any outside Windows program according to the restart process you want to be executed. We advise you to keep the DOS .BAT concept since it allows many editable possibilities, but you can replace the restart.bat file name by any other process which must be an executable one. Please refer to the Windows possibilities or third party software available for process creation. You also can create your own program, using your favorite compilers, that will launch the desired procedures and functions. The explanation above concerning Emergency process creation also applies here, but this time in order to restart your applications.
***************************************************************************************************************** |