gxdn

GXDLMSDirector

Gurux DLMSDirector is an easy-to-use application to communicate with DLMS/COSEM smart meters.
You can connect to one or more physical DLMS devices with GXDLMSDirector and you can select whether to read values from all listed devices, or one of them, or just a single object of a single device.

User Interface

  1. Menu bar holds the menus.
  2. Toolbar holds shortcut icons to most common commands.
  3. Devices collection lists the available items (Collection, Devices or Registers).
  4. Content view shows the properties and / or value(s) of the selected item.
  5. Status bar holds a ProgressBar to display the progress of the operation, when retrieving registers, or reading values from a physical device.

File menu
 

File menu
  • To create a new collection of Devices, select New.
  • To add a Device in collection of Devices, select AddDevice.
  • To open an existing collection of Devices, select Open.
  • To save the current collection of Devices, select Save.
  • To save the current collection of Devices on a different name or to a different location, select Save As...
  • To retrieve the register objects of selected Collection or Device, select Refresh.
  • To exit the application, select Exit.

View menu
 

View menu
  • To view / hide the toolbar, select / unselect ToolBar.
  • To view / hide the statusbar, select / unselect StatusBar.
  • To view / edit the properties of selected Collection or Device, select Properties...
Tools menu 

Tools menu
  • To connect to selected Collection or Device, select Connect.
  • To disconnect from selected Collection or Device, select Disconnect.
  • To get the values of selected Collection or Device, select Read.
  • To write value(s) of selected Data Object, select Write.
  • To remove selected Device or Register from the list, select Delete.
  • To view the Log as a text file, select View Log.
    Note: The text file does not update, it only shows the current rows of the Log.
  • To erase the rows of the Log, select Clear Log.
  • To view / edit / add device manufacturers, select Manufacturers...
  • To view / edit OBIS codes, select OBIS codes...
Graph menu 

Graph menu holds the command for displaying the Graph Items of the selected Object.
Help menu 

Help menu holds commands for opening
  • this manual (Contents...), and
  • the application information box (About...).

Shortcut Icons on GXDLMSDirector ToolBar

New Create a new collection of Devices.
Open Open an existing collection of Devices
Save Save the current collection of Devices to the file.
Connect/Disconnect Connect to / disconnect from selected Collection or Device
Read Read the values of selected Collection or Device
Write Write the value(s) of selected Data Object
Properties View / edit the properties of selected Collection or Device
Delete Remove selected Device or data object from the list

Content views of selected items

Various data is shown in the content view, according to, what kind of an item is selected.

Selecting the collection shows a list of Devices in the collection.
Selecting a Device shows data tables (aka Profile Generic) and objects of the selected device.
Selecting a Table shows the data table. Also the values in a data table are displayed, if they have been read.
Selecting a object shows caontent of the object.

Getting started with GXDLMSDirector

To communicate with a DLMS device using GXDLMSDirector, the physical device needs to be represented by a Device in the application.

A representative Device allows you to:
  • select device manufacturer
  • set the type and settings of the connection between the physical device and the application,
  • Read what data meter offers and then selecting what data is wanted to read, and
  • read the values of selected registers from the physical device.
With DLMS/COSEM standard, manufacturers can use different Client address, Server Address and Logical Name Referencing. If one of those parameters is wrong, meter do not answer anything.

Note:
When starting GXDLMSDirector for the first time after installing it, you get a pop-up saying that Manufacturer Settings are not present. The pop-up also asks, whether you want to install them online from Gurux web. It is recommended to install the latest settings online. In this way you do not need to know manufacturer dependent settings.

Create a collection of Devices

  1. To start a new collection of Devices, select New in the File menu.
  2. To add a your device(s) in the new collection, select Add Device in the File menu.
  3. In the opening Device Properties dialog:
    • Enter a Name for your device.
    • In the Manufacturer drop-down menu, select the manufacturer of your device.
    • In the Media drop-down menu, select the connection type to use.
    • In the Authentication drop-down menu, select the authentication (None, Low, High), and
      enter the Password, if needed.
    • Then enter / select the ID information of the device, in the Addressing box, displaying selections and fields according to the selected device manufacturer.
    • Next, set the Media specific settings in the Settings box, displaying selections and fields according to the selected connection type.
    • Finally, click OK.

