Skip to content

Commit 62d0b36

Browse files
committed
Update README.md
1 parent 771bbfd commit 62d0b36

1 file changed

Lines changed: 24 additions & 7 deletions

File tree

README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
11
# EPPG Controller
22

3-
![Build](https://github.com/openppg/eppg-controller/actions/workflows/config.yml/badge.svg)
3+
[![Build](https://github.com/openppg/eppg-controller/actions/workflows/config.yml/badge.svg)](https://github.com/openppg/eppg-controller/actions/workflows/config.yml)
44

55
Arduino based logic for OpenPPG SP140 Throttle Controller
66

7+
### Key Features
8+
9+
- CAN bus communication with ESC and BMS
10+
- LVGL-based LCD display interface
11+
- Bluetooth Low Energy (BLE) connectivity via NimBLE
12+
- Barometric altitude sensing (BMP3XX)
13+
- Multiple flight modes (manual, cruise)
14+
- Real-time sensor monitoring with hysteresis-based alerting
15+
- Web-based configuration via [config.openppg.com](https://config.openppg.com) (no firmware flash needed)
16+
717
#### This master branch is only for testing the latest firmware for the SP140 controllers running the ESP32-S3 processor.
818

919
X4 code has been migrated to a separate repo - https://github.com/openppg/x4-controller
@@ -39,10 +49,6 @@ OpenPPG supports flashing the firmware PlatformIO. Older versions were also comp
3949
3. Open the folder using the PlatformIO "open project" option inside of VSCode.
4050
4. The first time you build the project it will download the libraries.
4151

42-
#### Download and Prepare OpenPPG Code
43-
44-
1. Download the latest controller code zip from [here](https://github.com/openppg/eppg-controller/archive/master.zip)
45-
4652
#### Flash the OpenPPG Code
4753

4854
1. First make sure the code compiles by hitting the check button in the bottom left "Build".
@@ -65,10 +71,21 @@ $ esptool.py --chip esp32s3 merge_bin \
6571
0x10000 .pio/build/OpenPPG-CESP32S3-CAN-SP140/firmware.bin
6672
```
6773

68-
## Config tool
74+
## Testing
75+
76+
Unit tests use [Google Test](https://github.com/google/googletest) and run natively (no hardware required):
6977

70-
The open source web based config tool for updating certain settings over USB (without needing to flash firmware) can be found at https://config.openppg.com.
78+
```bash
79+
pio test -e native-test
80+
```
81+
82+
Test suites cover ESC error handling, throttle processing, hysteresis logic, sensor monitoring, and logging.
83+
84+
CI automatically runs cpplint, unit tests, and a full firmware build on every push.
85+
86+
## Config tool
7187

88+
The open source web based config tool for updating certain settings over USB (without needing to flash firmware) can be found at [config.openppg.com](https://config.openppg.com).
7289

7390
## Help improve these docs
7491

0 commit comments

Comments
 (0)