EQUOBOX TOOLKIT LITE User Guide

Transcription

1 SINAPSI S.r.l. Via delle Querce 11/ Bastia Umbra (PG) Italy T F EQUOBOX TOOLKIT LITE User Guide Rev Vietata la riproduzione o la divulgazione di questo documento senza autorizzazione scritta della SINAPSI S.r.l. - This document must not be copied or disclosed without written permission from SINAPSI S.r.l.

2 TABLE OF CONTENTS 1. M-BUS OVERVIEW DESCRIPTION of the M-Bus System Addressing Sizing the M-Bus System... 5 BUS signal specifications SIN.EQLC1 INSTALLATION SIN.EQLC1 Description SIN.EQLC1 Appearance Connections allowed Conneciotns allowed Status indicators SOFTWARE INSTALLATION System requirements Installation Installing the SIN.EQLC1 unit Installing the EQUOBOX TOOLKIT software LOGIN HOMEPAGE SETTINGS M-Bus interface Type of Search: you can select the type of meter search. Refer to the meter datasheet and to chapter. 17 Baudrate: the default value is 2400bps. To make any changes, refer to the meter datasheet and to chapter Toolkit Setup PLANT SECTION Creating a new plant Opening an existing plant Searching meters Meter setup New Readout Deleting a plant Closing a plant READOUT SECTION

3 8.1 Open Readout Reports in Excel format

4 1. M-BUS OVERVIEW 1.1 DESCRIPTION of the M-Bus System The M-Bus (Meter Bus) system is a communication protocol compliant with the EN standard. The M- Bus System provides the following advantages: High level of data transmission security Low wiring costs Long distances without requiring repeaters Large number of central units Detection of both battery-powered and mains-powered devices Automatic device recognition Vast array of systems and components available Different types of bus topology: linear, star, and tree Figure 1 - Bus topologies 1.2 Addressing The M-bus uses two types of addressing mode to detect the devices Primary addressing: up to 250 primary addresses can be allocated within an M-bus system (hexadecimal format). The primary address is normally allocated while setting up the central units. Secondary address: the secondary address consists of 8 bytes and allows the allocation of any number. By default, the secondary address of the devices is the same as the manufacturer serial number. This type of allocation prevents bus conflicts. 4

5 1.3 Sizing the M-Bus System Follow the instructions provided in the table to size the M-Bus system Type of plant Small residential buildings Maximum distance 350 m Overall cable length Cross-section mm m 0.8 mm 250 Number of devices (slaves) Max. transmission rate 9600 Baud Large residential buildings 350 m 4000 m 0.8 mm Baud 9600 Baud Small complex 1000 m 4000 m 0.8 mm Baud Large complex 3000 m 5000 m 1.5 mm Baud Medium neighbourhood Point-to-point connection 5000 m m 7000 m 1.5 mm m 1.5 mm Baud 300 Baud BUS signal specifications M-Bus system Number of devices per segment Transmission rate Bus voltage Bus Voltage (Master) Bus Voltage (slave) Bus current DC Bus current Current (slave) Transmitted current (slave) Designation n T U U M U S,R I M,V I M,K I S,R I S,S Condition SIN.EQLC1 0 Minimu m Typical IM=0 400mA 12 IM=0 400mA ±21 SIN.EQLC1 0 SIN.EQLC US=21 42V US=21 42B 11 Maximu m Baud Measure ment unit Bd 42 V 42 V ±42 V 90 ma 160 ma 1.2 ma 20 ma 5

6 2. SIN.EQLC1 INSTALLA ATION 2.1 SIN.EQLC1 Description SN.EQCL1 is a unit that reads M-Bus devices in compliance with the EN standard. You can connect up to 60 M-Bus devices to each SIN.EQLC1 unit. The SIN.EQLC1 unit can be used in three different ways: Master Mode connected to a datalogger of the EQUOBOX family (RTU or CPU) Master Mode connected to the EQUOBOX TOOLKIT software Slave/Repeater Mode with the device used as a signal amplifier 2.2 SIN.EQLC1 Appearance For a detailed description of the SIN.EQLC1 Level Converter, please refer to the relative user guide. For convenience, a brief description of the device is provided below. The figure below shows a SIN.EQLC1 Level Converter, thanks to which the EQUOBOX TOOLKIT software reads the M-Bus meters connected to it. A. Power supply input connector B. M-Bus Master Connector C. M-Bus Slave Connector D. Serial bus datalogger connector E. Mini USB-B for PC connection F. LED status indicators Figure 2 - Level Converter (SIN.EQLC1) The main features of the SIN.EQLC1 unit can be summarised as follows: M-Bus interface for datalogger Management of up to 60 M-Bus devices It can operate as a signal amplifier/repeater Communication speed between 300bps and 9600bps 24Vac/Vdc power supply 6

