Changes between Initial Version and Version 1 of WARPLab/Reference/Transport/UDP


Ignore:
Timestamp:
May 15, 2013, 5:30:42 PM (11 years ago)
Author:
chunter
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WARPLab/Reference/Transport/UDP

    v1 v1  
     1[[TracNav(WARPLab/TOC)]]
     2
     3= UDP Transport Module Implementations =
     4
     5The WARPLab Reference Design implements a [wiki:../../../Framework/Modules#Transport Transport] module that handles communication between WARP boards with UDP Ethernet traffic.
     6
     7'''Related Components:'''
     8 * MATLAB:
     9  * [source:ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_transport_eth_udp_java.m wl_transport_eth_udp_java] class
     10  * [source:ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_transport_eth_udp_pnet.m wl_transport_eth_udp_pnet] class
     11 * WARP Hardware:
     12  * [source:ResearchApps/PHY/WARPLAB/WARPLab7/C_Code_Reference/wl_transport.c wl_transport] C software
     13
     14
     15= Transport Commands Technical Reference =
     16
     17Transport commands are selected as string inputs to the {{{wl_transportCmd}}} method in [browser:ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_node.m wl_node.m]. These strings are each individual cases of the switch statement in {{{procCmd}}} method of [browser:ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_transport_eth_udp_java.m wl_transport_eth_udp_java.m] or [browser:ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_transport_eth_udp_java.m wl_transport_eth_udp_pnet.m].
     18
     19== Syntax ==
     20MATLAB allows two valid forms of syntax for calling methods
     21
     22 * Let {{{N}}} be a scalar or vector of {{{wl_node}}} objects
     23 * Let {{{command_string}}} be a string containing a particular command
     24 * Let {{{arg}}} be an argument for that command (optional)
     25
     26Syntax 1: {{{wl_transportCmd(N, command_string, arg1, arg2, ..., argN)}}}
     27
     28Syntax 2: {{{N.wl_transportCmd(command_string, arg1, arg2, ..., argN)}}}
     29
     30These two different forms of syntax are identical and either may be used for issuing commands to WARP nodes.
     31
     32
     33== Command List and Documentation ==
     34=== {{{ping}}} ===
     35Test to make sure node can be accessed via this[[BR]]
     36transport[[BR]]
     37
     38
     39'''Arguments:''' none
     40
     41'''Returns:''' true if board responds; raises error otherwise
     42
     43
     44=== {{{payload_size_test}}} ===
     45Determine's objects maxPayload parameter[[BR]]
     46
     47
     48'''Arguments:''' none
     49
     50'''Returns:''' none