Viltrus Electronics MX-9 User manual

JSC „VILTRUS“
K. Donelaičio str. 62, LT-44248 Kaunas, Lithuania
Mobile: [phone]
Email: [email protected]m
http://www.viltrus.com
MX-9 is Wireless M-Bus Data logger / Gateway
(433/868 MHz OMS)
User Manual

2
Content
1INTRODUCTION 4
2SETTING UP CONNECTION TO THE DEVICE 4
2.1 USB connection 5
2.2 ETHERNET Connection 5
2.3 GPRS connection 6
2.4 MX-9 connection diagrams 7
3"START" TAB 7
3.1 MX-9 Basic Information 7
3.2 Configuration files 8
3.3 Status indicators 9
4“DISCRETE INPUTS” TAB 10
5“COMMUNICATION” TAB 11
5.1 Communication > Ethernet 11
5.2 Communication > GPRS 12
5.3 Communication > UARTs 15
5.4 Communication > Virtual interfaces 15
5.5 Communication > Data transfer 17
5.6 Communication > FTP Server 20
5.7 Communication > MQTT Subscriber 21
5.8 Communication > Routing 22
5.9 Communication > Connected devices 25
5.9.1 M-Bus devices 25
5.9.2 Wireless M-Bus devices 33
5.10 Communication > Modbus devices 37
5.11 Communication > Modbus register grouping 39
6"ARCHIVES" TAB 41
7"LIMITS VERIFICATION" TAB 42
8"ALERTS" TAB / 43

3
8.1 SMS Alerts on Limit verification 43
8.2 Email Alerts on Limit verification 43
8.3 MQTT Alerts on Limit verification 44
9"TIME PARAMETERS" TAB 45
10 ABBREVIATIONS AND EXPLANATIONS 46
11 SAFETY INSTRUCTIONS 47
12 TECHNICAL DATA 48
12.1 Communication interfaces 48
12.2 Galvanic insulation 48
12.3 Indication 48
12.4 Power supply 49
12.5 Construction 4949
12.6 Climate conditions 49
12.7 Safety parameters 49
12.8 Other parameters 49

4
1 Introduction
This Manual will show you how to configure datalogger by using the MX-9 configurator software.
Figure 1. MX-9 Configurator
2 Setting up connection to the device
In order to configure the controller, user must connect its PC to the device by using any of
the following interfaces:
1. USB port
2. ETHERNET interface
3. Through a GPRS connection (only accessible after configuring GPRS APN, user
and password inside the controller)
Figure 2. MX-9 connection interfaces
NOTE: Not all the models support above interfaces. Check your ordering code first.

5
2.1 USB connection
Steps to be followed:
- Connect an USB cable class B to the correspondent port
- Open MX-9 Configuration Tool
- Set up "Connection Parameters" frame
- Select "ModBus RTU" option under "Connection type"
- Configure “Bode” and “Parity” parameters; default values are:"19200" , "none"
- Select COM port number asigned by your PC to the USB port
- Click on “Get all” to establish connection with controller.
Figure 3. USB connection set up
2.2 ETHERNET Connection
Steps to be followed:
- Connect a RJ45 Ethernet cable to the correspondent port.
- Open MX-9 Configuration Tool
- Set up "Connection Parameters" frame
- Select "ModBus TCP/IP" option under "Connection type"
- Add controller IP address and TCP port in "Host or IP" and “Port” text boxes respectively
- Select “Ethernet” option under “Connection through”
- Click on “Connect” to establish connection with controller.

6
Figure 4. Ethernet connection set up
2.3 GPRS connection
Steps to be followed:
- Check GPRS antenna is properly connected to the device.
- Open MX-9 Configuration Tool
- Set up "Connection Parameters" frame
- Select "ModBus TCP/IP" option under "Connection type"
- Add controller IP address and TCP port in "Host or IP" and “Port” text boxes, respectively
- Select “GPRS” option under “Connection through”
- Click on “Connect” to establish connection with controller.
Figure 6. GPRS connection set up