7 DIN rail mount (4 modules) Short circuit and overvoltage protection USB connection for EQUOBOX TOOLKIT meter reading 2.3 Connections allowed 1 The connections to be made in the Level Converter s various operating modes are shown below. Figure 3 - Connections M-Bus Slave input o (1) Pin 1 for M-Bus network connection (Repeater mode) o (2) Pin 2 for M-Bus network connection (Repeater mode) M-Bus Master output o (6) Pin 1 for M-Bus meter connection (Master mode) o (7) Pin 2 for M-Bus meter connection (Master mode) Datalogger connection o (3) TX for datalogger connection o (4) RX for datalogger connection o (5) GND for datalogger connection Power Supply o (8) Power supply (9..24Vac, 9..30Vdc) input 1 o (9) Power supply (9..24Vac, 9..30Vdc) input 2 The following figure shows an example of Level Converter connection in Master and in Repeater modes. 7

8 Figure 4 SIN.EQLC1 connection in Master and Slave (Repeater) mode 2.4 Conneciotns allowed 2 Following connections allowed in Figura 6 and Figura 5 e the only connection not allowed Figura 7 Figura 5 - Star Topology Figura 6 - Mexed Topology 8

9 Figura 7 - Ring topology 2.5 Status indicators The SIN.EQLC1 unit has 6 LED statuss indicators as shown in the figure: Figure 8 - Status indicators USB Activity: orange o 2 blinks the device is ready to be connected to the PC by means of the mini USB-B cable o 5 blinks PC successfully connected and device correctly recognised by the PC o Steady PC communicalng with the M-Bus devices TXD: green. Indicates the status of the data transmission to the M-Bus network connected to terminals (6) and (7) o ON data transmission in progress o OFF no data transmission in progress RXD: green Indicates the status of the data received by the M-Bus network connected to terminals (6) and (7) o ON data receplon in progress o OFF no data receplon in progress M-Bus error: red. Indicates whether the BUS current is correct or not o ON BUS overload error (possible short circuit on the M-Bus or excessive number of connected devices) o OFF no errors detected M-Bus ready: green. Indicates that the BUS voltage is correct and that theree are no anomalies. o ON The BUS is polarised with enough voltage to allow for proper operalon o OFF the BUS voltage is not sufficient to allow for proper operation 9

10 Power: green. Indicates whether the device is powered on o ON The device is powered on correctly o OFF The device is not powered on correctly 3. SOFTWARE INSTALL LATION 3.1 System requirements The following minimum system requirements must be met to ensure proper operation of the EQUOBOX TOOLKIT. - Operating System: Windows XP, Windows Vista, Windows 7, Windows 8 - HW features: 32 bit or 64 bit processor, 1 USB port (1.1 or upper) 3.2 Installation The SIN.EQLC1 unit should be installed on the computer before installing or using the software. To prevent any malfunctions, it is important to install the SIN.EQLC1 unit on the computer before installing or using the EQUOBOX TOOLKIT software 3.3 Installing the SIN.EQLC1 unit The installation and use of the SIN.EQLC1 level converter does not require the installation of any driver or software. Upon the first connection of a device to a USB port of the computer, follow these steps: - Power on the SIN.EQLC1 unit - Wait until the USB Activity LED starts blinking (8-10 seconds after switch-on) - Use a MINI USB Type B cable to connect the device to the computer, as shown in the figure Figure 6 - Connecting the SIN.EQLC1 unit - Wait for the message Found New Hardware to appear in the Windows taskbar - Wait for the Installation complete message, as shown in the figure 10

11 - Reboot if prompted by the operating system. Figure 7 - Installation complete 3.4 Installing the EQUOBOX TOOLKIT software The installation procedure of the SIN.EQLC1 management software is the same as for any new software Double click on the icon and follow the next steps Figure 8 - Installation Step 1 selecting the installation language Figure 9 - Installation Step 2 11

12 Figure 10 Installation Step 3 Selecting the EQUOBOX TOOLKIT installation directory Figure 11 - Installation Step 4 Creating a desktop shortcut Figure 92 - Installation Step 5 Installation complete If necessary, you will be prompted to install the Visual C Runtime software. 12

