SIPORT Configuration File

According to the Modbus import specifications, the SIPORT configuration file must be a CSV file.

Refer to the Modbus_template_4.0_SystemDefPointInstances.CSV template in the folder:
<installation drive>:\GMSProjects\GMSmainProjects\Profiles\ModbusDataTemplate

Information

NOTE: The MP2.1 files are not directly supported. To adapt existing 2.1 files you can use the following conversion utility:
C:\GMSProjects\GMSMainProject\Bin\Siemens.Gms.Modbus.ModbusCsvConverter.exe
On the server station, start the conversion utility. When prompted, enter the 2.1 CSV file pathname.
In a few seconds, a new CSV file is created in the same folder as the source file. The name of the new file has the …_converted.CSV suffix.

CSV File Structure for SIPORT

As described in the Modbus documentation section, the CSV file can contain multiple tables, and not all of them are mandatory. For the purpose of the SIPORT integration, make sure to provide the following tables:

  • [DRIVER]: It must be Modbus TCP.
  • [FILE VERSION]: It must be 4, referring to the structure of V4 template.
  • [LIBRARY]: It must be Global_Modbus_HQ_1.
  • [POLLGROUPS]:
  • [CONNECTIONS]: Communication channels between SIPORT and the management platform. You must define one interface for each device. See details below.
  • [DEVICES]: Door controllers. See details below.
  • [POINTS]: Physical points. See details below.

Detailed Data Structures

[POLLGROUPS]

  • [PollGroupName]:
  • [Interval]:

[CONNECTIONS]

  • [ConnectionName]: Connection name, no special characters allowed.
  • [ConnectionDescription]: Connection description to display in System Browser.
  • [SlaveId]: Unique connection number >0.
  • [IP_Address]: Controller IP address.
  • [Port]: TCP Modbus port. Default value: 502.
  • [Active]:
  • [Offset]:
  • [FrameCoding]:
  • [Alias]: Optional alias name.
  • [FunctionName]: Not used.
  • [Discipline],[Subdiscipline],[Type],[Subtype]: Optional fields available to set the corresponding management platform properties.

[DEVICES]

  • [ParentConnectionName]: Name of the interface assigned to this device.
  • [DeviceName]: Device name.
  • [DeviceDescription]: Device description to display in System Browser.
  • [ObjectModel]: Not used. Leave this field empty. By default, the system will use the GMS_MODBUS_Device Object Model.
  • [AddressProfile]:
  • [Alias]: Optional alias name.
  • [FunctionName]: Not used.
  • [Discipline],[Subdiscipline],[Type],[Subtype]: Optional fields available to set the corresponding management platform properties.
  • [LogicalHierarchy]: Used to create a hierarchy in the Logical View.
  • [UserHierarchy]: Used to create a hierarchy in the User-Defined View.

[POINTS]

  • [ParentConnectionName]:
  • [ParentDeviceName]: Name of the device to which the point is connected.
  • [Name]: Point name, no special characters allowed.
  • [Description]: Point description to display in System Browser.
  • [FunctionCode]: Not used.
  • [Offset]: Used in combination with the import rules table to achieve the correct value of the register. No offset (0) is required for the controller in the first line. Readers can have the following offsets: 10, 20, 30, 40, 50, 60, 70, 80. The first reader always has offset 10, then add the following intervals: 10 for single readers and 20 for dual readers. For example, if the first 2 doors have dual readers and the others single readers, the offsets in the configuration will be: 10, 30, 50, 60, 70, 80.
    The first valid offset for I/Os is 100. Each of the following I/Os has to add 10 to the offset of the preceding one.
  • [SubIndex], [DataType], [Direction]: Not used.
  • [DataType]:
  • [Direction]:
  • [LowLevelComparison]:
  • [ObjectModel]: Name of the object model linked to this point.
    • Controller: GMS_MODBUS_Siport_Controller.
    • Dual reader: GMS_MODBUS_Siport_Dual_Readers
    • Single reader: GMS_MODBUS_Siport_Single_Reader
    • I/O: GMS_MODBUS_Siport_IO
  • [Property]:
  • [AddressProfile]:
  • [Alias]: Optional alias name.
  • [Function]: Not used.
  • [Discipline],[Subdiscipline],[Type],[Subtype]: Optional fields available to set the corresponding management platform properties.
  • [Min], [Max], [MinRaw], [MaxRaw], [MinEng], [MaxEng], [Resolution], [Unit], [StateText], [PollGroup], [AlarmClass], [AlarmType], [AlarmValue], [EventText], [NormalText], [UpperHysteresis], [LowerHysteresis], [NoAlarmOn]
  • [LogicalHierarchy]: Used to create a hierarchy in the Logical View.
  • [UserHierarchy]: Used to create a hierarchy in the User-Defined View.