orion-rfef5352a
update features in readme.md
+108 −30
1 file changed
- M README.md +108 −30
| @@ -1,52 +1,130 @@ | |||
| 1 | − | ||
| 2 | 1 | # 🛰️ Orion RF (WIP) | |
| 3 | 2 | ||
| 4 | − | **Orion RF** is a portable RF & wireless experimentation toolkit built for the ESP32 platform. | |
| 3 | + | **Orion RF** is a portable RF & wireless experimentation toolkit built for the ESP32 platform with NRF24 support. | |
| 4 | + | ||
| 5 | + | > ⚠️ This project is currently under active development. Some features are experimental, incomplete, or may change frequently. | |
| 6 | + | ||
| 7 | + | --- | |
| 8 | + | ||
| 9 | + | # 🚀 Current Features | |
| 10 | + | ||
| 11 | + | ## 📡 Wireless Tools | |
| 12 | + | ||
| 13 | + | ### BLE Scan | |
| 14 | + | - Discover nearby Bluetooth Low Energy devices | |
| 15 | + | - View MAC address, RSSI, and device information | |
| 16 | + | - Real-time scanning interface | |
| 5 | 17 | ||
| 6 | − | > ⚠️ This project is **work in progress** — many features are planned but not yet implemented. | |
| 18 | + | ### WiFi Scan | |
| 19 | + | - Scan nearby WiFi access points | |
| 20 | + | - View: | |
| 21 | + | - SSID | |
| 22 | + | - Signal strength (RSSI) | |
| 23 | + | - Channel | |
| 24 | + | - Encryption type | |
| 25 | + | ||
| 26 | + | ### WiFi Analyzer | |
| 27 | + | - Analyze surrounding WiFi activity | |
| 28 | + | - Useful for understanding channel congestion and wireless environments | |
| 29 | + | ||
| 30 | + | ### RF Capture *(WIP)* | |
| 31 | + | - Experimental RF packet capture functionality | |
| 32 | + | - Replay support planned | |
| 7 | 33 | ||
| 8 | 34 | --- | |
| 9 | 35 | ||
| 10 | − | ## 🚀 Current Features | |
| 36 | + | # 📻 NRF24 Tools | |
| 11 | 37 | ||
| 12 | − | * **BLE Scanning** | |
| 38 | + | ### BLE Jammer | |
| 39 | + | - NRF24-based BLE interference testing | |
| 40 | + | - Functional | |
| 13 | 41 | ||
| 14 | − | * Discover nearby Bluetooth Low Energy devices | |
| 15 | − | * Display device info (MAC, RSSI, etc.) | |
| 42 | + | ### Bluetooth Jammer | |
| 43 | + | - NRF24-based Bluetooth interference testing | |
| 44 | + | - Functional | |
| 16 | 45 | ||
| 17 | − | * **WiFi Scanning** | |
| 46 | + | ### WiFi Jammer | |
| 47 | + | - NRF24-based WiFi interference testing | |
| 48 | + | - Experimental | |
| 18 | 49 | ||
| 19 | − | * Scan nearby access points | |
| 20 | − | * View SSID, signal strength, channel, encryption | |
| 50 | + | > ⚠️ These tools are intended strictly for wireless research, testing, and educational purposes in authorized environments. | |
| 21 | 51 | ||
| 22 | − | * **WiFi Packet Analysis** | |
| 52 | + | --- | |
| 23 | 53 | ||
| 24 | − | * Basic packet inspection and monitoring | |
| 25 | − | * Useful for learning wireless traffic behavior | |
| 54 | + | # ⌨️ BadUSB | |
| 26 | 55 | ||
| 27 | − | * **BadUSB** | |
| 56 | + | - HID keyboard emulation | |
| 57 | + | - Execute automated payloads/scripts | |
| 58 | + | - Useful for testing and automation workflows | |
| 28 | 59 | ||
| 29 | − | * HID-based payload execution | |
| 30 | − | * Emulate keyboard input for automation/testing | |
| 60 | + | --- | |
| 31 | 61 | ||
| 32 | − | - **Jammer ()** | |
| 62 | + | # 🖱️ BLE Mouse | |
| 63 | + | ||
| 64 | + | - ESP32-based Bluetooth mouse emulation | |
| 65 | + | - Experimental HID functionality | |
| 66 | + | ||
| 67 | + | --- | |
| 68 | + | ||
| 69 | + | # 🔧 System Utilities | |
| 70 | + | ||
| 71 | + | ### System Info | |
| 72 | + | - Display device/system information | |
| 73 | + | - Useful for debugging and diagnostics | |
| 74 | + | ||
| 75 | + | ### Device Check | |
| 76 | + | - Verify connected peripherals/modules | |
| 77 | + | - Hardware diagnostics utility | |
| 78 | + | ||
| 79 | + | ### Restart | |
| 80 | + | - Quick device reboot option from UI | |
| 81 | + | ||
| 82 | + | --- | |
| 83 | + | ||
| 84 | + | # 🧩 Project Status | |
| 85 | + | ||
| 86 | + | | Feature | Status | | |
| 87 | + | | -------------------- | ----------------- | | |
| 88 | + | | BLE Scan | ✅ Working | | |
| 89 | + | | WiFi Scan | ✅ Working | | |
| 90 | + | | WiFi Analyzer | ✅ Working | | |
| 91 | + | | BadUSB | ✅ Working | | |
| 92 | + | | BLE Mouse | ✅ Working | | |
| 93 | + | | BLE Jammer | ✅ Working | | |
| 94 | + | | Bluetooth Jammer | ✅ Working | | |
| 95 | + | | WiFi Jammer | ⚠️ Experimental | | |
| 96 | + | | RF Capture | 🚧 WIP | | |
| 97 | + | | RF Replay | 🚧 WIP | | |
| 98 | + | | SD Card Support | 🚧 Planned | | |
| 99 | + | | Emulator | 🚧 Planned | | |
| 100 | + | | NFC | 🚧 Planned | | |
| 101 | + | ||
| 102 | + | --- | |
| 103 | + | ||
| 104 | + | # 🛠️ Hardware | |
| 105 | + | ||
| 106 | + | - 1 x ESP32-S3 | |
| 107 | + | - 2 x NRF24L01 Modules | |
| 108 | + | - 2 x CC1101 Modules | |
| 109 | + | - 1 x OLED Display | |
| 110 | + | - Battery-powered portable setup | |
| 111 | + | ||
| 112 | + | --- | |
| 33 | 113 | ||
| 34 | − | - BLE/Bluetooth Jammer (Works with single NRF right now) | |
| 114 | + | # 📌 Notes | |
| 35 | 115 | ||
| 116 | + | - Designed primarily for learning, experimentation, and embedded RF research | |
| 117 | + | - Optimized for portable usage | |
| 118 | + | - UI-driven navigation system | |
| 36 | 119 | ||
| 37 | 120 | --- | |
| 38 | 121 | ||
| 39 | − | ## 🧩 Project Status | |
| 122 | + | # ⚖️ Disclaimer | |
| 40 | 123 | ||
| 41 | − | | Feature | Status | | |
| 42 | − | | ----------------- | ---------- | | |
| 43 | − | | BLE Scan | ✅ Working | | |
| 44 | − | | WiFi Scan | ✅ Working | | |
| 45 | − | | Packet Analysis | ✅ Working | | |
| 46 | − | | BadUSB | ✅ Working | | |
| 47 | − | | Jammer | Works Partially | | |
| 48 | − | | SD Card | 🚧 WIP | | |
| 49 | − | | RF Capture/Replay | 🚧 WIP | | |
| 50 | − | | Emulator | 🚧 WIP | | |
| 51 | − | | NFC | 🚧 Planned | | |
| 124 | + | This project is intended for: | |
| 125 | + | - Educational purposes | |
| 126 | + | - RF experimentation | |
| 127 | + | - Hardware research | |
| 128 | + | - Authorized security testing | |
| 52 | 129 | ||
| 130 | + | The authors are not responsible for misuse or illegal operation of this project. | |