mirror of
https://github.com/ByteWelder/Tactility.git
synced 2026-10-17 02:45:05 +00:00
79d3dd4fdb
app-module - Apps now have support for: - environment variables (inherit from parent app) - current workdir - window size (when running in terminal) - Add type aliases like `AppId` and `PackageId` - Remove data duplication between ledger and app instance records: create `AppManifestSet` - `AppManifest` usage safety improved: pass by value where needed, or use `AppId` instead of a manifest. Terminal and shell - Moved shell commands into coreutils-module as proper apps. - Refine stack size for terminal and shell because apps now run with their own task and stack (including in-memory apps) Platform - Fix for listing root dir on ESP32: wrap posix directory functions and wire in file systems. - Moved all platform-specific file system init code to platform subprojects Other - Fix for screenshot capture (issue with paths) - Fixes for coreutils app correctness - Memory optimizations (use more PSRAM where possible) in various locations such as app-module, shell and terminal. - `ls` and `help` commands now use terminal width and show columns of data by default - Created fs helpers at `TactilityKernel/include/tactility/filesystem/fs.h` (partially ported from `ShellFs`)
63 lines
2.1 KiB
Markdown
63 lines
2.1 KiB
Markdown
# Building
|
|
|
|
## Git
|
|
|
|
The repository uses git submodules. Make sure to use `--recurse-submodules` on relevant git commands.
|
|
|
|
## Simulator (Linux/macOS, no ESP-IDF needed)
|
|
|
|
> [!IMPORTANT]
|
|
> The simulator does **NOT** build or run on native Windows (Win32/PowerShell/cmd). This is
|
|
> a hard platform limitation, not a missing tool or PATH issue — do not attempt `cmake -B
|
|
> buildsim` on Windows, it will not work. WSL is a separate, Linux environment and is fine.
|
|
|
|
```bash
|
|
cmake -B buildsim -G Ninja
|
|
ninja -C buildsim # build firmware + tests
|
|
./buildsim/Firmware/Tactility # run simulator
|
|
```
|
|
|
|
## ESP32 firmware
|
|
|
|
```bash
|
|
python device.py <device-id> # generate sdkconfig for device (e.g. lilygo-tdeck)
|
|
python device.py <device-id> --dev # dev mode: force 4MB partition table
|
|
idf.py build # build firmware
|
|
idf.py flash monitor # flash and monitor
|
|
```
|
|
|
|
Device IDs are the folder names under `Devices/` (e.g. `lilygo-tdeck`, `m5stack-cores3`, `cyd-2432s028r`).
|
|
|
|
### Windows: activating the ESP-IDF environment
|
|
|
|
On native Windows, `idf.py` is not on PATH by default — it must be activated per-shell first.
|
|
The install script places a PowerShell profile activator per IDF version at
|
|
`%IDF_TOOLS_PATH%\Microsoft.v<version>.PowerShell_profile.ps1` (path controlled by the
|
|
`IDF_TOOLS_PATH` environment variable, set to wherever ESP-IDF's tools were installed, e.g.
|
|
`C:\Espressif\tools`). Source it before running any `idf.py` command:
|
|
|
|
```powershell
|
|
. "$env:IDF_TOOLS_PATH\Microsoft.v5.5.2.PowerShell_profile.ps1" # match the installed IDF version
|
|
Set-Location "<repo-root>"
|
|
idf.py build 2>&1 | Select-Object -Last 250
|
|
```
|
|
|
|
This is Windows-specific setup (the main dev works on Linux, where `idf.py` is normally
|
|
already on PATH via `export.sh`/`. ./export.sh` or a shell profile).
|
|
|
|
## Devicetree
|
|
|
|
A device implementation has a `.dts` file.
|
|
The parser at `Buildscripts/DevicetreeCompiler/` converts DTS into C code.
|
|
It's called from the `Tactility/` build process.
|
|
|
|
## Tests
|
|
|
|
Tests use Doctest and run on simulator (POSIX) target only:
|
|
|
|
```bash
|
|
cmake -B buildsim -G Ninja
|
|
ninja -C buildsim build-tests
|
|
cd buildsim && ctest --test-dir Tests
|
|
```
|