Skip to content

Latest commit

 

History

History
185 lines (140 loc) · 8.08 KB

CHANGES.md

File metadata and controls

185 lines (140 loc) · 8.08 KB

EPub-InkPlate An EPub Reader for InkPlate devices

Last news

(Updated 2022.5.01)

Update to version 2.0.1

  • For Inkplate-6PLUS and Inkplate-10: The ESP-IDF-Inkplate library has been updated (v0.9.6) to support some of these devices to be delivered without a second MCP chip onboard. The presence of the second MCP is now dynamically detected by the software.

  • For all Inkplate: Now using ESP-IDF framework v4.3.2

Update to version 2.0.0

The following are the main aspects that have been updated in this release:

  • Added Inkplate-6PLUS support as a new release. Mainly the touch screen, the WakeUp button, and the screen backlit capabilities. A calibration function is available to adjust the touch screen response. All interaction tools (menus, forms, viewers) have been extended to support gesture interactions. Gestures supported are Tap, Touch and hold, Pinching, Swipe left, Swipe right.
  • Date/Time support for all Inkplate device types. Include both Date/Time adjustment by hand and through the Internet (NTP server). Uses the RTC Chip when available, or the ESP32 internal real-time clock.
  • Bitmap fonts to get more precise pixels painting on low-resolution screens. A specific font format was created to support such a feature (fonts with extension .IBMF)
  • Fonts configuration file (font_list.xml) allows for changing the fonts used by the application.
  • New fonts supplied with the distribution. Can be used to replace the fonts listed in the fonts configuration file.
  • Better support of some EPUB books that use XML namespace extensively.

Installing this version requires the complete replacement of the micro SD Card content. The SDCard folder that is part of the release must be used to initialize the micro SD Card. The content of the config.txt file will need to be updated as stated in the installation manual.

The supplied documents (installation guide and user's guide) have been modified to take into account the new functionalities.

  • Font classes re-org to allow bitmap fonts
  • Tests with single PK file format
  • Create the IBMF font file format (my own file format design!)
  • Suite of tools to genereate IBMF font files
  • New class to manage Integrated BitMap Fonts (IBMF file format)
  • Character set translation
  • Support for both [x] monochrome and [x] grayscale
  • Glyphs translation to latin1 (multiple glyphs merge for accents)
  • Latin-A
  • fonts_list.xml format adjustments
  • Clear screen region performance improvement (20x faster)
  • RTC Date/Time support for all Inkplate devices
  • Inkplate-6PLUS touch screen calibration
  • FormViewer class redesign to support number fields
  • EPUB XML namespace parsing support
  • Numerical keypad for entering numbers in forms
  • Inkplate-6PLUS Debugging
  • Valgrind
  • Tests Inkplate-6 / Inkplate-10
  • Tests Inkplate-6PLUS
  • Documentation
  • Release generation script to be modified for Inkplate-6PLUS integration
  • New version release packaging

Update to version 1.3.1

  • Corrected an issue with books being read cleanup

  • Books being read are put on top of the Books list

  • Modifiable fonts list in the fonts_list.xml file

  • Wordsmithing of the user's guide (long overdue...)

  • Tests Inkplate-6 / Inkplate-10

  • Valgrind

  • Documentation

  • New version release packaging

Update to version 1.3.0

New User functionalities:

  • New ebook list Covers Matrix View (see pictures below).
  • Integration with new image streaming classes (png and jpeg).
  • Table of Content to select location to read inside an ebook.
  • Ebook deletion from the device.
  • Subscript/Superscript support.
  • Tracking of the current page location of the last 10 books read by the user.
  • Number of allowed ebooks changed from 100 to 200 maximum.

Internal changes:

  • Now using ESP-IDF version 4.3.0 through PlatformIO.
  • Complete redesign of the CSS Interpreter.
  • Integration in a single algorithm of the HTML Interpreter used by both the page location process and the screen painting process.
  • Correction of many small page painting issues.
  • Corrected an issue with the ebooks folder scanning process (simple db mgr bug).
  • Corrected an issue with the PowerOff menu entry.
  • Testing with 200 ebooks under Linux (page formatting and general functionalities).
  • Changes related to the new PlatformIO way of managing sdkconfig.
  • PNG image files transparency.
  • Stack usage optimization.
  • Web Server Enhancements (comma separated file size thousands, .epub file extension check).
  • Font obfuscation support (both Adobe and IDPF methods).
  • Non-volatile memory class to manage last books read tracking.
  • Testing ebooks on InkPlate-6.
  • Valgrind tests.
  • Documentation update.

Remaining steps to release:

  • Testing ebooks on InkPlate-10.
  • New version releases packaging.
  • Support of the forecoming Inkplate 6Plus (touch screen, backlit). Debugging remains to be completed (will happen for a future release).

Update to version 1.2

  • Recompiled to integrate ESP-IDF-Inkplate library v0.9.4
  • Adjustments for the ESP-IDF v4.2 framework.
  • Support for the 6-buttons extended board in new specific releases.
  • bld_all.sh script to automatically build all releases zip files.

Update to version 1.1.1

  • Recompiled to integrate ESP-IDF-InkPlate library v0.9.2 (A2D attenuation correction).

v1.1.0 information:

This is in preparation for version 1.1.0 The main ongoing modifications are:

  • Support of the new upcoming Inkplate-10 device.
  • Just in time calculation of pages locations through multithreading (a BIG change...).
  • Integration with the new ESP-IDF-Inkplate library.
  • Trigger pages location recalculation when parameters have changed.
  • Stop light-sleep, deep-sleep while pages location is being calculated.
  • Adjust web server to only show epub files and remove params/locs files on ebook delete.
  • Adjust Web server to stop page-locs to free memory before launching the server.
  • Save computed pages location to sdcard for quick ebook load.
  • Repair some known bugs (some issues to be addressed later).
  • Code refactoring and cleanup (tbd v1.2).
  • Udate documentation.
  • Tests, tests, tests, ...

Added functional features:

  • Title showned at top of pages (as an option).
  • Heap Size showned at bottom of pages (as an option).
  • Form entry simplified (OK / Cancel param no longer there).
  • Parameters for each ebook specific font/pictures adjustments.
  • Augmented CSS features (tbd v1.2).

Known bugs:

  • ebooks list geometry when screen orientation change.
  • recovery from too large image (memory allocation).
  • Page refresh on orientation/resolution changes.
  • PNG image files transparency (tbd v1.2).

v1.0 information:

The development is complete. The application is at version 1.0.0. Please look at the installation guide located in file doc/INSTALL.md and the user's guide located in doc/USER GUIDE.md. PDF versions of these guides are also available.

  • Integration of touch buttons through interrupts (not perfect. to be revisited).
  • Menu capability.
  • Options / Parameters menus.
  • Error dialogs.
  • About box.
  • Low-Level InkPlate Drivers refactoring.
  • Power management (Deep-Sleep after 15 minutes timeout, Light-Sleep between touchpad events).
  • Return to current book location between restarts.
  • Configuration management (save/load from the SD-Card).
  • Form tool to show / edit options / parameters.
  • books directory refresh dialog.
  • [!] Over the Air (OTA) updates (No hope... not enough flash space).
  • WiFi access to update ebooks (This item only added 600KB of code!).
  • Performance on new book scans (80% completion to be revisited after first release).
  • Options / Parameters form.
  • Battery level display.
  • Screen orientation (touchpads to the left (portrait) / right (portrait) / down (landscape) modes).
  • User's Guide and installation manuals.
  • Error dialog use (100% completion).
  • Debugging remaining issues.