13 Figure 103 Installation Step 6 Microsoft Visual C Runtime 4. LOGIN Upon launching the software, a login form will appear where users can enter their login data (Username/Password), which, by default, are: Username: admin Password: admin Figure Installation Step 7 13

14 Before pressing the LOGIN button, you can select the language among the available ones indicated by the flags. The software will save the language settings for the next logins. 5. HOMEPAGE Figure 125 Login The homepage will be displayed upon launching the software, as shown in the figure: The window is divided into four sections: Figure Homepage 14

15 Shows the current SIN.EQLC1 status The main items are the following: indicates the user who has logged in shows the name of the open plant being worked on 1 indicates the operation being carried out on the BUS shows the SIN.EQLC1 connection status o Connected: the device is connected correctly to the PC o Init. in progress: for the first 10 seconds, it verifies any possible firmware upgrade o Disconnected: the device is not connected to the PC shows the date and time of your PC Main application menu 2 allows you to access the Plant section allows you to access the Readout section allows you to access the Settings section allows you to exit the program Shows a submenu with the items of the section selected from the main menu. (Section 2) 3 In particular: PLANT: o o No open plant being worked on: SELECT PLANT > Allows you to open a plant among the existing ones. CREATE NEW PLANT > Allows you to create a new plant With an open plant being worked on (Indicated in section 1) PLANT INFO > Summary of plant data PLANT DATABASE > Allows you to modify the plant data METER SETUP > Allows you to modify the metering settings of the plant being worked on SEARCH METERS > Allows you to search the meters connected to the bus NEW READOUT > Allows a new readout of all the meters connected to the plant. DELETE PLANT > Allows you to delete the plant being worked on CLOSE PLANT > Allows you to close the plant being worked on READOUTS: o No open plant being worked on: OPEN READOUT > Allows you to access all the readouts of all the plants to view the data or create a report in XLS or CSV format CONSUMPTION REPORT > Allows you to create consumption reports based on one or more readouts carried out for the same plant. (Not available for the Lite version) o With an open plant being worked on (Indicated in section 1) 15

16 OPEN READOUT > Allows you to access all the readouts of the open plant to view the data or create a report in XLS or CSV format CONSUMPTION REPORT > Allows you to create consumption reports based on one or more readouts carried out for the open plant being worked on. (Not available for the Lite version) SETTINGS: o MBUS INTERFACE: Allows you to access the settings pertaining to the use of the level converter o TOOLKIT SETUP: Allows you to access the settings pertaining to the use of the software EXIT: allows you to exit the program. (Save any changes before logging out) 4 This section shows the content according to the selected menu (2) and submenu (3). 6. SETTINGS This section is dedicated to the settings of the SIN.EQSW1 and SIN.EQLC1 software. The submenu (Section 3) allows you to choose the settings pertaining to the level converter and software. 6.1 M-Bus interface This section allows you to access the following menus: M-Bus settings Figure 14 - M-Bus interface 16

17 Type of Search: you can select the type of meter search. Refer to the meter datasheet and to chapter o DESCRIPTION of the M-Bus System Primary address (ID): search by address Secondary address (serial number) ID + Serial number: search by address and serial number Baudrate: the default value is 2400bps. To make any changes, refer to the meter datasheet and to chapter o DESCRIPTION of the M-Bus System o ID scan range: define an ID search range. The value can range between 1 and 250 o Advanced settings: RST_APP: It launches the Reset Application command (to be used only if expressly required by the meter/s) before starting the search SND_NKE: sends the M-Bus command to initialise the Slave before carrying out the readout Press save to save the settings Level Converter Firmware o Current firmware update: shows the current firmware of the SIN.EQLC1 unit o Available updates: searches the available updates on your PC Update Firmware: press the button control to update the SIN.EQLC1 unit 6.2 Toolkit Setup This section allows the following settings: Figure 15 - Toolkit Setup Update EQUOBOX TOOLKIT o EQUOBOX Toolkit version: shows the Toolkit version. You can update it by pressing Check for updates online 17

18 o Meter database Rev.: shows the version of the meter database currently being used. You can update it by pressing Check for updates online o Data backup: select this to create a backup of your data. This file can only be used by Sinapsi personnel Account Login o Name: name of the user logging in. Change login data o Username: name of the user logging in. Change login data o Password: name of the user logging in. Change login data Save: press save to save the Account Login settings 7. PLANT SECTION Select PLANT from the main menu, according to whether the plant is open and being worked on or not, to access the plant submenu or the list of plants saved in the PC. 7.1 Creating a new plant To create a new plant, close any open ones, go to PLANT in the main menu, and select CREATE NEW PLANT. Figure 19 Creating a new plant Below are the fields to be filled out. Fields highlighted in Red are required 1. Plant reference: associate an unambiguous name to the plant 2. Owner Information data Name/Company Name Address Phone 3. Building Administrator 18

