HTTP Protocol Interface

Open Sniffer can be configured click by click through a web interface and data are typically visualized in Wireshark, but in many applications it might be useful to configure, capture and analyse the data programmatically.

Sniffer Status and State

GET Sniffer Status

Send HTTP GET request in following format: http://SNIFFER_IP/index.shtml

Sniffer should answer HTTP 200 OK. Within HTML page following line of code is interesting:


var values = removeSSItag('< !--#pindex-->STOPPED,00:1a:b6:00:0a:a6,10.10.10.2,15,3,0,0,0,0')
.split(",");

Highlighted parameters are displayed on the sniffer’s homepage. They are splitted with comma separator so their extraction is straightforward.

Param Value Format
State RUNNING/STOPPED/CT MODE ACTIVE String
Sniffer MAC address XX:XX:XX:XX:XX:XX Hex Notation
Sniffer IP address XXX.XXX.XXX.XXX Decimal Notation
Channel Number XX Decimal Notation
Sensitivity (High/Medium/Low/Lowest) 3/2/1/0 Decimal Notation
DHCP Active (On/Off) 1/0 Decimal Notation
CRC Filter (On/Off) 1/0 Decimal Notation
Packet through  0-4294967296 Decimal Notation
Packet dropped  0-4294967296 Decimal Notation

SET Sniffer State

Send HTTP GET request in following format: http://SNIFFER_IP/status.cgi?p=1

It works in toggle way, between RUNNING and STOPPED state.
Sniffer should answer HTTP 200 OK. HTML contains http://SNIFFER_IP/index.shtml.

Open Sniffer Settings

GET Sniffer Settings

Send HTTP GET request in following format: http://SNIFFER_IP/sett.shtml

Sniffer should answer HTTP 200 OK. Within HTML page following line of code is interesting:

var values = removeSSItag('< !--#pindex-->STOPPED,15,0,3,0,0,10.10.10.3,255.255.255.0,10.10.10.10,10.10.10.1,17754').split(",");

Param Value Format
State RUNNING/STOPPED/CT MODE ACTIVE String
Channel see channel list below Decimal Notation
Modulation see channel list below Hex Notation
Sensitivity (High/Medium/Low/Lowest) 3/2/1/0 Decimal Notation
CRC Filter (On/Off) 1/0 Decimal Notation
DHCP (On/Off) 1/0 Decimal Notation
Sniffer’s IP address xxx.xxx.xxx.xxx Decimal Notation
Sniffer’s Netmask xxx.xxx.xxx.xxx Decimal Notation
Gateway xxx.xxx.xxx.xxx Decimal Notation
Host IP address xxx.xxx.xxx.xxx Decimal Notation
Host UDP port 0-65535 Decimal Notation

SET Sniffer Radio Settings

Send HTTP GET request in following format (all parameters are required):

http://SNIFFER_IP/settings.cgi?chn=15&modul=0&rxsens=0&crcfilter=0

Param Value Format
chn see channel list below Decimal Notation
modul see channel list below Hex Notation
rxsens (Highest/High/Low/Lowest) 3/2/1/0 Decimal Notation
crcfilter (On/Off) 1/0 Decimal Notation

1) In case of Success
Sniffer should answer HTTP 200 OK. Html page contains http://SNIFFER_IP/sett.shtml .

2) In case of Error
Sniffer should answer HTTP 200 OK. Html page contains: “Wrong parameters!” string.

SET Sniffer Network (IPv4) Settings

Send HTTP GET request in following format (all parameters are required):

http://SNIFFER_IP/ipset.cgi?ipmode=0&ipaddr=10.10.10.2&nmask=255.255.255.0&gw=10.10.10.10
WARNING: Following parameters are stored in nonvolatile FLASH memory. Number of write cycles is limited, typically around 10 000 cycles

Param Value Format
ipmode (static/dynamic) 0/1 Decimal Notation
ipaddr xxx.xxx.xxx.xxx Decimal Notation
nmask xxx.xxx.xxx.xxx Decimal Notation
gw xxx.xxx.xxx.xxx Decimal Notation

1) In case of Success
Sniffer should answer HTTP 200 OK. Html page contains http://SNIFFER_IP/sett.shtml .

2) In case of Error
Sniffer should answer HTTP 200 OK. Html page contains: “Wrong parameters!” string.

SET Host Settings

Send HTTP GET request in following format (all parameters are required):

http://SNIFFER_IP/remoteipset.cgi?remoteip=10.10.10.1&remoteport=17754
WARNING: Following parameters are stored in nonvolatile FLASH memory. Number of write cycles is limited, typically around 10 000 cycles

Param Value Format
remoteip xxx.xxx.xxx.xxx Decimal Notation
remoteport 0-65535 Decimal Notation

1) In case of Success
Sniffer should answer HTTP 200 OK. Html page contains http://SNIFFER_IP/sett.shtml .

2) In case of Error
Sniffer should answer HTTP 200 OK. Html page contains: “Wrong parameters!” string.

Sniffer Energy Scanner

GET Energy Scan

Send HTTP GET request in following format:

http://SNIFFER_IP/escan.shtml

Sniffer should answer HTTP 200 OK. Within HTML page following line of code is interesting:

var values = removeSSItag('< !--#pindex-->STOPPED,-91,-91,-92,-91,-91,-91,...,-91,-91').split(",");

The numbers above represent captured scan over the all 31 channels during the 2s period. They are in [dbm] unit and ordered as follows: 780MHz channels 0-3, 868MHz channel 0, 915MHz channels 1-10, 2.4GHz channels 11-26.

Continuous Transmission Mode

GET Continuous Transmission Status

Send HTTP GET request in following format: http://SNIFFER_IP/test.shtml

Sniffer should answer HTTP 200 OK. Within HTML page following line of code is interesting:


var values = removeSSItag('< !--#ptest-->STOPPED,15,0,1,0,1').split(",");

Param Value Format
State STOPPED/RUNNING/CT MODE ACTIVE String
Channel see available channel/modulation table below Decimal Notation
Mode see ct modes table below Hex Notation
Modulation see available channel/modulation table below Hex Notation
Tx Power see tx power table below Hex Notation

SET Continuous Transmission

Send HTTP GET request in following format: http://SNIFFER_IP/test.cgi?chn=15&mode=1&modul=0&txlevel=0

Where parameters are:

Param Value Format
Channel see available channel/modulation table below Decimal Notation
Mode see ct modes table below Hex Notation
Modulation see available channel/modulation table below Hex Notation
Tx Power see tx power table below Hex Notation

1) In case of Success
Sniffer should answer HTTP 200 OK. Html page contains http://SNIFFER_IP/test.shtml .

2) In case of Error
Sniffer should answer HTTP 200 OK. Html page contains: “Wrong parameters!” string.

This mode is available from firmware v0.6.

Injection Mode

GET Injection Status

Send HTTP GET request in following format: http://SNIFFER_IP/inject.shtml

Sniffer should answer HTTP 200 OK. Within HTML page following line of code is interesting:


var values = removeSSItag('< !--#pinject-->STOPPED,1,15,0,0,0,1,1,0').split(",");

Param Value Format
State STOPPED/RUNNING/CT MODE ACTIVE/INJECTING/NETWORK SCANNING String
RF212 version 1/3 Decimal Notation
Channel see available channel/modulation table below Decimal Notation
Modulation see available channel/modulation table below Hex Notation
Tx Power see tx power table below Hex Notation
Rx Enable 0/1 Decimal Notation
Repeat number 1-4294967295 Decimal Notation
Time space 1 – 80000 (miliseconds) Decimal Notation
Estaminate time number in miliseconds of injecting, 0 = no injecting Decimal Notation


var ssipayload = removeSSItag('< !--#ppayload-->010203').split(",");

Param Value Format
Payload Chain of bytes, one byte is Two hexadecimal numbers Hex Notation

Example: 010203 represents 3 bytes: 0x01, 0x02, 0x03 (0x01 is sending as a first byte).

SET Injection mode

Send HTTP GET request in following format: http://SNIFFER_IP/ inject.cgi?chn=15&modul=0&txlevel=0&rxen=0&nrepeat=1&tspace=1&spayload=010203&len=3

Where parameters are:

Param Value Format
Channel see available channel/modulation table below Decimal Notation
Modulation see available channel/modulation table below Hex Notation
Tx Power see tx power table below Hex Notation
Rx Enable 0/1 Decimal Notation
Repeat number 1- 4294967295 Decimal Notation
Time space 1 – 80000 (miliseconds) Decimal Notation
Payload Chain of bytes. One byte is Two hexadecimal numbers Hex Notation
Length 1-125 Decimal Notation

1) In case of Success
Sniffer should answer HTTP 200 OK. Html page contains http://SNIFFER_IP/inject.shtml .

2) In case of Error
Sniffer should answer HTTP 200 OK. Html page contains: “Wrong parameters!” string.

This mode is available from firmware v0.6.

