Skip to main content

Plugin Configuration Reference

This page keeps each plugin's variable address, register string, and plugin-specific properties in one section. Search for the plugin name, verify the Variable address first, and then configure its properties. Common properties are described only once. See Plugin Catalog and Common Guidance for plugin scope and diagnostic entry points.

Verification Calibration

The current catalog contains 107 collection plugins and 15 data-forwarding target plugins. This page covers the variable address and visible fields for every plugin. Each plugin section contains only its address, specific properties, and necessary restrictions, so operators do not need to switch between pages.

First, distinguish between three types of attributes

Attribute locationOn-site meaningTypical troubleshooting points
Acquisition plugin attributesCommunication and protocol parameters when a collection device uses this protocol.If the device cannot read, the value is incorrect, or the write is slow, please check here.
Data forwarding group attributesDetermine which variables enter the forwarding chain and whether triggered by change or cycle.If a variable has a value but does not forward, first check the group range and trigger conditions.
Data forwarding target plugin propertiesConnection, upload format, cache, and variable mapping of an external system.If the target cannot connect, the external system cannot receive it, or the reverse writing does not work, check here.

Data Forwarding Group Properties

Data forwarding groups are not plugins, but they determine whether a variable qualifies to enter any forwarding target. When determining "why no data is sent" on site, first confirm in the following order: variable belongs to this group, group activated, trigger conditions met, target enabled, target connected successfully.

Configuration ItemsDescription
NameForwarding Group Name, which should be unique within the same system. It is recommended to reflect external systems and scopes, such as MES_ key points.
DescriptionClearly state the group's purpose, external systems, acceptance person, or maintenance boundaries to facilitate handover.
EnableWhen disabled, none of the targets in this group will start or generate forwarded data.
Log LevelControl the detail of the group's operation logs. You can temporarily use Debug for joint debugging, and after stabilization, switch back to Info.
Sortonly affects the page display order; the smaller the value, the higher it goes forward.
Variable Range ModeManual Manually select variables;All Enable all variables;CollectDevice Filter by device name; CollectGroup Filter by collection group.
Range ConfigurationEnter the device name when selecting CollectDevice; enter the collection group name when selecting CollectGroup. Multiple values are separated by English commas. Manual and All are usually left blank.
Trigger ModesChange Trigger by variable changes;Interval triggered only by period; IntervalOrChange Both changes and cycles are triggered.
Timed forwarding intervalUsed when triggered by cycles. For ordinary cycles, fill in milliseconds, for example, 1000; Cron expressions are only used for fixed-time tasks.
Online variables onlyOnce enabled, offline variables will not be forwarded. Do not enable the external system when it sees the last value before going offline.
Batch Processing ModeDetermines how to split batches of variables after a single trigger, for example, not splitting or splitting by data group.
Maximum batchmaximum number of variables per batch. Reduce when external interface timeouts, message body size is too large, or database pressure is high.

In-group Variable Attributes

These fields only indicate "how the variable participates in forwarding within the group" and cannot replace the target variable attributes.

Configuration ItemsDescription
VariablesCollection variables included in the current forwarding group. Manual mode, variables must be added to this group first.
After enablingand turning off, this variable does not participate in this group forwarding.
Data GroupsUsed for batch grouping, such as production lines, regions, and equipment groups. Batch processing mode is used when splitting data groups into groups.
Update ModeSingle-variable trigger method, with refined group-level trigger modes.
Participate group triggerAfter closure, this variable can still be uploaded in batches, but its own changes do not wake up the entire group.
AliasName of the external variable used during upload. When null, the original variable name is usually used.
SortOutput order of variables within the group.

Common Collection Attributes

Collect Retry Attributes

Configuration ItemsDescription
Number of failed retriesNumber of retries after a single read/write failure. Occasional jitter on the network or serial port can be appropriately increased; Long-term faults are too large and slow down fault feedback.
Read/Write Duty CycleWhen there are many write requests, perform several writes followed by a single read to avoid only writing without reading.
Write priorityPrioritizes write when there is a write task. Suitable for scenarios where control commands need to be issued quickly; normal collection can be kept off.

Foundation Universal Read/Write Attributes

Configuration ItemsDescription
Read/write timeoutSingle-read read/write wait time, unit: milliseconds. If the device response is slow or link delay is high, the speed can be increased appropriately.
Time Before FramesWait Time Before Sending a Packet, in milliseconds. Set frame spacing when older devices or serial buses are needed.
Reverse String ByteReverse and parse strings by byte or word. If the string order is incorrect, adjust accordingly.
Data parsing orderByte order/word order for multi-byte values. If the value is obviously too high, too small, or the symbol is incorrect, focus on verification.

Packing and DTU Properties

Configuration ItemsDescription
Maximum Package LengthMaximum address length for a single merge read. Efficiency can be improved when there are multiple points; The device does not support small size when large packages or frequent timeouts.
DTU IDDTU or transparent-terminal number. Direct-connected devices are usually left empty, and when accessed via DTU, they must match the field terminal number.

Common Address Conversion Suffixes

Collection plugins that decode raw bytes can append the following parameters to a register address. If a plugin does not support a suffix, follow that plugin's address description and the validation shown by the variable editor.

SuffixDescriptionExample
data=ABCD/BADC/CDAB/DCBAFour-byte data order. Adjust it when the address is correct but byte or word order is reversed.40001;data=CDAB
len=NString or fixed byte length.$PRO_NAME[];len=32
arraylen=NNumber of consecutive array elements.D100;arraylen=8
bcd=C8421/C5421/C2421/C3/GrayBCD or Gray encoding.D100;bcd=C8421
encoding=UTF-8String encoding; ASCII, Default, and Unicode are also available when required by the device.$PRO_NAME[];len=32;encoding=UTF-8
s=NOverrides the default station or device address; meaning and range are plugin-specific.s=2;D100

Common attributes of data forwarding targets

Basic attributes of targets

Configuration itemsDescription
NameUnique within the same forwarding group, used for page display, logging, and querying target paths.
DescriptionRecords external systems, interface owners, usage, or acceptance notes.
EnableWhen disabled, the target plugin will not start. If a variable has a value but the external system cannot receive it, it must first confirm that it is enabled.
Plugin NameSelect the specific forwarding plugin, such as MQTT, Kafka, Webhook, historical data target, etc.
Log levelDetail of the target runtime log. Interface can be temporarily elevated during joint commissioning.
Target AttributesConfigurations for the current plugin's connection, cache, upload format, etc. See the section for each target plugin.
Start timeoutTarget start wait time, in seconds. If external systems are slow or certificate verification is slow, the number can be increased appropriately.
Enable redundancyEnable principal-standby target switching. It only opens when there is a clear backup target.
Redundant TargetBackup target switched to when the current target fails, and must be in the same forwarding group.
Redundancy ModeSwitch by target offline state or by script return result.
Redundant scan intervalCheck if a switching cycle is needed, in milliseconds.
Script Detection for Redundancy SwitchingUse when redundancy mode is a script; switch only when the script returns true.

Channel-type Target Attributes

These fields are displayed when targets such as Modbus slaves or IEC104 slaves need to listen for or connect to TCP/serial/DTU channels.

Configuration ItemsDescription
Channel TypeSelect TCP Client, TCP Server, Communication modes such as serial port and DTU.
Remote addressThe peer address connected in client mode, for example, 192.168.1.10:502.
Local bound addressListening address in server mode, e.g., 0.0.0.0:502.
Enable SSLwhether TCP channels have TLS encryption. Ordinary intranet protocols are generally closed.
SSL target hostnameThe hostname used by the client to verify the authentication certificate should match the certificate.
SSL client certificateSelect when client mode requires two-way certificate authentication.
SSL server certificateCertificate used during server mode listening.
SSL CA CertificateUsed to verify the CA of the peer certificate chain.
Allow untrusted certificatesDebug can be enabled temporarily; it is recommended to turn off production environments.
SSL protocolspecifies the TLS version. Default without special requirements.
Check the revocation of the certificateCheck whether the certificate revocation status is complete. Opening the internal network without revocation service may cause slow connections or failures.
Serial portserial slot number, for example COM1.
Baud rateserial port rate, which must be consistent with the other end.
Data BitsSerial Data Bits, commonly 8.
Verification bitserial port verification method must be consistent with the other end.
Stop bitSerial port stop bit, must be consistent with the other end.
Whether DtrEnableenables DTR signals. Only when the on-site equipment requires hardware control lines can adjustments be made.
Whether RTS signals are enabled by RtsEnable. RS485 converters or special equipment may be required.
Asynchronous flowSerial port asynchronous read/write method. When the serial port is stable, it remains at default; adjust only if blocked or untimely reads occur.
Handshake MethodSerial port hardware/software handshake method. Most industrial equipment remains by default.
Size of the serial input bufferSize of the serial receiving buffer. Messages can be increased when messages are long or burst volumes are high.
Serial output buffer sizeSerial port sending buffer size.
Maximum concurrencyNumber of requests allowed to be processed simultaneously on the same channel. Strict protocol requirements for sequencing must be maintained at 1.
Packet Cache TimeStick/Unpack waiting window, unit: milliseconds. Packet fragmentation can be increased when fragmentation is obvious.
Connection timeoutEstablish connection wait time, in milliseconds.
Maximum Number of ConnectionsThe maximum number of client connections allowed in server mode.
Client cleanup timeThe server's cycle for clearing idle clients, measured in milliseconds.
Heartbeat ContentFill in when you need to actively send heartbeats.
Is the heartbeat HexIs the heartbeat content parsed using hexadecimal strings?
Heartbeat timeHeartbeat sending cycle, unit: milliseconds.
DtuIdDTU device identification. When connected via the DTU server, it is used to distinguish terminals.
Whether DtuId is HexDTU ID parsed as a hexadecimal string.
DTU service typeDTU registration/heartbeat recognition method should be consistent with the DTU device protocol.

Offline Cache Properties

Configuration ItemsDescription
Enable offline cachingIf a send fails, place the disk and wait for reshipment. Historical data, alarms, and key platform reporting suggestions are enabled.
Maximum number of rows in a cache fileEach cache file retains the maximum number of rows; if exceeded, old data will be cleaned up.
Upload shard sizeMaximum number of records per upload or repost. Reduce when the interface times out or the message body is too large.
Memory queue limitThe amount of data allowed to accumulate in memory. If exceeded, the order is placed first; if it cannot be ordered, the old data may be discarded.
Filter offline dataDo not upload offline variable data after enabled. External systems need to avoid enabling the last value when they see it.
Number of concurrent uploadsNumber of tasks uploaded simultaneously for the same target. When the order is strict, keep it at 1.

Upload template and script properties

Configuration itemsDescription
Detailed logOutput detailed content for each forwarding, suitable for template, topic, and script joint debugging; long-term operation is recommended to turn off.
JSON Indentation FormattingUploading JSON with indentation. Debugging and readability can be enabled; If you want low traffic, you can turn it off.
JSON ignores Nullwhether to omit empty fields when uploading JSON. Be cautious when the other side requires fixed fields on the other side.
Device List UploadWhether device data is merged into a list upload; After closing, upload each item one by one.
Variable list uploadWhether variable data is merged into a list upload; After closing, upload each item one by one.
Variable Dictionary UploadOrganize variables into device names and variable name-to-value dictionary structures, suitable for receiving by device object.
Alarm list uploadWhether alarm data is merged into a list upload; After closing, upload each item one by one.
Alarm Dictionary UploadOrganize alarms into a dictionary structure.
Upload the plugin event listWhether plugin connections, disconnections, errors, etc. are merged and uploaded.
Device Topic TemplateDevice Data Sending Location Template, which can use ${Name} or other entity fields. Leaving it empty means no such data is uploaded.
Variable Topic TemplateVariable data sending location template, such as MQTT Topic, Kafka Topic, RabbitMQ Routing Key, or Webhook URL.
Alarm Topic TemplateAlarm Data Transmission Location Template. Empty means no alarm is uploaded.
Plugin Event Topic TemplatePlugin Event Sending Location Template. An empty sign indicates no plugin upload event.
Device Entity ScriptRewrites the script for the device upload entity, only used when the other field's structure is special.
Variable entity scriptRewrite the script for the variable upload entity, allowing fields to be added, field names changed, or structures changed.
Alert entity scriptRewrite the script for the alarm upload entity.
Plugin event entity scriptOverrides the script for the plugin event upload entity.
Upload template configurationCustom payload template. Use ${field-name} placeholders after configuration; leave blank to use the default JSON.

