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 Property	Key
Hostname	hostname
Port	port
Local Address	New in 8.1.8 localAddress
Timeout	timeout
Max Concurrent Requests	concurrency
Slot Number	slotnumber
Connection Path	connectionPath
Automatic Rebrowse	automaticrebrowseenabled
Identity Request Frequency	New in 8.1.3 identityRequestFrequency
CIP Connection Size	cipconnectionsize
CIP Connection Timeout	New in 8.1.10 cipConnectionTimeout
Enabled	New in 8.1.28 enabled

CompactLogix Keys

Device Property	Key
Hostname	hostname
Local Address	New in 8.1.8 localAddress
Timeout	timeout
Connection Path	path
Concurrent Requests	concurrentRequests
Disable Automatic Browse	disableAutomaticBrowse
Show String Arrays	showStringArrays
Status Request Poll Rate	pollRate
Enabled	New in 8.1.28 enabled

com.inductiveautomation.omron.NjDriver Keys

Device Property	Key
Hostname	hostname
Local Address	New in 8.1.8 localAddress
Timeout	timeout
Concurrency	concurrency
Connection Size	connectionSize
Slot Number	slotNumber
Date/Time Offset	dateTimeOffsetHours
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 Property	Key
Hostname	hostname
Port	port
Timeout	timeout
Local Address	localAddress
Source Network	sourceNetwork
Source Node	sourceNode
Source Unit	sourceUnit
Destination Network	destinationNetwork
Destination Nodes	destinationNode
Destination Unit	destinationUnit
Concurrent Requests	concurrentRequests
Max Request Size	maxRequestSize
Max Gap Size	maxGapSize
Write Priority Ratio	writePriorityRatio
Enabled	New in 8.1.28 enabled

com.inductiveautomation.FinsUdpDeviceType

Device Property	Key
Bind Address	bindAddress
Bind Port	bindPort
Remote Address	remoteAddress
Remote Port	remotePort
Timeout	timeout
Source Network	sourceNetwork
Source Node	sourceNode
Source Unit	sourceUnit
Destination Network	destinationNetwork
Destination Nodes	destinationNode
Destination Unit	destinationUnit
Concurrent Requests	concurrentRequests
Max Request Size	maxRequestSize
Max Gap Size	maxGapSize
Write Priority Ratio	writePriorityRatio
Enabled	New in 8.1.28 enabled

com.inductiveautomation.MitsubishiTcpDeviceType

Device Property	Key
Device Series	series
Hostname	hostname
Port	port
Local Address	localAddress
Timeout	timeout
Max Gap Size	maxGapSize
Write Priority Ratio	writePriorityRatio
PC Number	New in 8.1.43 PcNumber
Network Number	New in 8.1.43 NetworkNumber
Request Destination Module I/O Number	New in 8.1.43 DestinationIOModuleNumber
Request Destination Module Station Number	New in 8.1.43 DestinationModuleStationNumber

ControlLogix Keys

Device Property	Key
Hostname	hostname
Local Address	New in 8.1.8 localAddress
Timeout	timeout
Connection Path	path
Concurrent Requests	concurrentRequests
Disable Automatic Browse	disableAutomaticBrowse
Show String Arrays	showStringArrays
Status Request Poll Rate	pollRate
Slot Number	slotNumber
Enabled	New in 8.1.28 enabled

com.inductiveautomation.Dnp3DeviceType Keys

Device Property	Key
Hostname	Hostname
Port	Port
Source Address	SourceAddress
Destination Address	DestinationAddress
Response Timeout	ResponseTimeout
Keep Alive Timeout	KeepAliveTimeout
Integrity Poll Period	IntegrityPollPeriod
Class 1 Poll Period	Class1PollPeriod
Class 2 Poll Period	Class2PollPeriod
Class 3 Poll Period	Class3PollPeriod
Unsolicited Event Classes	UnsolicitedEventClasses
Analog Output Command Mode	AnalogOutputCommandMode
Analog Output Read After Operate	AnalogOutputReadAfterOperate
Binary Output Read After Operate Delay	AnalogOutputReadAfterOperateDelay
Binary Output Command Mode	BinaryOutputCommandMode
Binary Output Read After Operate	BinaryOutputReadAfterOperate
Binary Output Read After Operate Delay	BinaryOutputReadAfterOperateDelay
Binary Output Trip Close Code	BinaryOutputTCC
Binary Output Operation Type	BinaryOutputOT
Binary Output Count	BinaryOutputCount
Binary Output On Time	BinaryOutputOnTime
Binary Output Off Time	BinaryOutputOffTime
Auto Time Sync	New in 8.1.39 AutoTimeSync
Application Layer Debug Logging	AppLayerDebugLogging
Physical Layer Debug Logging	PhysLayerDebugLogging

