Skip to main content
Version: 8.1

system.device.addDevice - deviceProps Listing

Below is a table of properties callable by system.device.addDevice.

note

The Description and Enabled properties may not be configured with this function, although a device connection could be disabled with a call to system.device.setDeviceEnabled() after creating the connection.

Changed in 8.1.28

note

Starting in version 8.1.28, you can set a device to be enabled or disabled when using system.device.addDevice, by specifying the "Enabled" property in the system function's "deviceProps" dictionary parameter. A value of "0" will add the new device in a disabled state, while a value of "1" will add the new device in an enabled state.

LogixDriver Keys

Device PropertyKey
Hostnamehostname
Portport
Timeouttimeout
Max Concurrent Requestsconcurrency
Slot Numberslotnumber
Connection PathconnectionPath
Automatic Rebrowseautomaticrebrowseenabled
CIP Connection Sizecipconnectionsize
Enabled
New in 8.1.28
enabled

CompactLogix Keys

Device PropertyKey
Hostnamehostname
Timeouttimeout
Connection Pathpath
Concurrent RequestsconcurrentRequests
Disable Automatic BrowsedisableAutomaticBrowse
Show String ArraysshowStringArrays
Status Request Poll RatepollRate
Enabled
New in 8.1.28
enabled

com.inductiveautomation.omron.NjDriver Keys

Device PropertyKey
Hostnamehostname
Local Address
New in 8.1.8
localAddress
Timeouttimeout
Concurrencyconcurrency
Connection SizeconnectionSize
Slot NumberslotNumber
Date/Time OffsetdateTimeOffsetHours
Enabled
New in 8.1.28
enabled

In addition to the keys above, the driver can be passed to a tagMap key, that allows addresses to be defined. For example:

props = {
"hostName" : "10.0.0.1",
"tagMap" : "HOST\tNAME\tDATATYPE\tADDRESS\tCOMMENT\tTAGLINK\tRW\tPOU\n\tfoo\tUINT_BCD[0..1]\t\t\tTRUE\tR\t\n"
}

system.device.addDevice(deviceType = "com.inductiveautomation.omron.NjDriver", \
deviceName = "nj",\
deviceProps = props)

com.inductiveautomation.FinsTcpDeviceType

Device PropertyKey
Hostnamehostname
Portport
Timeouttimeout
Local AddresslocalAddress
Source NetworksourceNetwork
Source NodesourceNode
Source UnitsourceUnit
Destination NetworkdestinationNetwork
Destination NodesdestinationNode
Destination UnitdestinationUnit
Concurrent RequestsconcurrentRequest
Max Request SizemaxRequestSize
Max Gap SizemaxGapSize
Write Priority RatiowritePriorityRatio
Enabled
New in 8.1.28
enabled

com.inductiveautomation.FinsUdpDeviceType

Device PropertyKey
Bind AddressbindAddress
Bind PortbindPort
Remote AddressremoteAddress
Remote PortremotePort
Timeouttimeout
Source NetworksourceNetwork
Source NodesourceNode
Source UnitsourceUnit
Destination NetworkdestinationNetwork
Destination NodesdestinationNode
Destination UnitdestinationUnit
Concurrent RequestsconcurrentRequest
Max Request SizemaxRequestSize
Max Gap SizemaxGapSize
Write Priority RatiowritePriorityRatio
Enabled
New in 8.1.28
enabled

com.inductiveautomation.MitsubishiTcpDeviceType

Device PropertyKey
Hostnameseries
Hostnamehostname
Portport
Local AddresslocalAddress
Timeouttimeout
Max Gap SizemaxGapSize
Write Priority RatiowritePriorityRatio

ControlLogix Keys

Device PropertyKey
Hostnamehostname
Timeouttimeout
Connection Pathpath
Concurrent RequestsconcurrentRequests
Disable Automatic BrowsedisableAutomaticBrowse
Show String ArraysshowStringArrays
Status Request Poll RatepollRate
Slot NumberslotNumber
Enabled
New in 8.1.28
enabled

com.inductiveautomation.Dnp3DeviceType Keys

