WM Config Tool Manual

From Advanticsys Tech Resources
Jump to: navigation, search

The WM Config Tool is a free desktop application available for our customers that allows a simple way to configure our DM-124 and DM-108 wireless Modbus bridges and our lighting control device HL-108. On this page you will find the user manual for the latest version of the application which can be downloaded from here

Installation

Welcome to the User Manual of the Configuration Tool for AdvanticSYS DM-124, DM-108 and HL-108 devices. This guide aims to cover step by step and in the simplest and shortest way, all issues concerning configuration, such as installation, usage and potential problems that may arise during the execution of the software tool.


Requirements

In the table below, minimum and recommended hardware and software requirements are listed.

Requisitos eng.png
Minimum and recommended requirements

Dependencies

To run the configurator user needs install the Microsoft Framework .NET v3.5 package or higher. During the installation process, it will automatically check if your computer has this software package installed. If not, it will proceed with the installation, so that you can start installing the WM Config Tool even if you are not sure whether .NET is installed on your system.

Execution and installation

To start the installion process, double-click the installation file. An installation wizard will start. Once you accept the license agreement, the wizard will let you select the folder where the files will be copied and if you want to create a shortcut on the desktop and in the start menu. Before completing the installation, it will check if. NET is installed on your computer, proceeding to install it if not detected.

Supported Devices

This configuration software is compatible with DM-124, DM-108 and HL-108 devices.

Connection

Configuration of DM-124 or DM-108 devices can be done in several ways:

  • Communicating via the RS-485 bus using Modbus RTU protocol
  • Only for DM-124: via radio using a UD1000 dongle


The WM Config Tool permits using any of the above, by simply selecting the corresponding option in the right hand side of the initial screen:

WM ConfigTool StartScreen.png
WM ConfigTool Initial Screen


RS485

Connect the RS-485 terminals A and B to the corresponding lines of your bus. It is assumed that access to the RS-485 bus is possible from a computer, for example through a USB-485 converter. Once a serial port is available, select RS485 as connection option, and then edit the corresponding parameters for the bus (baudrate, parity, data & stop bits). Finally, press the button labeled Connect in the lower right hand side corner of the screen.

DM-124 TerminalConnections.png
DM-124 Terminal Connections
DM-108 TerminalConnections.png
DM-108 Terminal Connections

Radio (only for DM-124)

This option is only available for DM-124. To make use of the radio configuration an UD1000 dongle is needed. Connect the UD1000 to your computer and in the configurator select OTA as connection option. It is necessary to indicate the serial port assigned to the UD1000 in the computer as well as the radio channel the DM-124 network is using. As always, press the button labeled Connect in the lower right hand side corner of the screen.

Devices scanning

Once connected, it is possible to scan for devices in different ways. To attempt to perform a broadcast scan, leave unchecked the Scan checkbox. If on the other hand a specific Modbus id or range of ids is desired then activate the Scan checkbox and specify the range of ids to be searched. Press the magnifying lens button to start searching, and the Stop button to cancel a running scan. As new devices are found they will be automatically added to the config tool.


WM ConfigTool ScanOptions.png
WM ConfigTool Scan Options


Depending of the modules connected, DM-124 and DM-108 have differents fields for their configuration:

  • DM-124
WM Config Tool: DM-124 Data Retrieved

From this screen it is possible to edit the different parameters to configure the DM-124 to work as needed. It is important to know exactly what the role of the DM-124 is going to be, so first of all it may be advisable to take a look at the theory of operation here. After having a clear view on the type of installation desired, proceed to the following section to see how to do it.

  • DM-108
WM Config Tool: DM-108 Data Retrieved

From this screen it is possible to edit the different parameters to configure the DM-108 to work as needed. It is important to know exactly what the role of the DM-108 is going to be, checking the Coordinator checkbox if it is necessary. After having a clear view on the type of installation desired, proceed to the following section to see how to do it.

Usage

DM-124 Parameters Configuration

Modbus Parameters

The DM-124 can have the following Modbus RTU parameters configured:

  • Modbus id (anything between 1 and 247).
  • RS-485 configuration parameters (baudrate, parity, start & stop bits, up to 19200 baudrate).
  • Packet-silence time, in milliseconds, in case the Modbus RTU default silence period is not the most adequate one to interface with a connected device.

By default, a brand new DM-124 has 1 as Modbus id, 19200 8 N 1 as RS485 configuration and the standards silence period between packets.

