From a02a3ffdee21a08de507ee1c56705569ed6be91c Mon Sep 17 00:00:00 2001 From: github-actions Date: Tue, 25 Jun 2024 17:14:45 +0000 Subject: [PATCH] update docs [bot] --- docs/genindex.html | 12 ++++++---- docs/inkycal.html | 53 ++++++++++++++++++++++++++------------------ docs/objects.inv | Bin 634 -> 646 bytes docs/searchindex.js | 2 +- 4 files changed, 40 insertions(+), 27 deletions(-) diff --git a/docs/genindex.html b/docs/genindex.html index 4bca78f..be82be7 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -129,6 +129,10 @@ +
@@ -253,6 +257,10 @@ +
@@ -285,10 +293,6 @@

T

-
@@ -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)

Inkycal main class

Main class of Inkycal, test and run the main Inkycal program.

@@ -157,35 +158,21 @@ cycles. After a refresh cycle, a new image is generated and shown.

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:
    -

  • int -> the remaining time in seconds until next update

    • -
+
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 @@ checks if the images could be generated correctly.

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.

+
+
diff --git a/docs/objects.inv b/docs/objects.inv index df0d12b84eda2aa56ec36add55bb97cc65ffa7c3..e54dc411ad5904efd6d0c696c83bd3342a7cd7b2 100644 GIT binary patch delta 538 zcmV+#0_FYs1cn8WcYn=p+b|5r?|upc+cm~|?X6fZJq+lu2M`#Gj)m%Llw{X^`pTA* z*jSf1jt}_|#s5!~L`o9+tt&wmWpLi8q6)h7!f2PALg)&6i(2xy&;aYnsGp%0=bLeI)CR;G5@ieBD6=+5d{qh z346JISvOl zp|1^Jt~Eh>Zd$!U%c)}&)+jBR5}jk?0^JT+KI||;OvKn=7RaTdTD~*?>I?A`Bx(+{ zY^yF23XqcVF@L?*OlE>AB?2*Qa4h?KdHo5nEp2w5+zXTjIIGAgR*A(qbe$MTZozW3 zX*XOwXUN~kiESnn9B^H}pX5W$oj}Xe{R_ZwK~_@OwNsg(hHT$}vr#yG?reZjNC(`2 zV+k99?FJ-5Wg284Z4H~?j&Gw?py8XvSC);H;jiE3uzxqf=g#v-ZpwW3kPn8TKYtqf z#v3K$*s$Jb;yap>_j4>}X>7bcqA93Y*w7D}9Z(C+@qG}+7Y@o^dbB3(OaC`JyN&#r zN4opx>~T7C&3T5W*yBQd5rge^$ByLwD;)wUnn~{!*=rX!O3&4QgDBse2bwMJ*_xEU cPwmXbY7;H%`AEr@T>qs0*SNjeC%q;#YlkonYybcN delta 526 zcmV+p0`dKZ1^NV#cYn!l+%OD=?|upc?RAXinp@Faaww3Z4wrsBsMQ?+N{WC~}joeUU-?tmFM)?p{G&p>jhOot4l zZ6OQpc(2(6n!Z`QA=%g&^!Z5)dlRVi#2>k-%iTjc8Gokv^7}M5A1MXLj*UJSzOyNL zKgDL2#>V3#nu3ar4dbH40kzN^-zH(aouC}0M{CkPkAI7^+st2hq;q@8p0~5qoOgJN zJtpdd80@e+P9*oA=_Qb&xtRS#_A