Connection Items

Connection Items

Overview

Connection related OPC items have several items that are common to all types of connections and several that are unique to the connection type.

Items Common To All Connections

Item Name

Data Type 

Description

Item Name

Data Type 

Description

ClosePort

BOOL

Writing a 1 to this item will make ACM close the port after the current transaction has finished. This may take some time if the current transaction is an archive history collection.

Description

String

This item displays the string entered into the Description textbox of the object.

Serial Connection Items

Item Name

Data Type 

Description

Item Name

Data Type 

Description

COMM_SYSTEMERROR

I4

Displays the current state of the channel. Read Only.

ConnectState

I2

Displays the current state of the channel. Read Only.

CurrentUser

String

Displays the name of the device that is currently communicating on the port. Read Only.

Hangup

Bool

Writing a 1 to this item will make ACM hang up if utilizing a modem for communications.

Serial, TCP/IP and TCP/IP SSL Connection Items

Item Name

Data Type 

Description

Item Name

Data Type 

Description

COMM_SYSTEMERROR

I4

Indicates if the system is in error.

ConnectState

I2

Displays the current state of the channel. Read Only.

CurrentHost

I2

Indicates the current Host Address that is in use by the port. A value of 1 means the port is using Host Address 1 for polling. A value of 2 means the port is using Host Address 2 for polling.

CurrentUser

String

Displays the name of the device that is currently communicating on the port. Read Only.

Hangup

Bool

Writing a 1 to this item will make ACM hang up if utilizing a modem for communications.

TCP Listen Connection Items

Item Name

Data Type 

Description

Item Name

Data Type 

Description

LogState

BOOL

Logs port state information.

TCP Pool Connection Items

Item Name

Data Type

Description

Item Name

Data Type

Description

COMM_SYSTEMERROR/n

I4

This item contains the Win32 API system error code for the last error that occurred during communication to this device. n is to be replaced with the port number 1-16. Example: Comm_SystemError /1.

ConnectState/n

I2

Displays the connection status of the connection. n is to be replaced with the port number 1-16. Example: ConnectState /1.

CurrentUser/n

String

This item will hold the name of the device currently communicating on the port. n is to be replaced with the port number 1-16. Example: CurrentUser /1.

Hangup/n

Bool

Hangs up the connection. n is to be replaced with the port number 1-16. Example: Hangup /1.

ModemHealth/n

Bool

This item is True if the modem is responding to the initialization string. n is to be replaced with the port  number 1-16. Example: ModemHealth /1.

UDP BSAP Connection Items

Item Name

Data Type 

Description

Item Name

Data Type 

Description

COMM_SYSTEMERROR

I4

Indicates if the system is in error.

ConnectState

I2

Displays the current state of the channel. Read Only.

For assistance, please submit a ticket via our Support Portal, email autosol.support@autosoln.com or call 281.286.6017 to speak to a support team member.