Configurable Data Group

A "Configurable Data Group" (CfgDg or CfgMB) provides a flexible way to create custom data groups on a per-device basis by using the remote device editor. You can use such data groups in one-off scenarios like testing or, if the data group definition is more broadly useful, paste its XML into the applicable device template file. You may add and configure up to 999 of these data groups per remote device.

Best practice recommends first writing a thorough device template file to accommodate as many of your field devices as possible. Then use a remote device editor to add one or more "Configurable Data Group(s)" on an ad hoc basis to suit unique situations.

You might find the CygNet DDS Data Group Copy Utility useful for copying a unique "Configurable Data Group" to other remote devices. You might find the Device Copy utility useful for copying remote devices that use the "Configurable Data Group(s)."

See the following subsections for more information:

Define a Configurable Data Group

Perform the following steps to define a configurable data group.

To Define a Configurable Data Group

  1. Using CygNet Explorer, select the DDS pane, click the Remote Devices page, and open the remote device to which you want to add a "Configurable Data Group".
  2. In the remote device Properties editor, click the Data Group tab, click Add, and double-click Configurable Modbus Data Group.
  3. Define general data group properties, then click Configure. (Ord# is only used as a data group identifier; it has no special uses beyond identifying an instance of a "Configurable Data Group").
  4. In the Configurable Data Group Definition dialog box that opens, specify the Byte Order and other "Configurable Data Group" settings. See Configurable Modbus Data Group Definition Properties.
  5. Click Add Element to add a new element to your "Configurable Data Group."
  6. Highlight the new element and click Edit Element to define the new element.
  7. In the applicable Read from Device or Write to Device fields, define blocks. Click Add Block to add a new block to your "Configurable Data Group."
  8. Highlight the new block and click Edit Block to define the new block. Your finished "Configurable Data Group" might look something like this:

Configurable Modbus Data Group Definition

Click the thumbnail to see an example
Configurable Modbus Data Group Definition

  1. If you define the data group and want to add its XML to a device template file, click Edit XML and paste the data group XML into the applicable device template file.
  2. If you've deleted elements and/or blocks in the process of creating the data group and want to reorder the existing elements and/or blocks in sequential order, click Renumber Elements & Blocks. (If you've given an element a custom name, clicking Renumber Elements will overwrite the name.)
  3. When you are finished, click OK and click OK again.

Configurable Modbus Data Group Definition Properties

The following table lists and describes the properties of the Configurable Data Group Definition dialog box.

Item Description

Byte Order

Options are:

  • Big Endian
  • Little Endian
  • Motorola
  • Intel

See byteOrder.

Security Level

See secLev.

Elements

Item

The name of an element or block. The element name can be modified in the XML file; the block name cannot.

See DataGroupElement.

Description

See desc.

Reg Num

See regNum.

Reg Def

See regDef.

Reference

See ref.

Data Type

See type.

Conversion

Options are:

  • BartonTimeD
  • BartonTimeS
  • CopyBytes
  • JTime
  • JTimeD
  • JTimeS
  • Mod10K
  • ReverseBytes
  • WordSwap

See cvtF.

Edit Element

Click to edit the selected element.

Add Element

Click Add Element to add a new element. If another element is currently highlighted, the added element is a copy of the highlighted element.

See DataGroupElement.

Delete Element

Click to delete a selected element.

Read from Device - Read Blocks

Can Read

See canRecv.

Can Read via UIS Command

See uccRecv.

Item

The name of an element or block. The element name can be modified in the XML file; the block name cannot.

See DataGroupElement.

Starting Reg

See regNum.

Reg Offset

See regOff.

Reg Count

See regCnt.

Function Code

See funcCode.

Byte Length

See regByteLen.

Bit Length

See regBitLen.

Edit Block

Click to edit the selected block.

Add Block

Click Add Block to add a new block. If another block is currently highlighted, the added block is a copy of the highlighted block.

See block.

Delete Block

Click to delete a selected block.

Write to Device - Write Blocks

Can Write

See canSend.

Can Write via UIS Command

See uccSend.

Item

The name of an element or block. The element name can be modified in the XML file; the block name cannot.

See DataGroupElement.

Starting Reg

See regNum.

Reg Offset

See regOff.

Reg Count

See regCnt.

Function Code

See funcCode.

Byte Length

See regByteLen.

Bit Length

See regBitLen.

Edit Block

Click to edit the selected block.

Add Block

Click Add Block to add a new block. If another block is currently highlighted, the added block is a copy of the highlighted block.

See block.

Delete Block

Click to delete a selected block.

Edit XML

Click to open your "Configurable Data Group Definition" in an XML editor. Make changes if required. This is useful for fine-tuning your configurable data group definition or for copying and pasting the data group definition into a device template file.

Renumber Elements and Blocks

Click to reset the numbering of your elements and blocks to a simple consecutive format. This is useful if you've deleted elements or blocks and want the data group elements and blocks to be more tightly ordered. But clicking Renumber Elements and Blocks overwrites data group element IDs whose names you have changed in the configurable data group's XML definition.

Clear Definition

Click to clear the entire data group definition.

Define a Configurable Data Group Element

Perform the following steps to define a configurable data group element.

To Define a Configurable Data Group Element

  1. At the Configurable Modbus Data Group Definition dialog box, click Add Element. Add as many data group elements as your "Configurable Data Group" requires.
  2. Highlight the data group element you want to define and click Edit Element. A dialog box like the following appears:

Data Group Element Definition

Click the thumbnail to see an example
Modbus Data Group Element Definition

  1. Specify the Data Type and other "Configurable Data Group" data group element settings. See Data Group Data Group Element Definition Properties.
  2. When you are finished, click OK. Repeat steps 1 - 3 until you've added all required data group elements.

Data Group Element Definition Properties

The following table lists and describes the properties of the Data Group Element Definition dialog box.

Item Description

Description

See desc.

Data Type

See type.

Conversion

Options are:

  • BartonTimeD
  • BartonTimeS
  • CopyBytes
  • JTime
  • JTimeD
  • JTimeS
  • Mod10K
  • ReverseBytes
  • WordSwap

See cvtF.

Units

See units.

Optional Display Mask

See dMask.

Data source

By Register Number

Selecting this option enables editing of the Register Number field.

Register Number

See regNum.

By Block Reference and Offset

Selecting this option enables editing of the Block # Reference and Register Offset fields.

Block # Reference

See regDef.

Register Offset

See regDef.

By Element Reference

Selecting this option enables editing of the Element Reference field.

Element Reference

See ref.

Bit position

See bPos.

Bit mask

See bMask.

XOR mask

See bXorMask.

Define a Configurable Block

Perform the following steps to define a configurable block.

To Define a Configurable Block

  1. At the Configurable Modbus Data Group Definition dialog box, click Add Block. Add as many read and/or write blocks as your "Configurable Modbus Data Group" requires.
  2. Highlight the block you want to define and click Edit Block. A dialog box like the following appears:

Block Definition

Modbus Block Definition

  1. Specify the Starting Register Number and other "Configurable Data Group" block settings. See Block Definition Properties.
  2. When you are finished, click OK. Repeat steps 1 - 3 until you've added all required data group elements.

Block Definition Properties

The following table lists and describes the properties of the Block Definition dialog box.

Item Description

Starting Register Number

See regNum.

Register Offset

See regOff.

Register Count

See regCnt.

Function Code

See funcCode.

Register Length

By Byte Length

See regByteLen.

By Bit Length

See regBitLen.

Back to top