7
2.4 MX-9 connection diagrams
In the following Figure, the most typical connection schemes of MX-9 with PC are shown. The
Configuration Tool described in this document or any other Modbus complaint software can
establish a communication link making use of Modbus RTU and/or Modbus TCP protocols.
Figure 7. MX-9 typical connection diagrams
3 "Start" tab
3.1 MX-9 Basic Information
Once user has established communication with MX-9, basic information such as "User
identificator" , "Serial number", "Last restart", "Firmware version","Software version", etc. is
shown in the left frame

8
Figure 8. “Start” tab. MX-9 basic information
3.2 Configuration files
This feature enables user to save and load configuration files so that programming a number of
controllers with the same configuration becomes an easy process. Steps to be followed are:
1. Set up all the configuration parameters making use of MX-9 Configuration Tool.
2. Then, under “Start” tab, click on "Save configuration" button. A dialog will be shown
requesting user to select folder destination.
3. Once the file has been stored, connect a new controller to the PC and then click on "Open
configuration" and select the file previously stored.
4. Then, click on "Write configuration" button to load such configuration into the new
controller.
5. A restart will be needed so that controller can start using the loaded configuration.
6. Repeat from step 3 with all the controllers that need the same configuration.

9
Figure 9. “Start” tab. Configuration files management
3.3 Status indicators
Several status indicators are shown in the MX-9 configuration tool in order to inform user about
current performance of Modbus communication:
1. Req: number of Modbus requests performed.
2. Answ: Number of Modbus answers received.
3. Tout: number of Modbus requests not answered (time outs raised).
4. Except: number of Modbus errors.

10
Figure 10. “Start” tab. Status indicators
4 “Discrete inputs” tab
Discrete inputs can be configured within this tab. They are shown organized in columns and
configuration parameters are shown in rows as follows:
"Current State": Graphical representation of current status (open/closed).
"Impulse quantity": Number of pulses counted from last reset.
"Value": Calculated from multiplying number of pulses counted (Impulse quantity) and
user-defined multiplier (Impulse multiplier).
"Enabled": user enable/disable discrete inputs to be used. In order to save memory, it is
recommend to only enable inputs in use.
"Mode":
"Discrete Input": input works as a standard discrete input detecting its current state (1 /
0)
"Impulse counter": input is used as a standard pulse counter, storing the amount of pulses
raised.
“Alarm signal”: input is used as an alarm input.
"Alarm state": If "Alarm signal" option is selected, controller will raised an alarm when one
of the following state is reached: "Open", "Close", "Both cases".
"Enable archiving": If enabled, events produced by discrete inputs are stored in the
datalogging archive.
"Debounce time": only pulses received within one or more “Debounce time” intervals are
registered.
"Impulse multiplier": user-defined multiplier. Values can be set from 1 to 1000. "Set initial
amount of pulses": initial value for pulse counter can be set here.
NOTE: After configuration is completed, click on "Set" button in order to save changes.

11
Figure 11. “Discrete inputs” tab
5 “Communication” tab
5.1 Communication > Ethernet
Ethernet interface parameters can be configured within this tab:
"MAC number": Media Access Control address
"IP address"
"Gateway IP"
"Mask"
NOTE: After configuration is completed, click on "Set" button in order to save changes.

12
Figure 12. “Ethernet” Configuration tab
5.2 Communication > GPRS
As previously described, MX-9 can be configured through a GPRS link. In order to do so,
user must enable GPRS connection as shown below. Then, click on "Set" button in order
to save changes.
Figure 13. “GPRS” Tab. Enabling communication

13
Within this tab, different services can be configured or checked.
1. GPRS connection parameters:
"APN": access point name provided by Internet Service Provider (ISP).
If needed by ISP, credentials can also be configured here:
"Username": provided by ISP.
"Password": provided by ISP.
NOTE: After configuration is completed, click on "Set" button in order to save changes.
Figure 14. “GPRS” tab. Internet Service Provider access data configuration
2. Connection status. Once GPRS connection is established, status will be shown as
below:

14
Figure 15. “GPRS” tab. Connection status
3. DynDNS account configuration: in order to avoid the need to have a fixed IP
address to be able to remotely access the device, it is possible to set up a
DynDNS account under the "DDNS setting". Steps to be followed are:
Select “Enable”
Fill in information according to your DynDNS account
Click on "Load from file" and select "dyndns.org_Register_String.txt "
which contains the connection string to be sent to DynDNS servers.
Figure 16. “GPRS” tab. DynDNS configuration
NOTE: After configuration is completed, click on "Set" button in order to save changes. NOTE:
It is recommended to disable GPRS connection if not used.

15
5.3 Communication > UARTs
Each UART can be configured individually. It is recommended to check peripheral devices
UART constraints before setting up parameters in the controller configuration tool.
NOTE: All devices connected to the same MX-9 UART must have the same communication
parameters.
"Bode": Transmission rate (bauds per second).
"Parity": Communication Parity.
"Data bits": Number of data bits within the communication packet.
"Stop bits": Number of stop bits within the communication packet.
"Packetization":
"time": One packet time has been reached, it is considered that the
packet has been properly sent.
"Symbol". Every time a "packet symbol" is received, it is considered that
the packet has been properly sent.
“Length”. Once the "packet byte count" has been reached, it is
considered that the packet has been properly sent.
“Packet time”: Transmission duration.
“Packet symbol”: Symbol which defines packet ending.
“Packet byte count”: Length which defines packet size
“Mode”: Full duplex or half duplex
“Destination of DTR”: bit which defines the "Data ready" state has been
reached. It must be configured following peripheral devices connected to
MX-9 UARTs vendor information. By default, if this information is not
available, it is recommended to select "OFF when send" option.
NOTE: After configuration is completed, click on "Set" button in order to save changes.
Figure 17. “UARTs” tab
5.4 Communication > Virtual interfaces
The MX-9 can perform as communication gateway Modbus server/client and datalogger
simultaneously. In order to set up these options, different virtual interfaces are needed as
shown below

16
Figure 18. “Virtual interfaces” tab
"COM Client". It is needed to configure a COM Client every time a
“transparent” communication mode or M-Bus compatibility is needed. This is
mandatory in order to read devices not compatible with Modbus RTU/TCP
protocols. Configuration parameters are:
"Enable": Do not enable any COM client if not needed.
"UART": Select the UART number in which a COM Client will be configured.
NOTE: Once a given UART is selected to be a COM client, it cannot be used with
any other configuration such as Modbus client/server.
"Stack depth": number of parallel executions that can be done in parallel by
the COM client.
“Timeout”: it defines the amount of milliseconds defined as time out.
"Number of repeats": number of retries defined in case of transmission error.
NOTE: COM Client must always be used when peripheral devices connected
to a given UART use protocols such as M-Bus, IEC-102, DLMS, etc.
NOTE: After configuration is completed, click on "Set" button in order to save
changes.
"Modbus RTU Client". This mode working mode must be used when the MX-
9 behaves as master in a Modbus RTU network (it sends Modbus requests
to the slaves connected to the Modbus RTU network). These requests will
be defined under the "Modbus devices" tab. Parameters to be configured
are:
"Enable": Do not enable any Modbus RTU client if not needed.
"UART": Select the UART to be associated to the Modbus RTU client.
NOTE: Once a given UART is selected to be a Modbus RTU client, it cannot be
used with any other configuration such as COM client.
"Stack depth": number of requests that can be stacked in the UART buffer.
It is recommended to set this value to 1 by default.
“Timeout”: it defines the amount of milliseconds defined as time out.
"Number of repeats": number of retries defined in case of transmission error.

