[[TracNav(WARPLab/TOC)]]

= Node Commands Technical Reference =

Node commands are selected as string inputs to the {{{wl_nodeCmd}}} 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_node.m wl_node.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_nodeCmd(N, command_string, arg1, arg2, ..., argN)}}}

Syntax 2: {{{N.wl_nodeCmd(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 == 
=== {{{get_hardware_info}}} ===
Reads details from the WARP hardware and updates node object parameters[[BR]]


'''Arguments:''' none

'''Returns:''' none (access updated node parameters if needed)

Hardware support:[[BR]]
All:[[BR]]
WARPLab design version[[BR]]
Hardware version[[BR]]
Ethernet MAC Address[[BR]]
Number of Interface Groups[[BR]]
Number of Interfaces[[BR]]

WARP v3:[[BR]]
Serial number[[BR]]
Virtex-6 FPGA DNA[[BR]]

=== {{{get_fpga_temperature}}} ===
Reads the temperature (in Celsius) from the FPGA[[BR]]


'''Arguments:''' none

'''Returns:''' (double currTemp), (double minTemp), (double maxTemp)

currTemp - current temperature of FPGA in degrees Celsius[[BR]]
minTemp - minimum recorded temperature of FPGA in degrees Celsius[[BR]]
maxTemp - maximum recorded temperature temperature of FPGA in degrees Celsius[[BR]]

=== {{{initialize}}} ===
Initializes the node; this must be called at least once per power cycle of the node[[BR]]


'''Arguments:''' none

'''Returns:''' none


=== {{{identify}}} ===
Blinks the user LEDs on the WARP node, to help identify MATLAB node-to-hardware node mapping[[BR]]


'''Arguments:''' none

'''Returns:''' none