Device PropertyKey
HostnameHostname
PortPort
Source AddressSourceAddress
Destination AddressDestinationAddress
Response TimeoutResponseTimeout
Keep Alive TimeoutKeepAliveTimeout
Integrity Poll PeriodIntegrityPollPeriod
Class 1 Poll PeriodClass1PollPeriod
Class 2 Poll PeriodClass2PollPeriod
Class 3 Poll PeriodClass3PollPeriod
Unsolicited Event ClassesUnsolicitedEventClasses
Analog Output Command ModeAnalogOutputCommandMode
Analog Output Read After OperateAnalogOutputReadAfterOperate
Binary Output Command ModeBinaryOutputCommandMode
Binary Output Read After OperateBinaryOutputReadAfterOperate
Binary Output Trip Close CodeBinaryOutputTCC
Binary Output Operation TypeBinaryOutputOT
Binary Output CountBinaryOutputCount
Binary Output On TimeBinaryOutputOnTime
Binary Output Off TimeBinaryOutputOffTime
Application Layer Debug LoggingAppLayerDebugLogging
Physical Layer Debug LoggingPhysLayerDebugLogging

Dnp3Driver Keys

Device PropertyKeyAcceptable Values
Hostnamehostname
Portport
Source AddresssourceAddress
Destination AddressdestinationAddress
Integrity Poll IntervalintegrityPollInterval
Direct Operate EnableddirectOperateEnabled
Unsolicited Messages EnabledunsolicitedMessagesEnabled
Message Fragment SizemaxMessageFragmentSize
Message Timeouttimeout
Retriesretries
Link Layer ConfirmationlinkLayerConfirmationEnabled
Default Outstation Conformance LeveloutstationConformanceDefault
  • "UNKNOWN"
  • "ONE"
  • "TWO"
  • "THREE"
  • "FOUR"
Analog Input PointsanalogInputDefaultValueType
  • "INTEGER"
  • "SHORT"
  • "FLOAT"
  • "DOUBLE"
  • "VARIATION_0"
Analog Input Frozen PointsanalogInputFrozenDefaultValueType
  • "INTEGER"
  • "SHORT"
  • "FLOAT"
  • "DOUBLE"
  • "VARIATION_0"
Analog Output PointsanalogOutputDefaultValueType
  • "INTEGER"
  • "SHORT"
  • "FLOAT"
  • "DOUBLE"
  • "VARIATION_0"
Counter PointscounterDefaultValueType
  • "INTEGER"
  • "SHORT"
  • "VARIATION_0"
Counter Frozen PointscounterFrozenDefaultValueType
  • "INTEGER"
  • "SHORT"
  • "VARIATION_0"
Binary Input PointsbinaryInputDefaultValueType
  • "PACKED"
  • "WITH_FLAGS"
  • "VARIATION_0"
Double-Bit Binary Input PointsdoubleBitBinaryInputDefaultValueType
  • "PACKED"
  • "WITH_FLAGS"
  • "VARIATION_0"
Binary Output PointsbinaryOutputDefaultValueType
  • "PACKED"
  • "WITH_FLAGS"
  • "VARIATION_0"
Enabled
New in 8.1.28
enabled

IEC61850Driver Keys

Device PropertyKey
HostnameHostname
PortPort
Request TimeoutRequestTimeout
Authentication EnabledAuthenticationEnabled
Authentication PasswordAuthenticationPassword
Use SCD FileUseScdFile
Use Configured HostnameUseConfiguredHostname
Use Configured OSI ParamsUseConfiguredOsiParams
IED NameIedName
Access Point NameAccessPointName
Client AE QualifierClientAeQualifier
Client AP TitleClientApTitle
Client Presentation-SelectorClientPSel
Client Session-SelectorClientSSel
Client Transport-SelectorClientTSel
Server AE QualifierServerAeQualifier
Server AP TitleServerApTitle
Server Presentation-SelectorServerPSel
Server Session-SelectorServerSSel
Server Transport-SelectorServerTSel
Use Report TimestampUseReportTimestamp
Enabled
New in 8.1.28
enabled

