| 1 | <div align="center"> |
| 2 | <img src="assets/logo.png" width="250" alt="Orion RF Logo" /> |
| 3 | <p>Portable RF & Wireless Toolkit for ESP32</p> |
| 4 | </div> |
| 5 | |
| 6 | |
| 7 | ## Features |
| 8 | |
| 9 | ### Wireless |
| 10 | - BLE scanning |
| 11 | - WiFi scanning |
| 12 | - WiFi analyzer |
| 13 | - RF capture (WIP) |
| 14 | - RF replay (planned) |
| 15 | |
| 16 | ### NRF24 |
| 17 | - BLE interference testing |
| 18 | - Bluetooth interference testing |
| 19 | - WiFi interference testing |
| 20 | |
| 21 | ### HID |
| 22 | - BadUSB keyboard emulation |
| 23 | - BLE mouse emulation |
| 24 | |
| 25 | ### Utilities |
| 26 | - System information |
| 27 | - Hardware diagnostics |
| 28 | - Device restart |
| 29 | |
| 30 | ## Hardware |
| 31 | - ESP32-S3 N16R8 |
| 32 | - 2x NRF24L01 Module |
| 33 | - 2x CC1101 Module |
| 34 | - PN532 NFC Module |
| 35 | - MicroSD card Module |
| 36 | - TP4056 Charging Module |
| 37 | - OLED display |
| 38 | - Battery-powered portable setup |
| 39 | |
| 40 | ## Status |
| 41 | |
| 42 | | Feature | Status | |
| 43 | |---|---| |
| 44 | | BLE Scan | Working | |
| 45 | | WiFi Scan | Working | |
| 46 | | WiFi Analyzer | Working | |
| 47 | | BadUSB | Working | |
| 48 | | BLE Mouse | Working | |
| 49 | | BLE Jammer | Working | |
| 50 | | Bluetooth Jammer | Working | |
| 51 | | WiFi Jammer | Working | |
| 52 | | RF Capture | WIP | |
| 53 | | RF Replay | WIP | |
| 54 | | SD Card Support | Planned | |
| 55 | | Emulator | Planned | |
| 56 | | NFC | WIP | |
| 57 | |
| 58 | |
| 59 | ## Installation |
| 60 | |
| 61 | ### End User Installation |
| 62 | |
| 63 | The easiest way to install ORION-RF is through the web installer. |
| 64 | |
| 65 | 1. Connect your ESP32-S3 to your computer using a USB cable. |
| 66 | 2. Open the installer page: |
| 67 | * https://krolyxon.github.io/orion-rf/ |
| 68 | 3. Click **Connect** and select your device. |
| 69 | 4. Click **Install** and wait for the flashing process to complete. |
| 70 | 5. Reboot the device if required. |
| 71 | |
| 72 | > Google Chrome, Microsoft Edge, and other Chromium-based browsers are recommended. It may or may not work on Firefox based browsers. |
| 73 | |
| 74 | --- |
| 75 | |
| 76 | ### Development Build |
| 77 | |
| 78 | #### Clone the Repository |
| 79 | |
| 80 | ```bash |
| 81 | git clone https://github.com/krolyxon/orion-rf.git |
| 82 | cd orion-rf |
| 83 | ``` |
| 84 | |
| 85 | #### Build & Upload Firmware |
| 86 | |
| 87 | ```bash |
| 88 | pio run -t upload |
| 89 | ``` |
| 90 | |