Welcome Guest, you are in: Login

EventIDE Wiki



Search the wiki



Element Icon UDP Port
Category: Communication AddIn: Base Elements
Creator: OkazoLab Scope: Parent event
Owns Snippets: None Usage: Snippets


NameDescription                              ConstraintsTypeOn
Remote address        The network address of the remote computer in IP format: xxx.xxx.xxx.xxx                String         
Remote port        The UPD port number on the remote computer                Int32         
Local address        The network address of the local computer in IP format: xxx.xxx.xxx.xxx                String         
Local port        The UPD port number on the local computer                Int32         
No-delay Mode        Defines whether the Nagle's algorithm is disabled on the UDP port, such that it sends the output data without a buffering delay.                Boolean         
Working Mode        Defines a working mode for the element. Select 'Auto Output' mode for sending data synchronously with an onset of the parent event, 'Input Detection' mode for catching the particular pattern in port input and 'Manual Output'/'Input Listener' modes for custom writing/reading scenarios controlled via snippets.                stSeri..         
Encoding        The encoding method that is used to convert raw port bytes into text strings and vice verse. The default encoding is ByteChar which converts each byte of data to a single char.                stSeri..         
Buffer Size        Size of the input circular buffer (in bytes) that stores all incoming port data when the element works in the 'Input Listener' mode. If the buffer is small, a part of the data can be lost before it is read by the program                Int32         
Test Input        Start a dialog window that monitors arriving port input in realtime. Use for verification of the selected port settings and encoding method.                Boolean         
Input        Returns a string containing the most recent port input, when the element works in the input modes. The property value is refreshed on each Control Loop step, therefore, it should be read in the Control Loop snippet.                String         
Triggering Input        When the element works in the 'Input Detection' mode, a value of this property defines the 'catching' input string. If such string is detected an incoming input at some moment, the element registers the detection time and becomes triggered. This property is essential for time-accurate registration of the specific input, e.g a button press, coming out of a external device.                String         
Trigger Once        Defines whether the element can be triggered multiple times, while the parent event is active. If the property value is 'true', only the first triggering is registered. Triggering can occur only in the 'Triggering on specific input' working mode                Boolean         
Output Buffer        Text buffer that accumulates data meant to be sent through the port.                String         
Send Now        Runtime command sending the current output value through the port. The command is enabled, when the element works in the Manual Output mode.                Boolean         
Runtime Status
Is Triggered        Indicates whether the element has been triggered at least once, since activation of the parent event. Triggering can occur only in the 'Input Detection' working mode.                Boolean         
Triggering Time        Returns a local event time of the last triggering on the element. Triggering can occur only in the 'Triggering on specific input' working mode.                clTime         
Is Enabled        If set to false the element is completely omitted when the experiment is run                Boolean         
Title        Title of the element                String         

UDP Port Element allows bidirectional data exchange through a computer network (by the UPD protocol). The element can be used for sending digital codes that are synchronized with events in your experiment. Also, the UDP port element can be used for asynchronous data transfers to the external devices.




Snapshot 1

Snapshot 1

Snapshot 2

Snapshot 2

Practical Use


Technique 1

  1. Step 1
  2. Step 2
    === Technique 2 ===
  3. Step 1
  4. Step 2

     // Check the trial outcome. Result and RT just other user variables
    // insert code snippet here..
    == Notes ==
  5. Insert Notes here..
  6. Insert Notes here..

  Name Size
- UDP-Port-Element-Icon.png 3.31 KB
- UDPPortElement.png 32.41 KB

ScrewTurn Wiki version Some of the icons created by FamFamFam.