Krolyxon
Commit 6262af5

Branches

Tags

Refs →

orion-rfREADME.md

88 lines · 1.7 KB · Markdown

1# Orion RF
2
3Orion 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 Module
31- 2x CC1101 Module
32- PN532 NFC Module
33- MicroSD card Module
34- TP4056 Charging Module
35- OLED display
36- Battery-powered portable setup
37
38## Status
39
40| Feature | Status |
41|---|---|
42| BLE Scan | Working |
43| WiFi Scan | Working |
44| WiFi Analyzer | Working |
45| BadUSB | Working |
46| BLE Mouse | Working |
47| BLE Jammer | Working |
48| Bluetooth Jammer | Working |
49| WiFi Jammer | Working |
50| RF Capture | WIP |
51| RF Replay | WIP |
52| SD Card Support | Planned |
53| Emulator | Planned |
54| NFC | WIP |
55
56
57## Installation
58
59### End User Installation
60
61The easiest way to install ORION-RF is through the web installer.
62
631. Connect your ESP32-S3 to your computer using a USB cable.
642. Open the installer page:
65 * https://krolyxon.github.io/orion-rf/
663. Click **Connect** and select your device.
674. Click **Install** and wait for the flashing process to complete.
685. Reboot the device if required.
69
70> Google Chrome, Microsoft Edge, and other Chromium-based browsers are recommended. It may or may not work on Firefox based browsers.
71
72---
73
74### Development Build
75
76#### Clone the Repository
77
78```bash
79git clone https://github.com/krolyxon/orion-rf.git
80cd orion-rf
81```
82
83#### Build & Upload Firmware
84
85```bash
86pio run -t upload
87```
88