Micro800 Keys

Device PropertyKey
Hostnamehostname
Portport
Local AddresslocalAddress
Timeouttimeout
Max Concurrent RequestsmaxConcurrentRequests
Write Priority RatiowritePriorityRatio
Automatic Rebrowse EnabledautomaticRebrowseEnabled
CIP Connection SizecipConnectionSize
CIP Connection TimeoutcipConnectionTimeout
Enabledenabled

MicroLogix Keys

Device PropertyKey
Hostnamehostname
Timeouttimeout
Browse Cache TimeoutbrowseCacheTimeout
Connection Pathpath
Disable Processor BrowsedisableProcessorBrowse
Zero TNS ConnectionuseZeroTnsConnections
Enabled
New in 8.1.28
enabled

ModbusRtuOverTcp and ModbusTcp Keys

Device PropertyKey
Hostnamehostname
Portport
Communication TimeoutcommunicationTimeout
Max Holding Registers Per RequestmaxHoldingRegistersPerRequest
Max Input Registers Per RequestmaxInputRegistersPerRequest
Max Coils Per RequestmaxCoilsPerRequest
Max Discrete Inputs Per RequestmaxDiscreteInputsPerRequest
Reverse Word OrderreverseWordOrder
One-based AddressingzeroBasedAddressing
Span GapsspanGaps
Allow Write Multiple Registers RequestwriteMultipleRegistersRequestAllowed
Force Multiple Register WritesforceMultipleRegisterWritesEnabled
Allow Write Multiple Coils RequestwriteMultipleCoilsRequestAllowed
Allow Read Multiple Registers RequestreadMultipleRegistersRequestAllowed
Allow Read Multiple CoilsreadMultipleCoilsAllowed
Allow Read Multiple Discrete InputsreadMultipleDiscreteInputsAllowed
Reconnect After Consecutive TimeoutsreconnectAfterConsecutiveTimeouts
Max Retry CountmaxRetryCount
Reverse String Byte OrderreverseStringByteOrder
Right Justify StringrightJustifyStrings
Read Raw StringsreadRawStrings
Enabled
New in 8.1.28
enabled

PLC5 Keys

Device PropertyKey
Hostnamehostname
Timeouttimeout
Browse Cache TimeoutbrowseCacheTimeout
Connection Pathpath
Disable Processor BrowsedisableProcessorBrowse
Zero TNS ConnectionuseZeroTnsConnections
Enabled
New in 8.1.28
enabled

S7300, S7400, S71200, and S71500 Keys

Device PropertyKey
Hostnamehostname
Timeouttimeout
Portport
PDU SizepduSize
Rack NumberrackNumber
CPU Slot NumbercpuSlotNumber
Reconnect After Consecutive TimeoutsreconnectAfterConsecutiveTimeouts
Enabled
New in 8.1.28
enabled

SLC Keys

Device PropertyKey
Hostnamehostname
Timeouttimeout
Browse Cache TimeoutbrowseCacheTimeout
Connection Pathpath
Disable Processor BrowsedisableProcessorBrowse
Zero TNS ConnectionuseZeroTnsConnections
Enabled
New in 8.1.28
enabled

TCPDriver Keys

Device PropertyKeyAcceptable Values
Port(s)ports
Addressaddress
Inactivity TimeoutinactivityTimeout
Message Delimiter TypemessageDelimiterType
  • "PacketBased"
  • "CharacterBased"
  • "FixedSize"
Message DelimitermessageDelimiter
Field CountfieldCount
Field DelimiterfieldDelimiter
Writeback EnabledwritebackEnabled
Writeback Message DelimiterwritebackDelimiter
Enabled
New in 8.1.28
enabled

UDPDriver Keys

Device PropertyKeyAcceptable Values
Port(s)ports
Addressaddress
Message Delimiter TypemessageDelimiterType
  • "PacketBased"
  • "CharacterBased"
  • "FixedSize"
Message DelimitermessageDelimiter
Field CountfieldCount
Field DelimiterfieldDelimiter
Message Buffer SizemessageBufferSize
Multicastmulticast
Enabledenabled