General Objective Variable Field

Configuration ItemDescription
Data1Reserve external fields for topics, URLs, or payload templates.
Data 2Reserve external fields, where external point numbers, regions, or service codes can be filled in.
Data 3Reserve external fields.
Data 4Reserve external fields.
Data 5Reserve external fields.
Data 6Reserve external fields.
Data 7Reserve external fields.
Data 8Reserve external fields.
Data 9Reserve an external field.
Data 10Reserve external fields.

MQTT Producer Public Attributes

Both the MQTT client and MQTT server producers include these fields.

Configuration ItemsDescription
Connection TypeSelect TCP or WebSocket. The access method must be consistent with the broker or client.
PortMQTT Service Port, commonly TCP 1883, TLS 8883.
WebSocket pathWebSocket access path, only WebSocket mode is effective.
Enable SSLWhether SSL/TLS is used. After activation, the certificate, hostname, and protocol version must be checked together.
CA NameVerify the CA certificate name of the peer certificate.
Allow untrusted certificatesDebug can be enabled temporarily, production recommended to turn off.
SSL protocol versionTLS protocol version. Default without special requirements.
Check certificate revocationCheck whether certificate revocation status is required. If there is no revocation service in the intranet environment, it can be closed.
UsernameMQTT authentication username.
PasswordMQTT authentication password.
QoS levelRelease quality level. AtMostOnce High performance but no guarantee of delivery; Upon arrival, it is necessary to confirm the platform's requirements and raise it.
Retain messagesWhether the broker keeps the last message. Ordinary real-time data is usually turned off.
RPC writes the Topicexternal system backwritten request topic prefix, actually using RpcWrite/+ and RpcWrite/+/Response.
Historical Read RPC TopicTopic prefix used by external systems to query historical records, numeric sequences, and alarms. The default is RpcHistory; requests use RpcHistory/<32-character-hex-request-id>, and responses use RpcHistory/<request-id>/Response.
Data Request TopicThe subject of the external system requesting full data. After receiving any message, it pushes data such as variables, devices, and alarms.
RPC ScriptA script for handling MQTT RPC write requests, used only when the other party's request format is not the default format.

Collection Plugin Properties

Custom Packet (CustomPacketMaster)

Variable address: ReadCommand@ByteOffset[.BitOffset][;write=WriteCommand]. Example: ReadTemp@4;write=SetTemp. The offset is relative to the response payload.

Includes collection retry, Foundation common read/write, and DTU properties. The Protocol Configuration field contains framing, commands, response matching, checksums, and diagnostic limits. Leave fields unused by the selected mode blank.

FieldDescription
Frame.FrameTypeSelect one framing mode: fixed-header length field, start/end codes, terminator, or fixed length.
Frame.HeaderLengthHeader bytes required before parsing a fixed-header frame. Keep the default in other modes.
Frame.HeaderMatchHex / HeaderMaskHexFixed-header hexadecimal signature and optional mask. Leave blank when signature-based resynchronization is not needed.
Frame.LengthFieldOffsetByte offset of the length field from the start of the complete frame.
Frame.LengthFieldSizeLength-field size; only 1, 2, or 4 bytes is valid.
Frame.LengthFieldEndianByte order of the length field: big-endian or little-endian.
Frame.LengthAdjustmentBytes added to the decoded length to obtain the complete frame length. It may be zero.
Frame.StartCodeHex / EndCodeHexHexadecimal start and end codes for start/end-code framing. Leave blank in other modes.
Frame.TerminatorHexHexadecimal terminator for terminator framing. Leave blank in other modes.
Frame.FixedLengthComplete frame size in bytes for fixed-length framing. Keep the default in other modes.
Frame.MinFrameLengthMinimum complete frame length accepted in start/end-code or terminator mode.
Frame.MaxPackageSizeMaximum complete frame size, default 65536 bytes. Cover the largest valid response without making it unbounded.
Commands[].NameUnique command name referenced by variable addresses. It cannot be blank or duplicated.
Commands[].ReadRequestHexComplete hexadecimal read request. Leave blank for a write-only command.
Commands[].ReadResponseRead-response ownership, success, checksum, and payload rules. Leave blank for a write-only command.
Commands[].WriteRequestHexTemplateHexadecimal write template containing exactly one value placeholder. Leave blank for a read-only command.
Commands[].WriteResponseConfigure when a write must wait for a response; leave blank for send-only writes.
Commands[].WriteSendOnlyCompletes a write after successful transmission without waiting for a response.
Commands[].RequestChecksumRequest checksum rule. Leave blank when the request has no checksum.
MatchSegments[].Offset / ExpectedHex / MaskHexResponse-match byte offset, expected hexadecimal value, and optional mask. Leave the mask blank for an exact match.
Response.SuccessSegmentsSegments that identify protocol success. Leave blank when every owned response is successful.
Response.PayloadOffset / PayloadLengthPayload start offset and length. A blank length consumes the rest of the frame.
Checksum.AlgorithmSelect None, Sum8, Xor8, Lrc8, or the required CRC16 algorithm.
Checksum.CalculationOffset / CalculationLengthChecksum calculation range. A blank length continues to the checksum field or frame end.
Checksum.ValueOffset / Endian / PlacementChecksum field offset, byte order, and overwrite or append placement.
TextEncodingEncoding for raw diagnostic text, default UTF-8. Change it only to match device text.
MaxDebugRequestBytesMaximum raw diagnostic request size in bytes, default 65536.

Modbus Master (ModbusMaster)

Variable address: 00001 coils, 10001 discrete inputs, 30001 input registers, and 40001 holding registers. Append s=N for station, .N for a register bit, f=N for a read function, or w=6/16 for a write function, for example s=2;40001.3.

includes acquisition and retry, Foundation general read/write, Modbus-specific packaging rules, and DTU properties. The old "maximum packing length" is no longer used for Modbus main stations.

Configuration ItemsDescription
Modbus TypeSelect Modbus TCP, RTU, or ASCII. The protocol form must be consistent with the channel and device. ModbusAscii supports only SerialPort, TcpClient, and streaming TcpService; it does not support UdpSession.
Default station numberDefault slave address. If you write the station number separately in the variable address, the variable address shall prevail.
FC1 maximum number of read coil bitsdefault 1600, range 1~2000. The device does not support lowering when reading large continuous coils.
FC2 maximum read discrete input bitsDefault 1600, range 1~2000. The device does not support lowering when reading large continuous discrete quantities.
FC3 maximum read-hold registersdefault 100, range 1~125. Set the keep-register capability per frame by device.
FC4 maximum number of input registers to read:Default 100, range 1~125. Set according to the input register capability per frame of the device.
FC15 maximum batch write coil bitsdefault 1968, range 1~1968. If exceeded, the validation fails before constructing the packet.
FC16 Maximum batch write registersdefault 123, range 1~123. If exceeded, the validation fails before constructing the packet.

After upgrading, each Modbus master device should be opened to check the six rules. The old MaxPack will not continue to be valid as the current configuration, nor should it be assumed that the old values will automatically map to six function codes.

Modbus ASCII parses :-started, hexadecimal, LRC, CRLF-terminated frames over a continuous byte stream. Bind it only to a serial, TCP client, or TCP service channel; UDP datagrams do not provide the required streaming frame boundary. This capability applies only to the Modbus master; Modbus slave mode remains limited to TCP and RTU.

Siemens S7 (SiemensS7Master)

Variable address: use the I, Q, M, DB, and V areas, for example DB1.DBX0.0, DB1.DBW0, DB1.DBD0, M10.0, or VW100.

includes Acquisition Retry, Foundation Universal Read/Write, and Packaging properties.

Configuration ItemsDescription
PLC TypeSelect S7-200, S7-300, PLC types such as S7-400, S7-1200, S7-1500.
Rackrack number, fill in according to PLC hardware or project communication parameters.
SlotCPU slot number: S7-1200/1500 commonly 1, S7-300 commonly 2, subject to on-site availability.
LocalTSAPLocal TSAP. Only fill out TSAP when the site explicitly requires it; otherwise, it remains by default.

DLT645-2007 (Dlt645_2007Master)

Variable address: a two-byte or four-byte data identifier, for example 02010100. Append s=12-digit-meter-address when several meters share one channel, for example 02010100;s=111111111111.

includes acquisition retry, Foundation general read/write, and DTU properties.

Configuration ItemsDescription
Default Address12-bit meter address. Used when the variable address is not specified in the table address.
PasswordPassword required for meter writing or special reading; Read-only scenarios are usually left blank.
Operator CodeMeter operator code, filled in according to meter data when writing or controlled reading.
Precursor HeaderMessage Precursor Byte, default FEFEFEFE; Only the meter requirements are adjusted when the requirements differ.
Control command validityNumber of minutes for which a disconnect/reconnect control command remains valid. The default is 5 minutes and the range is 1-60. This affects command generation, not the normal read/write timeout.

OPC UA client (OpcUaMaster)

Variable address: the OPC UA NodeId exactly as browsed from the server, for example ns=2;s=Devices/Line1/Temperature. Do not append Modbus address parameters.

includes the Collection Retry attribute.

Configuration ItemsDescription
Connection URLOPC UA server address, for example opc.tcp://192.168.1.10:49320.
Log in to accountFill in when the server requires account authentication.
Login passwordFilled in together with your login account.
Data change trigger conditionsWhich changes in subscription mode trigger reporting, usually kept by default.
Security PolicyWhether security policies are enabled. After activation, the certificate must be configured and server-side trust must be confirmed.
Accept untrusted certificatesExplicitly accepts an untrusted OPC UA server certificate. Enable only while commissioning a self-signed certificate; keep it disabled in production.
Name IdentifierOPC UA client application name, used for server-side identification and certificate matching.
CertificateName of the client certificate, selected from Certificate Management.
Whether to use SourceTimeUse server-side source time as the collection time; It needs to be closed when the gateway receives the record time.
Load server data typeRead server data type at startup for easy type matching; If the server is slow, startup time may increase.
Activate subscriptionAfter activation, use the subscription to receive changes; After disabling, read by polling.
Update FrequencySubscription update cycle, measured in milliseconds.
Dead ZoneTriggers only when the value changes exceed the dead zone, suitable for reducing analog jitter reporting.
Maximum group sizeMaximum number of nodes per subscription group. The server limit is smaller than the hour limit.
Heart RateOPC UA Session Heart Rate Cycle, unit: milliseconds.

OPC DA client (OpcDaMaster)

Variable address: the OPC DA ItemId, for example Channel1.Device1.Temperature. Use the identifier returned by the OPC server browser.

includes acquisition retry attributes.

Configuration ItemsDescription
OPC Server IPThe host where the OPC DA server is located. Remote DA also needs to confirm DCOM permissions.
OPC server nameOPC DA ProgID, for example Kepware.KEPServerEX.V6.
Server TimeUse OPC server source time; Turn off when the gateway needs to receive time.
Subscription ModeSubscribe to updates via DA after activation; After closure, read periodically.
CheckRatedetects reconnection frequency, measured in minutes.
Dead ZoneNumerical Change Dead Zone, used to filter out minor jitters.
Maximum group sizemaximum number of points per OPC group. Reduce when server pressure is high or subscription fails.
Subscription update frequencyOPC DA subscription update cycle, unit: milliseconds.