Dnp3Driver Keys

Device Property	Key	Acceptable Values
Hostname	hostname
Port	port
Local Address	New in 8.1.8 localAddress
Source Address	sourceAddress
Destination Address	destinationAddress
Integrity Poll Interval	integrityPollInterval
Direct Operate Enabled	directOperateEnabled
Unsolicited Messages Enabled	unsolicitedMessagesEnabled
Message Fragment Size	maxMessageFragmentSize
Message Timeout	timeout
Retries	retries
Time Synchronization Enabled	New in 8.1.17 TimeSynchronizationEnabled
Link Layer Confirmation	linkLayerConfirmationEnabled
Default Outstation Conformance Level	outstationConformanceDefault	"UNKNOWN" "ONE" "TWO" "THREE" "FOUR"
Analog Input Points	analogInputDefaultValueType	"INTEGER" "SHORT" "FLOAT" "DOUBLE" "VARIATION_0"
Analog Input Frozen Points	analogInputFrozenDefaultValueType	"INTEGER" "SHORT" "FLOAT" "DOUBLE" "VARIATION_0"
Analog Output Points	analogOutputDefaultValueType	"INTEGER" "SHORT" "FLOAT" "DOUBLE" "VARIATION_0"
Counter Points	counterDefaultValueType	"INTEGER" "SHORT" "VARIATION_0"
Counter Frozen Points	counterFrozenDefaultValueType	"INTEGER" "SHORT" "VARIATION_0"
Binary Input Points	binaryInputDefaultValueType	"PACKED" "WITH_FLAGS" "VARIATION_0"
Double-Bit Binary Input Points	doubleBitBinaryInputDefaultValueType	"PACKED" "WITH_FLAGS" "VARIATION_0"
Binary Output Points	binaryOutputDefaultValueType	"PACKED" "WITH_FLAGS" "VARIATION_0"
Enabled	New in 8.1.28 enabled

IEC61850Driver Keys

Device Property	Key
Hostname	Hostname
Port	Port
Request Timeout	RequestTimeout
Authentication Enabled	AuthenticationEnabled
Authentication Password	AuthenticationPassword
Use SCD File	UseScdFile
Use Configured Hostname	UseConfiguredHostname
Use Configured OSI Params	UseConfiguredOsiParams
IED Name	IedName
Access Point Name	AccessPointName
Client AE Qualifier	ClientAeQualifier
Client AP Title	ClientApTitle
Client Presentation-Selector	ClientPSel
Client Session-Selector	ClientSSel
Client Transport-Selector	ClientTSel
Server AE Qualifier	ServerAeQualifier
Server AP Title	ServerApTitle
Server Presentation-Selector	ServerPSel
Server Session-Selector	ServerSSel
Server Transport-Selector	ServerTSel
Use Report Timestamp	UseReportTimestamp
Enabled	New in 8.1.28 enabled

Micro800 Keys

Device Property	Key
Hostname	hostname
Port	port
Local Address	localAddress
Timeout	timeout
Max Concurrent Requests	concurrency
Write Priority Ratio	writePriorityRatio
Automatic Rebrowse Enabled	automaticRebrowseEnabled
CIP Connection Size	cipConnectionSize
CIP Connection Timeout	cipConnectionTimeout
Enabled	enabled

MicroLogix Keys

Device Property	Key
Hostname	hostname
Local Address	New in 8.1.8 localAddress
Timeout	timeout
Browse Cache Timeout	browseCacheTimeout
Connection Path	path
Disable Processor Browse	disableProcessorBrowse
Zero TNS Connection	useZeroTnsConnections
Enabled	New in 8.1.28 enabled

ModbusRtu Keys

