WriteEIPBuffer

Writes data from a referenced Buffer structure, created by the FormatOutputBuffer function, to remote client devices using the EtherNet/IP protocol. EtherNet/IP is an application-level protocol implemented on top of Ethernet and TCP/IP protocols, allowing the transfer of data in industrial environments over the Ethernet. For more information on the EtherNet/IP protocol, go to odva.org. The data is sent to the client within one Request Packet Interval (RPI). The RPI frequency is set by the client device. For more information, see FormatOutputBuffer.

Note:
  • For In-Sight vision systems running In-Sight 5.1.0 and later firmware, when a job containing this function is loaded, it will automatically be replaced by the WriteResultsBuffer function (the Protocol parameter will be set to Default). For more information, see WriteResultsBuffer.
  • This function is only available on In-Sight vision systems running In-Sight firmware 4.x.x, and is not available on In-Sight vision systems running In-Sight firmware 5.1.0 and later. For a complete list of models and supported firmware versions, see Firmware Versions.
  • Although an In-Sight vision system can communicate with more than one device at the same time using EtherNet/IP protocol, there can only be one bi-directional implicit connection.
  • An In-Sight vision system can act as a server only; it will not initiate a connection to another device. The Assembly data configuration must be specified on client device. For more information, see In-Sight Assembly Data Configuration (Implicit Messaging).
  • Only one WriteEIPBuffer function should be placed in the spreadsheet. Multiple WriteEIPBuffer functions may overwrite data waiting to be sent in the flash memory buffers.
  • RPI frequencies of less than 10ms may impact the performance of some vision tools.
  • In-Sight vision systems support both Explicit and Implicit EtherNet/IP messaging. ClosedSee Example.

    ReadEIP($A$0, "0d:4d:8s") in cell A4, reads 2 32 bit integers and a null terminated string from the PLC.

    GetBufferData($A$4, 0) displays the first 32 bit integer.

    GetBufferData($A$4, 1) displays the second 32 bit integer.

    GetBufferData($A$4, 2) displays the string.

  • Jobs containing this function that are saved in In-Sight Explorer 3.3.0 or higher are only compatible with In-Sight Explorer 3.3.0 and higher.
  • For more information, see Communicate with a Rockwell SLC 5/05 PLC.

WriteEIPBuffer Inputs

Syntax: WriteEIPBuffer(Event,Buffer)

Parameter Description

Event

 Specifies the event that forces an update.This parameter must be a reference to one of the following:
  • The Image data structure in cell A0, containing the AcquireImage function. For more information, see AcquireImage.
  • A cell containing an Event function. For more information, see Event.
  • A cell containing a Button function. For more information, see Button.

Buffer

Specifies a reference to a Buffer structure created by a FormatOutputBuffer function, which contains automatically formatted data.

Note: The maximum length for output data is 4,000 bytes.

WriteEIPBuffer Outputs

Returns

The number of elements written or #ERR if an input parameter is invalid, or if a connection to a client has not been established.