MQTT Acquisition Client (MqttCollectClient)

Variable address: fixed eight-segment format SubscribeTopic;JSONPath1||JSONPath2;Condition;PublishTopic;PayloadMode;Retain;RpcResponseTopic;TimeoutMs. Read example: device/data;$.Temperature. Write example: ;;;device/set;Json;false. RPC publish and response topics must each end with one {RequestId} level.

This plugin manages MQTT connections itself and does not use the collection of public read/write properties.

Configuration ItemsDescription
Connection TypeSelect TCP or WebSocket, Must be consistent with the broker.
IP addressMQTT Broker address.
PortMQTT Broker port.
WebSocket pathWebSocket connection path, only WebSocket mode is effective.
Enable SSLWhether SSL/TLS is used.
SSL target hostnamehostname used for certificate verification.
Client Certificate NameSelect the client certificate for two-way certificate authentication.
CA NameCA verifying the broker certificate.
Allow untrusted certificatesDebug can be enabled temporarily; production is recommended to turn it off.
SSL protocol versionTLS protocol version.
Check whether the certificate has been revokedCheck whether the certificate has been revoked.
Client IDMQTT ClientId. Multiple clients cannot be duplicated.
UsernameMQTT authentication username.
PasswordMQTT authentication password.
Survival TimeMQTT KeepAlive, unit: seconds.
Clear the sessionWhether the session is cleared after disconnection and reconnection. Turn off when you need to reserve an offline subscription.
MQTT protocol versionMQTT version, must match broker support.
QoS levelSubscription/Send Quality Level.
Detailed LogsOutput detailed MQTT transmission and reception logs, recall them together, and close once stabilized.
Connection timeoutWait time for establishing a connection, measured in milliseconds.
Check the cleanup timeThe cycle for cleaning invalid connections or statuses, in milliseconds.

MQTT Acquisition Server (MqttCollectServer)

Variable address: the same eight-segment Topic/JSONPath/write-route format as the MQTT client, for example device/data;$.Temperature. JSONPath supports candidates, array indexes, [?()] filters, wildcards, and recursive descent. See Field Path Rules.

This plugin starts the MQTT server inside the gateway and does not use the collection of public read/write attributes.

Configuration ItemsDescription
Connection TypeSelect TCP or WebSocket.
PortMQTT port listened to by the gateway.
WebSocket pathWebSocket listening path.
Enable SSLWhether SSL/TLS listening is enabled.
Server certificate nameServer certificate name, which must be configured when enabling SSL.
CA NameThe CA used to validate client certificates.
Allow untrusted certificatesDebug can be enabled temporarily; production is recommended to turn it off.
SSL protocol versionTLS protocol version.
Check whether the certificate has been revokedCheck whether the certificate has been revoked.
Allows connection with the ID prefixOnly allows client access with the specified ClientId prefix; Empty means not restricted by prefixes.
UsernameClient-side connection authentication username.
PasswordClient-side connection authentication password.
QoS levelMQTT delivery quality for control messages and RPC acknowledgements. AtMostOnce has low latency but may lose messages, AtLeastOnce may duplicate them, and ExactlyOnce has the highest overhead.
Detailed LogsOutput detailed connection and message logs for joint calls.
Check the cleanup timePeriod for cleaning invalid client states, measured in milliseconds.

Dedicated Gateway MQTT Collection Client (GatewayMqttCollectClient)

Variable address: fixed as RemoteKey/RemoteVariableId, for example edge-a/temperature-01. Do not enter a normal MQTT Topic or JSONPath.

This plugin uses one shared Broker connection to collect multiple edge Gateways. It does not use general MQTT Topic/JSONPath variable addresses. The variable address is always RemoteKey/RemoteVariableId.

PropertyDescription
Topic rootTopic root of the fixed protocol, default ThingsGateway/Gateway. The edge Producer and central collector must use the same value.
Allow remote writesWhether to accept variable RPC writes initiated by the edge Producer. Control also requires the target variable's write permission.
Snapshot interval (seconds)Period for requesting a complete variable snapshot, range 10-3600.
Request timeout (seconds)Wait time for snapshots and RPC, range 1-600.
Offline timeout (seconds)Marks a source offline after no valid protocol message. It must be greater than the snapshot interval and no more than 86400.
Remote source limitMaximum number of RemoteKey entries on one device, range 1-128.
Snapshot concurrency limitMaximum number of simultaneous source snapshots, range 1-32.
Inbound payload byte limitMaximum size of one inbound MQTT payload, range 4096-16777216 bytes.
Messages-per-second limitMaximum number of messages from all sources entering the parser each second, range 1-100000.
Inbound processing concurrency limitMaximum concurrent JSON inbound operations, range 1-64.
JSON depth limitMaximum JSON nesting depth accepted in protocol payloads, range 8-256.
Per-source catalog limitMaximum number of variable catalog entries for one source, range 1-1000000.
Total catalog limitMaximum catalog entries across all sources. It must cover the per-source limit and cannot exceed 3000000.
Pending RPC limitMaximum number of remote RPC batches waiting at the same time, range 1-4096.
Detailed logsRecords protocol summaries without sensitive fields or complete payloads.

Connection properties: Connection type, IP address, Port, WebSocket path, Enable SSL, SSL target hostname, Client certificate name, CA name, Allow untrusted certificates, SSL protocol version, Check certificate revocation, Client ID, Username, Password, Keep alive, Clean session, MQTT protocol version, and Connection timeout.

Remote source fieldDescription
RemoteKey1-64 ASCII letters, digits, hyphens, or underscores. It must be unique and participates in Topics, variable addresses, and request correlation.
DisplayNameNon-empty name used only for page and diagnostic display.
EnableControls subscription, catalog synchronization, snapshot requests, and RPC acceptance for this source.
QoS levelSubscription and publication QoS for this source's fixed protocol.

See Dedicated Gateway MQTT Collection for the complete workflow.

Dedicated Gateway MQTT Collection Server (GatewayMqttCollectServer)

Variable address: fixed as RemoteKey/RemoteVariableId, for example edge-a/temperature-01. RemoteKey must exactly match the remote-source configuration.

This plugin accepts multiple edge Gateways through one MQTT listener. Its capacity, snapshot, permission, and variable-address settings are listed here together with listener properties.

PropertyDescription
Topic rootTopic root of the fixed protocol, default ThingsGateway/Gateway. The edge Producer and central collector must use the same value.
Allow remote writesWhether to accept variable RPC writes initiated by an edge Producer. Control also requires the target variable's write permission.
Snapshot interval (seconds)Period for requesting a complete variable snapshot, range 10-3600.
Request timeout (seconds)Wait time for snapshots and RPC, range 1-600.
Offline timeout (seconds)Marks a source offline after no valid protocol message. It must be greater than the snapshot interval and no more than 86400.
Remote source limitMaximum number of RemoteKey entries on one device, range 1-128.
Snapshot concurrency limitMaximum number of simultaneous source snapshots, range 1-32.
Inbound payload byte limitMaximum size of one inbound MQTT payload, range 4096-16777216 bytes.
Messages-per-second limitMaximum number of messages from all sources entering the parser each second, range 1-100000.
Inbound processing concurrency limitMaximum concurrent JSON inbound operations, range 1-64.
JSON depth limitMaximum JSON nesting depth accepted in protocol payloads, range 8-256.
Per-source catalog limitMaximum number of variable catalog entries for one source, range 1-1000000.
Total catalog limitMaximum catalog entries across all sources. It must cover the per-source limit and cannot exceed 3000000.
Pending RPC limitMaximum number of remote RPC batches waiting at the same time, range 1-4096.
Detailed logsRecords protocol summaries without sensitive fields or complete payloads.
Listener propertyDescription
Connection typeTCP or WebSocket; it must match the edge Producer.
PortMQTT listener port. Also configure the WebSocket path when WebSocket is enabled.
WebSocket pathWebSocket listener path, default /mqtt.
Enable SSLEnables TLS. A server certificate is required when enabled.
Server certificate nameServer certificate selected from gateway certificate management.
CA nameCA used for mutual certificate authentication.
Allow untrusted certificatesAccepts untrusted client certificates. Keep it disabled in production.
SSL protocol versionTLS protocol version.
Check certificate revocationChecks the revocation status of client certificates.
Remote source fieldDescription
RemoteKey / DisplayName / Enable / QoS levelSame meanings as Client mode. RemoteKey must be unique.
AllowedClientIdMust exactly match the edge Producer's MQTT ClientId and be unique within this listener.
Username / PasswordIndependent MQTT credentials for this source. Do not share them with another source.
ClientCertificateSha256Optional lowercase SHA-256 client-certificate fingerprint. When fingerprint binding is used, every enabled source must provide a unique fingerprint.

See Dedicated Gateway MQTT Collection for the complete workflow.

CAN Master (CanMaster)

Variable address: 0xCANID[.StartByte][;R=0xResponseID][;L=DataLength][;E=1], for example 0x123.2 or 0x123;R=0x456;L=4;E=1.

includes acquisition retry and Foundation general read/write attributes.

Configuration ItemsDescription
Endpoint AddressCAN adapter and channel address, such as virtual channel or ZLG device channel.
Baud rateThe baud rate of the arbitration segment must match the bus.
Data Phase Baud RateCAN FD data segment baud rate, only CAN FD mode is valid.
protocol modechoose CAN2.0 or CAN FD.
Enable BRSCAN FD Whether segment variable rate is enabled. Ordinary CAN2.0 is ineffective.
Internal terminal resistorWhether to enable the adapter's internal terminal resistor is selected according to fieldbus wiring.
Hardware filter CANID listOnly receives the specified CAN ID; Empty means no filtering.

Allen-Bradley ControlLogix (ControlLogixMaster)

Variable address: a CIP tag name such as Motor.Speed; use Tank.Level[2] for an array element.

includes acquisition retry, Foundation general read/write, and packaging properties.

Configuration ItemsDescription
SlotControlLogix CPU Slot number.
BackplaneBackplane addressing parameters, filled in according to the PLC rack communication path.

Allen-Bradley PCCC (PCCCMaster)

Variable address: file-table form O/I/S/B/T/C/R/N/F/ST/A/L{DbBlock}:{Address}, for example O1:10, N7:0, or ST10:100.

i ncludes collection retry, Foundation general read/write, and packaging properties; No extra page plugin properties. When constructing this plugin, the default data parsing order is DCBA, and the maximum package length is 150. On-site key verification of variable address formats is required.

DCON Master (DCONMaster)

Variable address: [BitIndex][;W=WriteLength], for example 0 or 3;W=2. Use the DCON module command table for the bit index and write length.

includes acquisition retry, Foundation general read/write, packaging, and DTU properties.

Configuration ItemsDescription
StationDCON Station Number, It must match the module address.

EDPF_NT (EDPF_NTMaster)

Variable address: DecimalPointId[;TYPE=N], for example 100, 101;TYPE=1, or 102;TYPE=2. Omitted TYPE is 0; 0 is Single, 1 is Int32, 2 is Int16, and 3 is Int32.

No page plugin properties. This plugin does not display acquisition retries or Foundation fields; on-site key verification of channel, device, and variable address configurations is key.

HJ212 Master (HJ212Master)

Variable address: CN=XXX;MN=XXX;ST=XXX, for example CN=2011;MN=123456;ST=32. The fields are command code, device identifier, and system code.

Includes acquisition retries and Foundation general read/write attributes; No extra page plugin properties. On-site, we focused on verifying the HJ212 address field, the address content of variables such as MN, CN, ST, and the link parameters.

IEC 61850 client (IEC61850Master)

Variable address: LD/LN.DO.DA;FC=XX, for example LD0/LLN0.GGIO1.Ind1.stVal;FC=ST. Use the model's functional constraint such as ST, MX, or CO.

includes the Collect Retry attribute.

