• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Command Line Interface for Netsim (netsim)
2
3Usage:
4* `netsim [Options] <COMMAND>`
5
6Options:
7* `-h, --help`:    Print help information
8* `-v, --verbose`: Set verbose mode
9
10## Commands:
11* ### `version`:    Print Netsim version information
12    * Usage: `netsim version`
13* ### `radio`:      Control the radio state of a device
14    * Usage: `netsim radio <RADIO_TYPE> <STATUS> <NAME>`
15    * Arguments:
16        * \<RADIO_TYPE\>:   Radio type [possible values: ble, classic, wifi, uwb]
17        * \<STATUS\>:       Radio status [possible values: up, down]
18        * \<NAME\>:         Device name
19* ### `move`:       Set the device location
20    * Usage: `netsim move <NAME> <X> <Y> [Z]`
21    * Arguments:
22        * \<NAME\>:         Device name
23        * \<X\>:            x position of device
24        * \<Y\>:            y position of device
25        * [Z]:              Optional z position of device
26* ### `devices`:    Display device(s) information
27    * Usage: `netsim devices [OPTIONS]`
28    * Options:
29        * `-c, --continuous`:    Continuously print device(s) information every second
30* ### `reset`:      Reset Netsim device scene
31    * Usage: `netsim reset`
32* ### `pcap`:       Control the packet capture functionalities with commands: list, patch, get
33    * Usage: `netsim pcap <COMMAND>`
34    * #### Commands
35        * `list`:   List currently available Pcaps (packet captures)
36            * Usage: `netsim pcap list [PATTERNS]...`
37            * Arguments:
38                * [PATTERNS]...:  Optional strings of pattern for pcaps to list. Possible filter fields
39                                    include Pcap ID, Device Name, and Chip Kind
40        * `patch`:  Patch a Pcap source to turn packet capture on/off
41            * Usage: `netsim pcap patch <STATE> [PATTERNS]...`
42            * Arguments:
43                * \<STATE\>:        Packet capture state [possible values: on, off]
44                * [PATTERNS]...:  Optional strings of pattern for pcaps to patch. Possible filter fields
45                                    include Pcap ID, Device Name, and Chip Kind
46        * `get`:    Download the packet capture content
47            * Usage: `netsim pcap get [OPTIONS] [PATTERNS]...`
48            * Arguments:
49                * [PATTERNS]...:  Optional strings of pattern for pcaps to get. Possible filter fields
50                                    include Pcap ID, Device Name, and Chip Kind
51            * Options:
52                * `-o, --location`: Directory to store downloaded pcap(s)
53* ### `help`:       Print this message or the help of the given subcommand(s)
54