mirror of
https://github.com/colonelpanichacks/flock-you.git
synced 2026-06-12 15:13:30 -07:00
Add files via upload
This commit is contained in:
Colonel Panic
@@ -1,156 +1,292 @@
|
||||
# Flock You Web Dashboard
|
||||
# Flock You: Flock Safety Detection System
|
||||
|
||||
A Flask-based web dashboard for real-time monitoring and analysis of Flock Safety device detections with GPS integration.
|
||||
<img src="flock.png" alt="Flock You" width="300px">
|
||||
|
||||
**Professional surveillance camera detection for the Oui-Spy device available at [colonelpanic.tech](https://colonelpanic.tech)**
|
||||
|
||||
## Overview
|
||||
|
||||
Flock You is an advanced detection system designed to identify Flock Safety surveillance cameras and similar surveillance devices using multiple detection methodologies. Built for the Xiao ESP32 S3 microcontroller, it provides real-time monitoring with audio alerts and comprehensive JSON output.
|
||||
|
||||
## Features
|
||||
|
||||
### Real-Time Detection Monitoring
|
||||
- **Live Updates**: Real-time detection display via WebSocket
|
||||
- **Detection Filtering**: Filter by detection method (WiFi, BLE, MAC, Device Name)
|
||||
- **Statistics Dashboard**: Overview of detection counts and types
|
||||
- **Detailed View**: Complete device information for each detection
|
||||
### Multi-Method Detection
|
||||
- **WiFi Promiscuous Mode**: Captures probe requests and beacon frames
|
||||
- **Bluetooth Low Energy (BLE) Scanning**: Monitors BLE advertisements
|
||||
- **MAC Address Filtering**: Detects devices by known MAC prefixes
|
||||
- **SSID Pattern Matching**: Identifies networks by specific names
|
||||
- **Device Name Pattern Matching**: Detects BLE devices by advertised names
|
||||
|
||||
### GPS Integration
|
||||
- **GPS Dongle Support**: Connect USB GPS dongles for location tracking
|
||||
- **NMEA Parsing**: Automatic parsing of GPS coordinates
|
||||
- **Location Tagging**: Each detection can include GPS coordinates
|
||||
- **Satellite Information**: Display GPS fix quality and satellite count
|
||||
### Audio Alert System
|
||||
- **Boot Sequence**: 2 beeps (low pitch → high pitch) on startup
|
||||
- **Detection Alert**: 3 fast high-pitch beeps when device detected
|
||||
- **Heartbeat Pulse**: 2 beeps every 10 seconds while device remains in range
|
||||
- **Range Monitoring**: Automatic detection of device leaving range
|
||||
|
||||
### Data Export
|
||||
- **CSV Export**: Download detection data in CSV format
|
||||
- **KML Export**: Generate Google Earth compatible KML files
|
||||
- **GPS Coordinates**: Include latitude, longitude, and altitude
|
||||
- **Timestamped Files**: Automatic filename generation with timestamps
|
||||
### Comprehensive Output
|
||||
- **JSON Detection Data**: Structured output with timestamps, RSSI, MAC addresses
|
||||
- **Real-time Web Dashboard**: Live monitoring at `http://localhost:5000`
|
||||
- **Serial Terminal**: Real-time device output in the web interface
|
||||
- **Detection History**: Persistent storage and export capabilities (CSV, KML)
|
||||
- **Device Information**: Full device details including signal strength and threat assessment
|
||||
- **Detection Method Tracking**: Identifies which detection method triggered the alert
|
||||
|
||||
## Hardware Requirements
|
||||
|
||||
### Option 1: Oui-Spy Device (Available at colonelpanic.tech)
|
||||
- **Microcontroller**: Xiao ESP32 S3
|
||||
- **Display**: 5-inch 1280x720 IPS TFT with multi-touch
|
||||
- **Wireless**: Dual WiFi/BLE scanning capabilities
|
||||
- **Audio**: Built-in buzzer system
|
||||
- **Connectivity**: USB-C for programming and power
|
||||
|
||||
### Option 2: Standard Xiao ESP32 S3 Setup
|
||||
- **Microcontroller**: Xiao ESP32 S3 board
|
||||
- **Buzzer**: 3V buzzer connected to GPIO3 (D2)
|
||||
- **Power**: USB-C cable for programming and power
|
||||
|
||||
### Wiring for Standard Setup
|
||||
```
|
||||
Xiao ESP32 S3 Buzzer
|
||||
GPIO3 (D2) ---> Positive (+)
|
||||
GND ---> Negative (-)
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
- Python 3.8 or higher
|
||||
- USB GPS dongle (optional, for location tracking)
|
||||
- PlatformIO IDE or PlatformIO Core
|
||||
- Python 3.8+ (for web interface)
|
||||
- USB-C cable for programming
|
||||
- Oui-Spy device from [colonelpanic.tech](https://colonelpanic.tech)
|
||||
|
||||
### Setup
|
||||
1. **Install dependencies**:
|
||||
### Setup Instructions
|
||||
1. **Clone the repository**:
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd flock-you
|
||||
```
|
||||
|
||||
2. **Connect your Oui-Spy device** via USB-C
|
||||
|
||||
3. **Flash the firmware**:
|
||||
```bash
|
||||
pio run --target upload
|
||||
```
|
||||
|
||||
4. **Set up the web interface**:
|
||||
```bash
|
||||
cd api
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate # On Windows: venv\Scripts\activate
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
2. **Run the application**:
|
||||
5. **Start the web server**:
|
||||
```bash
|
||||
python app.py
|
||||
python flockyou.py
|
||||
```
|
||||
|
||||
3. **Access the dashboard**:
|
||||
Open your browser and navigate to `http://localhost:5000`
|
||||
6. **Access the dashboard**:
|
||||
- Open your browser to `http://localhost:5000`
|
||||
- The web interface provides real-time detection monitoring
|
||||
- Serial terminal for device output
|
||||
- Detection history and export capabilities
|
||||
|
||||
## Usage
|
||||
7. **Monitor device output** (optional):
|
||||
```bash
|
||||
pio device monitor
|
||||
```
|
||||
|
||||
### Basic Operation
|
||||
1. **Start the web server** using the command above
|
||||
2. **Connect your Flock You device** and ensure it's sending JSON data
|
||||
3. **View detections** in real-time on the dashboard
|
||||
4. **Filter detections** using the dropdown menu
|
||||
5. **Export data** using the export buttons
|
||||
## Detection Coverage
|
||||
|
||||
### GPS Setup
|
||||
1. **Connect GPS dongle** to your computer via USB
|
||||
2. **Select GPS port** from the dropdown in the header
|
||||
3. **Click "Connect"** to establish GPS connection
|
||||
4. **Monitor GPS status** via the status indicator
|
||||
5. **Detections will automatically include GPS data** when available
|
||||
### WiFi Detection Methods
|
||||
- **Probe Requests**: Captures devices actively searching for networks
|
||||
- **Beacon Frames**: Monitors network advertisements
|
||||
- **Channel Hopping**: Cycles through all 13 WiFi channels (2.4GHz)
|
||||
- **SSID Patterns**: Detects networks with "flock", "Penguin", "Pigvision" patterns
|
||||
- **MAC Prefixes**: Identifies devices by manufacturer MAC addresses
|
||||
|
||||
### Data Export
|
||||
- **CSV Export**: Downloads a CSV file with all detection data
|
||||
- **KML Export**: Downloads a KML file for viewing in Google Earth
|
||||
- **GPS Data**: Both formats include GPS coordinates when available
|
||||
### BLE Detection Methods
|
||||
- **Advertisement Scanning**: Monitors BLE device broadcasts
|
||||
- **Device Names**: Matches against known surveillance device names
|
||||
- **MAC Address Filtering**: Detects devices by BLE MAC prefixes
|
||||
- **Active Scanning**: Continuous monitoring with 100ms intervals
|
||||
|
||||
## API Endpoints
|
||||
### Real-World Database Integration
|
||||
Detection patterns are derived from actual field data including:
|
||||
- Flock Safety camera signatures
|
||||
- Penguin surveillance device patterns
|
||||
- Pigvision system identifiers
|
||||
- Extended battery and external antenna configurations
|
||||
|
||||
### Detection Management
|
||||
- `GET /api/detections` - Get all detections (with optional filtering)
|
||||
- `POST /api/detections` - Add new detection from Flock You device
|
||||
- `POST /api/clear` - Clear all detections
|
||||
**Datasets from deflock.me are included in the `datasets/` folder of this repository**, providing comprehensive device signatures and detection patterns for enhanced accuracy.
|
||||
|
||||
### GPS Management
|
||||
- `GET /api/gps/ports` - Get available serial ports
|
||||
- `POST /api/gps/connect` - Connect to GPS dongle
|
||||
- `POST /api/gps/disconnect` - Disconnect GPS dongle
|
||||
## Technical Specifications
|
||||
|
||||
### Data Export
|
||||
- `GET /api/export/csv` - Export detections as CSV
|
||||
- `GET /api/export/kml` - Export detections as KML
|
||||
### WiFi Capabilities
|
||||
- **Frequency**: 2.4GHz only (13 channels)
|
||||
- **Mode**: Promiscuous monitoring
|
||||
- **Channel Hopping**: Automatic cycling every 2 seconds
|
||||
- **Packet Types**: Probe requests (0x04) and beacons (0x08)
|
||||
|
||||
## Integration with Flock You Device
|
||||
### BLE Capabilities
|
||||
- **Framework**: NimBLE-Arduino
|
||||
- **Scan Mode**: Active scanning
|
||||
- **Interval**: 100ms scan intervals
|
||||
- **Window**: 99ms scan windows
|
||||
|
||||
The web dashboard is designed to receive JSON detection data from the Flock You ESP32 device. The device should send POST requests to `/api/detections` with JSON data in the following format:
|
||||
### Audio System
|
||||
- **Boot Sequence**: 200Hz → 800Hz (300ms each)
|
||||
- **Detection Alert**: 1000Hz × 3 beeps (150ms each)
|
||||
- **Heartbeat**: 600Hz × 2 beeps (100ms each, 100ms gap)
|
||||
- **Frequency**: Every 10 seconds while device in range
|
||||
|
||||
### JSON Output Format
|
||||
```json
|
||||
{
|
||||
"timestamp": 12345,
|
||||
"detection_time": "12.345s",
|
||||
"protocol": "wifi",
|
||||
"detection_method": "probe_request",
|
||||
"alert_level": "HIGH",
|
||||
"device_category": "FLOCK_SAFETY",
|
||||
"ssid": "Flock_Camera_001",
|
||||
"mac_address": "aa:bb:cc:dd:ee:ff",
|
||||
"rssi": -65,
|
||||
"signal_strength": "MEDIUM",
|
||||
"channel": 6
|
||||
"channel": 6,
|
||||
"mac_address": "aa:bb:cc:dd:ee:ff",
|
||||
"threat_score": 95,
|
||||
"matched_patterns": ["ssid_pattern", "mac_prefix"],
|
||||
"device_info": {
|
||||
"manufacturer": "Flock Safety",
|
||||
"model": "Surveillance Camera",
|
||||
"capabilities": ["video", "audio", "gps"]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## GPS Dongle Compatibility
|
||||
## Usage
|
||||
|
||||
The dashboard supports standard NMEA GPS dongles that output GPGGA sentences. Compatible devices include:
|
||||
- USB GPS receivers
|
||||
- Bluetooth GPS modules (when connected via USB adapter)
|
||||
- Serial GPS modules
|
||||
### Startup Sequence
|
||||
1. **Power on** the Oui-Spy device
|
||||
2. **Listen for boot beeps** (low → high pitch)
|
||||
3. **Start the web server**: `python flockyou.py` (from the `api` directory)
|
||||
4. **Open the dashboard**: Navigate to `http://localhost:5000`
|
||||
5. **Connect devices**: Use the web interface to connect your Flock You device and GPS
|
||||
6. **System ready** when "hunting for Flock Safety devices" appears in the serial terminal
|
||||
|
||||
## File Structure
|
||||
```
|
||||
webapp/
|
||||
├── app.py # Main Flask application
|
||||
├── requirements.txt # Python dependencies
|
||||
├── templates/
|
||||
│ └── index.html # Web dashboard template
|
||||
├── exports/ # Generated export files
|
||||
└── README.md # This file
|
||||
```
|
||||
### Detection Monitoring
|
||||
- **Web Dashboard**: Real-time detection display at `http://localhost:5000`
|
||||
- **Serial Terminal**: Live device output in the web interface
|
||||
- **Audio Alerts**: Immediate notification of detections (device-side)
|
||||
- **Heartbeat**: Continuous monitoring while devices in range
|
||||
- **Range Tracking**: Automatic detection of device departure
|
||||
- **Export Options**: Download detections as CSV or KML files
|
||||
|
||||
### Channel Information
|
||||
- **WiFi**: Automatically hops through channels 1-13
|
||||
- **BLE**: Continuous scanning across all BLE channels
|
||||
- **Status Updates**: Channel changes logged to serial terminal
|
||||
|
||||
## Detection Patterns
|
||||
|
||||
### SSID Patterns
|
||||
- `flock*` - Flock Safety cameras
|
||||
- `Penguin*` - Penguin surveillance devices
|
||||
- `Pigvision*` - Pigvision systems
|
||||
- `FS_*` - Flock Safety variants
|
||||
|
||||
### MAC Address Prefixes
|
||||
- `AA:BB:CC` - Flock Safety manufacturer codes
|
||||
- `DD:EE:FF` - Penguin device identifiers
|
||||
- `11:22:33` - Pigvision system codes
|
||||
|
||||
### BLE Device Names
|
||||
- `Flock*` - Flock Safety BLE devices
|
||||
- `Penguin*` - Penguin BLE identifiers
|
||||
- `Pigvision*` - Pigvision BLE devices
|
||||
|
||||
## Limitations
|
||||
|
||||
### Technical Constraints
|
||||
- **WiFi Range**: Limited to 2.4GHz spectrum
|
||||
- **Detection Range**: Approximately 50-100 meters depending on environment
|
||||
- **False Positives**: Possible with similar device signatures
|
||||
- **Battery Life**: Continuous scanning reduces battery runtime
|
||||
|
||||
### Environmental Factors
|
||||
- **Interference**: Other WiFi networks may affect detection
|
||||
- **Obstacles**: Walls and structures reduce detection range
|
||||
- **Weather**: Outdoor conditions may impact performance
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### GPS Connection Issues
|
||||
- Ensure GPS dongle is properly connected
|
||||
- Check that the correct serial port is selected
|
||||
- Verify GPS dongle is powered and has satellite fix
|
||||
- Check system permissions for serial port access
|
||||
### Common Issues
|
||||
1. **Web Server Won't Start**: Check Python version (3.8+) and virtual environment setup
|
||||
2. **No Serial Output**: Check USB connection and device port selection in web interface
|
||||
3. **No Audio**: Verify buzzer connection to GPIO3
|
||||
4. **No Detections**: Ensure device is in range and scanning is active
|
||||
5. **False Alerts**: Review detection patterns and adjust if needed
|
||||
6. **Connection Issues**: Verify device is connected via the web interface controls
|
||||
|
||||
### No Detections Displayed
|
||||
- Verify Flock You device is running and connected
|
||||
- Check network connectivity between device and server
|
||||
- Ensure device is sending data to correct endpoint
|
||||
- Check browser console for JavaScript errors
|
||||
### Debug Information
|
||||
- **Web Dashboard**: Real-time status and connection monitoring at `http://localhost:5000`
|
||||
- **Serial Terminal**: Live device output in the web interface
|
||||
- **Channel Hopping**: Logs channel changes for debugging
|
||||
- **Detection Logs**: Full JSON output for analysis
|
||||
|
||||
### Export Issues
|
||||
- Ensure `exports/` directory exists and is writable
|
||||
- Check available disk space
|
||||
- Verify file permissions
|
||||
## Legal and Ethical Considerations
|
||||
|
||||
## Security Notes
|
||||
### Intended Use
|
||||
- **Research and Education**: Understanding surveillance technology
|
||||
- **Security Assessment**: Evaluating privacy implications
|
||||
- **Technical Analysis**: Studying wireless communication patterns
|
||||
|
||||
- The dashboard runs on `0.0.0.0:5000` by default (accessible from any network)
|
||||
- Consider using a reverse proxy (nginx) for production deployment
|
||||
- Implement authentication if needed for multi-user environments
|
||||
- The Flask secret key should be changed in production
|
||||
### Compliance
|
||||
- **Local Laws**: Ensure compliance with local regulations
|
||||
- **Privacy Rights**: Respect individual privacy and property rights
|
||||
- **Authorized Use**: Only use in authorized locations and situations
|
||||
|
||||
## Development
|
||||
## Credits and Research
|
||||
|
||||
### Adding New Features
|
||||
- Modify `app.py` for backend functionality
|
||||
- Update `templates/index.html` for frontend changes
|
||||
- Add new API endpoints as needed
|
||||
- Update requirements.txt for new dependencies
|
||||
### Research Foundation
|
||||
This project is based on extensive research and public datasets from the surveillance detection community:
|
||||
|
||||
### Testing
|
||||
- Test GPS functionality with actual GPS dongle
|
||||
- Verify export functionality with sample data
|
||||
- Test real-time updates with multiple browser windows
|
||||
- Validate JSON data format compatibility
|
||||
- **[DeFlock](https://deflock.me)** - Crowdsourced ALPR location and reporting tool
|
||||
- GitHub: [FoggedLens/deflock](https://github.com/FoggedLens/deflock)
|
||||
- Provides comprehensive datasets and methodologies for surveillance device detection
|
||||
- **Datasets included**: Real-world device signatures from deflock.me are included in the `datasets/` folder
|
||||
|
||||
- **[GainSec](https://github.com/GainSec)** - OSINT and privacy research
|
||||
- Specialized in surveillance technology analysis and detection methodologies
|
||||
- **Research referenced**: Some methodologies are based on their published research on surveillance technology
|
||||
|
||||
### Methodology Integration
|
||||
Flock You unifies multiple known detection methodologies into a comprehensive scanner/wardriver specifically designed for Flock Safety cameras and similar surveillance devices. The system combines:
|
||||
|
||||
- **WiFi Promiscuous Monitoring**: Based on DeFlock's network analysis techniques
|
||||
- **BLE Device Detection**: Leveraging GainSec's Bluetooth surveillance research
|
||||
- **MAC Address Filtering**: Using crowdsourced device databases from deflock.me
|
||||
- **Pattern Recognition**: Implementing research-based detection algorithms
|
||||
|
||||
### Acknowledgments
|
||||
Special thanks to the researchers and contributors who have made this work possible through their open-source contributions and public datasets. This project builds upon their foundational work in surveillance detection and privacy protection.
|
||||
|
||||
## Support and Updates
|
||||
|
||||
### Documentation
|
||||
- **Technical Support**: Available through colonelpanic.tech
|
||||
- **Firmware Updates**: Regular updates with improved detection patterns
|
||||
- **Community**: Join our community for tips and modifications
|
||||
|
||||
### Purchase Information
|
||||
**Oui-Spy devices are available exclusively at [colonelpanic.tech](https://colonelpanic.tech)**
|
||||
|
||||
## License
|
||||
|
||||
This project is provided for educational and research purposes. Please ensure compliance with all applicable laws and regulations in your jurisdiction.
|
||||
|
||||
---
|
||||
|
||||
**Flock You: Professional surveillance detection for the privacy-conscious**
|
||||
|
||||
+156
@@ -0,0 +1,156 @@
|
||||
# Flock You Web Dashboard
|
||||
|
||||
A Flask-based web dashboard for real-time monitoring and analysis of Flock Safety device detections with GPS integration.
|
||||
|
||||
## Features
|
||||
|
||||
### Real-Time Detection Monitoring
|
||||
- **Live Updates**: Real-time detection display via WebSocket
|
||||
- **Detection Filtering**: Filter by detection method (WiFi, BLE, MAC, Device Name)
|
||||
- **Statistics Dashboard**: Overview of detection counts and types
|
||||
- **Detailed View**: Complete device information for each detection
|
||||
|
||||
### GPS Integration
|
||||
- **GPS Dongle Support**: Connect USB GPS dongles for location tracking
|
||||
- **NMEA Parsing**: Automatic parsing of GPS coordinates
|
||||
- **Location Tagging**: Each detection can include GPS coordinates
|
||||
- **Satellite Information**: Display GPS fix quality and satellite count
|
||||
|
||||
### Data Export
|
||||
- **CSV Export**: Download detection data in CSV format
|
||||
- **KML Export**: Generate Google Earth compatible KML files
|
||||
- **GPS Coordinates**: Include latitude, longitude, and altitude
|
||||
- **Timestamped Files**: Automatic filename generation with timestamps
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
- Python 3.8 or higher
|
||||
- USB GPS dongle (optional, for location tracking)
|
||||
|
||||
### Setup
|
||||
1. **Install dependencies**:
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
2. **Run the application**:
|
||||
```bash
|
||||
python app.py
|
||||
```
|
||||
|
||||
3. **Access the dashboard**:
|
||||
Open your browser and navigate to `http://localhost:5000`
|
||||
|
||||
## Usage
|
||||
|
||||
### Basic Operation
|
||||
1. **Start the web server** using the command above
|
||||
2. **Connect your Flock You device** and ensure it's sending JSON data
|
||||
3. **View detections** in real-time on the dashboard
|
||||
4. **Filter detections** using the dropdown menu
|
||||
5. **Export data** using the export buttons
|
||||
|
||||
### GPS Setup
|
||||
1. **Connect GPS dongle** to your computer via USB
|
||||
2. **Select GPS port** from the dropdown in the header
|
||||
3. **Click "Connect"** to establish GPS connection
|
||||
4. **Monitor GPS status** via the status indicator
|
||||
5. **Detections will automatically include GPS data** when available
|
||||
|
||||
### Data Export
|
||||
- **CSV Export**: Downloads a CSV file with all detection data
|
||||
- **KML Export**: Downloads a KML file for viewing in Google Earth
|
||||
- **GPS Data**: Both formats include GPS coordinates when available
|
||||
|
||||
## API Endpoints
|
||||
|
||||
### Detection Management
|
||||
- `GET /api/detections` - Get all detections (with optional filtering)
|
||||
- `POST /api/detections` - Add new detection from Flock You device
|
||||
- `POST /api/clear` - Clear all detections
|
||||
|
||||
### GPS Management
|
||||
- `GET /api/gps/ports` - Get available serial ports
|
||||
- `POST /api/gps/connect` - Connect to GPS dongle
|
||||
- `POST /api/gps/disconnect` - Disconnect GPS dongle
|
||||
|
||||
### Data Export
|
||||
- `GET /api/export/csv` - Export detections as CSV
|
||||
- `GET /api/export/kml` - Export detections as KML
|
||||
|
||||
## Integration with Flock You Device
|
||||
|
||||
The web dashboard is designed to receive JSON detection data from the Flock You ESP32 device. The device should send POST requests to `/api/detections` with JSON data in the following format:
|
||||
|
||||
```json
|
||||
{
|
||||
"timestamp": 12345,
|
||||
"detection_time": "12.345s",
|
||||
"protocol": "wifi",
|
||||
"detection_method": "probe_request",
|
||||
"ssid": "Flock_Camera_001",
|
||||
"mac_address": "aa:bb:cc:dd:ee:ff",
|
||||
"rssi": -65,
|
||||
"signal_strength": "MEDIUM",
|
||||
"channel": 6
|
||||
}
|
||||
```
|
||||
|
||||
## GPS Dongle Compatibility
|
||||
|
||||
The dashboard supports standard NMEA GPS dongles that output GPGGA sentences. Compatible devices include:
|
||||
- USB GPS receivers
|
||||
- Bluetooth GPS modules (when connected via USB adapter)
|
||||
- Serial GPS modules
|
||||
|
||||
## File Structure
|
||||
```
|
||||
webapp/
|
||||
├── app.py # Main Flask application
|
||||
├── requirements.txt # Python dependencies
|
||||
├── templates/
|
||||
│ └── index.html # Web dashboard template
|
||||
├── exports/ # Generated export files
|
||||
└── README.md # This file
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### GPS Connection Issues
|
||||
- Ensure GPS dongle is properly connected
|
||||
- Check that the correct serial port is selected
|
||||
- Verify GPS dongle is powered and has satellite fix
|
||||
- Check system permissions for serial port access
|
||||
|
||||
### No Detections Displayed
|
||||
- Verify Flock You device is running and connected
|
||||
- Check network connectivity between device and server
|
||||
- Ensure device is sending data to correct endpoint
|
||||
- Check browser console for JavaScript errors
|
||||
|
||||
### Export Issues
|
||||
- Ensure `exports/` directory exists and is writable
|
||||
- Check available disk space
|
||||
- Verify file permissions
|
||||
|
||||
## Security Notes
|
||||
|
||||
- The dashboard runs on `0.0.0.0:5000` by default (accessible from any network)
|
||||
- Consider using a reverse proxy (nginx) for production deployment
|
||||
- Implement authentication if needed for multi-user environments
|
||||
- The Flask secret key should be changed in production
|
||||
|
||||
## Development
|
||||
|
||||
### Adding New Features
|
||||
- Modify `app.py` for backend functionality
|
||||
- Update `templates/index.html` for frontend changes
|
||||
- Add new API endpoints as needed
|
||||
- Update requirements.txt for new dependencies
|
||||
|
||||
### Testing
|
||||
- Test GPS functionality with actual GPS dongle
|
||||
- Verify export functionality with sample data
|
||||
- Test real-time updates with multiple browser windows
|
||||
- Validate JSON data format compatibility
|
||||
+892
@@ -0,0 +1,892 @@
|
||||
from flask import Flask, render_template, request, jsonify, send_file
|
||||
import json
|
||||
import csv
|
||||
import os
|
||||
from datetime import datetime
|
||||
import time
|
||||
from flask_socketio import SocketIO, emit, join_room, leave_room
|
||||
import threading
|
||||
import serial
|
||||
import serial.tools.list_ports
|
||||
import queue
|
||||
import uuid
|
||||
|
||||
app = Flask(__name__)
|
||||
app.config['SECRET_KEY'] = os.environ.get('SECRET_KEY', 'flockyou_dev_key_2024')
|
||||
socketio = SocketIO(app, cors_allowed_origins="*", async_mode='threading', logger=True, engineio_logger=True)
|
||||
|
||||
# Global variables
|
||||
detections = []
|
||||
gps_data = None
|
||||
serial_connection = None
|
||||
gps_enabled = False
|
||||
flock_device_connected = False
|
||||
flock_device_port = None
|
||||
flock_serial_connection = None
|
||||
oui_database = {}
|
||||
serial_data_buffer = []
|
||||
reconnect_attempts = {'flock': 0, 'gps': 0}
|
||||
max_reconnect_attempts = 5
|
||||
reconnect_delay = 3 # seconds
|
||||
connection_lock = threading.Lock()
|
||||
serial_queue = queue.Queue()
|
||||
next_detection_id = 1 # Unique ID counter
|
||||
|
||||
# Load OUI database
|
||||
def load_oui_database():
|
||||
"""Load the IEEE OUI database for manufacturer lookups"""
|
||||
global oui_database
|
||||
try:
|
||||
with open('oui.txt', 'r', encoding='utf-8', errors='ignore') as f:
|
||||
for line in f:
|
||||
line = line.strip()
|
||||
if line and not line.startswith('#') and '(hex)' in line:
|
||||
# Parse OUI line format: "28-6F-B9 (hex) Nokia Shanghai Bell Co., Ltd."
|
||||
parts = line.split('(hex)')
|
||||
if len(parts) == 2:
|
||||
mac_prefix = parts[0].strip().replace('-', '').replace(' ', '').upper()
|
||||
manufacturer = parts[1].strip()
|
||||
if mac_prefix and manufacturer and len(mac_prefix) == 6:
|
||||
oui_database[mac_prefix] = manufacturer
|
||||
print(f"Loaded {len(oui_database)} OUI entries")
|
||||
except Exception as e:
|
||||
print(f"Error loading OUI database: {e}")
|
||||
|
||||
def lookup_manufacturer(mac_address):
|
||||
"""Look up manufacturer information for a MAC address"""
|
||||
if not mac_address:
|
||||
return None
|
||||
|
||||
# Extract first 6 characters (3 bytes) of MAC address
|
||||
mac_clean = mac_address.replace(':', '').replace('-', '').upper()
|
||||
if len(mac_clean) >= 6:
|
||||
oui = mac_clean[:6]
|
||||
return oui_database.get(oui, "Unknown Manufacturer")
|
||||
return "Unknown Manufacturer"
|
||||
|
||||
# GPS Dongle Configuration
|
||||
GPS_BAUDRATE = 9600
|
||||
GPS_TIMEOUT = 1
|
||||
|
||||
class GPSData:
|
||||
def __init__(self):
|
||||
self.latitude = None
|
||||
self.longitude = None
|
||||
self.altitude = None
|
||||
self.timestamp = None
|
||||
self.fix_quality = 0
|
||||
self.satellites = 0
|
||||
|
||||
def parse_nmea_sentence(sentence):
|
||||
"""Parse NMEA GPS sentence"""
|
||||
if not sentence.startswith('$'):
|
||||
return None
|
||||
|
||||
parts = sentence.strip().split(',')
|
||||
if len(parts) < 1:
|
||||
return None
|
||||
|
||||
sentence_type = parts[0]
|
||||
|
||||
if sentence_type == '$GPGGA': # Global Positioning System Fix Data
|
||||
if len(parts) >= 15:
|
||||
try:
|
||||
time_str = parts[1]
|
||||
lat = float(parts[2]) / 100
|
||||
lat_dir = parts[3]
|
||||
lon = float(parts[4]) / 100
|
||||
lon_dir = parts[5]
|
||||
fix_quality = int(parts[6])
|
||||
satellites = int(parts[7])
|
||||
altitude = float(parts[9]) if parts[9] else 0
|
||||
|
||||
# Convert to decimal degrees
|
||||
if lat_dir == 'S':
|
||||
lat = -lat
|
||||
if lon_dir == 'W':
|
||||
lon = -lon
|
||||
|
||||
return {
|
||||
'latitude': lat,
|
||||
'longitude': lon,
|
||||
'altitude': altitude,
|
||||
'fix_quality': fix_quality,
|
||||
'satellites': satellites,
|
||||
'timestamp': time_str
|
||||
}
|
||||
except (ValueError, IndexError):
|
||||
return None
|
||||
|
||||
return None
|
||||
|
||||
def safe_socket_emit(event, data, room=None):
|
||||
"""Safely emit socket events with error handling"""
|
||||
try:
|
||||
if room:
|
||||
socketio.emit(event, data, room=room)
|
||||
else:
|
||||
socketio.emit(event, data)
|
||||
except Exception as e:
|
||||
print(f"Socket emit error for {event}: {e}")
|
||||
|
||||
def gps_reader():
|
||||
"""Background thread for reading GPS data"""
|
||||
global gps_data, serial_connection, gps_enabled
|
||||
|
||||
while gps_enabled:
|
||||
if serial_connection and serial_connection.is_open:
|
||||
try:
|
||||
line = serial_connection.readline().decode('utf-8', errors='ignore')
|
||||
if line:
|
||||
parsed = parse_nmea_sentence(line)
|
||||
if parsed:
|
||||
gps_data = parsed
|
||||
safe_socket_emit('gps_update', parsed)
|
||||
except Exception as e:
|
||||
print(f"GPS read error: {e}")
|
||||
with connection_lock:
|
||||
gps_enabled = False
|
||||
safe_socket_emit('gps_disconnected', {})
|
||||
break
|
||||
time.sleep(0.1)
|
||||
|
||||
def flock_reader():
|
||||
"""Background thread for reading Flock device data"""
|
||||
global flock_serial_connection, flock_device_connected, serial_data_buffer
|
||||
|
||||
while flock_device_connected:
|
||||
if flock_serial_connection and flock_serial_connection.is_open:
|
||||
try:
|
||||
line = flock_serial_connection.readline().decode('utf-8', errors='ignore')
|
||||
if line:
|
||||
line = line.strip()
|
||||
if line:
|
||||
# Store in buffer for terminal
|
||||
serial_data_buffer.append(line)
|
||||
if len(serial_data_buffer) > 1000: # Keep last 1000 lines
|
||||
serial_data_buffer.pop(0)
|
||||
|
||||
# Forward to all serial terminal clients
|
||||
safe_socket_emit('serial_data', line, room='serial_terminal')
|
||||
print(f"Serial data sent to terminal: {line}")
|
||||
|
||||
# Try to parse as detection data
|
||||
try:
|
||||
data = json.loads(line)
|
||||
if 'detection_method' in data:
|
||||
# This is a detection, add it
|
||||
add_detection_from_serial(data)
|
||||
else:
|
||||
print(f"JSON data without detection_method: {data}")
|
||||
except json.JSONDecodeError:
|
||||
# Not JSON, just log it
|
||||
print(f"Flock device (non-JSON): {line}")
|
||||
|
||||
except Exception as e:
|
||||
print(f"Flock device read error: {e}")
|
||||
with connection_lock:
|
||||
flock_device_connected = False
|
||||
safe_socket_emit('flock_disconnected', {})
|
||||
# Trigger reconnection immediately
|
||||
attempt_reconnect_flock()
|
||||
break
|
||||
time.sleep(0.1)
|
||||
|
||||
def add_detection_from_serial(data):
|
||||
"""Add detection from serial data"""
|
||||
global detections, gps_data, next_detection_id
|
||||
|
||||
# Add GPS data if available
|
||||
if gps_data and gps_data.get('fix_quality') > 0:
|
||||
data['gps'] = {
|
||||
'latitude': gps_data.get('latitude'),
|
||||
'longitude': gps_data.get('longitude'),
|
||||
'altitude': gps_data.get('altitude'),
|
||||
'timestamp': gps_data.get('timestamp'),
|
||||
'satellites': gps_data.get('satellites'),
|
||||
'fix_quality': gps_data.get('fix_quality')
|
||||
}
|
||||
|
||||
# Add manufacturer information
|
||||
if 'mac_address' in data:
|
||||
data['manufacturer'] = lookup_manufacturer(data['mac_address'])
|
||||
|
||||
# Add server timestamp
|
||||
data['server_timestamp'] = datetime.now().isoformat()
|
||||
|
||||
# Add unique ID for aliasing
|
||||
data['id'] = next_detection_id
|
||||
next_detection_id += 1
|
||||
data['alias'] = '' # Empty alias by default
|
||||
|
||||
detections.append(data)
|
||||
|
||||
# Emit to connected clients
|
||||
safe_socket_emit('new_detection', data)
|
||||
print(f"New detection added: ID {data['id']}, Method: {data.get('detection_method')}, MAC: {data.get('mac_address')}")
|
||||
|
||||
def connection_monitor():
|
||||
"""Background thread for monitoring device connections"""
|
||||
global gps_enabled, flock_device_connected, serial_connection, reconnect_attempts
|
||||
|
||||
while True:
|
||||
# Check GPS connection
|
||||
if gps_enabled:
|
||||
try:
|
||||
if not serial_connection or not serial_connection.is_open:
|
||||
with connection_lock:
|
||||
gps_enabled = False
|
||||
safe_socket_emit('gps_disconnected', {})
|
||||
print("GPS connection lost")
|
||||
# Start reconnection attempts
|
||||
attempt_reconnect_gps()
|
||||
else:
|
||||
# Test if the connection is still valid
|
||||
serial_connection.in_waiting
|
||||
except Exception as e:
|
||||
print(f"GPS connection test failed: {e}")
|
||||
with connection_lock:
|
||||
gps_enabled = False
|
||||
safe_socket_emit('gps_disconnected', {})
|
||||
attempt_reconnect_gps()
|
||||
|
||||
# Check Flock You device connection
|
||||
if flock_device_connected:
|
||||
try:
|
||||
# Test if the connection is still valid
|
||||
if not flock_serial_connection or not flock_serial_connection.is_open:
|
||||
with connection_lock:
|
||||
flock_device_connected = False
|
||||
safe_socket_emit('flock_disconnected', {})
|
||||
print("Flock You device connection lost")
|
||||
# Start reconnection attempts
|
||||
attempt_reconnect_flock()
|
||||
else:
|
||||
# Try a simple read to test connection
|
||||
flock_serial_connection.in_waiting
|
||||
except Exception as e:
|
||||
print(f"Flock device connection test failed: {e}")
|
||||
with connection_lock:
|
||||
flock_device_connected = False
|
||||
safe_socket_emit('flock_disconnected', {})
|
||||
# Start reconnection attempts
|
||||
attempt_reconnect_flock()
|
||||
|
||||
time.sleep(2) # Check every 2 seconds
|
||||
|
||||
def attempt_reconnect_flock():
|
||||
"""Attempt to reconnect to Flock device"""
|
||||
global flock_device_connected, reconnect_attempts, flock_serial_connection
|
||||
|
||||
def reconnect_thread():
|
||||
global flock_device_connected, reconnect_attempts, flock_serial_connection
|
||||
|
||||
while not flock_device_connected and reconnect_attempts['flock'] < max_reconnect_attempts:
|
||||
try:
|
||||
print(f"Attempting to reconnect to Flock device (attempt {reconnect_attempts['flock'] + 1}/{max_reconnect_attempts})")
|
||||
|
||||
# Try to reconnect
|
||||
if flock_serial_connection:
|
||||
try:
|
||||
flock_serial_connection.close()
|
||||
except:
|
||||
pass
|
||||
|
||||
# Wait a moment for the device to be ready
|
||||
time.sleep(1)
|
||||
|
||||
flock_serial_connection = serial.Serial(flock_device_port, 115200, timeout=1)
|
||||
|
||||
# Test the connection
|
||||
test_data = flock_serial_connection.readline()
|
||||
|
||||
# If successful, update status
|
||||
with connection_lock:
|
||||
flock_device_connected = True
|
||||
reconnect_attempts['flock'] = 0
|
||||
print(f"Successfully reconnected to Flock device on {flock_device_port}")
|
||||
safe_socket_emit('flock_reconnected', {'port': flock_device_port})
|
||||
|
||||
# Restart the reading thread
|
||||
flock_thread = threading.Thread(target=flock_reader, daemon=True)
|
||||
flock_thread.start()
|
||||
return
|
||||
|
||||
except Exception as e:
|
||||
print(f"Reconnection attempt failed: {e}")
|
||||
reconnect_attempts['flock'] += 1
|
||||
time.sleep(reconnect_delay)
|
||||
|
||||
if reconnect_attempts['flock'] >= max_reconnect_attempts:
|
||||
print("Max reconnection attempts reached for Flock device")
|
||||
safe_socket_emit('reconnect_failed', {'device': 'flock'})
|
||||
reconnect_attempts['flock'] = 0 # Reset for future attempts
|
||||
|
||||
thread = threading.Thread(target=reconnect_thread, daemon=True)
|
||||
thread.start()
|
||||
|
||||
def attempt_reconnect_gps():
|
||||
"""Attempt to reconnect to GPS device"""
|
||||
global gps_enabled, reconnect_attempts
|
||||
|
||||
def reconnect_thread():
|
||||
global gps_enabled, reconnect_attempts
|
||||
|
||||
while not gps_enabled and reconnect_attempts['gps'] < max_reconnect_attempts:
|
||||
try:
|
||||
print(f"Attempting to reconnect to GPS device (attempt {reconnect_attempts['gps'] + 1}/{max_reconnect_attempts})")
|
||||
|
||||
# Try to reconnect
|
||||
test_ser = serial.Serial(serial_connection.port, GPS_BAUDRATE, timeout=1)
|
||||
test_ser.close()
|
||||
|
||||
# If successful, update status
|
||||
with connection_lock:
|
||||
gps_enabled = True
|
||||
reconnect_attempts['gps'] = 0
|
||||
print(f"Successfully reconnected to GPS device on {serial_connection.port}")
|
||||
safe_socket_emit('gps_reconnected', {'port': serial_connection.port})
|
||||
|
||||
# Restart the reading thread
|
||||
gps_thread = threading.Thread(target=gps_reader, daemon=True)
|
||||
gps_thread.start()
|
||||
return
|
||||
|
||||
except Exception as e:
|
||||
print(f"GPS reconnection attempt failed: {e}")
|
||||
reconnect_attempts['gps'] += 1
|
||||
time.sleep(reconnect_delay)
|
||||
|
||||
if reconnect_attempts['gps'] >= max_reconnect_attempts:
|
||||
print("Max reconnection attempts reached for GPS device")
|
||||
safe_socket_emit('reconnect_failed', {'device': 'gps'})
|
||||
reconnect_attempts['gps'] = 0 # Reset for future attempts
|
||||
|
||||
thread = threading.Thread(target=reconnect_thread, daemon=True)
|
||||
thread.start()
|
||||
|
||||
@app.route('/')
|
||||
def index():
|
||||
return render_template('index.html')
|
||||
|
||||
@app.route('/api/detections', methods=['GET'])
|
||||
def get_detections():
|
||||
"""Get all detections with optional filtering"""
|
||||
filter_type = request.args.get('filter', 'all')
|
||||
|
||||
if filter_type == 'all':
|
||||
return jsonify(detections)
|
||||
else:
|
||||
filtered = [d for d in detections if d.get('detection_method') == filter_type]
|
||||
return jsonify(filtered)
|
||||
|
||||
@app.route('/api/detections', methods=['POST'])
|
||||
def add_detection():
|
||||
"""Add a new detection from serial data"""
|
||||
global detections, gps_data
|
||||
|
||||
data = request.json
|
||||
|
||||
# Add GPS data if available
|
||||
if gps_data and gps_data.get('fix_quality') > 0:
|
||||
data['gps'] = {
|
||||
'latitude': gps_data.get('latitude'),
|
||||
'longitude': gps_data.get('longitude'),
|
||||
'altitude': gps_data.get('altitude'),
|
||||
'timestamp': gps_data.get('timestamp'),
|
||||
'satellites': gps_data.get('satellites')
|
||||
}
|
||||
|
||||
# Add manufacturer information
|
||||
if 'mac_address' in data:
|
||||
data['manufacturer'] = lookup_manufacturer(data['mac_address'])
|
||||
|
||||
# Add server timestamp
|
||||
data['server_timestamp'] = datetime.now().isoformat()
|
||||
|
||||
detections.append(data)
|
||||
|
||||
# Emit to connected clients
|
||||
socketio.emit('new_detection', data)
|
||||
|
||||
return jsonify({'status': 'success', 'id': len(detections)})
|
||||
|
||||
@app.route('/api/gps/connect', methods=['POST'])
|
||||
def connect_gps():
|
||||
"""Connect to GPS dongle"""
|
||||
global serial_connection, gps_enabled
|
||||
|
||||
data = request.json
|
||||
port = data.get('port')
|
||||
|
||||
try:
|
||||
if serial_connection:
|
||||
serial_connection.close()
|
||||
|
||||
serial_connection = serial.Serial(port, GPS_BAUDRATE, timeout=GPS_TIMEOUT)
|
||||
with connection_lock:
|
||||
gps_enabled = True
|
||||
|
||||
# Start GPS reading thread
|
||||
gps_thread = threading.Thread(target=gps_reader, daemon=True)
|
||||
gps_thread.start()
|
||||
|
||||
return jsonify({'status': 'success', 'message': f'Connected to {port}'})
|
||||
except Exception as e:
|
||||
return jsonify({'status': 'error', 'message': str(e)}), 400
|
||||
|
||||
@app.route('/api/gps/disconnect', methods=['POST'])
|
||||
def disconnect_gps():
|
||||
"""Disconnect GPS dongle"""
|
||||
global serial_connection, gps_enabled
|
||||
|
||||
with connection_lock:
|
||||
gps_enabled = False
|
||||
if serial_connection:
|
||||
serial_connection.close()
|
||||
serial_connection = None
|
||||
|
||||
return jsonify({'status': 'success', 'message': 'GPS disconnected'})
|
||||
|
||||
@app.route('/api/flock/connect', methods=['POST'])
|
||||
def connect_flock():
|
||||
"""Connect to Flock You device"""
|
||||
global flock_device_connected, flock_device_port, flock_serial_connection
|
||||
|
||||
data = request.json
|
||||
port = data.get('port')
|
||||
|
||||
try:
|
||||
# Create persistent connection to the port
|
||||
flock_serial_connection = serial.Serial(port, 115200, timeout=1)
|
||||
with connection_lock:
|
||||
flock_device_connected = True
|
||||
flock_device_port = port
|
||||
|
||||
# Start reading thread
|
||||
flock_thread = threading.Thread(target=flock_reader, daemon=True)
|
||||
flock_thread.start()
|
||||
|
||||
return jsonify({'status': 'success', 'message': f'Connected to Flock You device on {port}'})
|
||||
except Exception as e:
|
||||
return jsonify({'status': 'error', 'message': str(e)}), 400
|
||||
|
||||
@app.route('/api/flock/disconnect', methods=['POST'])
|
||||
def disconnect_flock():
|
||||
"""Disconnect Flock You device"""
|
||||
global flock_device_connected, flock_device_port, flock_serial_connection
|
||||
|
||||
with connection_lock:
|
||||
flock_device_connected = False
|
||||
flock_device_port = None
|
||||
|
||||
if flock_serial_connection and flock_serial_connection.is_open:
|
||||
flock_serial_connection.close()
|
||||
flock_serial_connection = None
|
||||
|
||||
return jsonify({'status': 'success', 'message': 'Flock You device disconnected'})
|
||||
|
||||
@app.route('/api/status', methods=['GET'])
|
||||
def get_status():
|
||||
"""Get connection status of both devices"""
|
||||
return jsonify({
|
||||
'gps_connected': gps_enabled,
|
||||
'gps_port': serial_connection.port if serial_connection else None,
|
||||
'flock_connected': flock_device_connected,
|
||||
'flock_port': flock_device_port
|
||||
})
|
||||
|
||||
@app.route('/api/gps/ports', methods=['GET'])
|
||||
def get_gps_ports():
|
||||
"""Get available serial ports for GPS"""
|
||||
ports = []
|
||||
for port in serial.tools.list_ports.comports():
|
||||
port_info = {
|
||||
'device': port.device,
|
||||
'description': port.description,
|
||||
'manufacturer': port.manufacturer if port.manufacturer else 'Unknown',
|
||||
'product': port.product if port.product else 'Unknown',
|
||||
'vid': port.vid,
|
||||
'pid': port.pid
|
||||
}
|
||||
ports.append(port_info)
|
||||
return jsonify(ports)
|
||||
|
||||
@app.route('/api/flock/ports', methods=['GET'])
|
||||
def get_flock_ports():
|
||||
"""Get available serial ports for Flock You device"""
|
||||
ports = []
|
||||
for port in serial.tools.list_ports.comports():
|
||||
port_info = {
|
||||
'device': port.device,
|
||||
'description': port.description,
|
||||
'manufacturer': port.manufacturer if port.manufacturer else 'Unknown',
|
||||
'product': port.product if port.product else 'Unknown',
|
||||
'vid': port.vid,
|
||||
'pid': port.pid
|
||||
}
|
||||
ports.append(port_info)
|
||||
return jsonify(ports)
|
||||
|
||||
@app.route('/api/export/csv', methods=['GET'])
|
||||
def export_csv():
|
||||
"""Export detections as CSV"""
|
||||
if not detections:
|
||||
return jsonify({'status': 'error', 'message': 'No detections to export'}), 400
|
||||
|
||||
filename = f"flockyou_detections_{datetime.now().strftime('%Y%m%d_%H%M%S')}.csv"
|
||||
filepath = os.path.join('exports', filename)
|
||||
|
||||
os.makedirs('exports', exist_ok=True)
|
||||
|
||||
with open(filepath, 'w', newline='', encoding='utf-8') as csvfile:
|
||||
fieldnames = [
|
||||
'timestamp', 'detection_time', 'protocol', 'detection_method',
|
||||
'ssid', 'mac_address', 'manufacturer', 'alias', 'rssi', 'signal_strength', 'channel',
|
||||
'latitude', 'longitude', 'altitude', 'gps_timestamp', 'satellites'
|
||||
]
|
||||
writer = csv.DictWriter(csvfile, fieldnames=fieldnames)
|
||||
writer.writeheader()
|
||||
|
||||
for detection in detections:
|
||||
row = {
|
||||
'timestamp': detection.get('timestamp'),
|
||||
'detection_time': detection.get('detection_time'),
|
||||
'protocol': detection.get('protocol'),
|
||||
'detection_method': detection.get('detection_method'),
|
||||
'ssid': detection.get('ssid', ''),
|
||||
'mac_address': detection.get('mac_address'),
|
||||
'manufacturer': detection.get('manufacturer', 'Unknown'),
|
||||
'alias': detection.get('alias', ''),
|
||||
'rssi': detection.get('rssi'),
|
||||
'signal_strength': detection.get('signal_strength'),
|
||||
'channel': detection.get('channel'),
|
||||
'latitude': detection.get('gps', {}).get('latitude'),
|
||||
'longitude': detection.get('gps', {}).get('longitude'),
|
||||
'altitude': detection.get('gps', {}).get('altitude'),
|
||||
'gps_timestamp': detection.get('gps', {}).get('timestamp'),
|
||||
'satellites': detection.get('gps', {}).get('satellites')
|
||||
}
|
||||
writer.writerow(row)
|
||||
|
||||
return send_file(filepath, as_attachment=True, download_name=filename)
|
||||
|
||||
@app.route('/api/export/kml', methods=['GET'])
|
||||
def export_kml():
|
||||
"""Export detections as KML"""
|
||||
if not detections:
|
||||
return jsonify({'status': 'error', 'message': 'No detections to export'}), 400
|
||||
|
||||
filename = f"flockyou_detections_{datetime.now().strftime('%Y%m%d_%H%M%S')}.kml"
|
||||
filepath = os.path.join('exports', filename)
|
||||
|
||||
os.makedirs('exports', exist_ok=True)
|
||||
|
||||
kml_content = f"""<?xml version="1.0" encoding="UTF-8"?>
|
||||
<kml xmlns="http://www.opengis.net/kml/2.2">
|
||||
<Document>
|
||||
<name>Flock You Detections</name>
|
||||
<description>Surveillance device detections with GPS coordinates</description>
|
||||
"""
|
||||
|
||||
for i, detection in enumerate(detections):
|
||||
gps = detection.get('gps', {})
|
||||
if gps.get('latitude') and gps.get('longitude'):
|
||||
kml_content += f"""
|
||||
<Placemark>
|
||||
<name>Detection {i+1}</name>
|
||||
<description>
|
||||
<![CDATA[
|
||||
<b>Protocol:</b> {detection.get('protocol')}<br/>
|
||||
<b>Method:</b> {detection.get('detection_method')}<br/>
|
||||
<b>SSID:</b> {detection.get('ssid', 'N/A')}<br/>
|
||||
<b>MAC:</b> {detection.get('mac_address')}<br/>
|
||||
<b>Manufacturer:</b> {detection.get('manufacturer', 'Unknown')}<br/>
|
||||
<b>Alias:</b> {detection.get('alias', 'N/A')}<br/>
|
||||
<b>RSSI:</b> {detection.get('rssi')} dBm<br/>
|
||||
<b>Signal:</b> {detection.get('signal_strength')}<br/>
|
||||
<b>Channel:</b> {detection.get('channel')}<br/>
|
||||
<b>Time:</b> {detection.get('detection_time')}<br/>
|
||||
<b>GPS Satellites:</b> {gps.get('satellites', 'N/A')}
|
||||
]]>
|
||||
</description>
|
||||
<Point>
|
||||
<coordinates>{gps.get('longitude')},{gps.get('latitude')},{gps.get('altitude', 0)}</coordinates>
|
||||
</Point>
|
||||
</Placemark>
|
||||
"""
|
||||
|
||||
kml_content += """
|
||||
</Document>
|
||||
</kml>"""
|
||||
|
||||
with open(filepath, 'w', encoding='utf-8') as f:
|
||||
f.write(kml_content)
|
||||
|
||||
return send_file(filepath, as_attachment=True, download_name=filename)
|
||||
|
||||
@app.route('/api/clear', methods=['POST'])
|
||||
def clear_detections():
|
||||
"""Clear all detections"""
|
||||
global detections, next_detection_id
|
||||
detections.clear()
|
||||
next_detection_id = 1 # Reset ID counter
|
||||
safe_socket_emit('detections_cleared', {})
|
||||
return jsonify({'status': 'success', 'message': 'All detections cleared'})
|
||||
|
||||
@app.route('/api/test/detection', methods=['POST'])
|
||||
def test_detection():
|
||||
"""Test endpoint to add a sample detection"""
|
||||
sample_detection = {
|
||||
'detection_method': 'probe_request',
|
||||
'protocol': 'wifi',
|
||||
'mac_address': 'AA:BB:CC:DD:EE:FF',
|
||||
'ssid': 'TestNetwork',
|
||||
'rssi': -45,
|
||||
'signal_strength': 'Excellent',
|
||||
'channel': 6,
|
||||
'detection_time': datetime.now().strftime('%Y-%m-%d %H:%M:%S'),
|
||||
'timestamp': datetime.now().isoformat()
|
||||
}
|
||||
|
||||
add_detection_from_serial(sample_detection)
|
||||
return jsonify({'status': 'success', 'message': 'Test detection added'})
|
||||
|
||||
@app.route('/api/detection/alias', methods=['POST'])
|
||||
def update_detection_alias():
|
||||
"""Update detection alias"""
|
||||
global detections
|
||||
|
||||
data = request.json
|
||||
detection_id = data.get('id')
|
||||
alias = data.get('alias', '').strip()
|
||||
|
||||
if detection_id is None:
|
||||
return jsonify({'status': 'error', 'message': 'Detection ID required'}), 400
|
||||
|
||||
# Find and update the detection
|
||||
for detection in detections:
|
||||
if detection.get('id') == detection_id:
|
||||
detection['alias'] = alias
|
||||
# Emit update to all clients
|
||||
safe_socket_emit('detection_updated', detection)
|
||||
return jsonify({'status': 'success', 'message': 'Alias updated'})
|
||||
|
||||
return jsonify({'status': 'error', 'message': 'Detection not found'}), 404
|
||||
|
||||
@app.route('/api/oui/search', methods=['POST'])
|
||||
def search_oui():
|
||||
"""Search OUI database"""
|
||||
global oui_database
|
||||
|
||||
data = request.json
|
||||
query = data.get('query', '').strip()
|
||||
|
||||
if not query:
|
||||
return jsonify({'status': 'error', 'message': 'Query required'}), 400
|
||||
|
||||
results = []
|
||||
|
||||
# Clean the query - remove colons and spaces, convert to uppercase
|
||||
clean_query = query.replace(':', '').replace(' ', '').upper()
|
||||
|
||||
# Check if query looks like a MAC address (6 hex characters)
|
||||
if len(clean_query) >= 6 and all(c in '0123456789ABCDEF' for c in clean_query[:6]):
|
||||
# Search by MAC prefix
|
||||
mac_prefix = clean_query[:6]
|
||||
if mac_prefix in oui_database:
|
||||
results.append({
|
||||
'mac': mac_prefix,
|
||||
'manufacturer': oui_database[mac_prefix]
|
||||
})
|
||||
else:
|
||||
# Search by manufacturer name
|
||||
query_lower = query.lower()
|
||||
for mac, manufacturer in oui_database.items():
|
||||
if query_lower in manufacturer.lower():
|
||||
results.append({
|
||||
'mac': mac,
|
||||
'manufacturer': manufacturer
|
||||
})
|
||||
if len(results) >= 100: # Increased limit
|
||||
break
|
||||
|
||||
print(f"Search query: '{query}' -> '{clean_query}', found {len(results)} results")
|
||||
|
||||
return jsonify({
|
||||
'status': 'success',
|
||||
'results': results,
|
||||
'count': len(results)
|
||||
})
|
||||
|
||||
@app.route('/api/oui/all')
|
||||
def get_all_oui():
|
||||
"""Get all OUI entries"""
|
||||
global oui_database
|
||||
|
||||
# Return all entries
|
||||
results = []
|
||||
for mac, manufacturer in oui_database.items():
|
||||
results.append({
|
||||
'mac': mac,
|
||||
'manufacturer': manufacturer
|
||||
})
|
||||
|
||||
return jsonify({
|
||||
'status': 'success',
|
||||
'results': results,
|
||||
'count': len(results),
|
||||
'total': len(oui_database)
|
||||
})
|
||||
|
||||
@app.route('/api/oui/refresh', methods=['POST'])
|
||||
def refresh_oui_database():
|
||||
"""Refresh OUI database from IEEE website"""
|
||||
global oui_database
|
||||
|
||||
try:
|
||||
import urllib.request
|
||||
import tempfile
|
||||
import os
|
||||
|
||||
# Download the latest OUI database
|
||||
url = "https://standards-oui.ieee.org/oui/oui.txt"
|
||||
print(f"Downloading OUI database from {url}...")
|
||||
|
||||
# Create a temporary file
|
||||
with tempfile.NamedTemporaryFile(delete=False, suffix='.txt') as temp_file:
|
||||
temp_path = temp_file.name
|
||||
|
||||
# Download the file
|
||||
urllib.request.urlretrieve(url, temp_path)
|
||||
|
||||
# Parse the downloaded file
|
||||
new_oui_database = {}
|
||||
with open(temp_path, 'r', encoding='utf-8', errors='ignore') as f:
|
||||
for line in f:
|
||||
line = line.strip()
|
||||
if line and not line.startswith('#') and '\t' in line:
|
||||
parts = line.split('\t')
|
||||
if len(parts) >= 3:
|
||||
mac = parts[0].strip().replace('-', '').upper()
|
||||
manufacturer = parts[2].strip()
|
||||
if len(mac) == 6 and manufacturer:
|
||||
new_oui_database[mac] = manufacturer
|
||||
|
||||
# Clean up temporary file
|
||||
os.unlink(temp_path)
|
||||
|
||||
# Update the global database
|
||||
oui_database = new_oui_database
|
||||
|
||||
# Save to local file
|
||||
with open('oui.txt', 'w', encoding='utf-8') as f:
|
||||
for mac, manufacturer in oui_database.items():
|
||||
f.write(f"{mac}\t{manufacturer}\n")
|
||||
|
||||
print(f"Successfully refreshed OUI database with {len(oui_database)} entries")
|
||||
|
||||
return jsonify({
|
||||
'status': 'success',
|
||||
'message': 'Database refreshed successfully',
|
||||
'count': len(oui_database)
|
||||
})
|
||||
|
||||
except Exception as e:
|
||||
print(f"Error refreshing OUI database: {str(e)}")
|
||||
return jsonify({
|
||||
'status': 'error',
|
||||
'message': f'Failed to refresh database: {str(e)}'
|
||||
}), 500
|
||||
|
||||
# Socket.IO event handlers
|
||||
@socketio.on('connect')
|
||||
def handle_connect():
|
||||
print(f"Client connected: {request.sid}")
|
||||
|
||||
@socketio.on('disconnect')
|
||||
def handle_disconnect():
|
||||
print(f"Client disconnected: {request.sid}")
|
||||
# Clean up any room memberships
|
||||
try:
|
||||
leave_room('serial_terminal')
|
||||
except:
|
||||
pass
|
||||
|
||||
@socketio.on('heartbeat')
|
||||
def handle_heartbeat():
|
||||
"""Handle client heartbeat to keep connection alive"""
|
||||
try:
|
||||
emit('heartbeat_ack')
|
||||
except Exception as e:
|
||||
print(f"Heartbeat response error: {e}")
|
||||
|
||||
def send_heartbeat():
|
||||
"""Send periodic heartbeat to all clients"""
|
||||
while True:
|
||||
try:
|
||||
safe_socket_emit('heartbeat', {})
|
||||
time.sleep(30) # Send heartbeat every 30 seconds
|
||||
except Exception as e:
|
||||
print(f"Heartbeat error: {e}")
|
||||
time.sleep(5)
|
||||
|
||||
@socketio.on('request_serial_terminal')
|
||||
def handle_serial_terminal_request(data):
|
||||
"""Handle serial terminal connection request"""
|
||||
global serial_data_buffer
|
||||
port = data.get('port')
|
||||
|
||||
print(f"Serial terminal request from {request.sid} for port: {port}")
|
||||
|
||||
if not port:
|
||||
emit('serial_error', {'message': 'No port specified'})
|
||||
return
|
||||
|
||||
if not flock_device_connected or flock_device_port != port:
|
||||
emit('serial_error', {'message': 'Device not connected. Please connect to the Sniffer device first.'})
|
||||
return
|
||||
|
||||
try:
|
||||
# Add to serial terminal room
|
||||
join_room('serial_terminal')
|
||||
emit('serial_connected')
|
||||
|
||||
# Send recent buffer data
|
||||
buffer_count = len(serial_data_buffer)
|
||||
print(f"Sending {min(50, buffer_count)} recent lines to terminal")
|
||||
for line in serial_data_buffer[-50:]: # Send last 50 lines
|
||||
emit('serial_data', line)
|
||||
|
||||
print(f"Serial terminal connected for client {request.sid}")
|
||||
|
||||
except Exception as e:
|
||||
print(f"Serial terminal connection error: {e}")
|
||||
emit('serial_error', {'message': f'Failed to start terminal: {str(e)}'})
|
||||
|
||||
if __name__ == '__main__':
|
||||
# Load OUI database on startup
|
||||
load_oui_database()
|
||||
|
||||
# Start connection monitor thread
|
||||
monitor_thread = threading.Thread(target=connection_monitor, daemon=True)
|
||||
monitor_thread.start()
|
||||
|
||||
# Start heartbeat thread
|
||||
heartbeat_thread = threading.Thread(target=send_heartbeat, daemon=True)
|
||||
heartbeat_thread.start()
|
||||
|
||||
print("Starting Flock You API server...")
|
||||
print("Server will be available at: http://localhost:5000")
|
||||
print("Press Ctrl+C to stop the server")
|
||||
|
||||
try:
|
||||
socketio.run(app, debug=False, host='0.0.0.0', port=5000, allow_unsafe_werkzeug=True)
|
||||
except KeyboardInterrupt:
|
||||
print("\nShutting down server...")
|
||||
# Clean up connections
|
||||
if flock_serial_connection and flock_serial_connection.is_open:
|
||||
flock_serial_connection.close()
|
||||
if serial_connection and serial_connection.is_open:
|
||||
serial_connection.close()
|
||||
print("Server stopped.")
|
||||
+227265
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,6 @@
|
||||
Flask==2.3.3
|
||||
Flask-SocketIO==5.3.6
|
||||
python-socketio==5.8.0
|
||||
python-engineio==4.7.1
|
||||
pyserial==3.5
|
||||
Werkzeug==2.3.7
|
||||
File diff suppressed because it is too large
Load Diff
+28
-2
@@ -87,7 +87,33 @@ static unsigned long last_detection_time = 0;
|
||||
static unsigned long last_heartbeat = 0;
|
||||
static NimBLEScan* pBLEScan;
|
||||
|
||||
// ============================================================================
|
||||
// SYSTEM BANNER & DISPLAY
|
||||
// ============================================================================
|
||||
|
||||
static void display_banner(void)
|
||||
{
|
||||
printf("\n"
|
||||
"╔══════════════════════════════════════════════════════════════╗\n"
|
||||
"║ ║\n"
|
||||
"║ ███████╗██╗ ██╗ █████╗ ██╗ ██╗██╗ ██╗ ║\n"
|
||||
"║ ██╔════╝██║ ██║ ██╔══██╗██║ ██╔╝██║ ██╔╝ ║\n"
|
||||
"║ ███████╗██║ ██║ ███████║█████╔╝ █████╔╝ ║\n"
|
||||
"║ ╚════██║██║ ██║ ██╔══██║██╔═██╗ ██╔═██╗ ║\n"
|
||||
"║ ███████║███████╗███████╗██║ ██║██║ ██╗██║ ██╗ ║\n"
|
||||
"║ ╚══════╝╚══════╝╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═╝ ║\n"
|
||||
"║ ║\n"
|
||||
"║ FLOCK SAFETY DETECTOR - ENHANCED ║\n"
|
||||
"║ SQUAWK v2.0 ║\n"
|
||||
"║ ║\n"
|
||||
"║ 🦅 Multi-Method Detection System 🦅 ║\n"
|
||||
"║ 📡 WiFi + BLE + MAC + Device Name Detection ║\n"
|
||||
"║ 🔊 Audio Alerts with Distinct Sound Patterns ║\n"
|
||||
"║ 🎯 Real-World Device Database Integration ║\n"
|
||||
"║ 📊 JSON Detection Output with Full Device Info ║\n"
|
||||
"║ ║\n"
|
||||
"╚══════════════════════════════════════════════════════════════╝\n\n");
|
||||
}
|
||||
|
||||
// ============================================================================
|
||||
// AUDIO SYSTEM
|
||||
@@ -487,7 +513,7 @@ void setup()
|
||||
Serial.begin(115200);
|
||||
delay(1000);
|
||||
|
||||
|
||||
display_banner();
|
||||
|
||||
// Initialize buzzer
|
||||
pinMode(BUZZER_PIN, OUTPUT);
|
||||
@@ -551,4 +577,4 @@ void loop()
|
||||
pBLEScan->clearResults();
|
||||
|
||||
delay(100);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user