17
"Delay before next request": In case peripheral devices need some “extra
time” to answer after a received request
NOTE: After configuration is completed, click on "Set" button in order to save
changes.
"Modbus RTU Server". This mode is used when the MX-9 will be used as
Modbus slave in a network. Requests from a Modbus server will be received
and answered.
"Enable": Do not enable any Modbus RTU server if not needed.
"UART": Select the UART to be associated to the Modbus RTU server.
NOTE: Once a given UART is selected to be a Modbus RTU server, it cannot be
used with any other configuration such as COM client.
"Address": Define Modbus address for MX-9. Modbus master must send
requests to the given address.
NOTE: After configuration is completed, click on "Set" button in order to save
changes.
5.5 Communication > Data transfer
Data collected by MX-9 can be sent in two different ways: FTP and MQTT protocols. In
both cases, parameters to be sent must be configured by setting up the data structure
following the next steps:
Go to Communication>Data transfer>Common parameters> and configure the
following parameters:
"Amount of group of registers": Number of registers or group of registers to be stored
in the CSV file.
"Set user archive". If selected, it enables automatic storage of selected registers in
the internal memory. It is recommended to always select this option so that in case
of file transmission failure, data can be retrieved and resent when communication is
reestablished.
"Parameter". It is filled in automatically.
"Register/Coil" Initial Modbus register address.
“Amount of registers”. Number of registers to be stored from the initial Modbus
registers address.
"Format": Data type of registered parameter.
"Header": Fixed column header to be written in CSV file.
"Dimension": Extra column in which data units can be stored.
Figure 19. “Data transfer” tab. CSV file structure definition

18
NOTE: Go to Archives>Configuration and specify ´User archive (min)´
value to set the datalogging period as shown in the following figure.
Figure 20. Setting up Datalogging period
NOTE: After configuration is completed, click on "Set" button in order to
save changes.
After configuring data structure, user can select in which way the device will send data. It
can be sent in a csv file to a remote FTP server or in a JSON formatted message to an
MQTT Broker.
1. Configure FTP client: Go to Communication>Data transfer>FTP> and configure the
following parameters:
“FTP server”: Up to 4 different FTP connections to remote FTP servers
can be configured.
"Enabled": Select it to enable an FTP connection
"FTP Port": By default, 21 but can be changed.
"Transfer period": It defines interval between CSV file sending
tasks.
"Number of last records to be read": It defines maximum number of
previous data stored and not sent due to communication error.
These data will be sent in a CSV file when communication is
restored.
"Transmission channel": It can be Ethernet or GPRS
“URL and directory of FTP servers”: It defines the complete FTP
server URL where CSV file will be hosted.
Username and password of FTP server: to be configured in case
credentials are requested by FTP server.

19
Figure 21. “Data transfer” tab. FTP client configuration
NOTE: In order to synchronize user archive storage and csv sending file through FTP link, the
following constraints must be taken into account:
"User archive sample time" must be equal or below the FTP "transfer period"
FTP "Repeat transfer if failure” time is recommended to be about half time of FTP "transfer
period".
2. Configure MQTT publisher: Go to Communication>Data transfer>MQTT> and
configure the following parameters:
“Topic”: A topic is a UTF-8 string, which is used by the broker to filter messages for each
connected client. A topic consists of one or more topic levels. Each topic level is
separated by a forward slash (topic level separator). Example: “building1/zoneA/room2”
“What type of data to be transferred”: It defines the functionality the device will have with
regard to MQTT data sending:
“Disabled”: if selected, the device will not send anything through MQTT port.
“Current values”: MX-9 will send real time values of parameters configured in Common
Parameters tab. In this case, sampling/sending period can be set from 1 to 86400
seconds.
“User Archive records”: this feature sends data every datalogging period set in
Archives>Configuration>´User archive (min)´ value.
NOTE: After configuration is completed, click on "Set" button in order to save
changes and “RESTART” (start menu>restart).

20
Figure 22. “Data transfer” tab. MQTT configuration
Once properly configured both this tab and Communication>MQTT Subscriber one, JSON
formatted messages will be sent to the MQTT Broker (for example, RabbitMQ) In the
following example, a “user archive records” message with a discrete input status is sent:
{
"SN":"86004",
"name":"MX-9",
"header":{
"startTime":"2016-02-07T15:06:00.000Z",
"endTime":"2016-02-07T15:06:00.000Z",
"recordCount":2,
"columns":{
"0":{
"id":"0",
"name":"relay1",
"dataType": "NUMBER",
"format":"unsigned short"
}
},
"data":[
{
"ts":"2016-02-07T15:06:00.000Z",
"f":{
"0":{"v":0}
}
}
]
}
5.6 Communication > FTP Server
If the MX-9 has a micro SD card installed, it can act as FTP server. In this tab, user can
configure both user and password to be used as credentials to enter into the internal file
system through an FTP connection.