Configuration ItemsDescription
IED IP AddressIP Address of the Collected IED.
IED portMMS port, commonly 102.
Connection timeout (ms)Establish connection timeout, in milliseconds.
Maximum number of packsMaximum number of batch readings at once. IED is reduced when response is slow or the message is too large.
Update frequency (ms)Polling or subscription processing cycle, measured in milliseconds.
SCL Configuration File PathSCL/ICD/SCD file path, used to import or generate variable models.
Enable RCB Report SubscriptionUse Report Subscription instead of Polling. IED reporting is enabled when configured correctly.
RCB Reporting IDReporting ID, which must be consistent with the IED reporting control block.
RCB reference listReport control block reference list, with multiple values separated by commas, semicolons, or line breaks. When null, it is automatically derived according to common conventions.
RCB buffer time (ms)Report buffer time, in milliseconds.
RCB integrity period (ms)Integrity reporting cycle, in milliseconds.
RCB TrgOpsReport Trigger Option Diagram, fill in according to IED report configuration.
RCB OptFldsOptional field position chart for the report, fill in according to IED report configuration.
RCB Single Request WriteWhether to use the Single Request mode when writing RCB parameters. Adjustments for some IED compatibility issues.
ReportReservationTimeSecondsBRCB Reserve time, measured in seconds; 0 means not to write the reserved item proactively.
Clearing the BRCB bufferWhether the buffer was cleared before enabling BRCB.
Enable GOOSE subscriptionswhether to subscribe to GOOSE packets.
GOOSE control block referencessubscribed GOOSE control block references.
GOOSE network interface IDreceives the GOOSE network card identifier. Linux commonly eth0, while Windows is indexed by interface or GUID.
GOOSE APP-IDGOOSE APP-ID Filter Value; 0 means no filtering.
Use URCB (Non-Buffered Reporting)Use URCB instead of BRCB. Enable only when the other party is configured with non-buffered reports.
IED authentication passwordentered when the IED requires certification.
Request timeout (ms)MMS request timeout, in milliseconds.
Maximum PDU sizeMMS PDU size limit; 0 uses the default value. Some IED are limited to filling out in a short time.
Enable TLS encrypted connectionMMS whether TLS is enabled.
TLS Client CertificateTLS Client Certificate Name.
TLS CA certificateCA verifies the CA of the IED server certificate.
TLS Chain VerificationWhether certificate chain verification is enabled.
TLS only allows known certificatesdoes it allow connections only to known certificates in the certificate repository?
SOE Event Record ConfigurationSOE Event Record Settings, depending on whether the project requires event retrospective configuration.

Variable Auxiliary Attributes:

Variable Configuration ItemsDescription
Object reference (auxiliary)Only used as an object reference display and validation aid; The actual read/write address is still recorded in the variable address bar.
Functional constraints (auxiliary)IEC 61850 FC auxiliary fields; In practice, FC usually uses ;FC=XX or [XX] specified.
Allow writesWhether the IEC 61850 variable is allowed to perform writes. It is recommended to activate control points.

Inovance (InovanceMaster)

Variable address: use the AM/H3U/H5U device area for the selected PLC family, for example Q0.0, IX0.0, MW0, MD0, M0, or D0; use s=2;D0 to override the station.

includes acquisition retrys, Foundation general read/write, packing, and DTU properties.

Configuration ItemsDescription
ModbusTypeUnderlying Modbus Communication modes are selected by channel and device.
InovanceTypeInovance protocol or device type, selected by PLC/controller model.
Stationstation number, which must match the device address.

KELID2008 (KELID2008Master)

Variable address: unsolicited-report channel number, for example 1 for channel 1. Do not use a Modbus address.

includes acquisition retries and Foundation general read/write attributes; No extra page plugin properties. On-site key verification of variable addresses and channel parameters.

LKSIS (LKSISMaster)

Variable address: DecimalPointId[;TYPE=PointType], for example 123;TYPE=0 or 456;TYPE=1. TYPE 0 or omitted means AI; TYPE 1 means DI. Values are updated by UDP reports.

No page plugin attribute. On-site key verification of equipment addresses, variable addresses, and link parameters.

Mitsubishi 1E (Mc1E_BinaryMaster)

Variable address: a 1E device area such as X/Y/M/F/V/B/D/W/TS/TC/TN/CS/CC/CN/S; examples are D100, M10, and X20.

includes acquisition retry, Foundation general read/write, and packaging properties.

Configuration ItemsDescription
PLCIDMitsubishi 1E PLC station number, according to PLC Fill in communication settings.

Mitsubishi 3E (Mc3E_BinaryMaster)

Variable address: a 3E device area such as X/Y/M/L/F/V/B/D/W/TS/TC/TN/CS/CC/CN/SM/SD/DX/DY; examples are D100, D100.3, and X10. Boolean access to a WORD area requires an explicit bit.

includes acquisition retry, Foundation universal read/write, and packaging properties.

Configuration ItemsDescription
NetWorkIDMitsubishi Network Number.
IOModuleStationthe IO module station number.
IOModuleIDIO module number, enter according to the communication path.
PLCIDPLC station number.

ModbusC1 (ModbusC1Master)

Variable address: a Modbus C1 0/1/3/4 area address, for example 40001 or s=2;40001.0.

includes acquisition retry, Foundation general read/write, packing, and DTU properties.

Configuration ItemsDescription
ModbusTypeModbus protocol form.
StationDefault station number.

ModbusC20 (ModbusC20Master)

Variable address: a Modbus C20 0/1/3/4 area address, for example 40001 or s=2;40001.0.

includes acquisition retry, Foundation general read/write, packing, and DTU properties.

Configuration ItemsDescription
ModbusTypeModbus protocol form.
StationDefault station number.

Omron FINS (OmronFinsMaster)

Variable address: D/CIO/W/H/A/E/TIM/CNT/IR/DR/CF, for example D0, CIO0, W0, E0.0, TIM0, or CF1.1.

includes collection retry, Foundation general read/write, and packaging properties.

Configuration ItemsDescription
ICFFINS message control fields, usually kept by default.
GCTnetwork layer information, usually maintaining the default 0x02.
DNAtarget network address.
DA2Target unit address.
SNAsource network address.
SA2source unit address.
SIDService ID.

OPC AE (OpcAeMaster)

Variable address: an OPC AE SourceID, for example Channel1.Device1.AlarmHigh. Multiple variables may subscribe to the same SourceID.

includes the acquisition retry attribute.

Configuration ItemsDescription
OpcAeUrlOPC AE Service Connection Address, For example, opcae://localhost/Kepware.KEPServerEX_AE.V6.
CheckRateDetects reconnection frequency, measured in minutes.

SECS (SECSMaster)

Variable address: s=N;f=N[;w][;SECS-II XML], for example s=1;f=3;w, s=6;f=11, or s=1;f=13;w;<List Length="0" />.

includes collection retrys, Foundation general read/write, and packaging properties.

Configuration ItemsDescription
Session IDHSMS session identifier, range 0-65534. It must match the equipment communication settings; 65535 is reserved for control messages.
Data transaction T3Timeout while a primary message waits for its reply, in milliseconds, default 45000.
Control transaction T6HSMS control-transaction response timeout, in milliseconds, default 5000.
Select session T7Timeout while waiting to select the session after connection, in milliseconds, default 10000.
Fragment receive T8Network-fragment receive timeout, in milliseconds, default 5000.

TIANXIN (TIANXINMaster)

Variable address: a TIANXIN data type with optional S=Station;, for example FlowRate, TotalAmount, Temp, or S=2;Pressure.

includes acquisition retrys, Foundation general read/write, packaging, and DTU properties.

Configuration ItemsDescription
StationStation number, fill in according to the equipment address.

TS550 (TS550Master)

Variable address: unsolicited-report channel number, for example 1 for channel 1.

includes acquisition retries and Foundation general read/write properties; No extra page plugin properties. On-site key verification of variable addresses and channel parameters.

USBScaner (USBScaner)

Variable address: no periodic register address. Scan data is updated by USB input events and verified with the plugin diagnostics.

No page plugin properties. This plugin is used for USB scanner input, with on-site key verification of scanner access, variable mapping, and data triggering.

Vigor (VigorMaster)

Variable address: bit areas X/Y/M/SM/S/T/C and word areas D/SD/R/T/C, for example M100, D100, or s=2;D100. C0-C199 are 16-bit counters; C200-C255 are 32-bit counters.

Includes acquisition retry, Foundation general read/write, packaging, and DTU properties.

Configuration ItemsDescription
StationStation number, fill in according to the equipment address.

ZeroMQ Acquisition Client (ZeroMQCollectClient)

Variable address: ${zmq_topic};${payload_item};${Condition}, for example device/data;Temperature or device/data;Status;TemperatureGreaterThan20.

This plugin manages ZeroMQ connections itself and does not use the collection of public read/write attributes.

Configuration ItemsDescription
Connection AddressZeroMQ address, for example, tcp://127.0.0.1:5555.
Socket typeZeroMQ Socket type, default subscription mode.
Binding Modetrue means Bind acts as the server; false means Connect is the client.
Subscription topic prefixesSUB mode subscription prefixes; An empty string means subscribe to all.
High watermarkZeroMQ queue has high watermarks; data backlog may be dropped or blocked if exceeded.
Detailed LogsOutput detailed sending and receiving logs, linked for calls.
Check cleaning timeCleaning status cycle, measured in milliseconds.

Extended Collection Plugin Properties

The following sections complete the property reference for the extended collection plugins. "No plugin-specific page fields" means that no fields appear beyond the listed common property groups; device, channel, and variable configuration is still required.

Dlt645_1997Master

Variable address: a two-byte data identifier such as B6-11. Prefix it with s=meter-address; when needed, for example s=1;B6-11.

Includes collection retry, Foundation common read/write, and DTU properties.

FieldDescription
Default addressDefault 12-digit meter address. A meter address in the variable address takes precedence.
Preamble headerFE bytes sent before a request. The default is FEFEFEFE; leave blank when the meter does not require a preamble.

Df1Master

Variable address: a file-table address such as N7:0, B3:0, F8:0, or ST9:0. For Boolean access, use N7:0/3 or N7:0.3.

Includes collection retry, Foundation common read/write, packing, and DTU properties.

FieldDescription
StationDF1 link station number. Set it according to the serial network plan.
DestinationNodeTarget PLC node number. It must match the device configuration.
SourceNodeGateway source node on the DF1 link. It must not conflict with another node.
ChecksumKindDF1 frame checksum, CRC16 by default. Change it only when the device explicitly uses another checksum.

LogixCipMaster

Variable address: a CIP tag name such as Motor.Speed; use Tank.Level[2] for an array element.

Includes collection retry, Foundation common read/write, and packing properties, plus the inherited Micro CIP route fields.

FieldDescription
SlotTarget controller slot in the EtherNet/IP route.
BackplaneBackplane route port, default 1. Change it for a direct or nonstandard route.

MicroCipMaster

Variable address: a CIP tag name such as Motor.Speed; use Tank.Level[2] for an array element.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
SlotTarget controller slot.
BackplaneBackplane route port, default 1.

SlcEthernetMaster

Variable address: a file-table address such as N7:0, B3:0, F8:0, or ST9:0. For Boolean access, use N7:0/3 or N7:0.3.

Includes collection retry, Foundation common read/write, and packing properties. There are no plugin-specific page fields; configure file-table addresses and node information in variable addresses.

BeckhoffAdsMaster

Variable address: use M100, I100, or Q100 for a byte address; M100.0 for a Boolean; ig=0x4020;io=100 for an explicit address; or s=MAIN.Variable for a symbolic address.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
SourceAmsNetIdRequired gateway-side AMS Net ID. It must match the local identifier in the ADS route.
SourceAdsPortGateway-side ADS logical port, range 1-65535. Set it from the local ADS route.
TargetAmsNetIdRequired PLC-side AMS Net ID. It must match the target controller.
TargetAdsPortPLC-side ADS logical port, range 1-65535. Set it to the target runtime port.