Network Scan Mode

GET Network Scan Status

Send HTTP GET request in following format: http://SNIFFER_IP/netscan.shtml

Sniffer should answer HTTP 200 OK. Within HTML page following line of code is interesting:

var values = removeSSItag('< !--#pnetscan-->STOPPED,0,2,0,0,0,0,0').split(",");

Param Value Format
State STOPPED/RUNNING/CT MODE ACTIVE/INJECTING/NETWORK SCANNING String
Remaining time number in miliseconds Decimal Notation
Scan time 0-80 (seconds) Decimal Notation
Scan on 780 Band 0/1 Decimal Notation
Scan on 868 Band 0/1 Decimal Notation
Scan on 915 Band 0/1 Decimal Notation
Scan on 2400 Band 0/1 Decimal Notation
Pending scan scan Decimal Notation

Network scan results:

var scansub = removeSSItag('< !--#psubband-->,,,,,,,,,,,,,,,').split(",");

psubband contains 4 channels of 780 Band, 1 channel of 868 Band and 10 channels of 915 Band. Each channels separate with comma.

var scan2g4 = removeSSItag('< !--#p2g4band-->,,,,,,,,,,,,,,,,').split(",");

p2g4band contains 16 channels of 2400 Band separate with comma.

Param Value Format
Channel scan Two hexadecimal bytes separate with comma Hex Notation

Example of one channel scan:

var scansub = removeSSItag('< !--#psubband-->0x1234;0x4567,,,,,,,,,,,,,,,').split(",");

SET Network Scan mode

Send HTTP GET request in following format: http://SNIFFER_IP/netscan.cgi?tscan=1&b780=1&b868=1&b915=1&b2400=1

Where parameters are:

Param Value Format
Scan time 0-80 Decimal Notation
Scan on 780 Band 0/1 Decimal Notation
Scan on 868 Band 0/1 Decimal Notation
Scan on 915 Band 0/1 Decimal Notation
Scan on 2400 Band 0/1 Decimal Notation

1) In case of Success
Sniffer should answer HTTP 200 OK. Html page contains http://SNIFFER_IP/netscan.shtml .

2) In case of Error
Sniffer should answer HTTP 200 OK. Html page contains: “Wrong parameters!” string.

Available Channels and Modulation

Freq/Channel Value Available Modulation Value
780/0 128 OQPSK-RC-250 1C
782/1 129 OQPSK-RC-250 1C
784/2 130 OQPSK-RC-250 1C
786/3 131 OQPSK-RC-250 1C
868/0 0 BPSK-20 00
906/1 1 BPSK-40/OQPSK-SIN-250 04/0C
908/2 2 BPSK-40/OQPSK-SIN-250 04/0C
910/3 3 BPSK-40/OQPSK-SIN-250 04/0C
912/4 4 BPSK-40/OQPSK-SIN-250 04/0C
914/5 5 BPSK-40/OQPSK-SIN-250 04/0C
916/6 6 BPSK-40/OQPSK-SIN-250 04/0C
918/7 7 BPSK-40/OQPSK-SIN-250 04/0C
920/8 8 BPSK-40/OQPSK-SIN-250 04/0C
922/9 9 BPSK-40/OQPSK-SIN-250 04/0C
924/10 10 BPSK-40/OQPSK-SIN-250 04/0C
2405/11 11 OQPSK-250 00
2410/12 12 OQPSK-250 00
2415/13 13 OQPSK-250 00
2420/14 14 OQPSK-250 00
2425/15 15 OQPSK-250 00
2430/16 16 OQPSK-250 00
2435/17 17 OQPSK-250 00
2440/18 18 OQPSK-250 00
2445/19 19 OQPSK-250 00
2450/20 20 OQPSK-250 00
2455/21 21 OQPSK-250 00
2460/22 22 OQPSK-250 00
2465/23 23 OQPSK-250 00
2470/24 24 OQPSK-250 00
2475/25 25 OQPSK-250 00
2480/26 26 OQPSK-250 00

Continuous Transmission modes

CT mode Value (Hex Notation) Available for band
PRBS_A 01 All bands
PRBS_0 02 All bands
PRBS_F 03 All bands
CW_m01 04 780/868/915 band
CW_p01 08 780/868/915 band
CW_m025 0C 780/868/915 band
CW_p025 10 780/868/915 band
CW_m05 20 2400 band
CW_p05 40 2400 band

Tx power values for Sub-gigahertz bands

rf212_txpower

Tx power values for 2.4 GHz band

rf231_txpower