UDP Port Element

Modified on 2018/07/16 21:59 by Administrator Categorized as Base Elements, Communications, Elements
<div style="margin-right: 10px; margin-left: 16px; margin-bottom:10px; float: right; width: 500px; overflow: hidden; height: auto; padding: 0px; background: #fafafa; background: -webkit-gradient(linear, left top, left bottom, from(#fbfbfb), to(#fafafa));background: -moz-linear-gradient(top, #fbfbfb, #fafafa);border: 1px dashed #ddd;box-shadow: 0 0 0 3px #fff, 0 0 0 5px #ddd, 0 0 0 10px #fff, 0 0 2px 10px #eee;">
== Summary ==
{s:Element Info Panel
| title=UDP Port
| category=Communication
| icon=[image|Element Icon|{UP(UDP-Port-Element)}UDP-Port-Element-Icon.png]
| author= OkazoLab
| addin= Base Elements
| scope= Parent event
| usage= Snippets
| ownsnippets= None
}
== Properties ==
{|
|-
! Name
! Description                              
! Constraints
! Type
! On<br/>runtime<br/>change
|-
| colspan="5" bgcolor="#AADDDDD" | Network
|-
| Remote address        
| The network address of the remote computer in IP format: xxx.xxx.xxx.xxx        
| {s:atDesign}        
| String        
|  
|-
| Remote port        
| The UPD port number on the remote computer        
| {s:atDesign}        
| Int32        
|  
|-
| Local address        
| The network address of the local computer in IP format: xxx.xxx.xxx.xxx        
| {s:atDesign}        
| String        
|  
|-
| Local port        
| The UPD port number on the local computer        
| {s:atDesign}        
| Int32        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Settings
|-
| 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.        
| {s:atDesign}        
| 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.        
| {s:atDesign}        
| 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.        
| {s:atNormal}        
| 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        
| {s:atDesign}        
| Int32        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Input
|-
| Test Input        
| Start a dialog window that monitors arriving port input in realtime.
Use for verification of the selected port settings and encoding method.        
| {s:atDesign}        
| 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.        
| {s:atStatus}        
| 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.        
| {s:atNormal}        
| 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        
| {s:atDesign}        
| Boolean        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Output
|-
| Output Buffer        
| Text buffer that accumulates data
meant to be sent through the port.        
| {s:atNormal}        
| 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.        
| {s:atRuntimeAction}        
| Boolean        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | 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.        
| {s:atNormal}        
| 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.        
| {s:atStatus}        
| clTime        
|  
|-
| colspan="5" bgcolor="#AADDDDD" | Control
|-
| Is Enabled        
| If set to false the element is completely omitted when the experiment is run        
| {s:atDesign}        
| Boolean        
|  
|-
| Title        
| Title of the element        
| {s:atDesign}        
| String        
|  
|-            
|}
== ==
</div>
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
<!--*****************************************************************************************************************************************************************************-->
'''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.{br}{br}

{TOC}
== Description ==
...
== Snapshots ==
{|
| [imageleft|Snapshot 1 <br/>|{UP(page - name)}*-sm.png |{UP(page - name)}*.png]
|| [imageleft|Snapshot 2 |{UP(page - name)}*-sm.png |{UP(page - name)}*.png]
|}
== Practical Use ==
...
=== Technique 1 ===
# Step 1
# Step 2
...
=== Technique 2 ===
# Step 1
# Step 2
...
<div style="margin-left:0px; margin-right:10px; margin-top:10px; width: auto; overflow: hidden; height: auto; background: #fafafa; background: -webkit-gradient(linear, left top, left bottom, from(#fbfbfb), to(#fafafa));background: -moz-linear-gradient(top, #fbfbfb, #fafafa);border: 1px dashed #ddd;box-shadow: 0 0 0 3px #fff, 0 0 0 5px #ddd, 0 0 0 10px #fff, 0 0 2px 10px #eee;">
@@ csharp // Check the trial outcome. Result and RT just other user variables
// insert code snippet here..
@@</div>           
...
== Notes ==
...
* Insert Notes here..
* Insert Notes here..
Meta Keywords:
Meta Description:
Change Comment:
EventIDE Wiki

Navigation¶

UDP Port Element
