summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorkrolyxon <me@krolyxon.com>2026-05-06 15:35:05 +0530
committerkrolyxon <me@krolyxon.com>2026-05-06 15:35:05 +0530
commitef5352a7f1964335630790fbf72d9d2a43815523 (patch)
tree574c15d0340f7d6956ee2c20ccfd6c9ac8f7ea17 /README.md
parenta51e4c5c84622ff80fdf16c16fb6dccda5950213 (diff)
update features in readme.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md138
1 files changed, 108 insertions, 30 deletions
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 currently under active development. Some features are experimental, incomplete, or may change frequently.
+
+---
+
+# 🚀 Current Features
+
+## 📡 Wireless Tools
+
+### BLE Scan
+- Discover nearby Bluetooth Low Energy devices
+- View MAC address, RSSI, and device information
+- Real-time scanning interface
-> ⚠️ This project is **work in progress** — many features are planned but not yet implemented.
+### WiFi Scan
+- Scan nearby WiFi access points
+- View:
+ - SSID
+ - Signal strength (RSSI)
+ - Channel
+ - Encryption type
+
+### 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
---
-## 🚀 Current Features
+# 📻 NRF24 Tools
-* **BLE Scanning**
+### BLE Jammer
+- NRF24-based BLE interference testing
+- Functional
- * Discover nearby Bluetooth Low Energy devices
- * Display device info (MAC, RSSI, etc.)
+### Bluetooth Jammer
+- NRF24-based Bluetooth interference testing
+- Functional
-* **WiFi Scanning**
+### WiFi Jammer
+- NRF24-based WiFi interference testing
+- Experimental
- * Scan nearby access points
- * View SSID, signal strength, channel, encryption
+> ⚠️ These tools are intended strictly for wireless research, testing, and educational purposes in authorized environments.
-* **WiFi Packet Analysis**
+---
- * Basic packet inspection and monitoring
- * Useful for learning wireless traffic behavior
+# ⌨️ BadUSB
-* **BadUSB**
+- HID keyboard emulation
+- Execute automated payloads/scripts
+- Useful for testing and automation workflows
- * HID-based payload execution
- * Emulate keyboard input for automation/testing
+---
-- **Jammer ()**
+# 🖱️ 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
+
+---
- - BLE/Bluetooth Jammer (Works with single NRF right now)
+# 📌 Notes
+- Designed primarily for learning, experimentation, and embedded RF research
+- Optimized for portable usage
+- UI-driven navigation system
---
-## 🧩 Project Status
+# ⚖️ Disclaimer
-| 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 |
+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.