| 1 | [[TracNav(WARPLab/TOC)]] |
| 2 | |
| 3 | = Node Module Implementation = |
| 4 | |
| 5 | The WARPLab Reference Design implements a [wiki:../../Framework/Modules#Node Node] module for brokering commands and responses to other modules in a WARP node. |
| 6 | |
| 7 | = Command List = |
| 8 | |
| 9 | 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]. |
| 10 | |
| 11 | == Syntax == |
| 12 | MATLAB allows two valid forms of syntax for calling methods |
| 13 | |
| 14 | * Let {{{N}}} be a scalar or vector of {{{wl_node}}} objects |
| 15 | * Let {{{command_string}}} be a string containing a particular command |
| 16 | * Let {{{arg}}} be an argument for that command (optional) |
| 17 | |
| 18 | Syntax 1: {{{wl_nodeCmd(N, command_string, arg1, arg2, ..., argN)}}} |
| 19 | |
| 20 | Syntax 2: {{{N.wl_nodeCmd(command_string, arg1, arg2, ..., argN)}}} |
| 21 | |
| 22 | These two different forms of syntax are identical and either may be used for issuing commands to WARP nodes. |
| 23 | |
| 24 | |
| 25 | == Command List and Documentation == |
| 26 | === {{{get_hardware_info}}} === |
| 27 | Reads details from the WARP hardware and updates node object parameters[[BR]] |
| 28 | |
| 29 | |
| 30 | '''Arguments:''' none |
| 31 | |
| 32 | '''Returns:''' none (access updated node parameters if needed) |
| 33 | |
| 34 | Hardware support:[[BR]] |
| 35 | All:[[BR]] |
| 36 | WARPLab design version[[BR]] |
| 37 | Hardware version[[BR]] |
| 38 | Ethernet MAC Address[[BR]] |
| 39 | Number of Interface Groups[[BR]] |
| 40 | Number of Interfaces[[BR]] |
| 41 | |
| 42 | WARP v3:[[BR]] |
| 43 | Serial number[[BR]] |
| 44 | Virtex-6 FPGA DNA[[BR]] |
| 45 | |
| 46 | === {{{get_fpga_temperature}}} === |
| 47 | Reads the temperature (in Celsius) from the FPGA[[BR]] |
| 48 | |
| 49 | |
| 50 | '''Arguments:''' none |
| 51 | |
| 52 | '''Returns:''' (double currTemp), (double minTemp), (double maxTemp) |
| 53 | |
| 54 | currTemp - current temperature of FPGA in degrees Celsius[[BR]] |
| 55 | minTemp - minimum recorded temperature of FPGA in degrees Celsius[[BR]] |
| 56 | maxTemp - maximum recorded temperature temperature of FPGA in degrees Celsius[[BR]] |
| 57 | |
| 58 | === {{{initialize}}} === |
| 59 | Initializes the node; this must be called at least once per power cycle of the node[[BR]] |
| 60 | |
| 61 | |
| 62 | '''Arguments:''' none |
| 63 | |
| 64 | '''Returns:''' none |
| 65 | |
| 66 | |
| 67 | === {{{identify}}} === |
| 68 | Blinks the user LEDs on the WARP node, to help identify MATLAB node-to-hardware node mapping[[BR]] |
| 69 | |
| 70 | |
| 71 | '''Arguments:''' none |
| 72 | |
| 73 | '''Returns:''' none |