[[TracNav(WARPLab/TOC)]] = UDP Transport Module Implementations = The WARPLab Reference Design implements a [wiki:../../../Framework/Modules#Transport Transport] module that handles communication between WARP boards with UDP Ethernet traffic. '''Related Components:''' * MATLAB: * [source:ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_transport_eth_udp_java.m wl_transport_eth_udp_java] class * [source:ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_transport_eth_udp_mex.m wl_transport_eth_udp_mex] class * WARP Hardware: * [source:ResearchApps/PHY/WARPLAB/WARPLab7/C_Code_Reference/wl_transport.c wl_transport] C software = Transport Commands Technical Reference = Transport 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], [browser:ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_transport_eth_udp_mex.m wl_transport_eth_udp_mex.m] or [browser:ResearchApps/PHY/WARPLAB/WARPLab7/M_Code_Reference/classes/wl_transport_eth_udp_pnet.m wl_transport_eth_udp_pnet.m]. == Syntax == MATLAB allows two valid forms of syntax for calling methods * Let {{{N}}} be a scalar or vector of {{{wl_node}}} objects * Let {{{command_string}}} be a string containing a particular command * Let {{{arg}}} be an argument for that command (optional) Syntax 1: {{{wl_transportCmd(N, command_string, arg1, arg2, ..., argN)}}} Syntax 2: {{{N.wl_transportCmd(command_string, arg1, arg2, ..., argN)}}} These two different forms of syntax are identical and either may be used for issuing commands to WARP nodes. == Command List and Documentation == === {{{ping}}} === Test to make sure node can be accessed via this transport[[BR]] '''Arguments:''' none '''Returns:''' true if board responds; raises error otherwise === {{{payload_size_test}}} === Determine objects maxPayload parameter[[BR]] '''Arguments:''' none '''Returns:''' none === {{{add_node_group_id}}} === Adds a Node Group ID to the node so that it can process broadcast commands that are received from that node group.[[BR]] '''Arguments:''' (uint32 NODE_GRP_ID) '''Returns:''' none NODE_GRP_ID: ID provided by wl_node_grp[[BR]] === {{{clear_node_group_id}}} === Clears a Node Group ID from the node so it can ignore broadcast commands that are received from that node group.[[BR]] '''Arguments:''' (uint32 NODE_GRP_ID) '''Returns:''' none NODE_GRP_ID: ID provided by wl_node_grp[[BR]]