19 Name/Company Name Address Phone 4. Plant data Plant Address Installer Installation Date 5. Readout interval: sets the devices. 6. Plant Notes Once you press OK, the plant is created and the PLANT INFO screen will be displayedd to indicate that the newly created plant is open to be worked on. 7.2 Opening an existing plant Select the SELECT PLANT submenu from the PLANT menu frequency with which the user must carry out a readout of the plant Figure 20 List of Plants Select Plant A list of plants saved in the computer will be displayed. Press OPEN PLANT to select the plant you wish to open. The main data of the selected plant will be displayed on the side. Upon opening the plant, the PLANT INFO panel will be displayed, summarising information, such as the database, number of meters in the plant, date of the last readout, and date of the next readout to be performed. 19

20 Figure 21 Plant Summary Panel The PLANT DATABASE submenu allows you to change the plant data regarding the property and installer entered whilst creating the plant. The submenu to change the data is shown below. Figure 162 Changing plant data 20

21 7.3 Searching meters Upon connecting the SIN.EQLC1 unit to your PC, you can search the meters on the M-Bus chain. This operation is carried out every time one or more meters must be added to the plant being worked on. Select SEARCH METERS from the submenuu panel and press start. Figure 17 - Searching meters The search mode is activated according to the settings saved in SETTINGS -> M-BUS INTERFACE. By default, the software first performs a search by primary address (Meter ID) in a range between 1 and 250; then, it completes the search by secondary address (Meter Serial Number). The default communication speed is 2400bps. The bus activity status is shown on the taskbar during the search Figure 18 - Searching meters The items that indicate the progresss of the search are: Total meters: indicates the overall number of meters found during the search. New meters found: indicates the number of new meters found during the search. 21

22 Baudrate: indicates the speed with which the SIN.EQLC1 unit queries the meters in the M-Bus chain. The default communication speed is 2400bps and can be changed from the Settings menu. Check the meter datasheet to verify the communication speed in the event that there is no response. Meter search status: indicate the status of the search Current address: indicates the serial number or the primary address that the SIN.EQLC1 unit is searching at that time. In the event of a search by serial number (secondary address), the wildcard logic is used to detect all the possible meters. Search by secondary address is based on the detection of any collision on the bus following the query of a set of serial numbers, such as 06XXXXXX. There is a remote possibility that some meters cannot be detected during this search. In such an event, we recommend allocating a primary address from 1 to 250 to the undetected meter and repeat the ID scan of the bus. The meter search is complete when all the possible serial numbers have been queried. The meters that have responded correctly to the SIN.EQLC1 unit s query will be progressively shown in the List of meters. Figure 19 - Saving the meters Based on the M-Bus protocol, all the devices in the chain will respond to the call of the SIN.EQLC1 unit. The meters in the database recognised by the SIN.EQLC1 unit will have their models graphically displayed. The model of a meter in the M-Bus chain will be managed even if its image is not displayed; however, additional settings may be required for the data provided by the meter (see meter setup). Every meter found in the M-Bus chain must be named: Device Name: enter the identification name of the device. This field will be shown in the Report section Description 1: add a first description to identify the meter. This field will be shown in the Report section Description 2: add a second description to identify the meter. Press SAVE for each meter found to confirm its addition to the plant being worked on. Once saved, the meter icon will change its status as described below. 22

23 The devices in the M-Bus chain can be queried several times in the event that a device in the chain does not answer the call. The List of Found Meters will show all the meters in the M-Bus chain, both the new ones and the ones previously saved. There is a visual distinction as shown below device already saved and added to the plant being worked on new device to be saved and added to the plant being worked on To save the new meters, follow the steps described above. 7.4 Meter setup You can change the settings of every previously saved meter by accessing the METER SETUP submenu. Figure 20 - Meter setup You can delete any meter added to the plant being worked on by pressing. Warning: all the data pertaining to the meter will be permanently deleted. Figure 21 - Displayed meters The displayed items are shown below. Fields highlighted in blue are editable 1. Meter setup Serial number: indicates the serial number of the selected meter 23

