mirror of
https://github.com/smittix/intercept.git
synced 2026-04-24 06:40:00 -07:00
Fix WiFi monitor parsing, improve setup, reorganize docs
- Fix monitor interface regex parsing (Issues #27, #28) - Add Python 3.9+ version check at startup - Fix setup.sh to handle PEP 668 and auto-create venv - Reorganize README: move detailed content to docs/ folder - Add docs/FEATURES.md, USAGE.md, TROUBLESHOOTING.md, HARDWARE.md
This commit is contained in:
125
docs/USAGE.md
Normal file
125
docs/USAGE.md
Normal file
@@ -0,0 +1,125 @@
|
||||
# INTERCEPT Usage Guide
|
||||
|
||||
Detailed instructions for each mode.
|
||||
|
||||
## Pager Mode
|
||||
|
||||
1. **Select Hardware** - Choose your SDR type (RTL-SDR, LimeSDR, or HackRF)
|
||||
2. **Select Device** - Choose your SDR device from the dropdown
|
||||
3. **Set Frequency** - Enter a frequency in MHz or use a preset
|
||||
4. **Choose Protocols** - Select which protocols to decode (POCSAG/FLEX)
|
||||
5. **Adjust Settings** - Set gain, squelch, and PPM correction as needed
|
||||
6. **Start Decoding** - Click the green "Start Decoding" button
|
||||
|
||||
### Frequency Presets
|
||||
|
||||
- Click a preset button to quickly set a frequency
|
||||
- Add custom presets using the input field and "Add" button
|
||||
- Right-click a preset to remove it
|
||||
- Click "Reset to Defaults" to restore default frequencies
|
||||
|
||||
## 433MHz Sensor Mode
|
||||
|
||||
1. **Select Hardware** - Choose your SDR type
|
||||
2. **Select Device** - Choose your SDR device
|
||||
3. **Start Decoding** - Click "Start Decoding"
|
||||
4. **View Sensors** - Decoded sensor data appears in real-time
|
||||
|
||||
Supports 200+ protocols including weather stations, TPMS, doorbells, and IoT devices.
|
||||
|
||||
## WiFi Mode
|
||||
|
||||
1. **Select Interface** - Choose a WiFi adapter capable of monitor mode
|
||||
2. **Enable Monitor Mode** - Click "Enable Monitor" (uncheck "Kill processes" to preserve other connections)
|
||||
3. **Start Scanning** - Click "Start Scanning" to begin
|
||||
4. **View Networks** - Networks appear in the output panel with signal strength
|
||||
5. **Track Devices** - Click the chart icon on any network to track its signal over time
|
||||
6. **Capture Handshakes** - Click "Capture" on a network to start handshake capture
|
||||
|
||||
### Tips
|
||||
|
||||
- Run with `sudo` for monitor mode to work
|
||||
- Check your adapter supports monitor mode: `iw list | grep monitor`
|
||||
- Use "Kill processes" option if NetworkManager interferes
|
||||
|
||||
## Bluetooth Mode
|
||||
|
||||
1. **Select Interface** - Choose your Bluetooth adapter
|
||||
2. **Choose Mode** - Select scan mode (hcitool, bluetoothctl)
|
||||
3. **Start Scanning** - Click "Start Scanning"
|
||||
4. **View Devices** - Devices appear with name, address, and classification
|
||||
|
||||
### Tracker Detection
|
||||
|
||||
INTERCEPT automatically detects known trackers:
|
||||
- Apple AirTag
|
||||
- Tile
|
||||
- Samsung SmartTag
|
||||
- Chipolo
|
||||
|
||||
## Aircraft Mode (ADS-B)
|
||||
|
||||
1. **Select Hardware** - Choose your SDR type (RTL-SDR uses dump1090, others use readsb)
|
||||
2. **Check Tools** - Ensure dump1090 or readsb is installed
|
||||
3. **Set Location** - Choose location source:
|
||||
- **Manual Entry** - Type coordinates directly
|
||||
- **Browser GPS** - Use browser's built-in geolocation (requires HTTPS)
|
||||
- **USB GPS Dongle** - Connect a USB GPS receiver for continuous updates
|
||||
4. **Start Tracking** - Click "Start Tracking" to begin ADS-B reception
|
||||
5. **View Map** - Aircraft appear on the interactive Leaflet map
|
||||
6. **Click Aircraft** - Click markers for detailed information
|
||||
7. **Display Options** - Toggle callsigns, altitude, trails, range rings, clustering
|
||||
8. **Filter Aircraft** - Use dropdown to show all, military, civil, or emergency only
|
||||
9. **Full Dashboard** - Click "Full Screen Dashboard" for dedicated radar view
|
||||
|
||||
### Emergency Squawks
|
||||
|
||||
The system highlights aircraft transmitting emergency squawks:
|
||||
- **7500** - Hijack
|
||||
- **7600** - Radio failure
|
||||
- **7700** - General emergency
|
||||
|
||||
## Satellite Mode
|
||||
|
||||
1. **Set Location** - Choose location source:
|
||||
- **Manual Entry** - Type coordinates directly
|
||||
- **Browser GPS** - Use browser's built-in geolocation
|
||||
- **USB GPS Dongle** - Connect a USB GPS receiver for continuous updates
|
||||
2. **Add Satellites** - Click "Add Satellite" to enter TLE data or fetch from Celestrak
|
||||
3. **Calculate Passes** - Click "Calculate Passes" to predict upcoming passes
|
||||
4. **View Sky Plot** - Polar plot shows satellite positions in real-time
|
||||
5. **Ground Track** - Map displays satellite orbit path and current position
|
||||
6. **Full Dashboard** - Click "Full Screen Dashboard" for dedicated satellite view
|
||||
7. **Iridium Mode** - Switch tabs to monitor for Iridium burst transmissions
|
||||
|
||||
### Adding Satellites from Celestrak
|
||||
|
||||
1. Click "Add Satellite"
|
||||
2. Select "Fetch from Celestrak"
|
||||
3. Choose a category (Amateur, Weather, ISS, Starlink, etc.)
|
||||
4. Select satellites to add
|
||||
|
||||
## Configuration
|
||||
|
||||
INTERCEPT can be configured via environment variables:
|
||||
|
||||
| Variable | Default | Description |
|
||||
|----------|---------|-------------|
|
||||
| `INTERCEPT_HOST` | `0.0.0.0` | Server bind address |
|
||||
| `INTERCEPT_PORT` | `5050` | Server port |
|
||||
| `INTERCEPT_DEBUG` | `false` | Enable debug mode |
|
||||
| `INTERCEPT_LOG_LEVEL` | `WARNING` | Log level (DEBUG, INFO, WARNING, ERROR) |
|
||||
| `INTERCEPT_DEFAULT_GAIN` | `40` | Default RTL-SDR gain |
|
||||
|
||||
Example: `INTERCEPT_PORT=8080 sudo python3 intercept.py`
|
||||
|
||||
## Command-line Options
|
||||
|
||||
```
|
||||
python3 intercept.py --help
|
||||
|
||||
-p, --port PORT Port to run server on (default: 5050)
|
||||
-H, --host HOST Host to bind to (default: 0.0.0.0)
|
||||
-d, --debug Enable debug mode
|
||||
--check-deps Check dependencies and exit
|
||||
```
|
||||
Reference in New Issue
Block a user