1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-24 05:53:49 +01:00

Merge pull request https://github.com/RIOT-OS/applications/pull/69 from kb2ma/sniffer/2019.10_update

sniffer: README updates
This commit is contained in:
Martine Lenders 2020-01-13 13:20:37 +01:00 committed by chrysn
commit ad5c7c9a4a
2 changed files with 22 additions and 4 deletions

View File

@ -1,12 +1,22 @@
About
=====
This application is build to run together with the script `./tools/sniffer.py` as sniffer for (wireless) data traffic. This application works with any board with any network device that supports the gnrc network stack (or precisely the gnrc parts up to the link-layer). Further the network device (and it's driver) needs to support promiscuous and raw mode for usable output. Finally the board needs to include auto-initialization code for the targeted network device.
This application is built to run together with the script `./tools/sniffer.py`
as a sniffer for (wireless) data traffic. This application works with any board
with any network device that supports the gnrc network stack (or precisely the
gnrc parts up to the link-layer). Further the network device (and its driver)
needs to support promiscuous and raw mode for usable output. Finally the board
needs to include auto-initialization code for the targeted network device.
Usage
=====
Compile and flash this application to the board of your choice. You can check if everything on the RIOT side works by connecting to the board via UART and by checking with `ifconfig` if a network device is available. Further you can check with `ifconfig 4 promisc` if promiscuous mode is supported and with `ifconfig 4 raw` if raw mode is supported by the driver/network device.
Compile and flash this application to the board of your choice. You can check
if everything on the RIOT side works by connecting to the board via UART and by
checking with `ifconfig` if a network device is available. Also note the
interface number for the following commands. Then you can check with
`ifconfig <iface> promisc` if promiscuous mode is supported and with
`ifconfig <iface> raw` if raw mode is supported by the driver/network device.
For further information on setting up the host part, see `RIOTBASE/dist/tools/sniffer/README.md`.
For further information on setting up the host part, see `./tools/README.md`.

View File

@ -40,7 +40,7 @@ General usage:
```
$ git clone https://github.com/RIOT-OS/applications/
$ cd applications/sniffer
$ RIOTBASE=<path/to/RIOT> BOARD=<name> make clean all flash
$ BOARD=<name> make clean all flash
```
2. Run the `sniffer.py` script (change to subfolder `tools/`) as follows :
@ -53,6 +53,14 @@ For network socket:
$ ./sniffer.py <host>:<port> <channel> [outfile]
```
You should see output like below:
```
ifconfig 3 set chan 26
ifconfig 3 raw
ifconfig 3 promisc
RX: 0
```
For detailed information on the parameters use the scripts on-line help:
```