Creating EFM Device Connections with Ignition scripting

EFM Device Connection configurations can be created through scripting using the standard Ignition function

system.device.addDevice()

The Description and Enabled properties may not be configured with this function. By default, the Enabled property is set to true and can be disabled with a call to system.device.setDeviceEnabled() after creating the connection.

The device driver types for the Cirrus Link EFM Modules are listed in the table below:

Driver Name	Device Type
Emerson ROC	Creating EFM Device Connections with Ignition scripting
ABB Totalflow	Creating EFM Device Connections with Ignition scripting
Opto 22 groov EPIC and SNAP PAC	Creating EFM Device Connections with Ignition scripting

Below are the table of properties callable by system.device.addDevice.

Properties in bold are mandatory properties that must be included in the addDevice call

Emerson ROC Keys

Device Property	Key	Default Setting	Datatype
Protocol Type	ProtocolType (ROC or ROC_PLUS)		String
Hostname	Hostname		String
TCP Port	Port		Integer
Socket Timeout	SocketTimeout	10	Integer
ROC Unit Code	RocUnitCode		Integer
ROC Group Code	RocGroupCode		Integer
Host Unit Code	HostUnitCode		Integer
Host Group Code	HostGroupCode		Integer
Periodic Mapping	PeriodicMappingId	None	Long
Configuration Mapping	ConfigurationMappingId	None	Long
Add All TLP Definitions	AddAllTLPDefinitions	False	Boolean
Security Enabled	SecurityEnabled	False	Boolean
Operator ID	OperatorId	Lol	String
Password	Password		String
Access Level Enabled	AccessLevelEnabled	False	Boolean
Access Level	AccessLevel	0	Integer
Date Time Offset	DateTimeOffset	0	Integer
Sync ROC RTC	SyncDateTime	False	Boolean
Sync Expression	SyncDateTimeExpression	0 0 0 * * ?	String
Alarm Scan Rate	AlarmScanRate	-1	Integer
Event Scan Rate	EventScanRate	-1	Integer
Minute History Scan Rate	HistoryMinuteScanRate	-1	Integer
Periodic History Scan Rate	HistoryPeriodicScanRate	-1	Integer
Daily History Scan Rate	HistoryDailyScanRate	-1	Integer
Enable Signature	EnableSignature	False	Boolean
Algorithm	HashingAlgorithm	None	String
Password	SignaturePassword		String
Group ID	GroupId	None	String
Edge ID	EdgeId	None	String
Device ID	DeviceId	None	String

Emerson ROC Sample Script

#new device connection using default settings
newProps = {}
newProps["ProtocolType"] = "ROC"
newProps["Hostname"] = "10.1.2.3"
newProps["Port"] = 2000
newProps["RocUnitCode"] = 10
newProps["RocGroupCode"] = 100
newProps["HostUnitCode"] = 20
newProps["HostGroupCode"] = 200
newProps["HashingAlgororithm"] = "SHA_1"
system.device.addDevice(deviceType = "EmersonRoc",deviceName = "MyROC",deviceProps = newProps)

ABB Totalflow Keys

Device Property	Key	Default Setting	Datatype
Board Type	BoardType		String
Hostname	Hostname		String
TCP Port	Port		Integer
Socket Timeout	SocketTimeout	10	Integer
Connection Type	ConnectionType	ON_DEMAND	String
Enable Auto-discovery	EnableAutoDiscovery	True	Boolean
Add All Totalflow Application Definitions	AddAllTotalflowApplicationDefinitions	True	Boolean
Add All Array-Register Definitions	AddAllArrayRegisterDefinitions	True	Boolean
Auto-generate Templates and Poll Group	AutoGenerateDefaultTemplatesAndPollGroup	True	Boolean
Array-Register Template Import Policy	ArrayRegisterTemplateImportPolicy	UPDATE	String
Poll Group Import Policy	PollGroupImportPolicy	UPDATE	String
Station ID	StationId	None	String
Keep Alive	ConnectionKeepAlive	0	Integer
Host Timeout	HostTimeout	3000	Long
Number Retries	NumberRetries	3	Integer
Supervisory Frames	SupervisoryFrames	3	Integer
Password			String
RBAC Enabled	RbacEnabled	False	Boolean
Operator ID	OperatorId	None	String
Password	OperatorPassword		String
Date Time Offset	DateTimeOffset	0	Integer
Alarm Source	AlarmSourceSelector	PERIODIC_HISTORY_SETTINGS	String
Alarm Scan Rate	AlarmScanRate	-1	Integer
Event Scan Rate	EventScanRate	0	Integer
Periodic History Scan Rate	HistoryPeriodicScanRate	0	Integer
Daily History Scan Rate	HistoryDailyScanRate	0	Integer
Record Info Scan Rate	RecordInfoScanRate	-1	Integer
Max Records To Read	MaxRecordsToRead	100	Integer
Periodic Mapping	PeriodicMappingId	None	Long
Enable Signature	EnableSignature	False	Boolean
Hashing Algorithm	HashingAlgorithm	None	String
Password	SignaturePassword		String
Group ID	GroupId	None	String
Edge ID	EdgeId	None	String
Device ID	DeviceId	None	String

??

Db2BlockSize

Db2PacketSize

SecurityCode

ABB Totalflow Sample Script

#new device connection using default settings
newProps = {}
newProps["BoardType"] = "G4"
newProps["Hostname"] = "10.1.2.3"
newProps["Port"] = 2000
system.device.addDevice(deviceType = "AbbTotalflow",deviceName = "MyABB",deviceProps = newProps)

Opto 22 groov EPIC and SNAP PAC

Device Property	Key	Default Setting	Datatype
Address	Address	192.168.1.100	String
TCP/IP Port	Port	22001	Integer
Timeout	Timeout	3000	Long
Data Scan Rate	DataScanRate	1000	Long

Opto22 Sample Script

#new device connection using default settings
newProps = {}
system.device.addDevice(deviceType = "SnapPacDriver",deviceName = "MyOpto22",deviceProps = newProps)

#new device connection
newProps = {}
newProps["Address"] = "156.23.25.42"
newProps["Port"] = 22001
newProps["Timeout"] = 3500
newProps["DataScanRate"] = 1500
system.device.addDevice(deviceType = "SnapPacDriver",deviceName = "MyOpto22",deviceProps = newProps)

Contents

Cirrus Link Resources

Inductive Resources

Emerson ROC Keys

ABB Totalflow Keys

Opto 22 groov EPIC and SNAP PAC