diff --git a/README.md b/README.md index 9b0d58a..02572f9 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,130 @@ - # 🛰️ Orion RF (WIP) -**Orion RF** is a portable RF & wireless experimentation toolkit built for the ESP32 platform. +**Orion RF** is a portable RF & wireless experimentation toolkit built for the ESP32 platform with NRF24 support. -> ⚠️ This project is **work in progress** — many features are planned but not yet implemented. +> ⚠️ This project is currently under active development. Some features are experimental, incomplete, or may change frequently. --- -## 🚀 Current Features +# 🚀 Current Features -* **BLE Scanning** +## 📡 Wireless Tools - * Discover nearby Bluetooth Low Energy devices - * Display device info (MAC, RSSI, etc.) +### BLE Scan +- Discover nearby Bluetooth Low Energy devices +- View MAC address, RSSI, and device information +- Real-time scanning interface -* **WiFi Scanning** +### WiFi Scan +- Scan nearby WiFi access points +- View: + - SSID + - Signal strength (RSSI) + - Channel + - Encryption type - * Scan nearby access points - * View SSID, signal strength, channel, encryption - -* **WiFi Packet Analysis** - - * Basic packet inspection and monitoring - * Useful for learning wireless traffic behavior - -* **BadUSB** - - * HID-based payload execution - * Emulate keyboard input for automation/testing - -- **Jammer ()** - - - BLE/Bluetooth Jammer (Works with single NRF right now) +### WiFi Analyzer +- Analyze surrounding WiFi activity +- Useful for understanding channel congestion and wireless environments +### RF Capture *(WIP)* +- Experimental RF packet capture functionality +- Replay support planned --- -## 🧩 Project Status +# 📻 NRF24 Tools -| Feature | Status | -| ----------------- | ---------- | -| BLE Scan | ✅ Working | -| WiFi Scan | ✅ Working | -| Packet Analysis | ✅ Working | -| BadUSB | ✅ Working | -| Jammer | Works Partially | -| SD Card | 🚧 WIP | -| RF Capture/Replay | 🚧 WIP | -| Emulator | 🚧 WIP | -| NFC | 🚧 Planned | +### BLE Jammer +- NRF24-based BLE interference testing +- Functional +### Bluetooth Jammer +- NRF24-based Bluetooth interference testing +- Functional + +### WiFi Jammer +- NRF24-based WiFi interference testing +- Experimental + +> ⚠️ These tools are intended strictly for wireless research, testing, and educational purposes in authorized environments. + +--- + +# ⌨️ BadUSB + +- HID keyboard emulation +- Execute automated payloads/scripts +- Useful for testing and automation workflows + +--- + +# 🖱️ BLE Mouse + +- ESP32-based Bluetooth mouse emulation +- Experimental HID functionality + +--- + +# 🔧 System Utilities + +### System Info +- Display device/system information +- Useful for debugging and diagnostics + +### Device Check +- Verify connected peripherals/modules +- Hardware diagnostics utility + +### Restart +- Quick device reboot option from UI + +--- + +# 🧩 Project Status + +| Feature | Status | +| -------------------- | ----------------- | +| BLE Scan | ✅ Working | +| WiFi Scan | ✅ Working | +| WiFi Analyzer | ✅ Working | +| BadUSB | ✅ Working | +| BLE Mouse | ✅ Working | +| BLE Jammer | ✅ Working | +| Bluetooth Jammer | ✅ Working | +| WiFi Jammer | ⚠️ Experimental | +| RF Capture | 🚧 WIP | +| RF Replay | 🚧 WIP | +| SD Card Support | 🚧 Planned | +| Emulator | 🚧 Planned | +| NFC | 🚧 Planned | + +--- + +# 🛠️ Hardware + +- 1 x ESP32-S3 +- 2 x NRF24L01 Modules +- 2 x CC1101 Modules +- 1 x OLED Display +- Battery-powered portable setup + +--- + +# 📌 Notes + +- Designed primarily for learning, experimentation, and embedded RF research +- Optimized for portable usage +- UI-driven navigation system + +--- + +# ⚖️ Disclaimer + +This project is intended for: +- Educational purposes +- RF experimentation +- Hardware research +- Authorized security testing + +The authors are not responsible for misuse or illegal operation of this project.