Class: FLNET

FLNET

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


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

Members


enabled :bool

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

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

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.

Type:
Since:
  • 1.0 (WAT 1.0)

<readonly> online :bool

Gets the online status for FLNet. When enabled, FLNet will be considered 'online' when it has been accepted into the FLNet network and is reading from and writing to the common memory map.

Changed to online are notified using flnet.FLNET#event:onlineChanged.

When FLNet goes offline, the behavior of the memory map is defined in flnet.FLSettings#offlineAction.

Type:
  • bool

<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.

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.

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)
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 1.0)

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 flnet.FLSettings#mmap or flnet.FLSettings#mmapFile and creates an object tree to access the defined instances and attributes.

Since:
  • 1.0 (WAT 1.0)

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

update()

Forces a re-read of the memory map and update the attributes. If the value of any attribute changes as a result, the valueChanged signal for that attribute will be emitted.

It is not necessary for the application to call this method, as it will be called automatically when the memory map has changed.

Since:
  • 1.0 (WAT 1.0)

Events


onlineChanged

Indicates that online has changed.

Parameters:
Name Type Description
online bool

New state of online

Since:
  • 1.2 (WAT 1.3)