Skip to content

Commit 7a3daf7

Browse files
committed
chore: release 1.4.0-yacp.155
1 parent 82ef0d6 commit 7a3daf7

76 files changed

Lines changed: 2021 additions & 163 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/ci.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ jobs:
7979
run: |
8080
set -euo pipefail
8181
mkdir -p dist-publish
82-
cp .pio/build/tiny/firmware-tiny.bin "dist-publish/YACP-${VERSION}-yacp-tiny.bin"
83-
cp .pio/build/xlarge/firmware-xlarge.bin "dist-publish/YACP-${VERSION}-yacp-xlarge.bin"
82+
cp .pio/build/tiny/firmware-tiny.bin "dist-publish/YACP-${VERSION}-tiny.bin"
83+
cp .pio/build/xlarge/firmware-xlarge.bin "dist-publish/YACP-${VERSION}-xlarge.bin"
8484
cd dist-publish
8585
sha256sum ./*.bin > SHA256SUMS.txt
8686
@@ -132,6 +132,6 @@ jobs:
132132
prerelease: true
133133
fail_on_unmatched_files: true
134134
files: |
135-
dist-publish/YACP-${{ steps.version.outputs.value }}-yacp-tiny.bin
136-
dist-publish/YACP-${{ steps.version.outputs.value }}-yacp-xlarge.bin
135+
dist-publish/YACP-${{ steps.version.outputs.value }}-tiny.bin
136+
dist-publish/YACP-${{ steps.version.outputs.value }}-xlarge.bin
137137
dist-publish/SHA256SUMS.txt

BUILD_CHECKLIST.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This checklist is printed in the GitHub Actions build summary and attached to ea
99
- [ ] User-facing additions, changes, and fixes are described factually.
1010
- [ ] `pio run -e tiny` succeeds.
1111
- [ ] `pio run -e xlarge` succeeds.
12-
- [ ] Firmware files use the `YACP-<version>-yacp-<variant>.bin` naming rule.
12+
- [ ] Firmware files use the `YACP-<version>-<variant>.bin` naming rule.
1313
- [ ] SHA-256 checksums are generated.
1414

1515
## Required when applicable

CHANGELOG.md

Lines changed: 261 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,264 @@
1+
## [v1.4.0-yacp.155] - 2026-07-31
2+
3+
### Added
4+
5+
- X3 readers can use the OEM black-and-white reinforcement waveform for periodic screen maintenance without a
6+
full-screen flash. It is also available as an assignable manual action.
7+
- Newly completed EPUB and XTC books now open a Reading Achievement screen with reading time, sessions, average session,
8+
favorite reading period, reading span, completed-book count, and total device reading time.
9+
- Reading Stats now includes a persistent Finished Books view containing the 32 most recently completed books, with
10+
five-entry pagination and total device reading time.
11+
12+
### Changed
13+
14+
- Periodic screen maintenance now supports intervals of 1, 5, 10, 15, 30, or 60 pages, or Never. Required cleanup
15+
after images, grayscale content, popups, wake, and sleep remains a full refresh.
16+
- The firmware profile chooser appears once per firmware version. Fresh installations recommend the YACP profile;
17+
upgrades safely default to preserving the current configuration.
18+
- The recommended YACP profile uses Left, Right, Confirm, Back, short-Power sleep, long-Power full refresh, Quick
19+
Resume after five minutes, no-flash X3 reinforcement on every page, and text antialiasing off.
20+
- Home performs one full refresh on entry and after closing its built-in menu, then returns to fast updates.
21+
- Release firmware names now follow `YACP-<version>-tiny.bin` and `YACP-<version>-xlarge.bin`.
22+
23+
### Fixed
24+
25+
- Finished Books is reachable on X4 and other devices without a real-time clock, and every retained entry is
26+
navigable instead of only the first five.
27+
- Moving a completed EPUB to `/Read/` now migrates its path identity explicitly, so distinct books with the same
28+
title no longer overwrite one another in Finished Books.
29+
- All 26 languages now provide their own label for the 60-page maintenance interval.
30+
- Finished-books index failures close the SD file before cleanup or backup recovery.
31+
- Host unit tests now register their PlatformIO target and use compiler-appropriate warning flags on Windows.
32+
- Release builds no longer retain a variable used only by disabled debug logging in the SD font registry cleanup.
33+
34+
## [v1.4.0-yacp.154] - 2026-07-30
35+
36+
### Changed
37+
38+
- Validated the complete pre-release change set on both Tiny and XLarge firmware targets.
39+
40+
## [v1.4.0-yacp.153] - 2026-07-30
41+
42+
### Changed
43+
44+
- Retried the combined release build with an explicit UTF-8 host environment after Windows CP1252 rejected the
45+
translation report.
46+
47+
## [v1.4.0-yacp.152] - 2026-07-30
48+
49+
### Changed
50+
51+
- Validated the complete pre-release change set on the Tiny firmware target.
52+
53+
## [v1.4.0-yacp.151] - 2026-07-30
54+
55+
### Fixed
56+
57+
- Finished-books index failures now always close the SD file before cleanup or recovery.
58+
59+
## [v1.4.0-yacp.150] - 2026-07-30
60+
61+
### Changed
62+
63+
- Re-ran Tiny validation with UTF-8 host output after Windows CP1252 rejected the translation report.
64+
65+
## [v1.4.0-yacp.149] - 2026-07-30
66+
67+
### Changed
68+
69+
- Re-ran Tiny validation in deterministic single-job mode after the Windows host stalled in parallel SCons.
70+
71+
## [v1.4.0-yacp.148] - 2026-07-30
72+
73+
### Changed
74+
75+
- Re-ran Tiny validation after the previous host terminal interrupted PlatformIO output.
76+
77+
## [v1.4.0-yacp.147] - 2026-07-30
78+
79+
### Changed
80+
81+
- Validated the Home refresh and persistent Finished Books page on the Tiny firmware target.
82+
83+
## [v1.4.0-yacp.146] - 2026-07-30
84+
85+
### Changed
86+
87+
- Validated the Home refresh and persistent Finished Books page in the X3 simulator.
88+
89+
## [v1.4.0-yacp.145] - 2026-07-30
90+
91+
### Added
92+
93+
- Reading Stats now includes a persistent Finished Books page after Reading Rhythm, including an empty state and
94+
this device's total reading time.
95+
- A bounded finished-books index is updated on completion and reader exit without scanning the full library.
96+
97+
### Fixed
98+
99+
- Home now performs one full refresh when it is entered and when the built-in YACP menu closes.
100+
101+
## [v1.4.0-yacp.144] - 2026-07-30
102+
103+
### Changed
104+
105+
- Validated short-Power firmware-profile confirmation on the Tiny firmware target.
106+
107+
## [v1.4.0-yacp.143] - 2026-07-30
108+
109+
### Fixed
110+
111+
- A short Power press now confirms the firmware profile even when the previous profile assigned that press to sleep.
112+
113+
## [v1.4.0-yacp.142] - 2026-07-30
114+
115+
### Changed
116+
117+
- Validated the device-wide reading-time card on the Tiny firmware target.
118+
119+
## [v1.4.0-yacp.141] - 2026-07-30
120+
121+
### Changed
122+
123+
- Validated the device-wide reading-time card on the X3 simulator.
124+
125+
## [v1.4.0-yacp.140] - 2026-07-30
126+
127+
### Added
128+
129+
- The book-completion achievement now shows total reading time accumulated on this device, including the session
130+
being completed.
131+
132+
## [v1.4.0-yacp.139] - 2026-07-30
133+
134+
### Changed
135+
136+
- Validated the stable firmware-profile chooser and empty Reading Stats entry on the simulator and Tiny target.
137+
138+
## [v1.4.0-yacp.138] - 2026-07-30
139+
140+
### Changed
141+
142+
- The firmware-profile panel now always presents the same YACP, CrossInk, and keep-current choices, defaults safely
143+
to keeping current settings on upgrades, and shows the complete effect of the selected profile.
144+
- Firmware-profile labels are translated directly in all 26 supported languages.
145+
- Reading Stats now remains available from every Home menu before any book, session, or completion has been recorded.
146+
147+
## [v1.4.0-yacp.137] - 2026-07-30
148+
149+
### Changed
150+
151+
- Validated version-aware setup-panel persistence and legacy-flag migration on the simulator and Tiny target.
152+
153+
## [v1.4.0-yacp.136] - 2026-07-30
154+
155+
### Changed
156+
157+
- A genuinely fresh installation still recommends the YACP preset, while upgrades preselect an already matching
158+
YACP, CrossInk, or Custom configuration.
159+
160+
## [v1.4.0-yacp.135] - 2026-07-30
161+
162+
### Changed
163+
164+
- The YACP/CrossInk setup panel now appears once for every newly flashed firmware version, while subsequent boots of
165+
that same version continue normally.
166+
- On firmware upgrades, the panel initially selects the currently matching YACP, CrossInk, or Custom configuration.
167+
168+
## [v1.4.0-yacp.134] - 2026-07-30
169+
170+
### Changed
171+
172+
- Validated the revised first-run YACP preset and Settings-to-Home refresh on the Tiny firmware target.
173+
174+
## [v1.4.0-yacp.133] - 2026-07-30
175+
176+
### Fixed
177+
178+
- The translated first-run setup description now wraps within the narrow display instead of drawing past its edges.
179+
180+
## [v1.4.0-yacp.132] - 2026-07-30
181+
182+
### Changed
183+
184+
- Revalidated the first-run YACP preset and Settings-to-Home refresh in the Linux simulator environment.
185+
186+
## [v1.4.0-yacp.131] - 2026-07-30
187+
188+
### Changed
189+
190+
- Returning from Settings now gives every Home theme one clean full refresh.
191+
- The recommended first-run YACP preset now enables Quick Resume after a five-minute idle timeout, uses X3 no-flash
192+
screen reinforcement on every page, disables text anti-aliasing, and maps the front buttons as Left, Right, OK,
193+
Back.
194+
195+
## [v1.4.0-yacp.130] - 2026-07-30
196+
197+
### Changed
198+
199+
- Validated the current completion-achievement statistics and English simulator reference capture together.
200+
201+
## [v1.4.0-yacp.129] - 2026-07-30
202+
203+
### Changed
204+
205+
- Updated simulator QA coverage for the current completion-achievement statistics.
206+
207+
## [v1.4.0-yacp.128] - 2026-07-30
208+
209+
### Changed
210+
211+
- Repository documentation and QA artifacts now reflect only the current Reading Stats feature set.
212+
213+
## [v1.4.0-yacp.127] - 2026-07-30
214+
215+
### Changed
216+
217+
- Integrated the completion-achievement screen with the latest screen-maintenance build.
218+
219+
## [v1.4.0-yacp.126] - 2026-07-30
220+
221+
### Changed
222+
223+
- Screen-maintenance settings and the assignable no-flash refresh action now use shorter, more explicit labels
224+
distinguishing the flashing full refresh from the X3 no-flash refresh, translated in all 26 firmware languages.
225+
226+
## [v1.4.0-yacp.125] - 2026-07-30
227+
228+
### Changed
229+
230+
- The completion achievement shows the book's reading span in days.
231+
232+
## [v1.4.0-yacp.123] - 2026-07-30
233+
234+
### Added
235+
236+
- Leaving a newly finished EPUB or XTC book for Home now shows a celebratory achievement screen with the book's
237+
reading time, sessions, average session, favorite reading period, reading span, and completed-book count.
238+
- Completion-achievement labels are translated in all 26 firmware languages.
239+
240+
### Fixed
241+
242+
- Automated Reading Stats demo captures now honor the simulator's English screenshot override.
243+
244+
## [v1.4.0-yacp.111] - 2026-07-30
245+
246+
### Added
247+
248+
- Periodic screen maintenance can now use either a full refresh or the X3 OEM black-and-white reinforcement waveform
249+
at the selected page interval. Manual refreshes and cleanup required after images or popups remain full.
250+
- The same no-flash X3 black-and-white reinforcement is available as an assignable short/long Power action and as a
251+
long-press Confirm or Back action; grayscale pages and non-X3 devices retain the full-refresh fallback.
252+
253+
## [v1.4.0-yacp.97] - 2026-07-30
254+
255+
### Changed
256+
257+
- Reader full-refresh frequency now defaults to 30 pages and offers 60 pages or Never; Never keeps required cleanup
258+
refreshes after images, indexing, wake, and sleep screens.
259+
- Choosing the recommended YACP button experience during first-run setup now makes a short Power press sleep and a
260+
long Power press refresh the screen, while the CrossInk choice retains its original Power behavior.
261+
1262
## [v1.4.0-yacp.93] - 2026-07-28
2263

3264
### Changed

0 commit comments

Comments
 (0)