CimonHmiMaster

Variable address: use X/Y/M/L/K/F/D/S/TC/TS/CC/CS, for example D1, D1.15, or X10. Boolean values use WORD-address.bit, with bit numbers from 0 to 15.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
CpuModelPLC CPU model used to validate device-area address boundaries.
FrameNumberSeven-bit protocol frame number, range 0x00-0x7F. It must match the PLC or virtual server.

DeltaMaster

Variable address: DVP examples include X0, Y0, M0, and D0.0; AS300 examples include SM0, SR0, HC0, and D0. X/Y addresses are octal. Prefix with s=2; to override the station.

Includes all Modbus Master properties.

FieldDescription
PLC seriesSelect the Delta PLC series that defines how device areas map to Modbus addresses.

FatekProgramMaster

Variable address: bit areas are X/Y/M/S/T/C; WORD areas are WX/WY/WM/WS/WT/WC/RT/RC/R/D/F, for example X50, WY8, RT12, or R100.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
StationPLC station number in the protocol range 01H-FEH.
MaxDiscretePackMaximum discrete points in one contiguous read, range 1-256. Reduce it if the device cannot reliably return a large request.

FujiCommandMaster

Variable address: use B/M/K/F/A/D/S/TS/TR/CS/CR/BD/WL/W9 or W21 through W125, for example D100 or W21.200.

Includes collection retry, Foundation common read/write, and packing properties. There are no plugin-specific page fields; determine the connection route from the variable address and device communication settings.

FujiSpbMaster

Variable address: use Y/X/M/L/TC/CC/TN/CN/D/R/W, for example D100, TN20, or D10.12.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
StationPLC station used by requests, default 1. It must match the device station.

FujiSphMaster

Variable address: WORD areas are I/Q/M1/M3/M10. Append .0..15 for Boolean access, for example I0, Q20, or M3.1000.12.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
ConnectionIdTarget CPU or link-module connection number, default 0xFE. Set it from the PLC network configuration.

GeSrtpMaster

Variable address: I/Q/M/T/SA/SB/SC/S/G support bit or byte access, while AI/AQ/R are WORD areas. Examples are M1, Q100, R1, and AI100. Addresses start at 1.

Includes collection retry, Foundation common read/write, and packing properties. There are no plugin-specific page fields; configure memory areas and data format through variable and common properties.

InovanceComputerLinkMaster

Variable address: an Inovance Computer Link device address such as D100; use s=2;D100 to override the default station.

Includes collection retry, Foundation common read/write, and packing properties, plus the FX Links link fields.

FieldDescription
StationDefault target station. A station in the variable address takes precedence.
WaitingTimeFrame wait time in units of 10 ms. Increase it for a slow PLC.
SumCheckEnables the additive checksum. It must match the PLC frame setting.
FormatSelect format 1 or 4 to match the PLC Computer Link frame format.

InovanceConnectedCipMaster

Variable address: an Inovance connected-CIP tag name such as Motor.Speed or Tank.Level[2].

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
SlotPLC slot number.
BackplaneBackplane route number, default 1.

InovanceEasyNetMaster

Variable address: use W/D/R/X/Y/M/S/B/U/UB/UW, for example D100 or X10. X/Y addresses are octal; U areas are hexadecimal.

Includes collection retry, Foundation common read/write, and packing properties. There are no plugin-specific page fields; set the PLC model, station, and address through the variable address rules.

KeyenceKvOldMaster

Variable address: contacts use R-word.bit, T/C/CTH/CTC; WORD areas use DM/TM/AT/CTH/CC/CT/TC/T. Examples are R10.3, DM100, and T1.

Includes collection retry and Foundation common read/write properties. There are no plugin-specific page fields; the PLC model, station, and address are determined by the variable configuration.

KeyenceMcAsciiMaster

Variable address: bit areas X/Y/B are hexadecimal, while M/L/SM/TS/TC/CS/CC are decimal. WORD areas SD/D/R/TN/CN are decimal, while ZR/W are hexadecimal. Example: D100.3.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
NetWorkIDMC route network number.
IOModuleStationTarget module station number.
IOModuleIDTarget module I/O number, default 0x03FF.
PLCIDTarget PLC number, default 0xFF.

KeyenceMcBinaryMaster

Variable address: bit areas X/Y/B are hexadecimal, while M/L/SM/TS/TC/CS/CC are decimal. WORD areas SD/D/R/TN/CN are decimal, while ZR/W are hexadecimal. Example: D100.3.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
NetWorkIDMC route network number.
IOModuleStationTarget module station number.
IOModuleIDTarget module I/O number, default 0x03FF.
PLCIDTarget PLC number, default 0xFF.

KeyenceNanoMaster

Variable address: contacts use R/CR/MR/LR-word.bit or B/VB. Append .U for a WORD view and .D for a DWORD current value, for example R10.3, R10.0.U, T1.D, or B10.U.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
StationMultidrop link station, range 0-99.
UseStationControls whether the CR connection command carries the two-digit station. Turn it off for a direct connection that does not require a station.

LsisMaster

Variable address: device areas are P/M/L/K/F/T/C/D/S/Q/I/N/U/Z/R. Boolean examples are MX103 and MX10.3; non-Boolean examples are MB100, DW100, DD100, and DL100.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
ProtocolModeSelect Cnet or Fast Ethernet to match the channel and PLC module.
StationDefault Cnet station, range 00H-1FH. Used only in Cnet mode.
CpuSeriesFast Ethernet CPU series. Used only in Fast Ethernet mode.
BaseNumberFast Ethernet module base number. Not used in Cnet mode.
SlotNumberFast Ethernet module slot, default 3. Not used in Cnet mode.
CompanyIdEight-character company identifier, default LSIS-XGT. Change it only when the peer requires another identifier.

MegMeetMaster

Variable address: MC80/100/200/280/200E use X/Y/M/SM/S/T/C/D/R, for example X0, D0.0, R0, or s=2;D0. X is octal and read-only.

Includes all Modbus Master properties. There are no plugin-specific page fields; use the variable address rules for the selected PLC series.

Mc1E_AsciiMaster

Variable address: a 1E device area such as X/Y/M/F/V/B/D/W/TS/TC/TN/CS/CC/CN/S; examples are D100, M10, and X20.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
PLCIDTarget PLC number, default 0xFF. Set it according to the 1E network plan.

Mc3E_AsciiMaster

Variable address: bit areas are X/Y/M/S/L/F/V/B/SM/SB/DX/DY/TS/TC/SS/SC/CS/CC; WORD areas are D/SD/W/SW/R/Z/ZR/TN/SN/CN. Example: D100.3.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
NetWorkIDMC network number.
IOModuleStationTarget module station number.
IOModuleIDTarget module I/O number, default 0x03FF.
PLCIDTarget PLC number, default 0xFF.

A3CMaster

Variable address: bit areas are X/Y/M/S/L/F/V/B/SM/SB/DX/DY/TS/TC/SS/SC/CS/CC; WORD areas are D/SD/W/SW/R/Z/ZR/TN/SN/CN. Use s=2;D100 to override the station.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
StationDefault station. An s= parameter in the variable address takes precedence.
SumCheckEnables additive checksum generation and validation. It must match the PLC.
FormatSelect A3C format 1-4 to match the PLC or CPU communication setting.

FxLinksMaster

Variable address: bit areas are M/X/Y/S/TS/CS; WORD areas are D/R/TN/CN, for example D100, M35, or s=2;D100. X/Y addresses are octal.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
StationDefault target station.
WaitingTimeFrame wait time in units of 10 ms.
SumCheckEnables the additive checksum.
FormatSelect format 1 or format 4.

FxSerialMaster

Variable address: WORD areas are D/TN/CN; bit areas are M/S/X/Y/TS/TC/CS/CC, for example D100 or X10. X/Y addresses are octal.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
IsNewVersionSelects the newer command prefix and internal address map. Match it to the PLC model and recheck it when all reads and writes fail.

MitsubishiCipMaster

Variable address: a Mitsubishi CIP tag name such as Motor.Speed or Tank.Level[2].

Includes collection retry, Foundation common read/write, and packing properties, plus the inherited Micro CIP route fields.

FieldDescription
SlotTarget controller slot.
BackplaneBackplane route port, default 1.

McR_BinaryMaster

Variable address: an MC R-series device. In addition to standard MC areas, the plugin supports bit areas such as LST/LSC/LT/LTC/ST/SC and WORD areas such as LTN/STN; examples are LST10 and LTN10.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
NetWorkIDMC network number.
IOModuleStationTarget module station number.
IOModuleIDTarget module I/O number, default 0x03FF.
PLCIDTarget PLC number, default 0xFF.

NanjingDcsMaster

Variable address: a standard Modbus area address such as 40001 or s=2;40001.3. Connection probing and the six-byte status frame are handled automatically.

Includes all Modbus Master properties. There are no plugin-specific page fields; connection probing and the leading status frame are handled automatically.

OmronCipMaster

Variable address: an Omron CIP tag name. Use Tag[index] for partial array access, for example Tank.Level[2].

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
SlotTarget controller slot.
BackplaneBackplane route port, default 1.

OmronConnectedCipMaster

Variable address: an Omron connected-CIP tag name. Use Tag[index] for partial array access, for example Tank.Level[2].

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
SlotTarget controller slot.
BackplaneBackplane route port, default 1.
ConnectionTimeoutMultiplierConnected-session inactivity timeout multiplier, default 2. Increase it for a high-latency link.

OmronHostLinkMaster

Variable address: use D/CIO/C/W/H/A/E-area.address/TIM/CNT, for example D100, CIO20, E1.100, or TIM0; use s=2;D100 to override the station.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
PLC stationDefault PLC station.
Information control fieldHost Link ICF field. Set it according to the network route.
Destination unit addressTarget CPU unit address.
Source unit addressSource unit address used by the gateway.
Service IDRequest service identifier, which must match the response.
Response wait characterProtocol response-wait character, default 0. Change it only when required by the device.

OmronHostLinkCModeMaster

Variable address: use D/DM/C/CIO/LR/H/HR/A/AR/TIM/CNT/E-area.address, for example D100, CNT20, or E1.100; use s=2;D100 to override the station.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
PLC stationDefault PLC station. It must match the Host Link C-Mode device.

PanasonicMcMaster

Variable address: bit areas are X/Y/L/R/TS/CS/SM; WORD areas are DT/LD/TN/CN/SD, for example R10.A, DT100, or D100.3. WORD bit numbers are .0..15.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
NetWorkIDMC network number.
PLCIDTarget PLC number, default 0xFF.
IOModuleIDTarget module I/O number, default 0x03FF.
IOModuleStationTarget module station number.

PanasonicMewtocolMaster

Variable address: bit areas X/Y/R/L use WORD.hex-bit; T/C use contact numbers. WORD areas are DT/LD/F/T/C/K/SD/IX/IY/ID, for example R10.A, T100, or DT100.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
StationDefault target station, default 0xEE.
MaxBitPackMaximum points in one contiguous bit read, default 400. Reduce it when the device rejects a large request.

SiemensFetchWriteMaster

Variable address: use I/Q/M/DB/T/C with a decimal byte offset, for example DB20.100 or M100.3. Boolean values must explicitly use byte.bit.

Includes collection retry, Foundation common read/write, and packing properties. There are no plugin-specific page fields; configure the PLC station and address in each variable address.

SiemensPpiMaster

Variable address: use V/AI/AQ/T/C/SM/I/Q/M/DB, for example M100, DB1.DBW0, or s=2;M100.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
PLC stationPPI target PLC station, default 2.

ToyoPucMaster

