Class: Profinet

Profinet

Provides methods and attributes for configuring Profinet and accessing the memory map.


Fires:
Example
var profinet = $wat.load('profinet')[0];

Extends

Members


<readonly> domainName :string

Gets the domain name assigned to the device. Can only be read when enabled.

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

enabled :bool

Gets/sets whether the device is enabled. The other settings (such as the memory map) must be configured prior to enabling. Changes made after enabling will not take effect until the device is disabled and then re-enabled.

Type:
  • bool
Since:
  • 1.0 (WAT 2.4)
Inherited From:
See:

<readonly> gwAddr :string

Gets the gateway address assigned to the device. Can only be read when enabled.

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

<readonly> hostName :string

Gets the host name assigned to the device. Can only be read when enabled.

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

<readonly> inputs :object

Gets an object that contains the input (and I/O) blocks defined in the memory map. Blocks appear as properties with the name given in the memory map.

Type:
  • object
Since:
  • 1.0 (WAT 2.4)

<readonly> ipActive :string

Returns true if the assigned IP address is being used by the device. Can only be read when enabled.

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

<readonly> ipAddr :string

Gets the IP address assigned to the device. Can only be read when enabled.

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

<readonly> linkUp :string

Returns true if the network link is up. Can only be read when enabled.

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

<readonly> macAddr :string

Gets the MAC address assigned to the device. Can only be read when enabled.

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

<readonly> nmAddr :string

Gets the netmask address assigned to the device. Can only be read when enabled.

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

<readonly> online :bool

Gets the online status of the device. When enabled, the device will be considered 'online' when it has been accepted into the network and is reading from and writing in a fieldbus-specific way.

Changes to online are notified using onlineChanged.

When the device goes offline, the behavior of the memory map is defined in offlineAction.

Type:
  • bool
Since:
  • 1.0 (WAT 2.4)
Inherited From:
See:

<readonly> outputs :object

Gets an object that contains the output (and I/O) blocks defined in the memory map. Blocks appear as properties with the name given in the memory map.

Type:
  • object
Since:
  • 1.0 (WAT 2.4)

<readonly> settings :profinet.PNSettings

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

Type:
Since:
  • 1.0 (WAT 2.4)
Overrides:
See:

Methods


dump()

Dumps input and output buffers to the trace log. Useful for debugging, when the trace log is being forwarded to a log server.

Since:
  • 1.0 (WAT 2.4)
Inherited From:

load()

Loads the memory map that has been set using mmap or mmapFile and creates an object tree to access the defined instances and attributes.

Since:
  • 1.0 (WAT 2.4)
Inherited From:

Events


enabledChanged

Indicates that enabled has changed. Does not indicate if the device has successfully joined a network. Use onlineChanged for that.

Parameters:
Name Type Description
enabled bool
Since:
  • 1.0 (WAT 2.4)
Inherited From:

onlineChanged

Indicates that online has changed.

Parameters:
Name Type Description
online bool

New state of online

Since:
  • 1.0 (WAT 2.4)
Inherited From: