Class: FLNET

FLNET

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


Example
var flnet = $wat.load('flnet')[0];

Extends

Members


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> input1 :cip.UDT

Gets an object that can be used to access the input map from Area 1. Area 1 is smaller than area 2 and typically used for bit-accessible I/O mapping. Note that 'input' is server-centric. Because this plugin can be thought of as a client the 'input' (input to server) is actually an output and thus writable. Objects defined in the memory map are not accessible when using WSAPI. For WSAPI consider map instead.

Type:
Since:
  • 1.0 (WAT 1.0)

<readonly> input2 :cip.UDT

Gets an object that can be used to access the input map from Area 2. Area 2 is larger than area 1 and thus is more suitable for more complex memory maps. Note that 'input' is server-centric. Because this plugin can be thought of as a client the 'input' (input to server) is actually an output and thus writable. Objects defined in the memory map are not accessible when using WSAPI. For WSAPI consider map instead.

Type:
Since:
  • 1.0 (WAT 1.0)

<readonly> map :object

Gets an object representation of the memory map. It contains properties to access the inputs and outputs sections of the defined memory map. The memory map is also available directly from the FLNET object. The difference is that some properties and functions are not available on internal (anything with children) nodes of this property. This should be used for WSAPI applications.

Type:
  • object
Since:
  • 1.8 (WAT 2.4)
See:

<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> output1 :cip.UDT

Gets an object that can be used to access the output map from Area 1. Area 1 is smaller than area 2 and typically used for bit-accessible I/O mapping. Note that 'output' is EIP server-centric. Because this plugin can be thought of as a client the 'output' (output from server) is actually an input and thus read-only. Objects defined in the memory map are not accessible when using WSAPI. For WSAPI consider map instead.

Type:
Since:
  • 1.0 (WAT 1.0)

<readonly> output2 :cip.UDT

Gets an object that can be used to access the output map from Area 2. Area 2 is larger than area 1 and thus is more suitable for more complex memory maps. Note that 'output' is EIP server-centric. Because this plugin can be thought of as a client the 'output' (output from server) is actually an input and thus read-only. Objects defined in the memory map are not accessible when using WSAPI. For WSAPI consider map instead.

Type:
Since:
  • 1.0 (WAT 1.0)

<readonly> settings :flnet.FLSettings

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

Type:
Since:
  • 1.0 (WAT 1.0)
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:

input(index)

Gets the memory map input defined by index. Must be either 0 (Area 1) or 1 (Area 2).

Parameters:
Name Type Description
index number

the index of the input to get (0 or 1)

Since:
  • 1.0 (WAT 1.0)
Returns:
Type
cip.CIPVar

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:

output(index)

Gets the memory map output defined by index. Must be either 0 (Area 1) or 1 (Area 2).

Parameters:
Name Type Description
index number

the index of the output to get (0 or 1)

Since:
  • 1.0 (WAT 1.0)
Returns:
Type
cip.CIPVar

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:

mapChanged

Indicates that the map property has changed.

Since:
  • 1.8 (WAT 2.4)

onlineChanged

Indicates that online has changed.

Parameters:
Name Type Description
online bool

New state of online

Since:
  • 1.0 (WAT 2.4)
Inherited From: