orion-rf278646b
unshittify README.md
+50 −122
1 file changed
- M README.md +50 −122
| @@ -1,128 +1,56 @@ | |||
| 1 | − | # 🛰️ Orion RF (WIP) | |
| 2 | − | ||
| 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 | |
| 17 | − | ||
| 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 | |
| 33 | − | ||
| 34 | − | --- | |
| 35 | − | ||
| 36 | − | # 📻 NRF24 Tools | |
| 37 | − | ||
| 38 | − | ### BLE Jammer | |
| 39 | − | - NRF24-based BLE interference testing | |
| 40 | − | - Functional | |
| 41 | − | ||
| 42 | − | ### Bluetooth Jammer | |
| 43 | − | - NRF24-based Bluetooth interference testing | |
| 44 | − | - Functional | |
| 45 | − | ||
| 46 | − | ### WiFi Jammer | |
| 47 | − | - NRF24-based WiFi interference testing | |
| 48 | − | - Able to jam 2.4Ghz wifi connections (Not 5G) | |
| 49 | − | ||
| 50 | − | --- | |
| 51 | − | ||
| 52 | − | # ⌨️ BadUSB | |
| 53 | − | ||
| 54 | − | - HID keyboard emulation | |
| 55 | − | - Execute automated payloads/scripts | |
| 56 | − | - Useful for testing and automation workflows | |
| 57 | − | ||
| 58 | − | --- | |
| 59 | − | ||
| 60 | − | # 🖱️ BLE Mouse | |
| 61 | − | ||
| 62 | − | - ESP32-based Bluetooth mouse emulation | |
| 63 | − | - Experimental HID functionality | |
| 64 | − | ||
| 65 | − | --- | |
| 66 | − | ||
| 67 | − | # 🔧 System Utilities | |
| 68 | − | ||
| 69 | − | ### System Info | |
| 70 | − | - Display device/system information | |
| 71 | − | - Useful for debugging and diagnostics | |
| 72 | − | ||
| 73 | − | ### Device Check | |
| 74 | − | - Verify connected peripherals/modules | |
| 75 | − | - Hardware diagnostics utility | |
| 76 | − | ||
| 77 | − | ### Restart | |
| 78 | − | - Quick device reboot option from UI | |
| 79 | − | ||
| 80 | − | --- | |
| 81 | − | ||
| 82 | − | # 🧩 Project Status | |
| 83 | − | ||
| 84 | − | | Feature | Status | | |
| 85 | − | | -------------------- | ----------------- | | |
| 86 | − | | BLE Scan | ✅ Working | | |
| 87 | − | | WiFi Scan | ✅ Working | | |
| 88 | − | | WiFi Analyzer | ✅ Working | | |
| 89 | − | | BadUSB | ✅ Working | | |
| 90 | − | | BLE Mouse | ✅ Working | | |
| 91 | − | | BLE Jammer | ✅ Working | | |
| 92 | − | | Bluetooth Jammer | ✅ Working | | |
| 93 | − | | WiFi Jammer | ⚠️ Experimental | | |
| 94 | − | | RF Capture | 🚧 WIP | | |
| 95 | − | | RF Replay | 🚧 WIP | | |
| 96 | − | | SD Card Support | 🚧 Planned | | |
| 97 | − | | Emulator | 🚧 Planned | | |
| 98 | − | | NFC | 🚧 Planned | | |
| 99 | − | ||
| 100 | − | --- | |
| 101 | − | ||
| 102 | − | # 🛠️ Hardware | |
| 103 | − | ||
| 104 | − | - 1 x ESP32-S3 | |
| 105 | − | - 2 x NRF24L01 Modules | |
| 106 | − | - 2 x CC1101 Modules | |
| 107 | − | - 1 x OLED Display | |
| 1 | + | # Orion RF | |
| 2 | + | ||
| 3 | + | Orion RF is a portable RF and wireless toolkit built on the ESP32 platform with NRF24 and CC1101 support. | |
| 4 | + | ||
| 5 | + | ## Features | |
| 6 | + | ||
| 7 | + | ### Wireless | |
| 8 | + | - BLE scanning | |
| 9 | + | - WiFi scanning | |
| 10 | + | - WiFi analyzer | |
| 11 | + | - RF capture (WIP) | |
| 12 | + | - RF replay (planned) | |
| 13 | + | ||
| 14 | + | ### NRF24 | |
| 15 | + | - BLE interference testing | |
| 16 | + | - Bluetooth interference testing | |
| 17 | + | - WiFi interference testing | |
| 18 | + | ||
| 19 | + | ### HID | |
| 20 | + | - BadUSB keyboard emulation | |
| 21 | + | - BLE mouse emulation | |
| 22 | + | ||
| 23 | + | ### Utilities | |
| 24 | + | - System information | |
| 25 | + | - Hardware diagnostics | |
| 26 | + | - Device restart | |
| 27 | + | ||
| 28 | + | ## Hardware | |
| 29 | + | - ESP32-S3 N16R8 | |
| 30 | + | - 2x NRF24L01 | |
| 31 | + | - 2x CC1101 | |
| 32 | + | - OLED display | |
| 108 | 33 | - Battery-powered portable setup | |
| 109 | 34 | ||
| 110 | − | --- | |
| 111 | − | ||
| 112 | − | # 📌 Notes | |
| 113 | − | ||
| 114 | − | - Designed primarily for learning, experimentation, and embedded RF research | |
| 115 | − | - Optimized for portable usage | |
| 116 | − | - UI-driven navigation system | |
| 35 | + | ## Status | |
| 117 | 36 | ||
| 118 | − | --- | |
| 37 | + | | Feature | Status | | |
| 38 | + | |---|---| | |
| 39 | + | | BLE Scan | Working | | |
| 40 | + | | WiFi Scan | Working | | |
| 41 | + | | WiFi Analyzer | Working | | |
| 42 | + | | BadUSB | Working | | |
| 43 | + | | BLE Mouse | Working | | |
| 44 | + | | BLE Jammer | Working | | |
| 45 | + | | Bluetooth Jammer | Working | | |
| 46 | + | | WiFi Jammer | Experimental | | |
| 47 | + | | RF Capture | WIP | | |
| 48 | + | | RF Replay | WIP | | |
| 49 | + | | SD Card Support | Planned | | |
| 50 | + | | Emulator | Planned | | |
| 51 | + | | NFC | WIP | | |
| 119 | 52 | ||
| 120 | − | # ⚖️ Disclaimer | |
| 121 | 53 | ||
| 122 | − | This project is intended for: | |
| 123 | − | - Educational purposes | |
| 124 | − | - RF experimentation | |
| 125 | − | - Hardware research | |
| 126 | − | - Authorized security testing | |
| 54 | + | ## Disclaimer | |
| 127 | 55 | ||
| 128 | − | The authors are not responsible for misuse or illegal operation of this project. | |
| 56 | + | Use responsibly and only where authorized. | |