| [6320] | 1 | .. _wlan_exp_util: |
|---|
| 2 | |
|---|
| 3 | .. include:: globals.rst |
|---|
| 4 | |
|---|
| 5 | ################## |
|---|
| 6 | WLAN Exp Utilities |
|---|
| 7 | ################## |
|---|
| 8 | |
|---|
| 9 | Common utilities for the WLAN Experiment framework. |
|---|
| 10 | |
|---|
| 11 | UART Print Levels |
|---|
| 12 | ***************** |
|---|
| 13 | |
|---|
| 14 | Defined UART print levels to control the verbosity of the wlan_exp UART output. |
|---|
| 15 | |
|---|
| 16 | .. autodata:: wlan_exp.util.uart_print_levels |
|---|
| 17 | |
|---|
| 18 | |
|---|
| 19 | Transmit / Receive Rate Definitions |
|---|
| 20 | *********************************** |
|---|
| 21 | |
|---|
| 22 | Supported transmit / receive rates for WlanExpNode |
|---|
| 23 | |
|---|
| 24 | .. autodata:: wlan_exp.util.phy_modes |
|---|
| 25 | .. autofunction:: wlan_exp.util.get_rate_info |
|---|
| 26 | .. autofunction:: wlan_exp.util.rate_info_to_str |
|---|
| 27 | |
|---|
| 28 | |
|---|
| 29 | Channel Definitions |
|---|
| 30 | ******************* |
|---|
| 31 | |
|---|
| 32 | Supported channels for WlanExpNode |
|---|
| 33 | |
|---|
| 34 | .. autodata:: wlan_exp.util.wlan_channels |
|---|
| 35 | .. autofunction:: wlan_exp.util.get_channel_info |
|---|
| 36 | .. autofunction:: wlan_exp.util.channel_info_to_str |
|---|
| 37 | |
|---|
| 38 | |
|---|
| 39 | Antenna Mode Definitions |
|---|
| 40 | ************************ |
|---|
| 41 | |
|---|
| 42 | Supported antenna modes for WlanExpNode |
|---|
| 43 | |
|---|
| 44 | .. autoattribute:: wlan_exp.util.wlan_rx_ant_modes |
|---|
| 45 | :annotation: = Dictionary of receive antenna modes |
|---|
| 46 | |
|---|
| 47 | .. autoattribute:: wlan_exp.util.wlan_tx_ant_modes |
|---|
| 48 | :annotation: = Dictionary of transmit antenna modes |
|---|
| 49 | |
|---|
| 50 | MAC Address Definitions |
|---|
| 51 | *********************** |
|---|
| 52 | |
|---|
| 53 | Pre-defined MAC address constants |
|---|
| 54 | |
|---|
| 55 | .. autoattribute:: wlan_exp.util.mac_addr_desc_map |
|---|
| 56 | :annotation: = List of tuples (MAC value, mask, description) that describe various MAC address ranges |
|---|
| 57 | |
|---|
| 58 | .. autoattribute:: wlan_exp.util.mac_addr_mcast_mask |
|---|
| 59 | :annotation: = Multicast MAC Address Mask |
|---|
| 60 | |
|---|
| 61 | .. autoattribute:: wlan_exp.util.mac_addr_local_mask |
|---|
| 62 | :annotation: = Local MAC Address Mask |
|---|
| 63 | |
|---|
| 64 | .. autoattribute:: wlan_exp.util.mac_addr_broadcast |
|---|
| 65 | :annotation: = Broadcast MAC Address |
|---|
| 66 | |
|---|
| 67 | |
|---|
| 68 | Node Utility Functions |
|---|
| 69 | ********************** |
|---|
| 70 | |
|---|
| 71 | .. autofunction:: wlan_exp.util.init_nodes |
|---|
| 72 | .. autofunction:: wlan_exp.util.broadcast_cmd_set_mac_time |
|---|
| 73 | .. autofunction:: wlan_exp.util.broadcast_cmd_write_time_to_logs |
|---|
| 74 | .. autofunction:: wlan_exp.util.broadcast_cmd_write_exp_info_to_logs |
|---|
| 75 | .. autofunction:: wlan_exp.util.filter_nodes |
|---|
| 76 | .. autofunction:: wlan_exp.util.check_bss_membership |
|---|
| 77 | |
|---|
| 78 | |
|---|
| 79 | Misc Utility Functions |
|---|
| 80 | ********************** |
|---|
| 81 | |
|---|
| 82 | .. autofunction:: wlan_exp.util.create_locally_administered_bssid |
|---|
| 83 | .. autofunction:: wlan_exp.util.int_to_ip |
|---|
| 84 | .. autofunction:: wlan_exp.util.ip_to_int |
|---|
| 85 | .. autofunction:: wlan_exp.util.mac_addr_to_str |
|---|
| 86 | .. autofunction:: wlan_exp.util.str_to_mac_addr |
|---|
| 87 | .. autofunction:: wlan_exp.util.mac_addr_to_byte_str |
|---|
| 88 | .. autofunction:: wlan_exp.util.byte_str_to_mac_addr |
|---|
| 89 | .. autofunction:: wlan_exp.util.sn_to_str |
|---|
| 90 | .. autofunction:: wlan_exp.util.node_type_to_str |
|---|
| 91 | .. autofunction:: wlan_exp.util.mac_addr_desc |
|---|
| 92 | .. autofunction:: wlan_exp.util.debug_here |
|---|
