If you don’t intend on adding a Modbus TCP device, skip to the next section.

The instructions below detail how to integrate multiple Modbus devices in bulk. You’ll need to create a .CSV file with the Modbus data point data and import it to Building Operator Discovery. Then, a Modbus device must be created in Building Operator Discovery and the CSV file assigned.

Creating .CSV file

To create a .CSV file, see the information below.

Download Template: http://www.siemens.com/download?A6V11971292


Please note that in this file, you must:

  • Begin column "A' data with lowercase letters.
  • Add a ping register so that Building Operator Discovery can monitor the controller to make sure it’s active.
  • Manually upload this file to Building Operator Discovery.

Configuration Information

The following information is required to help configure your .CSV file.

  • name (required): Name of the register. It must be unique and must start with a lowercase letter (a-z). A-Z, a-z, 0-9, and underscores are allowed. No spaces or other special characters.
  • addr (required): The address of the register that follows the Modbus convention.
    • 0xxxx - Coil (00001-065536)
    • 1xxxx - Discrete Input (10001-165536)
    • 3xxxx - Input Register (30001-365536)
    • 4xxxx - Holding Register (40001-465536)
  • data (required) - this defines the data type of the register.
    • Bit Mask Types: Supports a position notation for cases where bits are packed into input or holding registers. Format: name, addr, data, rw.
      Examples:
      - do0, 40101, bit:0, rw
      - do1, 40101, bit:1, rw
      - do2, 40101, bit:2, rw
    • Word and Byte Order: If register data not stored in network byte order, you can specify the order using suffix.
      - u2le Unsigned 16-bit Int - Little endian byte and word order
      - u2leb Unsigned 16-bit Int - Little endian byte order only
      - u2lew Unsigned 16-bit Int - Little endian word order only
  • rw (required): Determines read and write permissions.
    • rw: Register may be read and written.
    • r: Register is read-only.
    • w: Register is write-only.
  • scale (optional): Allows user to apply a scale factor to the registers. Format: (operator)(number) where the number is a numeric constant.
  • Examples:
    • Add: +1.5
    • Minus: -0.25
    • Multiply: *10
    • Division: /1000
  • dis (optional): An optional tag that allows the user to specify a display name for the register.
  • unit (optional): Defines the unit to use for the register.
  • tags (optional): Tags to apply to the point when learned into the database.
  • folderPath (optional): Organize points by applying a folderPath.

Uploading a .CSV File to Building Operator Discovery

Once you’ve configured the file, it’s time to upload it to Building Operator Discovery.

  1. Select and expand the Modbus drop-down in the Navigation tree.
  1. Select Register Maps.
  1. Select Upload, below the Modbus Register Maps list. You won’t see any results if you haven’t uploaded a Modbus file yet.
  1. Select Choose File. Select the appropriate file from your device.
  1. Select Upload to proceed. Your file will now appear in the Modbus Register Maps list results.

Adding a Modbus connector

Once you’ve uploaded the file, you must then create a Modbus connector. This connector will help you add data points to your Modbus devices later.

Modbus Properties

  • Dis: Name of connector
  • ModbusSlave: The salve of the Modbus device being connected (default is 1).
  • Existing Register Map: If you've already configured a Modbus connector, this property will let you choose from a list of available registers or to create a new one with ModbusRegMapUri.
  • ModbusRegMapUri: Specify the name of the register map to link with this connector. Replace "xxx" with whatever the name of the register map is.
  • Uri: To specify the Uri, enter the host, protocol, and port (default 502).

Supported Protocols

Protocol Type

Address

TCP/IP

modbus-tcp://host/

RTU over TCP/IP

modbus-rtutcp://host/

To add a Modbus connector:

  1. Navigate to and expand Connectors > Modbus in the Navigation tree.
  1. Select + Add.
  1. In the pop-up, select the Existing Register Map drop-down and select the file you just uploaded.
  1. (Optional) If you have not yet uploaded the register map file, you can supply a ModbusRegMapURI.
  1. The Uri field gives information on the Modbus address. You can leave “modbus-tcp://” as the protocol address and replace “host” with the device’s IP address.
  1. Select Add when finished.