Add project README with build instructions
This commit is contained in:
parent
dbed318124
commit
bdc867a60b
48
README.md
Normal file
48
README.md
Normal file
@ -0,0 +1,48 @@
|
||||
# Heltec V3 MeshCore Repeater
|
||||
|
||||
A standalone MeshCore LoRa mesh repeater for the Heltec WiFi LoRa 32 V3.
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
pio run
|
||||
```
|
||||
|
||||
## Flash
|
||||
|
||||
**Via USB:**
|
||||
```bash
|
||||
pio run -t upload
|
||||
```
|
||||
|
||||
**Via OTA:**
|
||||
1. Connect to serial: `screen /dev/ttyUSB0 115200`
|
||||
2. Type: `start ota`
|
||||
3. Join WiFi: `MeshCore-OTA`
|
||||
4. Browse to: `http://192.168.4.1/update`
|
||||
5. Upload: `.pio/build/heltec_v3_repeater/firmware.bin`
|
||||
|
||||
## Monitor
|
||||
|
||||
```bash
|
||||
pio device monitor
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Edit `platformio.ini`:
|
||||
|
||||
```ini
|
||||
-D ADVERT_NAME='"RPM Repeater"'
|
||||
-D ADVERT_LAT=0.0
|
||||
-D ADVERT_LON=0.0
|
||||
-D ADMIN_PASSWORD='"password"'
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
Requires MeshCore library at `../MeshCore`.
|
||||
|
||||
## Docs
|
||||
|
||||
See [docs/](docs/) for detailed documentation.
|
||||
Loading…
x
Reference in New Issue
Block a user