Class: PCCCClient

PCCCClient

Provides methods and properties for managing an EtherNet/IP connection using PCCC.

Members


enabled :bool

Gets/sets whether PCCC is enabled.

Type:
  • bool
Since:
  • 1.0 (WAT 2.2)
See:

host :string

The name or IP address to connected to during open. When this value is not an IP address, it will attempt to be resolved to an IP address using DNS.

Type:
  • string
Since:
  • 1.0 (WAT 2.2)

<readonly> pccc :eipc.PCCCMap

Gets an object that contains the PCCC memory map. Until load is called successfully, this object will have no properties.

Type:
  • eipc.PCCCMap
Since:
  • 1.0 (WAT 2.2)

port :number

The EtherNet/IP port (not TCP port) to connect to during open. Typically corresponds to the slot number when communicating with a PLC.

Type:
  • number
Since:
  • 1.0 (WAT 2.2)

<readonly> settings :eipc.PCCCSettings

Gets an object that can be used to read and write the PCCC settings. The values in this object must be configured prior to connecting.

Type:
Since:
  • 1.0 (WAT 2.2)
See:

Methods


close()

Stops EtherNet/IP communications.

Since:
  • 1.0 (WAT 2.2)

load()

Attempts to load the memory map specified in the settings. If successful, the resulting memory map will be available in pccc.

Since:
  • 1.0 (WAT 2.2)
Returns:

True if the memory map was successfully parsed.

Type
bool

open()

Attempts to establish communications with the server/port specified in host/port.

Since:
  • 1.0 (WAT 2.2)
Returns:

True if the communication attempt successfully started (does not indicate if communications have been successfully established).

Type
bool

Events


closed

Indicates that PCCC communications have been terminated. connectedChanged may also be used.

Since:
  • 1.0 (WAT 2.2)

connectedChanged

Indicates the connection state of the PCCC connection has changed.

Parameters:
Name Type Description
connectionState bool
Since:
  • 1.0 (WAT 2.2)

error

Emitted whenever a communications error is encountered.

Parameters:
Name Type Description
errorDescription string
Since:
  • 1.0 (WAT 2.2)

opened

Indicates that PCCC communications have been successfully established. connectedChanged may also be used.

This event can be used to show the status of the PCCC connection.

Since:
  • 1.0 (WAT 2.2)