Important: the DM-124 must have a unique Modbus id inside the Modbus network, as in itself it is a Modbus node. Choose a Modbus id multiple of 10 if you want this DM-124 to act as network coordinator (i.e. if it is going to be connected to the Modbus Master device). There can only be one network coordinator inside a DM-124 cluster.

DM-124 Modbus Parameters

Radio Parameters

The DM-124 can have the following wireless parameters configured:

  • Radio id, anything between 1 and 65534
  • Group id, anything between 1 and 254
  • Radio Channel, anything between 11 and 26

By default, a brand new DM-124 has a random Radio id, 34 as Group id and uses Radio Channel 15.

Important: the DM-124 must have a unique Radio id inside the cluster. A cluster is established by DM-124 devices that have the same Group id and Radio Channel.

DM-124 Radio Parameters

Slave Device Parameters

Additionally it is possible to map other AdvanticSyS compatible wireless sensors to the DM-124. This enables to access data provided by the sensors by ready the associated DM-124 registers.

To add new slave devices select the desired number with the Slave Motes drop down list at the left of the screen. This will add the new slave devices to the main configuration area at the right hand side:

DM-124 Edit number of Slave Wireless Devices

Configuration appears in red if there is some incompatibility with the chosen options. The slave devices must have different radio ids among them, and with the DM-124 itself. Once the incompatibilities are solved the configuration screen appears as follows:

DM-124 Edit Slave Device Configuration

It is possible to view the slave data that is being gathered by pressing the View Slave Data button. This opens a window in which we can select the register we want to read. However, the device will return valid data only when fresh data is written, otherwise it will return a Modbus exception until a new slave transmission updates the register.

DM-124 Slave Data

Pulse Counter Settings

The included pulse counter can be read by clicking the appropriate icon, and it can also be set to a specific starting value by writing a value and clicking the pencil icon.

DM-124 Pulse Counter

Default Parameters

It is possible to return to the default settings by pressing the Set Default Values button:

DM-124 Default Settings Button

DM-108 Parameters Configuration

Modbus Parameters

The DM-108 can have the following Modbus RTU parameters configured:

  • Modbus id (anything between 1 and 247).
  • RS-485 configuration parameters (baudrate, parity, start & stop bits, up to 19200 baudrate).

By default, a brand new DM-108 has 19200 8 N 1 as RS485 configuration. The Modbus ID is random.

Important: the DM-108 must have a unique Modbus ID inside the Modbus network, as in itself it is a Modbus node.

DM-108 Modbus Parameters

Radio Parameters

The DM-108 can have the following wireless parameters configured:

  • Radio ID (value range: between 258 and 65280). The Radio ID 257 is reserved only for the DM-108 which will be the Coordinator. We recommend not to change the default value under any circumstance.
  • The Coordinator checkbox actives that role for the DM-108. The checking also changes the Radio ID to 257. If it is unchecked, the role of DM-108 is to be Endpoint. After the unchecking, by default, the Radio ID backs to the original Radio ID.
  • Group ID, anything between 0 and 255.
  • Radio Channel, anything between 0 and 9.
  • TX Power, list of different selectable power levels in dBm, between -2 and +26 dBm.
  • AES Encryption Enabled. This option enables the wireless security based on the AES 128bits algorithm. Its disabling increase mildly the speed of communications.
  • ACK Enabled: This parameter enables the acknowledgement between radio messages. Its enabling strengthens the wireless communications and avoids the loss of Modbus requests. If it is disabled, the Modbus master has all the control of the timeouts and retries of the Modbus data frames.
  • ACK Timeout. Passed this time, a radio message is considered lost, which means that the ACK of the transmitted message has not been received.
  • ACK Retries. It is the number of retransmissions after an ACK fail.

By default, a brand new DM-108 has a random Radio ID, Endpoint role, 0 as Group ID, Radio Channel 0 and +26dBm TX power.

Important: the DM-108 must have an unique Radio ID inside the radio network. A cluster is established by DM-108 devices that have the same Group id and Radio Channel. Each cluster must have only one Coordinator.

DM-108 Radio Parameters

Pulse Counter Settings

The included pulse counter can be read by clicking the appropriate icon, and it can also be set to a specific starting value by writing a value and clicking the pencil icon. It is also possible to select the type of pulse edge.

DM-108 Pulse Counter

Default Parameters

It is possible to return to the default settings by pressing the Set Default Values , which is below the Update button:

DM-108 Default Settings Button

Apply changes

Once finished with the different settings, it is necessary to upload the new configuration to the device. To do so, press the Upload button. A progress bar will indicate the process finalization:

WM Upload Settings

Resources