Variable address: basic and extended program areas include K/V/T/C/L/X/Y/M/S/N/R/D/B and EK/EV/ET/EC/EL/EX/EY/EM/ES/EN/EB/H/U/GX/GY/GM, for example M10.A or prg=1;D100. Numeric addresses are hexadecimal.

Includes collection retry, Foundation common read/write, and packing properties. There are no plugin-specific page fields; set the CPU, station, and address through the variable address rules.

XinJeInternalMaster

Variable address: bit areas are X/Y/M/SM/T/C/CM/ET/HM/HS/HT/HC; WORD areas are D/SD/TD/CD/HD/FD/ETD/HTD/HCD/HSD/ID/QD, for example X0, D0, or s=2;D0. WORD bit addresses are not supported.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
Default stationUsed when the variable address does not specify a station. Range 1-247, default 1.

XinJeModbusMaster

Variable address: an XC/XD/XL mixed device address such as D0, HD0, X0, D0.0, or s=2;D0. X/Y addresses are octal; available areas depend on the PLC series.

Includes all Modbus Master properties.

FieldDescription
PLC seriesSelect XC, XD, XL, or the applicable series to define the mixed Modbus address map.

YaskawaMemobusMaster

Variable address: bit areas are C/X; WORD areas are H/R/EH/EI/M/G/I/O/S. A symbolic WORD bit must include .bit, for example M100.3. Use to=2;from=1;H0 to override the CPU route.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
Destination CPU numberMessage destination CPU number, default 2.
Source CPU numberSource CPU number used by the gateway, default 1.
Maximum bit pack sizeContiguous bit-read limit, default 2000. Reduce it for a constrained device or unstable link.

YokogawaLinkMaster

Variable address: bit areas are X/Y/I/E/M/T/C/L; WORD areas are D/B/F/R/V/Z/W/TN/CN, for example Y100, D100, or cpu=2;D100.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
Default CPU numberUsed when the variable address does not specify a CPU, default 1.
Maximum bit pack sizeContiguous bit-read limit, default 256.

AiBusMaster

Variable address: a decimal parameter number from 0 to 255. Prefix it with s=station; to override the default station, for example s=2;0.

Includes collection retry, Foundation common read/write, and DTU properties.

FieldDescription
Default stationInstrument station, range 0-80. An s= prefix in the variable address takes precedence.

BarcodeIngressMaster

Variable address: barcode returns the barcode text and source returns the source identifier. This plugin has no periodic register address.

Does not display the common collection properties; it exposes only a source filter.

FieldDescription
Source IPAccept barcode reports only from this remote IP. Leave blank to accept every source on the current channel.

Cjt188Master

Variable address: a two-byte or three-byte data identifier such as 90-1F. Prefix it with s=14-digit-address; when needed, for example s=12345678901234;90-1F.

Includes collection retry, Foundation common read/write, and DTU properties.

FieldDescription
Default addressDefault 14-digit meter address, used when the variable address does not specify one.
Instrument typeCJ/T 188 instrument-type byte. Set it from the water, gas, or heat-meter manual.
Enable preambleSends two FE bytes when enabled. Turn it off when the peer does not require a preamble.
Match response addressStrictly validates the response address. Consider turning it off only for a proxy or a meter with nonstandard responses.

Dam3601Master

Variable address: a standard Modbus address such as 40001 or s=2;40001. Use the device point table for temperature registers.

Includes all Modbus Master properties. There are no plugin-specific page fields; configure the station and temperature registers from the device point table.

Dlt698Master

Variable address: a four-byte OAD such as 20-00-02-00. Optional parameters include s=, ca=, sat=, and logic=, for example s=149100007290;ca=0;20-00-02-00.

Includes collection retry, Foundation common read/write, and DTU properties.

FieldDescription
Server addressRequired hexadecimal text representing a 1-16 byte server address. It cannot be blank.
Client addressMaster client address. Set it according to the meter security and link configuration.
Enable FE preambleSends four FE bytes before every request when enabled. Turn it off when the peer does not require them.
Native TCP lifecycleEnables login and application-association processing for a native DL/T 698 TCP device. Leave it off for other transports or gateways.

Dtsu6606Master

Variable address: a standard Modbus address such as 40001 or s=2;40001. Use the meter manual for electrical measurement registers.

Includes all Modbus Master properties. There are no plugin-specific page fields; configure the station and electrical registers from the meter manual.

EcFanMaster

Variable address: fixed fields emergency, minimum, and maximum, which read emergency mode, minimum speed, and maximum speed respectively.

Includes collection retry and Foundation common read/write properties.

FieldDescription
Fan stationFan address, range 1-30, default 1.

KeyenceDlen1Master

Variable address: no general periodic register address. Sensor commands, status, and I/O are handled through dedicated diagnostics and dynamic methods.

Includes collection retry and Foundation common read/write properties. There are no plugin-specific page fields. This command-oriented plugin does not use periodic register variables.

KeyenceSr2000Master

Variable address: no general periodic register address. Scanning, reset, and lock control are handled through dedicated diagnostics and dynamic methods.

Includes collection retry and Foundation common read/write properties. There are no plugin-specific page fields; use the dedicated operations for scanning, reset, and lock control.

RkcMaster

Variable address: a two-character tag such as M1, AA, or ER; use s=2;M1 to specify the station.

Includes collection retry, Foundation common read/write, and DTU properties.

FieldDescription
Default stationTwo-digit ASCII station, range 0-99. A station in the variable address takes precedence.

SamCardMaster

Variable address: no general periodic register address. Module detection, card discovery, selection, and reading use dedicated diagnostics and dynamic methods.

Includes collection retry and Foundation common read/write properties. There are no plugin-specific page fields; card discovery, selection, and reading are explicit operations.

ScaleStreamMaster

Variable address: weight, tare, unit, net, positive, outofrange, stable, print, tenfold, valid, extended, taretype, or source.

Does not display common collection properties; it exposes stream validation and source-filter fields.

FieldDescription
Enable checksum byteRequires a checksum byte after the carriage return. It must match the scale output format.
Source IPAccept data only from this remote IP. Leave blank for serial input or unrestricted reverse-TCP input.

ShineInMaster

Variable address: Color/Light/LightDegree/WorkMode/Address/PulseWidth/Channel. Use c=2;Light to override the read channel from 1 to 8.

Includes collection retry, Foundation common read/write, and DTU properties.

FieldDescription
Default channelUsed when a variable address has no c= prefix. Range 1-8, default 1.

TurckRfidMaster

Variable address: a decimal tag byte position such as 0, 8, or 120. Boolean values use BYTE.bit, for example 10.3, with bit numbers from 0 to 7.

Includes collection retry, Foundation common read/write, and packing properties. There are no plugin-specific page fields; specify tag byte addresses and lengths in variables or dedicated operations.

VibrationStreamMaster

Variable address: actual.x/y/z, peak.accelerationx/y/z, peak.speedx/y/z, peak.offsetx/y/z, peak.temperature, peak.voltage, peak.interval, or address.

Does not display common collection properties; it exposes only the sensor address.

FieldDescription
StationSensor station, range 1-65535, default 1.

DigitronCplMaster

Variable address: a decimal WORD position such as 0, 100, or 65520; use s=2;100 to override the station. Boolean bit addresses are not supported.

Includes collection retry, Foundation common read/write, packing, and DTU properties.

FieldDescription
Default stationDefault request station, range 0-255, default 1.

AbbWebApiMaster

Variable address: a fixed API field name such as CtrlState, ErrorState, jointtarget, robtarget, ioin, ioout, ServoEnable, RapidExecution, or RapidTasks.

Includes collection retry properties and does not use the Foundation communication fields.

FieldDescription
Robot hostRequired host name or IP address. Do not include a scheme, port, or path.
Web API portRange 1-65535. Common values are 80 for HTTP and 443 for HTTPS.
Use HTTPSUses HTTPS and server-certificate validation when enabled.
User nameHTTP authentication user name. Leave blank when authentication is disabled on the robot.
PasswordPassword paired with the user name. Leave it blank when the user name is blank.
Request timeout millisecondsPer-request timeout, range 1-600000 ms.
Allow invalid server certificateEnable only temporarily when testing a self-signed certificate; keep it off in production.
Maximum response bytesResponse-body limit, range 1 byte-16 MiB, default 1 MiB.

EfortRobotMaster

Variable address: no register variable address. Use the dedicated Read robot status diagnostic or dynamic method.

Includes collection retry and Foundation common read/write properties. There are no plugin-specific page fields; verify the TCP channel, timeout, and send delay.

EstunRobotMaster

Variable address: a robot Modbus register mapping such as 40001. Use the Estun controller point table for the actual register map.

Includes all Modbus Master properties. There are no plugin-specific page fields; configure the robot register map and control states from the device manual.

FanucCnc0iMaster

Variable address: PMC byte areas are G/F/Y/X/A/R/T/K/C/D/E, for example R0 or D100. System status, alarms, programs, and directories are read through dedicated methods.

Includes collection retry and Foundation common read/write properties.

FieldDescription
Operation pathPath number on a multi-path machine, range 1-32767, default 1.
Text encodingRequired encoding for alarms, program names, and directories. Match the CNC language environment, for example GB2312.
Maximum PMC pack bytesPMC bytes merged into one periodic read, range 1-65535, default 1024.
Maximum program bytesProgram upload or download limit, range 1 byte-256 MiB, default 16 MiB.

FanucRobotInterfaceMaster

Variable address: WORD areas are D/AI/AQ/GI/GO/R1..R10/SR1..SR6; bit areas are I/Q/M/SDO/SDI/RDI/RDO/UI/UO/SI/SO, for example D1, R1, M1, or UI1. Addresses start at 1.

Includes collection retry and Foundation common read/write properties.

FieldDescription
Client IDClient number in the connection request, default 1024. Avoid duplicates on the same controller.
Text encodingFixed-width snapshot text encoding, default GB2312. Recheck it when Chinese text or symbols are garbled.
Maximum word-area pack lengthMaximum WORD count merged into one periodic read, default 6130.
Maximum bit-area pack lengthMaximum bit count merged into one periodic read, default 8192.

HyundaiTrackingMaster

Variable address: tracking, source, command, state, count, x, y, z, rx, ry, or rz. Variables are updated by UDP tracking frames.

Includes collection retry and Foundation common read/write properties.

FieldDescription
Robot source IPAllows only this robot IP to establish the UDP tracking session. Leave blank to accept any source.

KukaControllerTcpMaster

Variable address: a KUKA controller variable such as $POS_ACT. Strings must include length and encoding, for example $PRO_NAME[];len=32;encoding=UTF-8.

Includes collection retry and Foundation common read/write properties. There are no plugin-specific page fields; provide program and variable names through explicit operations or variable addresses.

KukaVariableProxyMaster

Variable address: a KUKA variable-proxy name such as $POS_ACT. Strings use $PRO_NAME[];len=32;encoding=UTF-8. Each variable is requested independently.

Includes collection retry and Foundation common read/write properties. There are no plugin-specific page fields; variable-proxy addresses and program-control parameters are supplied with each operation.

OrientalMotorMaster

Variable address: input, input[byte-offset], output, or output[byte-offset], for example input or output[4]. Only output is writable.

Includes collection retry, Foundation common read/write, and packing properties.

FieldDescription
Run/Idle headerFour-byte Run/Idle header in output datagrams, default 1. Match the adapter assembly parameters.
RPI timeBidirectional cyclic-I/O request interval, range 1-4294967 ms, default 100 ms.
Connection timeoutForward Open timeout, range 1-256 seconds and required to be a power of two, default 2 seconds.

YamahaRcxMaster

Variable address: no general periodic register address. Status and control parameters are read or written through dedicated diagnostics and dynamic methods.

Includes collection retry and Foundation common read/write properties. There are no plugin-specific page fields; common fields control response timeout and send delay, while dedicated operations provide command parameters.

Yrc1000Master

Variable address: controller status fields are returned by dedicated methods; there is no general register string. Select the six-axis or seven-axis layout in the device properties.