Device Property	Key
Serial Port	serialPort
Bit Rate	bitRate
Data Bits	dataBits
Parity	parity
Stop Bits	stopBits
Handshake	handshake
Communication Timeout	communicationTimeout
RS-485 Mode	rs485Mode
Max Holding Registers Per Request	maxHoldingRegistersPerRequest
Max Input Registers Per Request	maxInputRegistersPerRequest
Max Coils Per Request	maxCoilsPerRequest
Max Discrete Inputs Per Request	maxDiscreteInputsPerRequest
Reverse Word Order	reverseWordOrder
One-based Addressing	zeroBasedAddressing2
Span Gaps	spanGaps
Allow Write Multiple Registers Request	writeMultipleRegistersRequestAllowed
Force Multiple Register Writes	forceMultipleRegisterWritesEnabled
Allow Write Multiple Coils Request	writeMultipleCoilsRequestAllowed
Allow Read Multiple Registers Request	readMultipleRegistersRequestAllowed
Allow Read Multiple Coils	readMultipleCoilsAllowed
Allow Read Multiple Discrete Inputs	readMultipleDiscreteInputsAllowed
Reconnect After Consecutive Timeouts	reconnectAfterConsecutiveTimeouts
Max Retry Count	maxRetryCount
Reverse String Byte Order	reverseStringByteOrder
Right Justify String	rightJustifyStrings
Read Raw Strings	readRawStrings
Enabled	New in 8.1.28 enabled

ModbusRtuOverTcp and ModbusTcp Keys

Device Property	Key
Hostname	hostname
Local Address	New in 8.1.8 localAddress
Port	port
Communication Timeout	communicationTimeout
Concurrent Requests	New in 8.1.0 concurrentRequests
Max Holding Registers Per Request	maxHoldingRegistersPerRequest
Max Input Registers Per Request	maxInputRegistersPerRequest
Max Coils Per Request	maxCoilsPerRequest
Max Discrete Inputs Per Request	maxDiscreteInputsPerRequest
Reverse Word Order	reverseWordOrder
One-based Addressing	zeroBasedAddressing2
Span Gaps	spanGaps
Allow Write Multiple Registers Request	writeMultipleRegistersRequestAllowed
Force Multiple Register Writes	forceMultipleRegisterWritesEnabled
Allow Write Multiple Coils Request	writeMultipleCoilsRequestAllowed
Allow Read Multiple Registers Request	readMultipleRegistersRequestAllowed
Allow Read Multiple Coils	readMultipleCoilsAllowed
Allow Read Multiple Discrete Inputs	readMultipleDiscreteInputsAllowed
Reconnect After Consecutive Timeouts	reconnectAfterConsecutiveTimeouts
Max Retry Count	maxRetryCount
Reverse String Byte Order	reverseStringByteOrder
Right Justify String	rightJustifyStrings
Read Raw Strings	readRawStrings
Enabled	New in 8.1.28 enabled

PLC5 Keys

Device Property	Key
Hostname	hostname
Local Address	New in 8.1.8 localAddress
Timeout	timeout
Browse Cache Timeout	browseCacheTimeout
Connection Path	path
Disable Processor Browse	disableProcessorBrowse
Zero TNS Connection	useZeroTnsConnections
Enabled	New in 8.1.28 enabled

S7300, S7400, S71200, and S71500 Keys

Device Property	Key
Hostname	hostname
Local Address	New in 8.1.8 localAddress
Timeout	timeout
Port	port
PDU Size	pduSize
Rack Number	rackNumber
CPU Slot Number	cpuSlotNumber
Reconnect After Consecutive Timeouts	reconnectAfterConsecutiveTimeouts
Enabled	New in 8.1.28 enabled

SLC Keys

Device Property	Key
Hostname	hostname
Local Address	New in 8.1.8 localAddress
Timeout	timeout
Browse Cache Timeout	browseCacheTimeout
Connection Path	path
Disable Processor Browse	disableProcessorBrowse
Zero TNS Connection	useZeroTnsConnections
Enabled	New in 8.1.28 enabled

TCPDriver Keys

Device Property	Key	Acceptable Values
Port(s)	ports
Address	address
Local Address	New in 8.1.8 localAddress
Connect Timeout	New in 8.1.17 ConnectTimeout
Inactivity Timeout	inactivityTimeout
Message Delimiter Type	messageDelimiterType	"PacketBased" "CharacterBased" "FixedSize"
Message Delimiter	messageDelimiter
Field Count	fieldCount
Field Delimiter	fieldDelimiter
Write Timeout	New in 8.1.24 WriteTimeout
Writeback Enabled	writebackEnabled
Writeback Message Delimiter	writebackDelimiter
Enabled	New in 8.1.28 enabled

UDPDriver Keys

Device Property	Key	Acceptable Values
Port(s)	ports
Address	address
Message Delimiter Type	messageDelimiterType	"PacketBased" "CharacterBased" "FixedSize"
Message Delimiter	messageDelimiter
Field Count	fieldCount
Field Delimiter	fieldDelimiter
Message Buffer Size	messageBufferSize
Multicast	multicast
Enabled	enabled