24 Device Name: indicates the name of the device Description 1: add a first description to identify the meter Description 2: add a first description to identify the meter Installation Date: indicates when the meter was installed. This is set automatically upon saving the meter as described in the previous chapter. Primary ID: indicates the address of the meter. The addresses can range between 1 and 250 Manufacturer code: indicates the manufacturer code Version: indicates the version of the meter. Physical Medium: indicates the type of value read by the meter Baudrate: Indicates the speed with which the meter communicates with the SIN.EQLC1 unit. Check the meter manual to verify the communication speed. Readout by: select whether take readings via primary or secondary ID Manufacturer: indicates the manufacturer s name in the event that the meter in the database is identified by the SIN.EQLC1 unit. Model: indicates the meter model in the event that the meter in the database is identified by the SIN.EQLC1 unit. Details: specifies different configurations for the same meter model. Meter data: you can select the values to be displayed in the Readout menu. Below is an example regarding a list of the values that can be selected for a meter. The table shows all the data originated from a meter query. In the event that the meter is in the database of the SIN.EQLC1 unit, the data in the User Description column will be filled out automatically; otherwise, the user will have to give a name to the User Description fields, which, by default, are the same as the M-Bus Description field. The same applies to the Display Data column. In this case, if the meter is in the SIN.EQLC1 database, the data will be pre-set and can always be changed by the user; otherwise, if the meter is not recognised, they will be selected directly by the user. Figure 22 - Selectable values 24

25 7.5 New Readout Access the New Readout section to acquire the measurements. Press Start to start reading the dataa of every meter in the list. If the meter has been read out successfully, the message OK will appear on the Readout Status; otherwise, the word ERROR will appear. The data read from the meter and listed in the Meter Data section can be sorted in the columns, by: User description M-Bus description Readout value Type of value Tariff When all the meters are read correctly, you can save the readout and store it in the plant being worked on. 7.6 Deleting a plant Figure 23 - New readout Select the DELETE PLANT submenu to delete the plant being worked on. Figure 24 - Deleting a plant Press Yes to complete the operation. Warning: all the data pertaining to the plant, including all the readouts performed, will be permanently deleted. 25

26 7.7 Closing a plant Select the CLOSE PLANT submenu to close the plant being worked on. Any new meters identified or readouts performed will not be saved automatically; therefore, before you close it, make sure that all the data have been correctly stored in the plant being worked on. Upon closing the plant being worked on, the following window will be displayed: Figure 25 - Closing a plant 26

27 8. READOUT SECTION 8.1 Open Readout Select Open Readout from the READOUTS menu to open an existing readout to view the consumption data or generate a report. The list of all the readouts that have been saved will be displayed. Figure 26 - Readouts Select the filter to display the plants among: All plants: shows the readouts of all the plants that have been created. Filter by plant: shows only the readouts pertaining to the selected plant. All dates: does not filter by date Filter by date: shows the readouts performed in the interval between the selected dates. Select the list you want to open from the readout list and press OPEN. Figure 27 - Plant Readouts 27

28 The screen is divided into four parts Meter list: shows the list of meters of the plant at the time of the readout o Serial number: shows the serial number of the meter o Device name: shows the name of the meter o Description: shows the description (if added beforehand) o Readout state: shows the readout status of the selected meter Readout Date: shows the date when the readout was performed Operator: shows the name of the user performing the readout Annotations: shows the notes, if any Meter Data: shows the values selected in the Meter Setup section o Display Main Fields: this item is active by default. It shows only the standard fields set in the meters based on what was described in chapter Meter setup o Display Main Fields: when deactivated, it shows all the fields read by the meter XLS: sets the export in.xls format CSV: sets the export in.csv format Press CREATE REPORT to generate a report according to the settings selected as described above. Select a name and a path to save it on your PC. Figure 28 - Defining the saving path 28

29 8.2 Reports in Excel format Below is an example of a report in Excel format generated for a plant with two meters. Figure Example of a report Whether in.xls or.csv format, the report consists of: - A Heading: Which shows the name of the operator who has performed the readout, the name of the plant of the readout, its address, and the date and time of the readout. - Meter data: This section shows the data pertaining to the meters of the plant at the time of the readout. It consists of a line that shows the serial number and the three descriptions associated to the meter. The next line shows the heading of the data of that particularr meter, whose readout date is shown in the first column and readout time in the second column. The next columns show the heading of the meter fields included in the report indicated with the M-Bus description, User Description, and unit of measurement. By default, the report includes only the fields marked with Display Data in Meter Setup, unless the Display only the main fields setting is unticked before generating the report. Note: the extracted data from the system provide: Use of the point for the thousands Use of the comma for the tens 29