You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ Do not introduce UI dependencies into core modules. If a core function needs use
38
38
39
39
The project uses two static analysis tools to catch bugs early. Both are available after sourcing ESP-IDF (`source ~/esp/esp-idf/export.sh`), except `cppcheck` which is installed separately.
40
40
41
-
Both tools cover `main/` and first-party components (`bbqr`, `cUR`, `k_quirc`, `sd_card`, `video`, `wave_4b`, `wave_35`, `wave_43`, `crowpanel`). `libwally-core` and `wave_5` are excluded (third-party upstream code: libwally-core is the original; wave_5 ships a vendored ST-style HX8394 driver).
41
+
Both tools cover `main/` and first-party components (`bbqr`, `cUR`, `k_quirc`, `sd_card`, `video`, `wave_4b`, `wave_35`, `wave_43`, `crowpanel`, `wave_7b`). `libwally-core` and `wave_5` are excluded (third-party upstream code: libwally-core is the original; wave_5 ships a vendored ST-style HX8394 driver).
ESP32-P4 does not contain radio (WiFi, BLE), but these boards have a radio in a secondary chip (ESP32-C6 mini). Exploring radio-less, simpler and cheaper ESP32-P4-only boards is part of the project's hardware research.
Build with [just](https://github.com/casey/just) (recommended) or `idf.py` directly. All `just` commands accept a board parameter, one of `wave_4b` (default), `wave_35`, `wave_5`, `wave_43`, or `crowpanel`:
75
+
Build with [just](https://github.com/casey/just) (recommended) or `idf.py` directly. All `just` commands accept a board parameter, one of `wave_4b` (default), `wave_35`, `wave_5`, `wave_43`, `crowpanel`, or `wave_7b`:
75
76
76
77
```bash
77
78
just build # Build for wave_4b (default)
78
79
just build wave_35 # Build for wave_35
79
80
just build wave_5 # Build for wave_5
80
81
just build wave_43 # Build for wave_43
81
82
just build crowpanel # Build for CrowPanel 7" / 10.1"
83
+
just build wave_7b # Build for wave_7b
82
84
just flash wave_5 # Flash for wave_5
83
85
just monitor # Serial monitor
84
86
just clean # Wipe all build_<board> dirs + sdkconfig
> **Note:**`just` builds each board into its own `build_<board>/` directory, so switching boards needs no clean. The raw `idf.py` commands above share the default `build/` directory and `sdkconfig`: run `idf.py fullclean && rm sdkconfig` when switching boards that way.
@@ -117,6 +122,7 @@ just sim wave_35 # Run simulator as wave_35 (320x480)
117
122
just sim wave_5 # Run simulator as wave_5 (720x1280)
118
123
just sim wave_43 # Run simulator as wave_43 (480x800)
119
124
just sim crowpanel # Run simulator as crowpanel (1024x600)
125
+
just sim wave_7b # Run simulator as wave_7b (1024x600)
120
126
just sim-build wave_35 # Build only
121
127
just sim-clean # Remove simulator build artifacts
122
128
just sim-reset # Wipe simulator data (factory reset)
@@ -218,6 +224,7 @@ Pre-release firmware is provided **for research and testing purposes only**. Any
0 commit comments