Includes collection retry and Foundation common read/write properties.

FieldDescription
Controller typeSelects the six-axis or seven-axis position-field layout. It must match the actual Yaskawa controller.

YrcHighEthernetMaster

Variable address: dedicated command fields. Processing division 1 is for robot control and 2 is for file control. There is no general periodic register string.

Includes collection retry and Foundation common read/write properties.

FieldDescription
Processing division1 selects robot control and 2 selects file control. Use 1 for normal status, I/O, and motion commands.

Iec104Master

Variable address: ca=N;type=N;ioa=N, for example ca=1;type=9;ioa=100. The three parts are the common address, information-object type, and information-object address.

Includes collection retry and Foundation common read/write properties.

FieldDescription
Common addressDefault common address, range 1-65534. It must match the server.
Send window KUnacknowledged I-frame send window, range 1-32767, default 12.
Receive acknowledgement threshold WI-frames received before an S-frame is sent, range 1-32767, default 8. It should normally be less than K.
Acknowledgement delay T2Delay before sending an S-frame when W is not reached, in milliseconds, default 10000.
Idle test interval T3Interval for TESTFR on an idle link, in milliseconds, default 20000.

KnxMaster

Variable address: a KNX group address in main/middle/sub form, for example 1/2/3. Main group range: 0-31; middle group: 0-7; sub-group: 0-255.

Includes collection retry and Foundation common read/write properties.

FieldDescription
KeepAliveIntervalMillisecondsInterval before rechecking the KNX/IP tunnel after successful communication, in milliseconds, default 60000.

OpenProtocolMaster

Variable address: mid=N;response=N;revision=N[;station=N;spindle=N] or subscribe=N, for example mid=10;response=11;revision=1 or subscribe=61.

Includes collection retry and Foundation common read/write properties. The common read/write timeout is displayed as Query timeout.

FieldDescription
Login revisionMID 0001 revision, range 0-999, default 1.
Query timeoutRequest-response timeout, range 1-65535 ms, default 5000.
Fragment receive timeoutNetwork-fragment accumulation timeout, in milliseconds, default 5000.
Enable heartbeatSends MID 9999 periodically. Keep it enabled for a persistent connection.
Heartbeat intervalMID 9999 interval, in milliseconds, default 10000.
Acknowledge all unsolicited messagesIgnores the No Ack Flag and acknowledges every mapped unsolicited message. Enable only when required by the controller.
Custom unsolicited acknowledgementsUse unsolicitedMID:ackMID, separated by commas or semicolons. Leave blank when no additional mapping is required.

SecsSerialMaster

Variable address: s=N;f=N[;w][;SECS-II XML], for example s=1;f=3;w, s=6;f=11, or s=1;f=13;w;<List Length="0" />.

Includes collection retry and Foundation common read/write properties. The main transaction uses the common timeout with T3 semantics.

FieldDescription
Device IDSECS-I Device ID. It must match the equipment.
Inter-byte T1Maximum interval between adjacent bytes in one block, in milliseconds, default 10000.
Line response T2Wait for ENQ, EOT, ACK, NAK, or another line response, in milliseconds, default 5000.
Primary transaction T3Primary-message reply timeout, in milliseconds, default 45000.
Multi-block T4Wait between adjacent blocks in a multi-block message, in milliseconds, default 10000.
NAK retry countMaximum retries after a NAK or failed block transmission, default 3.
Collision prioritySide that wins when the host and equipment send ENQ together. It must match the link agreement.

Data Forwarding Target Plugin Properties

Modbus slave (ModbusSlave)

Target variable address: the Modbus address exposed to an external master, for example 40001, 30001, or 00001.0. Also configure the data type so that variables do not occupy overlapping register ranges.

includes basic target attributes and channel-type target attributes.

Target configuration itemsDescription
Modbus typeModbus protocol form provided externally, such as TCP or RTU.
Default station numberSlave address used when the external master is not specified or the variable is not covered.
Data parsing orderByte order/word order used when providing multi-byte values externally.
Reverse String BytesWhether the order of string bytes is reversed.
Multi-site ModeWhether multiple station numbers are allowed. External main stations are enabled when accessing different station numbers.
Allows RPC writetarget-level write switch. After closing, the external Modbus master cannot write the gateway variable backward.
Write memory immediatelyImmediately update the gateway memory value after receiving the write.
Send Delay TimeReply Pre-Send Delay, unit: milliseconds. Set when the other device is slow or the link needs to be spaced.
Client permission listRestricts client IPs and write permissions allowed to connect; Empty means no restrictions.

Variable Properties:

Variable configuration itemsDescription
Slave variable addressThe address of this variable exposed to external Modbus masters.
Data TypeThe data type displayed externally must be consistent with the parsing method of the external main station.
Allows RPC writesvariable write switches. You can only write when both the target and variable levels are allowed.

MQTT Client Producer (MqttClientProducer)

Target variable mapping: use Data 1 through Data 10 and Allow RPC write in Topic or Payload templates. When these fields are blank, the default variable entity is used.

includes target base attributes, offline cache attributes, upload template and script attributes, and MQTT producer public attributes.

Target configuration itemsDescription
IP addressMQTT Broker address.
SSL target hostnamehostname used for certificate verification.
Client Certificate NameSelect the client certificate for two-way certificate authentication.
Client IDMQTT ClientId, which must avoid duplication with other clients.
Survival TimeMQTT KeepAlive, measured in seconds.
Clear the sessionWhether to clear the session. Turn it off when you need to keep offline subscription or session status.
MQTT protocol versionMQTT protocol version, must match broker support.

The variable property contains the generic target variable field Data 1 to Data 10, and adds:

Variable Configuration ItemDescription
Allow RPC writeAllows external MQTT RPC requests to write back to this variable. It takes effect only when the target-level, Topic, and script configurations are all correct.

MQTT Server Producer (MqttServerProducer)

Target variable mapping: use Data 1 through Data 10 and Allow RPC write in Topic or Payload templates. When these fields are blank, the default variable entity is used.

includes target base attributes, offline cache attributes, upload template and script attributes, and MQTT producer common attributes.

Target configuration itemsDescription
Server certificate nameGateway as MQTT The certificate used by the server when SSL is enabled.
Allows connection of ID prefixesOnly allows specified ClientId prefixes to be accessed; Empty means not restricted by prefixes.

The variable attribute contains the generic target variable field Data 1 to Data 10, and adds:

Variable Configuration ItemDescription
Allows RPC to writeAllows external clients accessing the MQTT server to reverse the variable.

ThingsBoard Client Producer (ThingsBoardClientProducer)

Target variable mapping: ThingsBoard defines the Topic. Variable properties primarily configure the external name and Allow RPC write.

includes the target base property and offline cache property. This target is uploaded to a fixed topic as agreed by the ThingsBoard Gateway.

Target configuration itemsDescription
Connection typeSelect either TCP or WebSocket.
IP addressThingsBoard MQTT access address.
PortThingsBoard MQTT port.
WebSocket pathWebSocket access path.
Enable SSLWhether SSL/TLS is used.
SSL target hostnamecertificate verification hostname.
Client Certificate NameSelect the client certificate for two-way certificate authentication.
CA nameCA that verifies the server-side certificate.
Allow untrusted certificatesDebugging can be enabled temporarily; production is recommended to turn off.
SSL protocol versionTLS protocol version.
Check whether the certificate is revokedCheck whether the certificate has been revoked.
Client IDMQTT ClientId.
UsernameThingsBoard Access Token or username, entered according to platform authentication method.
PasswordEntered when the platform requires password authentication.
KeepAlive TimeMQTT KeepAlive, unit: seconds.
Clear the sessionWhether to clear the session.
MQTT protocol versionMQTT protocol version, default MQTT 5.
QoS levelRelease quality level.
Retain messagesWhether to keep messages. Real-time telemetry is usually turned off.
Detailed LogOutput detailed upload log, link and call.

Variable Properties:

Variable Configuration ItemDescription
Allow RPC writeAllows ThingsBoard RPC requests to write back to the variable.

OPC UA Server (OpcUaServer)

Target variable address: an OPC UA NodeId or external variable name such as ns=2;s=Line1/Temperature. Also configure the data type and Allow RPC write.

Contains the target base attributes.

Target configuration itemDescription
Service addressDefault opc.tcp://127.0.0.1:48410. OPC UA service listening address. Multiple addresses are separated by semicolons.
Name IdentifierOPC UA server application name, which the client will see.
Security PolicyWhether OPC UA security policies are enabled. After activation, the certificate and account must be configured in sync.
Allow certificate loginWhether to publish the X509 user-certificate login policy. Enable it when clients log in with user certificates.
Client certificate trust modeManualTrustList is maintained through four issuer/trusted stores; SpecifiedCA validates client application and user certificates against the selected CA.
Trusted client CAUsed only by SpecifiedCA. When selected, only certificates issued by this CA are trusted; when blank, valid client certificates are trusted automatically.
Allows RPC writetarget-level write switch. After closing, the OPC UA client cannot write gateway variables.
Historical data targetStable history-target name. Leave blank to keep OPC UA historical data reads closed.
Historical alarm targetTarget name that supports historical alarm queries. Leave blank to keep OPC UA historical event reads closed.
UsernameOPC UA client account username.
PasswordOPC UA client account and password.
Server Certificate NameOPC UA Server Certificate Name.
Server issuing CASelect the issuing CA when the server certificate is CA-issued, so the complete certificate chain can be sent.

For the actual certificate-store procedures, five-store read/write scope, and permission requirements, see the device debugging manual.

Variable Properties:

Variable configuration itemsDescription
Data TypeThe node data type seen by the OPC UA client. Type mismatches can cause client write or parse failures.
Allows RPC writevariable writes toggle. You can only write when both the target and variable levels are allowed.

Kafka Producer (KafkaProducer)

Target variable mapping: use Data 1 through Data 10 in Topic, Key, or Payload templates to carry external fields. When these fields are blank, the default variable entity is used.

includes target base attributes, offline cache attributes, upload templates, and script attributes.

Target configurationDescription
Service addressKafka Bootstrap Servers, usually hosts: port, with multiple brokers filled in according to Kafka's terms.
Release TimeoutSingle Release Wait Time, in milliseconds.
UsernameSASL verified username. Leave SASL blank when not enabled.
PasswordSASL authentication password. Leave SASL blank when not enabled.
Security protocolsKafka security protocols, such as plaintext, SASL, or SSL combinations, must be consistent with the cluster.
SASL mechanismSASL mechanism, such as Plain,ScramSha256, ScramSha512.

Variable attribute is the general target variable field Data 1 to Data 10.

RabbitMQ Producer (RabbitMQProducer)

Target variable mapping: use Data 1 through Data 10 in the exchange, Routing Key, or Payload templates to carry external fields. When these fields are blank, the default variable entity is used.

includes target base attributes, offline cache attributes, upload templates, and script attributes. Topic templates for variables, devices, alarms, and plugin events are used as routing keys in RabbitMQ.

Target configuration itemsDescription
IP addressRabbitMQ service address.
portRabbitMQ port, commonly 5672.
UsernameRabbitMQ verified username.
PasswordRabbitMQ authentication password.
Declaration QueueWhether the gateway automatically declares the queue. Queues are closed when the platform creates them uniformly.
Declare the switchWhether the gateway automatically declares the switch. If the account does not have creation permission, it will be closed.
Enable release confirmationwait for the broker to release confirmation. Activated when reliability requirements are high.
Requires successful routingRequires messages to be routed at least to one queue. If the Routing Key misses, it will be treated as a failure.
Switch TypeRabbitMQ switch type, such as topic,direct, fanout.
Release timeoutRelease wait time, in milliseconds.
Virtual HostRabbitMQ Virtual Host, which must match the account permissions.
Switch NameThe name of the switch used for publishing.

The variable attribute is a generic target variable field, data 1 to data 10.

