Krolyxon
Commit 2586c8d

Branches

Tags

Refs →

orion-rfREADME.md

91 lines · 1.7 KB · Markdown

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