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	Datatype
Protocol Type	ProtocolType (ROC or ROC_PLUS)	String
Hostname	Hostname	String
TCP Port	Port	Integer
Socket Timeout	SocketTimeout	Integer
ROC Unit Code	RocUnitCode	Integer
ROC Group Code	RocGroupCode	Integer
Host Unit Code	HostUnitCode	Integer
Host Group Code	HostGroupCode	Integer
Periodic Mapping	PeriodicMappingId	Long
Configuration Mapping	ConfigurationMappingId	Long
Add All TLP Definitions	AddAllTLPDefinitions	Boolean
Security Enabled	SecurityEnabled	Boolean
Operator ID	OperatorId	String
Password	Password	String
Access Level Enabled	AccessLevelEnabled	Boolean
Access Level	AccessLevel	Integer
Date Time Offset	DateTimeOffset	Integer
Sync ROC RTC	SyncDateTime	Boolean
Sync Expression	SyncDateTimeExpression	String
Alarm Scan Rate	AlarmScanRate	Integer
Event Scan Rate	EventScanRate	Integer
Minute History Scan Rate	HistoryMinuteScanRate	Integer
Periodic History Scan Rate	HistoryPeriodicScanRate	Integer
Daily History Scan Rate	HistoryDailyScanRate	Integer
Enable Signature	EnableSignature	Boolean
Algorithm	HashingAlgorithm	String
Password	SignaturePassword	String
Group ID	GroupId	String
Edge ID	EdgeId	String
Device ID	DeviceId	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	Datatype
Board Type	BoardType	String
Hostname	Hostname	String
TCP Port	Port	Integer
Socket Timeout	SocketTimeout	Integer
Connection Type	ConnectionType	String
Enable Auto-discovery	EnableAutoDiscovery	Boolean
Add All Totalflow Application Definitions	AddAllTotalflowApplicationDefinitions	Boolean
Add All Array-Register Definitions	AddAllArrayRegisterDefinitions	Boolean
Auto-generate Templates and Poll Group	AutoGenerateDefaultTemplatesAndPollGroup	Boolean
Array-Register Template Import Policy	ArrayRegisterTemplateImportPolicy	String
Poll Group Import Policy	PollGroupImportPolicy	String
Station ID	StationId	String
Keep Alive	ConnectionKeepAlive	Integer
Host Timeout	HostTimeout	Long
Number Retries	NumberRetries	Integer
Supervisory Frames	SupervisoryFrames	Integer
Password	SecurityCode	String
RBAC Enabled	RbacEnabled	Boolean
Operator ID	OperatorId	String
Password	OperatorPassword	String
Date Time Offset	DateTimeOffset	Integer
Alarm Source	AlarmSourceSelector	String
Alarm Scan Rate	AlarmScanRate	Integer
Event Scan Rate	EventScanRate	Integer
Periodic History Scan Rate	HistoryPeriodicScanRate	Integer
Daily History Scan Rate	HistoryDailyScanRate	Integer
Record Info Scan Rate	RecordInfoScanRate	Integer
Max Records To Read	MaxRecordsToRead	Integer
Periodic Mapping	PeriodicMappingId	Long
Enable Signature	EnableSignature	Boolean
Hashing Algorithm	HashingAlgorithm	String
Password	SignaturePassword	String
Group ID	GroupId	String
Edge ID	EdgeId	String
Device ID	DeviceId	String

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	Datatype
Address	Address	String
TCP/IP Port	Port	Integer
Timeout	Timeout	Long
Data Scan Rate	DataScanRate	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