Page History: UDP Port Element
Compare Page Revisions
Page Revision: 2016/05/17 16:17
|
UDP Port element
|
| Info |
| Category: |
Communication |
|
AddIn: |
Base Elements |
| Creator: |
OkazoLab Team |
|
Scope: |
Parent Event |
| Owns Snippets: |
no |
|
Usage: |
Runtime Screen,Snippets |
Element actions aligned with epochs of the parent event
| Epoch | Actions |
|---|
| Initialized |
| Rendered |
| Activating |
| Activated |
| Running |
| Deactivated |
| Deinitialized |
Properties
Generic Properties
| Name | Description | Attributes | Value Type | Proxy Reflex |
|---|
| Network |
| 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 | |
+=== Properties inherited from clSerialPortElement ===
Inherited properties of clSerialPort
| Name | Description | Constraints | Value Type | Upon Runtime Change |
|---|
| Settings |
| 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. | | Struct,Int32 |
| 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. | | Struct,Int32 |
| 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 |
| Output |
| Test Output | Initiates a single output transfer through the port by sending the current content of the Output Buffer property | |
| Output Buffer | Text buffer that accumulates data meant to be sent through the port. | | String |
| Send Now | Runtime action that initiates an instant transfer of the current output value through the port. Manual runtime calls of this action are required if the element works in the Manual Output mode. | | Boolean | Assigning "true" to the linked Proxy in snippets initiates a single action call |
| 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. | |
| Input | Returns the most recent content of the circular input buffer, when the element works in the Input Listener. The property is refreshed automatically on each OnRunning cycle, therefore, a property value should be read in the Running snippet. | | String |
| Triggering Input | When the element works in the 'Input Detection' mode, the 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 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 'Input Detection' working mode | | Boolean |
| Runtime Status |
| Is Input Lost | Indicates that a part of the input has been lost due to large amount of incoming data at runtime or due to an insufficient size of the input buffer. Try to increase the buffer size or reduce a processing load when the element is active. | | Boolean |
| 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 |
| Trigger Time | Indicates the local event time of the last element triggering. Triggering can occur only in the 'Input Detection' working mode. | | UInt64 |
+=== Properties inherited from clElement ===
Inherited properties of clElement
| Name | Description | Constraints | Value Type | Upon Change |
|---|
| Control |
| 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.
Description
Short description
Snapshots
 Snapshot 1
| Snapshot 2 |
Practical Use
Technique 1
- Step 1
- Step 2
Technique 2
- Step 1
- Step 2
// Check the trial outcome. Result and RT just other user variables
// insert code snippet here..
Notes
Insert Notes here..