Your device now appears in the Devices collection, on the left column of the user interface.
Add all the required representatives in the Devices collection the same way.

Determine the registers to use

To determine the registers of the physical device, retrieve the register objects from the device. If there are registers that are not needed, you can delete them. To retrieve the registers of a physical device, it needs to have a properly set Device representative, as guided above.

Making connection to the device

  1. In the collection of Devices, select the device to connect to.
    Note: To connect to all devices, select the collection (Devices).
  2. In the Tools menu, select Connect.

Reading available objects from the device

When connection is made for a first time there are on objects on the device. This is because every device can offer different kinds of information. To find out what kind of data meter can offer Association View is read. This is done selecting Refresh from Tools menu. This may take a while, depending on the amount of registers in the device and the used connection type. When the objects are retrieved, save the devices.
In this way you won't need to retrieve the register objects every time you start communicating with the device.

Delete the data objects that are not needed

If you want to you can delete data objects that you are not interested. It's done like this.
  1. In the collection of Devices, select the data object to delete.
  2. In the Tools menu, select Disconnect, if not disconnected already.
  3. In the Tools menu, select Delete.
Note
Association View can be read any time later if you want to refresh content of meter.

Delete the devices that are not needed

  1. Select the device to remove.
  2. In the Tools menu, select Disconnect, if not disconnected already.
  3. In the Tools menu, select Delete.

Communicate with the device

Now that your system is all set, you can start communicating with your DLMS device.

  1. On the left column list, select the item (Collection, Device, or data object) to read.
  2. In the Tools menu, select Connect, if not connected already.
  3. When connected, select Read to retrieve the device values.
Note 1: The device may get disconnected, if it is busy doing its main task, which is measuring consumption of electricity. If that happens just connect to the meter again. Some meters need some time before re-connection can be made.

Device Properties

By default the settings given in Manufacturer Settings are used to communicate with a device. However, when adding a new Device in the system, the Device Properties dialog includes text fields and drop-down lists to change the editable settings of a device.

Device Settings

Media specific settings

Device Properties dialog asks for media specific settings, according to the selected connection media.

Net

  • Enter the Host name (IP Address of the physical device).
  • Enter the number of the Port to use.
  • Check the check box if using Serial port through ethernet.

Serial

  • Select the Serial Port to use.
  • To set more accurate settings (BitRate, DataBits, Parity, StopBits, ParityCheck, and Flow Control), click the Advanced... button.

Terminal

  • Enter the Phone Number.
  • Select the Serial Port to use.
  • To set more accurate settings (BitRate, DataBits, Parity, StopBits, and Flow Control), click the Advanced... button.

Supported Device Manufacturers

To view the list of manufacturers, whose devices have build-in support in GXDLMSDirector,
select Manufacturers..., in the Tools menu

In the opening Manufacturers dialog

  • on the left, you get a (1) list of the supported device manufacturers, and
  • on the right, you see the (2) manufacturer specific settings
    (of the selected manufacturer).

Below the settings are (3) buttons to

  • add a new manufacturer to the list
  • edit the settings of any listed manufacturer
  • remove a manufacturer from the list,
    and below them, (4) button to update manufacturer settings online, and (5) buttons to confirm, or cancel the removal.

Add a manufacturer in the list

  • In the Manufacturers dialog, click the New button.
  • In the opening Manufacturer Settings dialog (picture below)
    1. enter the Name and ID of the manufacturer company
    2. check, whether to use Logical name referencing
      • using Logical Names (LN) is based on OBIS codes
      • Short Names (SN) use simply register addresses
    3. check, whether to use IEC 62056-47
      • COSEM transport layers for IPv4 networks
      • relevant only with Network connection
    4. select what to do, when there is no data traffic, by setting the Inactivity Mode
      (an example below)
      • None = nothing is done
      • KeepAlive = the Alive message is sent, according to the time set in KeepAlive Interval
      • Reopen = connection is opened again
      • ReopenActive = the connection to the device is opened again, even during data transfer

    5. set the time (in seconds) waited before, and in between, operations by setting the KeepAlive Interval
    6. select the Start Protocol
      • starting protocol: IEC (default) or straight DLMS
    7. In the Addressing section
      • check, whether to Enable authentication, and select Authentication level None / Low / High
      • set Client Address in Hex
    8. In the Server Address section
      • select the Address Type:
        • Default (according to the standard),
        • SerialNumber (used in multi-drop connections to get a unique HDLC address for each device), or
        • Custom (for devices that do not support the standard)
      • select the Type of the server address: Byte / UInt16 / UInt32
      • enter Serial Number Formula, if using SerialNumber Address Type
      • set the Physical and Logical address, to form the server address
    9. Finally, to close the Manufacturer Settings dialog, and save the added manufacturer, click OK.
  • Back in the Manufacturers dialog, click the OK button.
  • Exit, and restart GXDLMSDirector, for the changes to take effect.


Note: The settings set here are used by default, when adding a new device in the system.
However, some of the manufacturer dependent settings can be changed for a device, when adding it.


 
About Inactivity Mode and KeepAlive Interval

By default an Alive message is sent to the device, if there has been no traffic for a determined time. The time is determined by setting the KeepAlive Interval.

If the device replies to the message, the determined time is waited, and a new message is sent, and so on.

But if the determined time goes by, and no answer is received from the device, the operation set in Inactivity Mode is carried out.

For example:

You set KeepAlive Interval to 40, and Inactivity Mode to Reopen.
After no traffic has been detected for 40 seconds, an Alive message is sent to the device.

If the device replies to the message, 40 seconds is waited, and a new message is sent, and so on.

But if no answer is received in 40 seconds, the connection to the device is closed, and then opened again.


Edit manufacturer specific settings

  1. In the Manufacturers dialog, select the manufacturer, whose settings to edit.
  2. Click the Edit button.
  3. In the opening Manufacturer Settings dialog, edit the required settings.
  4. Save the changes by clicking the OK button.
  5. Back in the Manufacturers dialog, click the OK button.
Notes:
  • The Manufacturer ID is not editable, once it is set. This is to avoid errors that occur, if the ID is changed by mistake.
  • If the Manufacturer ID needs to be changed, you need to
    • Create a new Manufacturer with a correct ID.
    • Remove the one with the incorrect ID.


Remove a manufacturer from the list

To remove an existing manufacturer from the list
  1. Select the manufacturer to remove.
  2. Click Remove button.
  3. Click OK button to confirm the removal.

Attention, Device Manufacturers
If your meter type is not yet in the list of supported manufacturers, kindly, send us the settings, and we'll publish a manufacturer template for your device type, too. This way, you will get more visibility, and our users will get more easy-to-use options.

To get your settings in the list

  1. Save your settings by creating a new manufacturer with your name and ID.
  2. Restart GXDLMSDirector.
  3. Go to directory C:\ProgramData\Gurux\OBIS or, in older systems, C:\Program Files\Common Files\Gurux\OBIS.
  4. Copy the .obx file with your ID, and attach it to an E-mail message to us.

 


 
When there are new manufacturer templates available, you get a notification on the UI of GXDLMSDirector.
 


 
The OBIS (Object Identification System) determines the identification of data objects in DLMS/COSEM communication. The OBIS codes are used as Logical names of data objects. The DLMS User Association defines and allocates OBIS codes, and maintains list of valid OBIS codes. All the device manufacturers, however, have not abided by the recommendations. This is why the OBIS codes are made editable, to some degree, in GXDLMSDirector.

Though it is made possible, it is not recommended to add OBIS codes manually in the GXDLMSDirector, but to get them directly from the physical device itself. This is done by adding a device in the Devices Collection, and retrieving the register objects from the physical device, as guided in section Getting started. Once you have retrieved the register objects from the device, you can view their OBIS codes.

The OBIS codes of devices of the supported device manufacturers are automatically available in the OBIS codes dialog.

To view the OBIS codes

  1. In the Tools menu, select OBIS codes...

  2. In the opening OBIS codes dialog, on the left, you get a list of the supported device manufacturers.

  3. In the OBIS codes dialog, select the manufacturer, whose OBIS codes to view.

  4. A list of OBIS codes of the selected manufacturer is displayed on the right.

  5. Double-click an OBIS code in the list, to open it in the OBIScode form:



           
 



In the OBIS Code Form you can edit
  • The LogicalName
  • Description of the OBIS code
  • ValueType, if available
  • ValueUIType, if available, and
  • the Interface, which the selected OBIS code belongs to.
  • you can also add / edit / remove enumerated values in the Value Editor.

To edit the OBIS codes

  1. To edit the LogicalName or Description, just replace the text in the text field.
  2. To edit ValueType, or ValueUIType
    • Click on the row to edit,
    • open the drop-down list of available options by clicking on the arrow down, in the end of the row, and
    • select the required option in the drop down list.
  3. To change the Interface, select the correct one in the drop-down list (top left in OBIS Code Form).
  4. To add / edit / remove enumerated values, see section Value Editor below.
  5. When all required properties of the OBIS code are edited, click OK to save the changes.



Value Editor

In the Value Editor, the top most drop-down list shows the items available to edit. The enumerated device values, and the corresponding UI values, are shown in the list.

In the example picture, on the right Status of the Clock register is selected.

Below the list are buttons for creating a new, editing and removing a device value / UI value pair.

This way you can easily remove the value pairs that your device does not support, from the list, or edit which UI Value is to represent which Device Value. You can also add new value pairs, if they are not all listed.

The purpose of using device values and UI values as pairs, is to make interpretation of the read data easier for the user. With value pairs, the user gets information in human language, and does not have to know, or to remember, which device language value means which.

An example of using a value pair:
Let us assume that value one means that the device is turned on. When the value, retrieved from the device, equals one, the application displays "ON", instead of "1".

 



Read values from a physical device

  1. In the left column listing, select the item to read, by clicking its name.
    • To read all registers of all devices in the listing, select the collection of Devices.
    • To read all registers of one device, select the Device to read.
    • To read a single register:
      • first click the plus sign next to the name of the Device,
      • then select the Register to read.
  2. After selecting the item to read, select Connect in the Tools menu, if not connected already.
  3. When connected, select Read in the Tools menu to retrieve the device values.

Note: Once you have selected a Register, you can change

  • the ValueType of the register object, by selecting the required type in the drop-down list
  • the Description of the register object, by typing a new description in the text field

Edit and write values back to a physical device

  1. In the left column listing, select the item, whose value to edit, by clicking its name.
  2. Enter the new value to the Value text field.
  3. Press Enter.

    A Value changed icon appears
    • at the end of the row of the edited value, and
    • on the edited data object, in the Device Tree, on the left.
  4. To write the edited value back to the device, select Write in the Tools menu.

Note: You can only write one data obejct at a time.


Tip: You can also use the shortcut icons in the Toolbar to
  • Connect to
  • Disconnect from
  • Read values from and
  • Write values to
  • a physical device.
h2>Read values and display them graphically Note: Only values of data objects of type table can be displayed graphically.

Read table values

  1. In the left column listing, select the table to read, by clicking its name.
  2. After selecting the table, select Connect in the Tools menu, if not connected already.
  3. When connected, select what values are read by checking the relevant check box.

  4. Select Read in the Tools menu to retrieve the values.
  5. When values are read, select the Graph tab to display the values graphically.


Select items to show in / to leave out of the graphic

  1. In the left column listing, select the table, whose graphical display to edit, by clicking its name.
  2. Select Displayed Data... in the Graph menu.
  3. In the opening Graph Items dialog, select the item to leave out of the graphic, by clicking its name.
  4. Disable the displaying of the item, by changing the value of Enabled property to False.
  5. The color of the disabled value is no longer shown in the Graph Items list, it has been replaced by a red tick.





Edit the colors of the graphic

  1. In the Graph Items dialog, select the item, whose color to change, by clicking its name.
  2. Change the color by clicking the arrow down icon, and selecting the required color.

Supported Operating systems:
  • Windows 8.1
  • Windows 8
  • Windows 7

Connection types
  • Net
  • Serial
  • Terminal

If you have any questions, suggestions or problems concerning GXDLMSDirector,
kindly present your questions and comments at our Forum.


Project type: 
Full project
Short name: 
GXDLMSDirector
Enable issue tracker: 
Yes
Has project releases: