-
text_wrap() (in module inkycal.custom.functions)
Inkycal documentation — inkycal 2.0.3 documentation
+ Inkycal documentation — inkycal 2.0.4 documentation
Inkycal — inkycal 2.0.3 documentation
+ Inkycal — inkycal 2.0.4 documentation
Inkycal
@@ -130,7 +131,7 @@
Copyright by aceinnolab
-class inkycal.main. Inkycal ( settings_path : str = None render : bool = True )
+class inkycal.main. Inkycal ( settings_path : str = None render : bool = True use_pi_sugar : bool = False shutdown_after_run : bool = False )
Inkycal main class
Main class of Inkycal, test and run the main Inkycal program.
@@ -157,35 +158,21 @@
countdown ( interval_mins : int = None ) → int
-Returns the remaining time in seconds until next display update.
+Returns the remaining time in seconds until the next display update based on the interval.
-Args:
-
-interval_mins = int -> the interval in minutes for the update if no interval is given, the value from the settings file is used.
+Args:
+interval_mins (int): The interval in minutes for the update. If none is given, the value from the settings file is used.
-
Returns:
+ Returns: int: The remaining time in seconds until the next update.
-
-async run ( )
-Runs main program in nonstop mode.
-Uses an infinity loop to run Inkycal nonstop. Inkycal generates the image
-from all modules, assembles them in one image, refreshed the E-Paper and
-then sleeps until the next scheduled update.
-
-
-
-
-test ( )
+
+dry_run ( )
Tests if Inkycal can run without issues.
Attempts to import module names from settings file. Loads the config
for each module and initializes the module. Tries to run the module and
@@ -193,6 +180,28 @@
Generated images can be found in the /images folder of Inkycal.
+
+
+process_module ( number ) → bool
+Process individual module to generate images and handle exceptions.
+
+
+
+
+async run ( run_once = False )
+Runs main program in nonstop mode or a single iteration based on the run_once flag.
+
+Args:
+run_once (bool): If True, runs the updating process once and stops. If False, runs indefinitely.
+
+
+Uses an infinity loop to run Inkycal nonstop or a single time based on run_once.
+Inkycal generates the image from all modules, assembles them in one image,
+refreshes the E-Paper and then sleeps until the next scheduled update or exits.
+
+
@@ -232,14 +241,14 @@
-inkycal.custom.functions. draw_border ( image xy size radius = 5 thickness = 1 shrinkage = (0.1, 0.1) )
+inkycal.custom.functions. draw_border ( image: <module 'PIL.Image' from '/home/runner/work/Inkycal/Inkycal/venv/lib/python3.11/site-packages/PIL/Image.py'>, xy: ~typing.Tuple[int, int], size: ~typing.Tuple[int, int], radius: int = 5, thickness: int = 1, shrinkage: ~typing.Tuple[int, int] = (0.1, 0.1) ) → None Draws a border at given coordinates.
Args:
image: The image on which the border should be drawn (usually im_black or
-im_colour.
xy: Tuple representing the top-left corner of the border e.g. (32, 100)
-where 32 is the x co-ordinate and 100 is the y-coordinate.
size: Size of the border as a tuple -> (width, height).
radius: Radius of the corners, where 0 = plain rectangle, 5 = round corners.
thickness: Thickness of the border in pixels.
The extracted timezone can be used to show the local time instead of UTC. e.g.
>>> import arrow
>>> print ( arrow . now ()) # returns non-timezone-aware time
->>> print ( arrow . now ( tz = get_system_tz ()) # prints timezone aware time.
+>>> print ( arrow . now ( tz = get_system_tz ())) # prints timezone aware time.
-inkycal.custom.functions. internet_available ( )
+inkycal.custom.functions. internet_available ( ) → bool checks if the internet is available.
Attempts to connect to google.com with a timeout of 5 seconds to check
if the network can be reached.
@@ -315,7 +324,7 @@
-inkycal.custom.functions. text_wrap ( text font = None max_width = None )
+inkycal.custom.functions. text_wrap ( text : str font = None max_width = None )
Splits a very long text into smaller parts
Splits a long text to smaller lines which can fit in a line with max_width.
Uses a Font object for more accurate calculations.
@@ -334,7 +343,7 @@
-inkycal.custom.functions. write ( image xy box_size text font = None ** kwargs )
+inkycal.custom.functions. write ( image: <module 'PIL.Image' from '/home/runner/work/Inkycal/Inkycal/venv/lib/python3.11/site-packages/PIL/Image.py'>, xy: ~typing.Tuple[int, int], box_size: ~typing.Tuple[int, int], text: str, font=None, **kwargs )
Writes text on an image.
Writes given text at given position on the specified image.
diff --git a/docs/objects.inv b/docs/objects.inv
index df0d12b8..e54dc411 100644
Binary files a/docs/objects.inv and b/docs/objects.inv differ
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
index 063dd06e..9bb91e7a 100644
--- a/docs/py-modindex.html
+++ b/docs/py-modindex.html
@@ -3,7 +3,7 @@
Python Module Index — inkycal 2.0.3 documentation
+ Python Module Index — inkycal 2.0.4 documentation
Quickstart — inkycal 2.0.3 documentation
+ Quickstart — inkycal 2.0.4 documentation
Search — inkycal 2.0.3 documentation
+ Search — inkycal 2.0.4 documentation
@@ -29,7 +29,7 @@ ready-to-flash version of Inkycal called InkycalOS-Lite with everything pre-inst
via [GitHub Sponsors](https://github.com/sponsors/aceisace). This helps keep up maintenance costs, implement new
features and fixing bugs. Please choose the one-time sponsor option and select the one with the plug-and-play version of
Inkycal. Then, send your email-address to which InkycalOS-Lite should be sent.
-Alternatively, you can also use the paypal.me link and send the same amount as Github sponsors to get access to
+Alternatively, you can also use the PayPal.me link and send the same amount as GitHub sponsors to get access to
InkycalOS-Lite!
## Main features
@@ -42,10 +42,13 @@ following built-in modules are supported:
* Image - Display an Image from URL or local file path.
* Slideshow - Cycle through images in a given folder and show them on the E-Paper.
* Feeds - Synchronise RSS/ATOM feeds from your favorite providers.
-* Stocks - Display stocks using Tickers from Yahoo! Finance.
+* Stocks - Display stocks using Tickers from Yahoo! Finance. Special thanks to @worstface
* Weather - Show current weather, daily or hourly weather forecasts from openweathermap.
* Todoist - Synchronise with Todoist app or website to show todos.
* iCanHazDad - Display a random joke from [iCanHazDad.com](iCanhazdad.com).
+* Webshot - Display a website as an image. Special thanks to @worstface
+* Tindie - Show the latest orders from your Tindie store.
+* XKCD - Show XKCD comics. Special thanks to @worstface
## Quickstart
@@ -56,7 +59,8 @@ Watch the one-minute video on getting started with Inkycal:
## Hardware guide
Before you can start, please ensure you have one of the supported displays and of the supported Raspberry
-Pi: `|4|3A|3B|3B+|2B|ZeroW|ZeroWH|Zero2W|`. We personally recommend the Raspberry Pi Zero W as this is relatively cheaper, uses
+Pi: `|4|3A|3B|3B+|2B|ZeroW|ZeroWH|Zero2W|`. We personally recommend the Raspberry Pi Zero W as this is relatively
+cheaper, uses
less power and is perfect to fit in a small photo frame once you have assembled everything.
**Serial** displays are usually cheaper, but slower. Their main advantage is ease of use, like being able to communicate
@@ -74,26 +78,27 @@ grayscale levels, which does not compare to the 256 grayscales of LCDs, but far
links below may or may not contain the required driver board. Please ensure you get the correct driver board for the
display!**
-| type | vendor | Where to buy |
-|---------------------------------------------------------------------------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| 7.5" Inkycal (plug-and-play) | Aceinnolab (author) | [Buy on Tindie](https://www.tindie.com/products/aceisace4444/inkycal-build-v1/) Pre-configured version of Inkycal with custom frame and a web-ui. You do not need to buy anything extra. Includes Raspberry Pi Zero W, 7.5" e-paper, microSD card, driver board, custom packaging and 1m of cable. Comes pre-assembled for plug-and-play. |
-| Inkycal frame (kit -> requires wires, 7.5" Display and Zero W with microSD card | Aceinnolab (author) | [Buy on Tindie](https://www.tindie.com/products/aceinnolab/inkycal-frame-custom-driver-board-only/) Ultraslim frame with custom-made front and backcover inkl. ultraslim driver board). You will need a Raspberry Pi, microSD card and a 7.5" e-paper display |
-| Driver board | Aceinnolab (author) | [Buy on Tindie](https://www.tindie.com/products/aceinnolab/universal-e-paper-driver-board-for-24-pin-spi/) Ultraslim, 24-pin SPI driver board for many serial e-paper displays. |
-| `[serial]` 12.48" (1304×984px) display | waveshare / gooddisplay | Search for `Waveshare 12.48" E-Paper 1304×984` on amazon or similar |
-| `[serial]` 7.5" (640x384px) -> v1 display (2/3-colour) | waveshare / gooddisplay | Search for `Waveshare 7.5" E-Paper 640x384` on amazon or similar |
-| `[serial]` 7.5" (800x480px) -> v2 display (2/3-colour) | waveshare / gooddisplay | Search for `Waveshare 7.5" E-Paper 800x480` on amazon or similar |
-| `[serial]` 7.5" (880x528px) -> v3 display (2/3-colour) | waveshare / gooddisplay | Search for `Waveshare 7.5" E-Paper 800x528` on amazon or similar |
-| `[serial]` 5.83" (400x300px) display | waveshare / gooddisplay | Search for `Waveshare 5.83" E-Paper 400x300` on amazon or similar |
-| `[serial]` 4.2" (400x300px)display | waveshare / gooddisplay | Search for `Waveshare 4.2" E-Paper 400x300` on amazon or similar | |
-| `[parallel]` 10.3" (1872×1404px) display | waveshare / gooddisplay | Search for `Waveshare 10.3" E-Paper 1872×1404` on amazon or similar |
-| `[parallel]` 9.7" (1200×825px) display | waveshare / gooddisplay | Search for `Waveshare 9.7" E-Paper 1200×825` on amazon or similar |
-| `[parallel]` 7.8" (1872×1404px) display | waveshare / gooddisplay | Search for `Waveshare 7.8" E-Paper 1872×1404` on amazon or similar |
-| Raspberry Pi Zero W | Raspberry Pi | Search for `Raspberry Pi Zero W` on amazon or similar |
-| MicroSD card | Sandisk | Search for `MicroSD card 8GB` on amazon or similar |
+| type | vendor | Where to buy |
+|---------------------------------------------------------------------------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| 12.48" Inkycal (plug-and-play) | Aceinnolab (author) | [Buy on Tindie](https://www.tindie.com/products/aceinnolab/inkycal-1248-build/) Pre-configured version of Inkycal with matte black aluminium designer frame and a web-ui. You do not need to buy anything extra. Includes Raspberry Pi Zero W, 12.48" e-paper, microSD card, driver board, custom packaging and 1m of cable. Comes pre-assembled for plug-and-play. |
+| 7.5" Inkycal (plug-and-play) | Aceinnolab (author) | [Buy on Tindie](https://www.tindie.com/products/aceisace4444/inkycal-build-v1/) Pre-configured version of Inkycal with custom frame and a web-ui. You do not need to buy anything extra. Includes Raspberry Pi Zero W, 7.5" e-paper, microSD card, driver board, custom packaging and 1m of cable. Comes pre-assembled for plug-and-play. |
+| Inkycal frame (kit -> requires wires, 7.5" Display and Zero W with microSD card | Aceinnolab (author) | [Buy on Tindie](https://www.tindie.com/products/aceinnolab/inkycal-frame-custom-driver-board-only/) Ultraslim frame with custom-made front and backcover inkl. ultraslim driver board). You will need a Raspberry Pi, microSD card and a 7.5" e-paper display |
+| Driver board | Aceinnolab (author) | [Buy on Tindie](https://www.tindie.com/products/aceinnolab/universal-e-paper-driver-board-for-24-pin-spi/) Ultraslim, 24-pin SPI driver board for many serial e-paper displays. |
+| `[serial]` 12.48" (1304×984px) display | waveshare / gooddisplay | Search for `Waveshare 12.48" E-Paper 1304×984` on amazon or similar |
+| `[serial]` 7.5" (640x384px) -> v1 display (2/3-colour) | waveshare / gooddisplay | Search for `Waveshare 7.5" E-Paper 640x384` on amazon or similar |
+| `[serial]` 7.5" (800x480px) -> v2 display (2/3-colour) | waveshare / gooddisplay | Search for `Waveshare 7.5" E-Paper 800x480` on amazon or similar |
+| `[serial]` 7.5" (880x528px) -> v3 display (2/3-colour) | waveshare / gooddisplay | Search for `Waveshare 7.5" E-Paper 800x528` on amazon or similar |
+| `[serial]` 5.83" (400x300px) display | waveshare / gooddisplay | Search for `Waveshare 5.83" E-Paper 400x300` on amazon or similar |
+| `[serial]` 4.2" (400x300px)display | waveshare / gooddisplay | Search for `Waveshare 4.2" E-Paper 400x300` on amazon or similar | |
+| `[parallel]` 10.3" (1872×1404px) display | waveshare / gooddisplay | Search for `Waveshare 10.3" E-Paper 1872×1404` on amazon or similar |
+| `[parallel]` 9.7" (1200×825px) display | waveshare / gooddisplay | Search for `Waveshare 9.7" E-Paper 1200×825` on amazon or similar |
+| `[parallel]` 7.8" (1872×1404px) display | waveshare / gooddisplay | Search for `Waveshare 7.8" E-Paper 1872×1404` on amazon or similar |
+| Raspberry Pi Zero W | Raspberry Pi | Search for `Raspberry Pi Zero W` on amazon or similar |
+| MicroSD card | Sandisk | Search for `MicroSD card 8GB` on amazon or similar |
## Configuring the Raspberry Pi
-Flash Raspberry Pi OS on your microSD card (min. 4GB) with [Raspberry Pi Imager](https://rptl.io/imager).
-Use the following settings:
+
+Flash Raspberry Pi OS on your microSD card (min. 4GB) with [Raspberry Pi Imager](https://rptl.io/imager). Please use this version of [Raspberry Pi OS - bookworm](https://downloads.raspberrypi.com/raspios_lite_armhf/images/raspios_lite_armhf-2023-05-03/2023-05-03-raspios-bullseye-armhf-lite.img.xz) as the latest release is known to have some issues with the latest kernel update.
| option | value |
|:--------------------------|:---------------------------:|
@@ -163,13 +168,19 @@ top of the repo to get access to Inkycal-OS-Lite. Alternatively, you can also us
amount as GitHub sponsors to get access to InkycalOS-Lite!
This will help keep this project growing and cover the ongoing expenses too! Win-win for everyone! 🎊
+### Bonus: PiSugar support
+The PiSugar is a battery pack for the Raspberry Pi Zero W. It can be used to power the Raspberry Pi and the e-paper, allowing battery life up to several weeks.
+If you have a PiSugar board, please see the wiki page on how to install the PiSugar driver and configure Inkycal to work with it:
+[PiSugar support](https://github.com/aceinnolab/Inkycal/wiki/PiSugar-support)
+
+
### Manual installation
Run the following steps to install Inkycal. Do **not** use sudo for this, except where explicitly specified.
```bash
# Raspberry Pi specific section start
-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-dev
+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-dev
git clone https://github.com/WiringPi/WiringPi
cd WiringPi
./build
diff --git a/clear_display.py b/clear_display.py
deleted file mode 100644
index be726f3f..00000000
--- a/clear_display.py
+++ /dev/null
@@ -1,12 +0,0 @@
-"""
-Clears the display of any content.
-"""
-from inkycal import Inkycal
-
-print("loading Inkycal and display driver...")
-inky = Inkycal(render=True) # Initialise Inkycal
-print("clearing display...")
-inky.calibrate(cycles=1) # Calibrate the display
-print("clear complete...")
-
-print("finished!")
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
index 138ae34f..d5f566df 100644
--- a/docs/_static/documentation_options.js
+++ b/docs/_static/documentation_options.js
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
- VERSION: '2.0.3',
+ VERSION: '2.0.4',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js
index 92da3f8b..b08d58c9 100644
--- a/docs/_static/searchtools.js
+++ b/docs/_static/searchtools.js
@@ -178,7 +178,7 @@ const Search = {
htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
- for (const removalQuery of [".headerlinks", "script", "style"]) {
+ for (const removalQuery of [".headerlink", "script", "style"]) {
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
}
if (anchor) {
@@ -328,13 +328,14 @@ const Search = {
for (const [title, foundTitles] of Object.entries(allTitles)) {
if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
for (const [file, id] of foundTitles) {
- let score = Math.round(100 * queryLower.length / title.length)
+ const score = Math.round(Scorer.title * queryLower.length / title.length);
+ const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
normalResults.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
null,
- score,
+ score + boost,
filenames[file],
]);
}
diff --git a/docs/about.html b/docs/about.html
index 2fa7e792..1adec597 100644
--- a/docs/about.html
+++ b/docs/about.html
@@ -4,7 +4,7 @@
-