Danfoss SonoRead Tool Operating guide

Operating Guide

SonoRead Tool Software

Table of Contents

1. Introduction ............................................................................................................................................... 2

1.1 Main characteristics ................................................................................................................................................................2

1.2 References ..................................................................................................................................................................................2

2. Installation procedure .............................................................................................................................. 2

2.1 Minimum requirements ........................................................................................................................................................2

2.2 Installation of the SonoRead Tool software ..................................................................................................................3

2.3 SonoRead Tool update...........................................................................................................................................................4

3. Software structure .................................................................................................................................... 4

3.1 Main screen ................................................................................................................................................................................4

3.2 Settings tool ...............................................................................................................................................................................5

3.2.1 SonoRead 868 wM-Bus .................................................................................................................................................5

3.2.2 General ................................................................................................................................................................................5

3.2.3 AES Key ................................................................................................................................................................................6

3.2.4 License .................................................................................................................................................................................7

3.3 Roads tool ...................................................................................................................................................................................7

3.3.1 Roads overview (start page) ........................................................................................................................................7

3.3.2 Managing a chosen Road .............................................................................................................................................8

3.3.3 Searching and filtering tasks in the road navigator ...........................................................................................9

3.3.4 Selecting multiple items ...............................................................................................................................................10

3.3.5 Create a new Road...........................................................................................................................................................10

3.3.6 Add a group or a task (device) to the road .............................................................................................................11

3.3.7 Display the state of a task .............................................................................................................................................11

3.3.8 Change an existing road file .......................................................................................................................................13

3.3.9 Execute a task ....................................................................................................................................................................14

3.3.10 Warnings .............................................................................................................................................................................14

3.3.11 List of error messages ....................................................................................................................................................15

3.4 Export tool .................................................................................................................................................................................15

3.4.1 Export characteristics ....................................................................................................................................................15

3.4.2 Exporting a road file .......................................................................................................................................................15

3.5 About tool ..................................................................................................................................................................................16

3.6 Feedback assistant ..................................................................................................................................................................16

4. Best Practice ............................................................................................................................................... 17

4.1 How to organize a road .........................................................................................................................................................17

4.1.1 Organizing Groups ..........................................................................................................................................................17

4.2 Recommended ways to edit the road .............................................................................................................................18

4.2.1 Copy content of a road to another road .................................................................................................................18

4.2.2 Combine two roads into a new road ........................................................................................................................18

4.2.3 Move part of a road to another road ........................................................................................................................18

5. Troubleshooting procedure ..................................................................................................................... 19

5.1 Procedure to follow ................................................................................................................................................................19

Operating Guide SonoRead Tool

1. Introduction

1.1 Main characteristics

SonoRead Tool software permits remote

reading of the data from Danfoss SonoHCA radio devices. For this purpose, the SonoRead Tool software works with the SonoRead 868 radio modems.

The list of devices to read is saved in a road file in XML format. The road files can be created or modified directly using the SonoRead Tool software.

A road file contains a list of tasks organized in groups of subgroups. The SonoRead Tool software can only work on a single road file at a time, but several can be stored with easy transition from one road file to another.

The data produced by performing the task (read) are inserted in the road file. The file is updated when the task is completed. The road file is automatically saved whenever its content is changed.

Tasks can be performed individually or in groups.

The road files – in xml format – can be read and changed using a simple text editor. Most databases include export and import functions in xml format.

This software runs on computer or tablet with Windows OS.

This document gives important information about the installation and use of the SonoRead Too l softwa re.

In addition, a road can be created or changed using the SonoRead Tool software. A task or a group can be added, changed, deleted or reinitialised.

The SonoRead Tool software can be translated into other languages. For further information about the translation tools, please contact Danfoss directly.

The SonoRead Tool software works with the radio modem SonoRead 868.

SonoRead Tool software connects to the modems using Bluetooth.

1.2 References

2. Installation procedure

2.1 Minimum requirements

[1]Open Metering System Technical Report 03, XML-Key Exchange, Issue 1.0.2 / 2015-10,

available at:

http://oms-group.org/en/download4all/technicalreports/

The SonoRead Tool software can be obtained by contacting your local representative.

The following equipment is needed to run the SonoRead Tool software:

• PC computer or tactile tablet with: Windows 7 32/64 bits operating system

• 2 GB memory

• Screen resolution: 1024x768 pixels

• Bluetooth connection if used with

SonoRead 868

It is advisable to have:

• A SonoRead 868 radio modem to perform tests

• Internet access to update the software

Remark fo r Windows 10 users:

The generic COM ports provided by the integrated driver of Windows 10 aren’t always working. It can be necessary to install the manufacturer Bluetooth drivers to create a COM port which work with the SonoRead Tool!

2 | VU.SH.D1.02 © Danfoss | 2019.05

Operating Guide SonoRead Tool

2.2 Installation of the SonoRead Tool software

The SonoRead Tool_<version>.exe file launches the installation of the SonoRead Tool software.

Procedure to install the application:

• Double click on the Setup.exe icon to launch the installation program.

• The installation help window

“Setup – SonoRead Tool” will now appear.

• Installation of a shortcut on the desktop.

• Define the installation path and validate with

the Next button.

• If the installation directory does not exist, press the Yes button to create it.

