[2.0.4] Late June 2024
Word from the author:
Thanks for your patience everyone!
This release is fully compatible with the previous release, v2.0.3 and therefore, no changes to the settings.json file are required. It is a minor release but fixes a number of bugs which were present in the previous release.
A big shoutout to all the contributors of Inkycal on Github, Discord and Tindie. Thank you very much for your help, effort and time!
Thank you very much to all those who provided excellent support on Discord to new users, gave feature suggestions, found bugs and bugfixes 🥇
As a reminder, if you sponsored Inkycal via InkycalOS-Lite or by purchasing Inkycal from our Tindie store, you will soon get an e-mail with the latest version of InkycalOS-Lite (please also check the spam folder). This time, there will be plenty of time to download the image, which was possible with part of the sponsorships and sales of Inkycal! Thank you very much!
✅ You can now get a ready-to-flash version of Inkycal, aka. InkycalOS-Lite for the Raspberry Pi (all versions) by sponsoring Inkycal as a one-time tier here: Sponsor Inkycal which does not require installing Inkycal or setting up the Raspberry Pi. The OS file is based on Raspberry Pi OS - bookworm - and generated automatically so privacy is also not an issue. This can save you hours of work and helps cover ongoing costs for maintenance and development of Inkycal
ℹ️ Did you know, you can also purchase a pre-assembled version of Inkycal from our official Tindie store over here:
- 7.5" pre-assembled version of Inkycal - includes access to InkycalOS-Lite
- 12.48" pre-assembled version of Inkycal - includes access to InkycalOS-Lite
Release notes
Changed
- Updated dependencies to the most-recent supported version
- Unified logging all over the library. Print statements are now rare. This makes it easier to identify why Inkycal isn't working without having to look up the logs
- Inkycal now makes use of a JSON-Cache to make it more resilient against resets etc. For example, the slideshow module will remember the last index even after a shutdown
- Inkycal now uses a list of supported displays instead of having to look up each driver in the driver directory
- Renamed tests according to python standards, starting with
test_..
, allowing unittest/pytest to automatically discover and run these tests.
Fixed
- Fixed an annoying vertical alignment issue causing some characters to look chopped off
- Fixed the alignment of the red-circle on the calendar module
- Fixed weekday-names not translating in the weather module
- Fixed python 3.11 issues with numpy on Raspberry Pi OS
Added
- Added long-awaited support of PiSugar v1/2/3. Still a bit experimental (no calibration handling), but works for most part. If PiSugar support is enabled, Inkycal will set the new alarm before shutting down the system, increasing battery life. Please note that around 70 updates were possible with the 1200mAh PiSugar 3 board, so one update a day to three should be max to get at least one month battery life.
- Added Webshot module which can be used to display a webpage. Works on InkycalOS-Lite too and does not need a GUI.
- Added XKCD module
- Added Tindie module
- Added support for much longer update-intervals than the previous max of once every 60 minutes
- Added Material-UI icons font
- Added dedicated Pipeline for unittests directly on Raspberry Pi OS to ensure Inkycal can run reliably on Raspberry Pi OS
- Added Feature-request and PR template
- Added support for 5.83" display (v2)
- Added support for 12.48" display on 64-bit systems
- Added Inkycal fullweather-module
- Added
settings.py file (not to be confused with
settings.json`) to set VCOM and other internal variables - Added support for 13.3" SPI display (to be tested)
Upgrading instructions from Inkycal v2.0.3 to v2.0.4:
# update system and install system dependencies
sudo apt-get update
sudo apt-get install git zlib1g libjpeg-dev libatlas-base-dev rustc libopenjp2-7 python-dev-is-python3 scons libssl-dev python3-venv python3-pip git libfreetype6-dev wkhtmltopdf libopenblas-base libopenblas-dev
# installing Inkycal dependencies
cd ~/Inkycal
source venv/bin/activate
git pull
# if you get an error message when running git-pull, chances are you modified some files, which would be overwritten.
# Make a copy of these files outside the Inkycal folder, then run
# git reset --hard
# to erase all modifications. Then continue
pip install --upgrade pip
pip install wheel
pip install -e ./
# Check if everything still works:
python inky_run.py
Enable PiSugar support
Warning! PiSugar support should only be enabled if Inkycal is already working as expected, the PiSugar installer from PiSugar has been run and the PiSugar board is fully charged and attached to the Raspberry Pi.
Please follow the instructions on the wiki page here: https://github.com/aceinnolab/Inkycal/wiki/PiSugar-support
After this mod, you should see more infos about the PiSugar board (version, current time, remaining battery etc.). Once Inkycal has completed showing the first image, it will set an alarm on the PiSugar and shut-down the Raspberry Pi. At the next scheduled update_interval, the Raspberry Pi will boot, show an image and then shutdown again. The shutdown cannot be initiated if sudo requires a password, as it is the case with InkycalOS-Lite. As a workaround at your own risk, you can run the following command so that sudo commands do not require a password.
echo 'ALL ALL=(ALL:ALL) NOPASSWD: ALL' | sudo tee /etc/sudoers.d/010_disable_sudo_password
If it works correctly, reboot with sudo reboot
.
P.S.: If you run into issues, please do not hesitate to open up an issue on Github or letting me know via Inkycal on Discord. There will also be a thread in the discussions tab here for support