Data collection system
AXIS READER
User guide
Kaunas, 2011
Software package „AXIS Reader“
Content
INDRODUCTION – THE PURPOSE OF SOFTWARE PACKAGE............................................................................... 3
REVIEW OF BASIC PROPERTIES ..................................................................................................................................... 3
T
HE DATA COLLECTION PROGRAM
„AXIS
R
EADER
“ .......................................................................................................... 3
D
ATA VISUALIZATION PROGRAM
„AXIS
W
EBSERVER
“ ...................................................................................................... 4
PROGRAM „AXIS READER“ ............................................................................................................................................ 5
F
IRST START
......................................................................................................................................................................... 5
U
PDATING THE DATABASE
................................................................................................................................................... 6
T
HE MAIN WINDOW
.............................................................................................................................................................. 6
B
ASIC MENU STRUCTURE
..................................................................................................................................................... 6
Management ................................................................................................................................................................... 7
Administrative tools ........................................................................................................................................................ 8
Program settings ............................................................................................................................................................ 9
About .............................................................................................................................................................................. 9
R
EADING DEVICES MANUALLY
............................................................................................................................................. 9
D
EVICE LIST
....................................................................................................................................................................... 12
View the list of devices ................................................................................................................................................. 12
Add new location or device .......................................................................................................................................... 13
Edit selected record ...................................................................................................................................................... 14
Adding new device ........................................................................................................................................................ 17
Manual reading ............................................................................................................................................................ 17
Delete record ................................................................................................................................................................ 17
View map ...................................................................................................................................................................... 17
D
EVICE DATA REVIEW AND REPORTS
................................................................................................................................. 18
R
EVIEW OF ACTIVE DEVICES
.............................................................................................................................................. 21
T
ERMINATE ALL SCANS
...................................................................................................................................................... 24
D
ATABASE
......................................................................................................................................................................... 24
P
ROGRAM SETTINGS
........................................................................................................................................................... 25
General settings ............................................................................................................................................................ 25
Modem settings ............................................................................................................................................................. 26
Message center ............................................................................................................................................................. 26
„Web server“ ............................................................................................................................................................... 28
I
NFO WINDOW
.................................................................................................................................................................... 28
C
LIENTS LIST
...................................................................................................................................................................... 29
Add new client .............................................................................................................................................................. 29
Show clients list ............................................................................................................................................................ 29
Edit client data ............................................................................................................................................................. 30
Delete client .................................................................................................................................................................. 31
Activate data record ..................................................................................................................................................... 31
Send an e-mail .............................................................................................................................................................. 31
C
HANGING NAMES
............................................................................................................................................................. 31
L
ICENSE
............................................................................................................................................................................. 32
„A
BOUT US
“
AND PROGRAM UPDATES
............................................................................................................................... 34
PROGRAM „WEB SERVER“ ........................................................................................................................................... 35
C
ONFIGURATION
................................................................................................................................................................ 35
C
ONNECTING TO WEB SERVER
............................................................................................................................................ 36
D
ATA REVIEW
.................................................................................................................................................................... 37
SOFTWARE PACKAGE INSTALLATION .................................................................................................................... 39
MANUFACTURER ............................................................................................................................................................. 43
2
Software package „AXIS Reader“
Indroduction
– the purpose of software package
This software is for accounting devices to collect data collection, analysis and visualization.
Data collection, vizualization and processing system "Axis Reader software“ package consists of two programs: data collection programe „AXIS Reader“ and data visualization using web browser programe "Axis Webserver“.
The data storage device DK-3 is used for reading data from the SKS-3, SKS-4, SKU-03,SKM-
1M,SKU-01xx , SKU-4 types of heat meters via optical, wired or wireless digital interfaces. Data can be readed from other types of meters, with a standard M-Bus interface, used to save collected data and transfer it to computer database.
The data storage device DK-3 is equipped to work with the program "Axis Reader“ ,which can be installed in personal computer operating systems Windows 2000/NT/XP/Vista/7.
Review of basic properties
The data collection pro gram „AXIS Reader“
Data
collection
Data archive
Data vizualization
Users
The data collection programme Axis Reader is used for collecting data from objects using cable modems or GSM, or GPRS Internet connection, or directly connect to the meter. The programe supports many standard and non-standard device communications protocols. It is an independent program that works as a service, i.e. can simultaneously read data automatically at a specified time or read data at specified period from a specified list of devices:
From one to several devices (direct connect via the serial communication channel)
From one to several devices (using GSM modems)
Enco telemetry devices (via Ethernet or GPRS connection).
3
Software package „AXIS Reader“
It also can be scaned manualy, i.e. from the same list of devices, or manually set parameters, which are necesarry to read device.
The list of all accounting and regulatory devices ever made by AB „Axis Industries“:
SKM-1 (all modifications)
SKU-01 (all modifications)
SKS-3 (all modifications)
SKU-03
SR-1
other
Also other manufacturers (“Siemens”, “Danfoss”) heat meters as well.
It‘s possible not only scan device parameters, but to manage them also.
Readed data is saved in an archive, so all saved data can be watched and analized by variety of standart applications. The data stored in the archives contains of all possible data readed from the accounting devices - real measured parameters, statistics of hours ; statistics of days; statistics of months; statistics of stops, etc.
Data visualization program „AXIS Webserver“
The data visualization program "Axis Webserver" is used to display stored data on the Internet.
This program forms the accumulated data from the "Axis Reader” data archive. This program forms data from accumulated "Axis Reader“ archive. The program results can be displayed on any standard web browser.
4
Software package „AXIS Reader“
Program „AXIS Reader“
First start
To run the program, you need click „Start“ button on the desktop taskbar.
When menu opens, select „Programs“, next – „AXIS“ and click on „AXIS Reader“. found:
When the programe is started for the first time, it displays a message that the database can not be
It is necessary to create a new database or link the old one.
5
Software package „AXIS Reader“
Updating the database
If you specify an older version of the application database, program automaticaly convert database into new one. It may take a few minutes, depending on the amount of data accumulated in the old database. Also a copy of old database named „db_name.mdb.BAK“ will be done.
The main window
The program consists of a standard Windows environment with standard window management tools and menus:
Basic menu structure
Management consists of several menu levels.
The expanded text menu can be seen in the first bar.
6
Software package „AXIS Reader“
Menu with icons, which are divided into separate groups can be seen in the second bar.
Let‘s briefly discusses all of the tabs with icons.
Management
Description of icons tab „Management“ is listed below.
Description of icons tab „Management“.
Icon Function
Opens window for manually read devices (F2).
Opens the list of devices scanned (F5).
Shows the data readed from device (F3).
A new entry (region, city, street, device).
Add new device (Ctrl + Ins).
Edits the selected device (Ctrl + E).
Starts scanning device manually (Ctrl + F2).
Starts scanning device automatically.
7
Software package „AXIS Reader“
Terminates current automatic reading (Shift + Ctrl + Del).
Delete (Ctrl +Del).
Show device locations on the map.
Show the status of the reading process.
Administrative tools
Icon
Opens a list of users.
Add a new client.
Edit selected user‘s data.
Deletes all marked records.
Function
Activates or deactivates the record.
Sends selected client e-mail containing data.
8
Software package „AXIS Reader“
Program settings
Icon Function
Opens old or create a new database.
Program settings (F4).
Opens the sent and received data display window (Ctrl + D).
About
Icon
Opens „About us“ window.
Function
Opens license management window.
Checks for newer version.
Reading devices manually
Press button „Manually read device“ to read devices manually. Opens window:
9
Software package „AXIS Reader“
Choose device type from list „Device type“, data interface from list „Reading interface“, data reading period from list „Data period in days“, needed data type from list „Parameter type“, and other parameters, if needed. Some devices have an extended list of parameters (for example SKU-3)(on the right side).
When reading through the serial interface,must choose optional interface port, parity, stop bits, number of bits, connection speed and modem „legs“.
When reading via modem, opens window like shown below, where telephone number must be written in and method of dialing chosen. Your modem settings can be changed changed in program settings.
When reading using a device (such as "Enco") connected to a local area network, Internet or
GPRS network, IP address and port must be entered .
10
Software package „AXIS Reader“
If all parameters are set, reading can be started by pressing the button „Manually read“. Settings window closes and scanning the data begins.There opens the information window, which is featured a list of active devices.
If reading is successfully finished and a setting „Show data, when reading manually“selected , then scanned data will be seen immediately.
To see the scanning process, information display window can be opened (Ctrl + D). Requests, answers and other data can be seen in this window.
11
Software package „AXIS Reader“
Read data saves in database if a setting, save read data from devices to database is chosen. If the database does not contain such a device, the device is placed in the group „Undefined devices location“. If device already exists in database, and „Update, if device type and number matches“ settings are marked, device‘s data updates automatically.
Device list
View the list of devices
This is the main program window, where new devices can be added, scanned data reviewed and device settings changed .
12
Software package „AXIS Reader“
This window shows all the added and read devices in the database. If the device was scanned manually, the device will be added to the group „Undefined devices location“. If the device address is specified, it will be assigned a specific district. If the device address is specified, it will be assigned to specific location. Devices can be assigned to previously entered address by simply dragging them on the correct location address. If to changing the name of the region, city, street, or to changing device settings is wanted, press the right button on the desired entry and choose the menu that appears or use keyboard shortcuts:
Add new location or device (Ctrl + L)
Add users template to device (Ctrl + T)
Add new device (Ctrl + Ins)
Edit selected entry (Ctrl+ E)
Delete selected entry (Ctrl + Del)
Add new location or device
Depending on what the entry is selected, deeper entry is added. If the selected device or "not location", new region is added. If a region is selected, city is added. If city is selected, street is added.
If street is selected, device is added. Here is hierarchy:
Device list
District
Place 2
City 2
Place 3
City 1
Street 1
Street 2
City 3
Place 4
Device 1 Device 2
Street 3
City 4
Place 5
Device 3 Device n
Street n
City n
Place n
To add region press down arrow and type text to appeared window.
Be careful when entering similar streets from different cities, device must be added to specified street and specified city.
The following window shows when attempting to add a new device:
13
Software package „AXIS Reader“
Edit selected record
If you select the desired device, push the button "Edit selected device“ or the key combination (Ctrl + E or Ctrl + Enter) or holding the Ctrl and twice press the left mouse button opens a window:
14
Software package „AXIS Reader“
On the left side of the window you can specify the device‘s country, town or street. Unallocated devices can be seen below.
To add a new country, city or street, press the button on the right marked „...“ and write name, after navigating to the end of list, using arrows.
On the right side of the device settings can be changed: device type, consumer report template, the subscriber's name, reading period, period in days (depth of reading data), device and M-Bus numbers.
15
Software package „AXIS Reader“
This window opens when user‘s template is chosen:
Pressing the button "Select template file" links previously created report template or a blank MS
Excel document.
Next set additional page (tab) name, lines and columns indexes, where report data will appear.
Select wanted data from left side parameters type list.
Clicking "OK", will protect the template information.
Clicking button "Delete template“, erase all template parameters.
It should be noted that each device requires a separate template, because the program always writes to the specified position, pushing the older data down (inserts line). Standard MS Excel functions can be used to create complex reports.
16
Software package „AXIS Reader“
Adding new device
Pressing the button "Add a new device" opens the same window as clicking the
"Edit selected record". Settings fields must be filled for all new devices.
Manual reading
If you open the list of devices, select needed device , choose manual scan command
"Read selected device manually“ (Ctrl + F2), then starts scanning data from the device.
Delete record
If you open the device list, select the needed record like device, street address, town or region and click command delete the selected record (Ctrl + Del) this will erase all related entries (data, settings etc.). If you want to delete the entry in the higher hierarchy, delete all records in the lower hierarchy first.
View map
If you open the device list, and select needed entry with the correct street, city or region, and pressed the button "Show on Google map“, you can see the device on the map.
17
Software package „AXIS Reader“
Device data review and reports
When you select particular device and click "Show device data“, quick key (F3), pressing the
Enter key or double clicking the left mouse button opens a window that displays the data read from device. Needed data can be selected on the screen.
Pressing the right button on the desired object, open the menu:
18
Software package „AXIS Reader“
Menu consists of following items:
Generate report (Alt + F5) – functions discussed in following pages
Delete selected data (Alt + Del) – deletes selected data (current, hours, days or months
Statistics, errors)
Delete selected records data up to specified date (Alt + F11)
– delete selected data from the period of the current date to the date specified.
In the tab "Parameter list" you can hide or show the fields you want, and changed the settings can be memorized by pressing "Save Filter". If you press the button "Filter", then the data will be elected by the date specified in the "From" and "Up to" strips.
The data can be viewed in graphical format. This can be done by opening the tab "Graphics".
19
Software package „AXIS Reader“
Pressing the button "Create Report" will create and open standard report.
The program can prepare standard reports, but you can also use custom reports using your own report templates and automatically filling in the necessary data. This requires MS Excel because
templates are filling with MS Excel.
If you press the button "Open the user account", extract to user specified template in MS Excel format will be created. Template data is filled, regardless of their type was set in the template. This is done because it is automatically selected data type that fits best. To fill in the template data from the desired period, set out time mark "Up to".
Completed template sheet handy to use as a data source, the other pages.
20
Filled users template looks like this:
Software package „AXIS Reader“
Review of active devices
When reading data from the devices, a list containing all the devices and their status can be seen.
Double-clicking the mouse on the record, reading window opens. This can be done when reading manually or automatically as well.
If you remove the device during data reading, data reading is terminated.
Remote thermal regulator SR-1 data scanning and management
Default remote thermal controller scanning and data management.
21
Software package „AXIS Reader“
Heating temperature schedule can be set.
Hot water system temperature schedule can be set.
The user can change the heating and hot water systems critical parameters
22
Software package „AXIS Reader“
View and change the critical circuit parameters
View and change the type of building, alarm or gear travel options
23
Software package „AXIS Reader“
Read data of regulation in archive, that was accumulated during specified interval of time and display statistics by the table or graph.
Terminate all scans
If you want to stop all devices reading, click the button "Disconnect all devices."
Database
If you want to specify a different database or create new, click button "Open Database", specify the database location and name and click "Open."
24
Software package „AXIS Reader“
Program settings
Program settings are made up of several groups.
General settings
All general settings can be changed in this tab.
25
Software package „AXIS Reader“
„Received data from device write in data base“. All read data from devices saves in database.
„Reading manually, the same type and serial number of the device, writes in existing device record“. If there is the same type and serial number, like currently reading, data is attributed to this device in data base
„Don‘t receiving data if they exists in data base“. Interrupt the reading, if such data is readily available.
„Show scan window, reading the manual“. Displays readed data when reading manualy.
„Change energy value units (MWh ->Gcal) for MBus protocol devices“. When reading devices by MBUS protocol, measurement units automatically converted from MWh to Gcal.
„TCP server active (only for ENCO devices)“. Starts TCP server. This allows the program to retrieve data from remote Enco devices via the Internet .
„TCP server port“. Sets the TCP server port that can connect to Enco devices.
„Show TCP server receiving window“. Shows data received over a TCP server.
„Automatic reading devices“. Switches on the automatic scanning of devices.
„Automatic reading error, repeat“. Sets the number of times to try to retrieve the device if an error occurs.
„Automatic reading error, repeat every min.“. Sets period of trying to read, if an error occurs.
„Automatic reading error log“. Creates an error log.
„Show references in the program“. When you move the mouse cursor on the program button, displays a hint.
„Delete records older than ...“ Deletes all entries older than the specified date.
„Compact database“. Compress database, and this increases the work performance.
„Change names ... „ Change names.
Modem settings
This is window of modem settings.
If the program will be used to collect data via modems, it is necessary to determine which interface to connect the modem and configure the correct settings.
Scenarios can be made in the bottom of the window.
Message center
26
Software package „AXIS Reader“
The window for reporting e-mail forwarding and configuration. If your computer is configured to work with program MS Outlook, do not have to do anything additional. To check if configuration is correct, you must enter the recipient's e-mail address (for testing only), and click "Test" button. If the letter is received at the address - everything is configured correctly.
If you use the SMTP server settings input will look like this:
27
Software package „AXIS Reader“
„Web server“
Program „Web server general settings. More about them here .
Info window
To see the scanning process, you can turn on the information display window (Ctrl + D).
Requests, answers and other data can be seen in it.
28
Software package „AXIS Reader“
Clients list
Add new client
Pressing the button "Add client" or Shift + Ins opens window, through which adds a new client:
If the tick "Active User" is set, then the messages is automatically sent the user at a specified time or when automatic scanning devices.
Write in new client’s name, which will be seen in the list.
User name and password field is filled, to connect to „Web server“ via web browser.
Fields below is for sending e-mails configuration.
A list of devices and client list also opens in the background .
Show clients list
Pressing the button "Show client list" or the key combination Shift + F5 opens the window with a list of clients and devices assigned to them.
29
Software package „AXIS Reader“
Users can be assigned to devices by simply selecting the desired device, and dragging it to desired client. Data type of data displayed is showed near assigned device . Data type can activated or deactivated by pressing button "Activate data record" or using the keyboard shortcut Shift + A. Activated data type is displayed in blue and will be inserted in the report.
Green display attached device template.
Edit client data
Pressing the button "Edit selected client" or Shift + E opens window as you create a new user, but with the previously entered data.
30
Software package „AXIS Reader“
Delete client
Selecting the desired client or device assigned to it and pressing the "Delete selected record(s)" or the key combination Shift + Del will delete the selected item.
Activate data record
Data type can activated or deactivated by pressing button "Activate data record" or using the keyboard shortcut Shift + A. Activated data type is displayed in blue and will be inserted in the report.
Send an e-mail
Clicking 'Send selected client e-mail "or the key combination Shift + S will form a report for the period to current time, and sent by e-mail, no matter, the client is active or not.
Changing names
Possible to change names to some you prefer better. This can be done by going to "Program Settings" and choosing the desired operation.
31
Software package „AXIS Reader“
Clicking "Change data type names“ opens a window where a left side shows the current name, and on the right side, you can enter any name you want. Entered items saves by clicking
„Yes“. To restore names, click "Reset".
The same procedure for changing other names: devices, media types, parameters and measurement units. Set parameters of devices, environment, and the names of the units of measurement is valid in „Axis Reader“ and “Web server“ program, and the parameter names only in
„web server“ program.
License
Functions of programme depends on type of license you have.
License management can be done by pressing the "License management".
32
Software package „AXIS Reader“
For the first time introduced the program is running at full functionality, but for a limited45day trial period. After the trial period, it is necessary to register the program with the desired functionality.
To register the program, please send us an activation code and we'll generate a license key. After receiving a licence key, paste it into the field and confirm it. Then program starts to work with funcions under license.
33
„About us“ and program updates
Clicking on "About ...“ -> „About us“ opens window , showing the information about the producer and program update options.
Setting tick "Auto check new program version" will check whether there is a newer version of the program. Setting tick "Show DK3 firmware update warning window" will be checked for new data storage device DK-3 firmware.
Click "Check new version" will manually check and report about the current version of the program.
Software package „AXIS Reader“
Program „Web server“
Program web server is designed to display data via a web browser on your computer, joined a local network or the Internet connection.
Configuration
The main "web server" program settings can be changed in
„Axis Reader“ program settings window tab, „Web server".
Select "Request Authorization" will allow to join only those users who are correctly configured „Axis Reader“, and administrator. Users see only their assigned devices and their data. The administrator will see all devices and data.
Clicking "start web server“ will activate server.
At program start-up asks what mode program will operate.
Icon near clock can be seen after startup:
Double-click on the icon opens a configuration menu.
35
Software package „AXIS Reader“
Connecting to web server
The Web server can be joined by entering existing IP address of the computer in web browser
(i.e. http://localhost/ , 10.12.3.64, 192.168.1.10 ar 172.157.16.39). If you are using a firewall , it must be properly configured for this program To ensure that the server is accessible via the web, you may need to configure a network devices and equipment.
If correctly connected, appears accumulated data:
If user authorization is active, attempting to connect to the Web server will require to enter your user name and password in browser:
36
Software package „AXIS Reader“
In such cases the connection is only possible after success loging in, and only those devices can be seen which are assigned to the user. Online Administrator can view all data.
Data review
When connected to a server, devices and their data can be seen.
Select the data period, the data of interest (on the top of table) and the optional schedule or report review.
When choosing a data type, you can choose the data type of the group (energy, capacity, power, flow, temperature, time, status) by clicking on the top of the table of parameters. You can also select specific settings, placing ticks near the parameter name. Clicking on "All parameters" will again open all possible parameters.
37
Software package „AXIS Reader“
Changing the display period, carried out by entering a date or choosing it in the calendar:
After changing the date, it is necessary to press the button "Change period“, in order for data to be refreshed.
Display of data can be choosen by this buttons:
Selecting "Full Data Report“ generates a report. The report generated by the settings selected in program "Axis reader“.
Selecting "Graphic representation" generates data schedule:
38
Software package „AXIS Reader“
Software package installation
The programs are allowed to be installed by PC professional administrator.
Axis Reader program can be installed on your computer running the installation executable file
„AXISReaderSetup_Vxxxxx.exe“
During installation, follow the installation wizard.
Click „Next“.
39
Software package „AXIS Reader“
Click Next
The path, where program will be installed. Click „Next“.
Enter the "Start" bar folder name, which will be included in the program launch icon. Click
„Next“.
40
Software package „AXIS Reader“
Shows all previously entered software installation settings. Click "Install". Wait until the program is installs.
41
Software package „AXIS Reader“
Click „Finish“. Program installation is complete.
42
Software package „AXIS Reader“
Manufacturer
AB „AXIS INDUSTRIES“
Kulautuvos g. 45a
LT-47190, Kaunas
Tel. (+370 37) 36 02 34
Fax. (+370 37) 36 03 58
Email: [email protected]
Web: www.axis.lt
43