• Press the Install button to start the program installation procedure.

• The files are now being installed on the PC computer or tactile tablet.

When you click on the Finish button, the SonoRead Tool software will be launched automatically.

• A window will show you when the installation has been completed.

VU.SH.D1.02 | 3© Danfoss | 2019.05

Operating Guide SonoRead Tool

2.3 SonoRead Tool update

3. Software structure

3.1 Main screen

An automatic check for updates done at the start-up can be configured using the Settings tool.

You can also check for updates manually in: About  Check for updates.

Launch the software with the SonoRead Tool shortcut created during installation.

The main menu of the SonoRead Tool software enables one of the available tools to be chosen. Select the tool by clicking on the appropriate button in the main window.

When the installation file for a new release has been downloaded, simply follow the installation procedure described above. There is no need to uninstall the old release. When the SonoRead Tool software is uninstalled, the data (roads, user preference) will be kept in the respective directories.

Main functions of the Export button:

4 | VU.SH.D1.02 © Danfoss | 2019.05

Operating Guide SonoRead Tool

3.2 Settings tool

The Settings tool defines the SonoRead Tool user parameters. Settings are grouped into the following sections:

1. SonoRead 868 settings

2. General settings

3. AES key settings

4. License settings

To save the changes please use the Save [1] button.

To return to the main software menu, click on the

Back [2] button.

3.2.1 SonoRead 868 wM-Bus

3.2.2 General

• COM port Define the communication port to which

the SonoRead 868 radio modem will be connected. Select the COM port to be used and press the Try connection button.

If successful: “Connection succeeded !”, if the

connection failed: “Unable to connect !”

• Maximum listening time

Defines the maximum time in minutes the

SonoRead Tool waits messages from the

wM-Bus devices that are scheduled to be

read. The time must be between 1 and 30 minutes.

• Language Enables the display language to be chosen.

A restart of the SonoRead Tool is mandatory for full support of the selected language.

• Check for update at start-up

• Show virtual keyboard Check/uncheck the box.

• Ensure radio address uniqueness

When adding or editing a task, the SonoRead

Tool will check that the entered radio address and task type (read/parametrization) combination is not already present in the current road.

Operating Guide SonoRead Tool

3.2.3 AES Key

C:\Users\username\Documents\SonoRead Tool\SonoReadToolDb

This section configures the encryption key settings. There are two main ways to handle the encryption keys:

1. Global encryption keys

With global encryption keys, groups of

installed devices share the same encryption key (e.g. different key based on the device type). SonoRead Tool supports three global keys and if defined, they are all tried when encrypted data is received from a device.

2. Individual encryption keys

With individual keys each device can have

its own. This mode is activated when the encryption key database is enabled in settings. When a device is read out, the possible individual keys are tried first before the global AES keys. Each parametrize task which programs the encryption key to the device will also add the key’s information into the database. In addition, SonoRead Tool supports import and export of the individual encryption keys using the OMS Key Exchange format [1]. It is possible to import new encryption keys into the database with a OMS Key Exchange format file. You can also export all the keys from the database into an OMS Key Exchange file.

With AES key settings you can define the default encryption keys that will be used to decrypt any data received from a device. In addition, you can enable the encryption key database to allow individual keys for each device as well as import and export of these files.

• AES Key 1 (default)

• AES Key 2

• AES Key 3 AES 128 encryption key values. If a Danfoss

product (e.g. SonoHCA) uses an AES encryption key, fill up one of the fields with the value of the key to visualize data. All the keys will be tried to decrypt the encrypted data.

AES Key 1 will be used as the default key when

a new parametrization task is added to a road.

• Use Encryption key database Check/uncheck the box to enable/disable

internal encryption key database. Each device has its own individual encryption key when the database is enabled.

• Database location Shows the location of the internal encryption

key database. You can select another location with the Browse button. If the selected

location is a directory with an existing database, it will be opened. If the selected directory is empty then a new database will be created. If multiple users share a common database then, all users need to be able to write to the selected location.

• Status Displays the status of the encryption key

database. When in use it should read “Database opened normally”.

• Default import/export key encryption key In the export and import files all encryption

keys are wrapped together, this field defines the default value of the key encryption key.

• Import Pressing this button starts the import of a

OMS Key Exchange file into the database, see chapter 3.2.4.1 for details.

• Export Pressing this button starts the export of

all keys in the database into an OMS Key Exchange file, see chapter 3.2.4.2 for details.

3.2.3.1 Importing an OMS Key Exchange file

• Press the Import button

• A file selection dialog will open; select the

OMS Key Exchange file you would like to import. If the signature validation fails for

the selected file a confirmation dialog will be shown.

• A new dialog will open; give the key encryption key that was used to create the file and press Import button on the dialog.

• Once the import is complete, a message dialog is opened with information about how many devices and keys have been imported. Pressing OK on the dialog completes the import process.

3.2.3.2 Exporting to an OMS Key Exchange

file

• Press the Export button

• A file selection dialog will open; select the

directory and file name for the OMS Key Exchange file.

• A new dialog will open; give the key encryption key to be used and press the Export button.

• Once the export is complete a message dialog will be opened with information about how many devices and keys have been exported. Pressing OK on the dialog completes the export process.

+ 14 hidden pages