Projects STRLCPY CatSniffer Commits d6a48323
🤬
Revision indexing in progress... (symbol navigation in revisions will be accurate after indexed)
  • ■ ■ ■ ■ ■ ■
    firmware/pycatsniffer/README.md
    skipped 23 lines
    24 24  ==========
    25 25  Run pycatsniffer
    26 26  ----------------
    27  -**pycatsniffer**'s main role it to read packets captured from the CatSniffer board and pipe the packets in PCAP format to a named pipe (by default "/tmp/ccsniffpiper").
     27 +**pycatsniffer**'s main role it to read packets captured from the CatSniffer board and pipe the packets in PCAP format to a named pipe (by default `/tmp/ccsniffpiper`).
    28 28   
    29 29  Default mode starts with Bluetooth Low Energy configuration.
    30  -For BLE, the advertising channel (37, 38 or 39) must be selected, the deafult is 37.
     30 +For BLE, the advertising channel (`37`, `38` or `39`) must be selected, the deafult is `37`.
    31 31   
    32  -The capture device can be configured to follow a data connection between a specific Bluetooth Low Energy Master (Initiator) and Slave device. Type `a` in the options menu and write the address of the Initiator (Master) device. If this option is not setted, the capture device will start to follow the first data connection that appears on the selected advertising channel.
     32 +The capture device can be configured to follow a data connection between a specific Bluetooth Low Energy Master (Initiator) and Slave device. Type `-a` in the options menu and write the address of the Initiator (Master) device next. If this option is not setted, the capture device will start to follow the first data connection that appears on the selected advertising channel.
    33 33   
    34 34  To get this default behaviour, just run the command:
    35 35  `python pycatsniffer.py`
    skipped 1 lines
    37 37  The following options will be available
    38 38   
    39 39  Commands:
    40  -c: Print current RF Channel
    41  -n: Trigger new pcap header before the next frame
    42  -h,?: Print this message
    43  -[37,39]: Change RF channel
    44  -s: Start/stop the packet capture
    45  -q: Quit
     40 + * `c: Print current RF Channel`
     41 + * `n: Trigger new pcap header before the next frame`
     42 + * `h,?: Print this message`
     43 + * `[37,39]: Change RF channel`
     44 + * `s: Start/stop the packet capture`
     45 + * `q: Quit`
    46 46   
    47 47  In this mode the output of captured packets will only be displayed on the terminal.
    48 48   
    49  -You can start packet capture by pressing the s key followed by the Enter key.
    50  -To stop, press the s key again followed by the Enter key again.
     49 +You can start packet capture by pressing the `s` key followed by the `Enter` key.
     50 +To stop, press the `s` key again followed by the `Enter` key again.
    51 51   
    52 52  To run in normal mode and pipe using `/tmp/ccsniffpiper` type `sudo python pycatsniffer.py -f /tmp/ccsniffpiper` in the terminal
    53 53   
    54  -Start the packet capture by pressing the s key and then the Enter key in the terminal where pycatsniffer is running.
     54 +Start the packet capture by pressing the `s` key and then the `Enter` key in the terminal where pycatsniffer is running.
    55 55  In headless mode use `sudo python pycatsniffer.py -d -f /tmp/ccsniffpiper`
    56 56   
    57 57  To see further information, run the help command:
    skipped 5 lines
    63 63   
    64 64  To setup Wireshark correctly, perform the following steps:
    65 65   
    66  -*Start Wireshark using sudo wireshark (linux)
    67  -*Add new pipe interface: Capture -> Options -> Manage Interfaces -> Pipes-> click on + to add new pipe -> type `/tmp/ccsniffpiper` and apply.
     66 +* Start Wireshark using sudo wireshark (linux)
     67 +* Add new pipe interface: Capture -> Options -> Manage Interfaces -> Pipes-> click on + to add new pipe -> type `/tmp/ccsniffpiper` and apply.
    68 68  Note - The capture interface will not be saved.
    69  -*Click the start button to start a capture.
     69 +* Click the start button to start a capture.
    70 70  * The pipe will then appear as an interface.
    71 71   
    72 72  General packet format
    73 73  ======================================
    74  -This is just * **[documentation](https://software-dl.ti.com/lprf/packet_sniffer_2/docs/user_guide/html/sniffer_fw/firmware/command_interface.html)** of the packet format from the TI firmware on CatSniffer.
     74 +This is just **[documentation](https://software-dl.ti.com/lprf/packet_sniffer_2/docs/user_guide/html/sniffer_fw/firmware/command_interface.html)** of the packet format from the TI firmware on CatSniffer.
    75 75   
    76 76  The UART packet format is shown in the table below.
    77 77   
    skipped 15 lines
Please wait...
Page is in error, reload to recover