freeink-sdk/platformio.crosspoint.sample.ini at main · Free-Ink/freeink-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
; ============================================================================
; CrossPoint local override — build CrossPoint against a FreeInk SDK checkout
; ============================================================================
;
; Drop this into the CrossPoint repo as `platformio.local.ini` to repoint
; CrossPoint's SDK libraries at a local FreeInk SDK checkout (instead of its
; bundled open-x4-sdk submodule), so SDK changes iterate without bumping a
; submodule pointer.
;
; It overrides ONLY [base].lib_deps. It deliberately does NOT redefine env blocks:
; those (and their device flags) live in CrossPoint's own platformio.ini, and a
; local override of an env's build_flags would replace them — dropping the device
; selection and breaking the build.
;
; Steps:
;   1. Copy this file to the CrossPoint repo root as `platformio.local.ini`.
;   2. Replace /path/to/freeink-sdk below with your FreeInk SDK checkout path.
;   3. Build a target:
;        pio run -e default       # X3+X4 dev (serial log, debug)
;        pio run -e gh_release    # X3+X4 release (serial log, info)
;        pio run -e slim          # X3+X4 slim (no serial log)
;
; IMPORTANT: FreeInk has no default device — every build env must select one (or
; more) with -DFREEINK_DEVICE_<NAME>. CrossPoint's C3 envs already pass
; `-DFREEINK_DEVICE_X3 -DFREEINK_DEVICE_X4` (see its [xteink_c3] anchor); the S3
; m5paper env passes -DFREEINK_DEVICE_M5. A build with no device flag fails with
; "no device selected". If you add an env, give it a device flag.
;
; No CrossPoint *source* changes are needed — the compat headers (EInkDisplay.h,
; InputManager.h, BatteryMonitor.h, SDCardManager.h, BoardConfig.h) preserve every
; include path and class name CrossPoint already uses. The `default` env composes
; both XTEINK_X4 (800x480/SSD1677) and XTEINK_X3 (792x528/UC8253) into one image;
; CrossPoint's HalDisplay picks one at runtime after I2C fingerprinting.
;
; Linker note for local CrossPoint + FreeInk env overrides:
; If your local override redefines an [env:*].build_flags block and the final
; link fails with undefined `app_main` and `loopTaskHandle`, add this flag to
; that env's build_flags:
;
;   -Wl,.pio/build/default/FrameworkArduino/main.cpp.o
;
; pioarduino/Arduino-ESP32 3.3.x packages Arduino's startup object inside
; libFrameworkArduino.a. Some local override/link-order combinations do not pull
; that archive member before ESP-IDF asks for `app_main`. Linking main.cpp.o
; directly forces Arduino's startup symbols into the image. Adjust `default` in
; the path if the env name differs.
;
; The Name=symlink:// entries override CrossPoint's SDK lib_deps by name; the
; remaining entries are CrossPoint's own application libraries, unchanged.

[base]
lib_deps =
  BatteryMonitor=symlink:///path/to/freeink-sdk/libs/hardware/BatteryMonitor
  InputManager=symlink:///path/to/freeink-sdk/libs/hardware/InputManager
  EInkDisplay=symlink:///path/to/freeink-sdk/libs/display/FreeInkDisplay
  SDCardManager=symlink:///path/to/freeink-sdk/libs/hardware/SDCardManager
  BoardConfig=symlink:///path/to/freeink-sdk/libs/hardware/BoardConfig
  PowerManager=symlink:///path/to/freeink-sdk/libs/hardware/PowerManager
  FreeInkUI=symlink:///path/to/freeink-sdk/libs/ui/FreeInkUI
  bblanchon/ArduinoJson @ 7.4.2
  ricmoo/QRCode @ 0.0.1
  bitbank2/PNGdec @ 1.1.6
  https://github.com/bitbank2/JPEGDEC.git#86282979224c8a32fd51e091ed5a35b0c699a52b
  links2004/WebSockets @ 2.7.3