Historical Data Target (HisDataForwardTarget)

Target variable mapping: normally uses the variable name and in-group alias; there is no separate register string. Configure sampling mode, interval, and condition in the target-variable properties.

Includes the objective's basic attributes and offline cache attributes.

Target configuration itemsDescription
Database typeDatabase type for historical data writing. The connection string must match the database type.
Custom SQL PatternWrite to Custom SQL Wide Tables. Stay closed when you don't understand the structure of the target table.
Table segmentation strategyLarge data volumes or long retention periods are used to split tables by time and other strategies.
Connection stringDatabase connection information, including server, port, database name, account, password, and encryption policy.
Name of the numeric historical tableName of the historical table written to the numeric variable.
String history table nameThe name of the historical table written by the string variable.
Variable Information Table NameThe independent table name of the current statically configured target variable, default variableInfo. Only SqlServer, MySQL, Sqlite, and PostgreSQL will create and update this table; QuestDB and TDengine do not create them.
Retention DaysHistorical Data Retention Period. Assess traceability requirements and disk capacity before setup.
Historical table scriptsCustom table creation or writing scripts. It is only used when interfacing with existing table structures or special rules.
Time zone offsetTime zone offset for the time written, for example, +08:00.
Forced insertionWrite data upon receipt, without reducing the amount of records according to the sampling strategy. Having many points or short cycles can significantly increase database pressure.
Default sampling strategyUsed when variable properties are not configured. Variable sampling is suitable for state quantities, interval sampling is suitable for trend, and conditional sampling is suitable for recording according to operating conditions.
Default Sampling IntervalThe default sampling strategy is used for intervals, in milliseconds.
Default Conditional ExpressionsUsed when the default sampling strategy is conditional; expressions are only added when they meet the criteria.
Custom template configurationCustom SQL wide table field template. Field names and data types must match the target database.

When starting or reinitializing historical goals, update the independent variable information table with variables currently in the forwarding range. This table stores static information such as variables, devices, channels, units, types, and read/write settings, but does not store the value of each sample; After changes in variable or device configuration, re-enabling the target or restarting GatewayRuntime can refresh this information.

Variable Attributes:

Variable Configuration ItemsDescription
Sampling StrategyHow this variable is entered into the current historical target.
Sampling intervalSampling interval used during sampling, unit: milliseconds.
Conditional ExpressionsUsed during conditional sampling; only when the expression is satisfied is it recorded.

Real-time Data Target (RealDataForwardTarget)

Target variable mapping: normally uses the variable name and in-group alias; there is no separate register string. The target properties determine the table name and field structure.

Includes the basic attributes of the target.

Target configuration itemsDescription
Database typeDatabase type for real-time data writing.
Connection stringReal-time database connection information; the account must have permission to create tables, update, and write.
Real-time table nameTable name that stores the latest variable values and static variable information. The initial initialization creates a complete record of all variables in the current target range; subsequent updates only write to real-time fields.
Real-time table scriptsUsed when customizing real-time table structures or writing logic.
Time zone offsetTime zone used to write time.

Real-time targets do not create a separate variableInfo table; Variables, devices, channels, units, types, and read/write settings are saved in the real-time table records. After enabling "Filter Offline Data," subsequent changes in offline variables will not be written, but the initial initialization will still retain the static information and current state of the offline variable. After changes in variable or device configuration, re-enable the target or restart GatewayRuntime to refresh the static information in the real-time table.

No target variable property. The range and triggering method of variables are determined by the data forwarding group.

Historical Alarm Target (HisAlarmForwardTarget)

Target variable mapping: this target stores alarm entities and has no collection register string. The data-forwarding group determines the variable scope.

Includes the target's basic attributes and offline cache attributes.

Target configuration itemDescription
Database typeDatabase type where historical alarms are written.
Sharding StrategyUsed when alarm volume is high or retention cycles are long.
Connection stringHistorical alarm database connection information.
Historical alarm table namesSave the names of alarm events.
Retention DaysHistorical Alarm Retention Cycle.
Historical alarm table scriptsUsed when customizing alarm table structures or writing logic.
Time zone offsetThe time zone used when writing the alarm event time.
Minimum alarm levelOnly alarms of this level and above are kept. Maintain a lower grade when full traceability is required.

No target variable attribute. Whether an alarm is written is determined by the range of the forwarding group, the alarm status, and the minimum alarm level.

Webhook (Webhook)

Target variable mapping: use Data 1 through Data 10 in URL or Payload templates to carry external fields. When these fields are blank, the default variable entity is used.

includes target base attributes, offline cache attributes, upload templates, and script attributes. The variable topic template is used as the final request URL in the webhook.

Target configuration itemsDescription
Signature keyDingTalk robot adds Secret. Leave WeCom, Feishu, or regular HTTP interfaces blank when not needed.
Custom request headersJSON-formatted headers, such as {"Authorization":"Bearer token"}. Formatting errors can cause requests to fail.
Message formatRaw Send JSON or template content directly; Text/Markdown Compatible with bot message formats.
Request timeout (seconds)HTTP request wait time, measured in seconds. If the interface is slow, you can add it; if it's too large, it slows down and fails to retry.

The variable attribute is a general target variable field data 1 to data 10.

SyncBridge (SyncBridge)

Target variable mapping: synchronization normally uses the variable ID, variable name, and in-group alias. There is no separate register string.

Includes target base properties. One Hub can aggregate configuration and real-time values from multiple Edges.

Target Configuration ItemsDescription
RoleSelect HubServer or EdgePublisher.
LocalPeerIdStable and unique identity of the current node.
ListenUri / RemoteUriHub listener endpoint / Hub endpoint reached by the Edge.
VerifyTokenSecond authentication secret after TLS; no public default is provided.
TransportCertificateName / TransportCaCertificateNameCurrent-node certificate and the private CA used to verify peers.
TransportTargetHostHostname used by an Edge to verify the Hub certificate.
TransportSslProtocols / CheckCertificateRevocationTLS protocol selection and certificate revocation checking.
HeartbeatIntervalMsAuthenticated heartbeat interval; default 5000 ms.
RealtimeFlushIntervalMs / RealtimeAckTimeoutMsReal-time coalescing window and application-acknowledgement timeout.
MaxRealtimeBatchVariables / MaxRealtimeBatchBytesLimits of one real-time batch.
MaxConfigChunkBytesMaximum bytes in one configuration chunk.
ConfigSyncModeAutomatic Edge synchronization policy after reconnect and scope changes.
MaxConcurrentConfigurationSyncPeersHub concurrency for configuration requests across Edges.
AllowRemoteRpcBridge-wide reverse-write gate.

There are no target-variable properties. The forwarding-group scope determines the mirror. See SyncBridge Gateway Synchronization for the complete workflow.

IEC104 Slave (IEC104Slave)

Target variable address: enter the decimal information-object address in the variable property's StartAddress, for example 100. The target's Station is the common address and the variable's DataType is the information-object type; do not combine these three values into the master-side address string.

includes target base attributes and channel-type target attributes.

Target Configuration ItemsDescription
IsWithTimeInfoWhether it includes the time mark. The other party's main station requires the telemetry/telesignaling band to activate the time mark.
StationIEC104 public address/station number must match the main station configuration.
DeviceRpcEnableTarget-level write switch that controls whether the master may write back values.
SendDelayTimeSend delay time, in milliseconds. Set the packet spacing when the link is required.

Variable Properties:

Variable Configuration ItemsDescription
StartAddressIEC104 Information Entity Starting Address.
DataTypeIEC104 data types, such as telemetry and telesignaling, must be consistent with the main station table.
VariableRpcEnableVariable write toggle. You can only write when both the target and variable levels are allowed.

IEC 61850 Server (IEC61850Server)

Target variable address: LD/LN.DO.DA;FC=XX, for example LD0/LLN0.GGIO1.Ind1.stVal;FC=ST. Object references are normally generated when the model is imported.

Includes Target Foundation Properties.

Target configuration itemsDescription
IED namePublicly exposed IED name.
IED portMMS service port, commonly 102.
Vendor NameVendor name in the server model.
Allow writetarget-level write switch.
Callback Timeout (ms)Write or control the maximum time waiting for the gateway RPC result; if the timeout expires, the request will be rejected.
SCL Configuration File PathSCL/ICD/SCD file path, used to build data models from files.
GOOSE network card interfacepublishes the network card identifier used by GOOSE; Leave it blank to select automatically and list it in the log.
Enable GOOSE PublishingWhether to publish GOOSE.
Report DataSet NameDefault Report DataSet Name.
URCB NameDefault non-buffered report control block name.
BRCB NameDefault buffer report control block name.
Report ConfRevReport Configuration version number. When the model changes, it should be updated in parallel.
Report TrgOpsReport trigger option bitmaps. Configured according to the requirements of the station control layer system.
Report OptFldsOptional field bitmaps.
Report BufTimeReport buffer time, in milliseconds.
Report IntgPdReport completeness cycle, unit: milliseconds.
GOOSEDataSet NameGOOSE dataset name.
GOOSE block nameGOOSE block name.
GOOSE control block AppIDGOOSE control block appID string; When null, generate according to the logical device name.
GOOSEConfRevGOOSE configuration version number.
GOOSE Fixed OffsetWhether to use fixed offset. The other party strictly configures the SCD offset resolution as required.
GOOSE Minimum TimeGOOSE Minimum Recall Time, in milliseconds.
Maximum GOOSE TimeMaximum GOOSE Relaunch Time, in milliseconds.
GOOSE VLAN priorityGOOSE VLAN priority, ranging from 0 to 7.
GOOSE VLAN IDGOOSE VLAN ID.
GOOSE APPIDGOOSE Physical APPID.
GOOSE Target MACGOOSE Target Multicast MAC, e.g., 01-0C-CD-01-00-01.
SOE Event Log ConfigurationSOE Event Log Configuration. Configuration when event sequential tracing is required.
IEC 61850 versionstandard version: 0 is Edition1, 1 is Edition2, 2 is Edition2.1.
Maximum Number of ConnectionsMaximum Number of MMS Client Connections.
Enable dynamic datasetsWhether the client is allowed to create dynamic datasets.
Enable File ServiceWhether to enable MMS File Service.
Enable the logging serviceWhether to enable the logging service.
Reporting Buffer SizeBRCB Reporting Buffer Size.
BRCB contains ResvTmswhether BRCB contains reserved time fields. Some clients require it, while others are incompatible.
RCB contains OwnerDoes RCB contain the Owner field?
File Service PathThe base path when the file service is enabled.
Enable TLS encrypted connectionwhether MMS is enabled TLS.
TLS server certificateTLS server certificate name.
TLS CA CertificateCA verifying client certificates.
TLS Chain VerificationWhether certificate chain verification is enabled.
TLS only allows known certificateswhether only known certificates from the certificate repository are allowed to connect.

Variable Properties:

Variable configuration itemsDescription
Object referencesIEC 61850 object references, such as logical devices/logical nodes/data object paths.
Data TypeExternal data object types, such as MV, SPS, SPC, etc.
Allow writevariable write switch.
Control ModelControl models used by control points: state-only, direct control, select-and-execute execution, etc.
GOOSE releasewhether to include this variable in the GOOSE release dataset.

ZeroMQ Producer (ZeroMQProducer)

Target variable mapping: use Data 1 through Data 10 in Topic or Payload templates to carry external fields. When these fields are blank, the default variable entity is used.

includes target base attributes, offline cache attributes, upload templates, and script attributes.

Target configuration itemsDescription
Connection addressZeroMQ address, e.g., tcp://127.0.0.1:5555.
Socket typeZeroMQ Socket type, default release mode.
Binding Modetrue means Bind acts as the server; false means Connect as the client.
High watermarkZeroMQ queue cache limit; data backlog may be blocked or discarded if exceeded.

The variable attribute is a general target variable field. data 1 to data 10.