From 571e0235395b65ec3db6cdef6c7cbe6bb131fb7b Mon Sep 17 00:00:00 2001 From: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com> Date: Tue, 25 Mar 2025 08:03:09 +0100 Subject: [PATCH] Update doc about rotationTime --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 793d156..e6ab3f3 100644 --- a/README.md +++ b/README.md @@ -165,7 +165,7 @@ You have to add the class name to the config of the module you want to show on a | `excludes` | *NA* | *NA* | **Deprecated**. Use `fixed` instead. | | `hiddenPages` | `{String: [String...]...}` | `{}` | An Object defining special `hiddenPages` which are not available on the normal page rotation and only accessible via a notification. Modules defined in `fixed` are ignored and need to be also added if you wish to have them on any hidden page. | | `animationTime` | `int` | `1000` | Fading animation time. Set to `0` for instant change. Value is in milliseconds (1 second = 1000 milliseconds). | -| `rotationTime` | `int` | `0` | **Deprecated**. Use `timings` instead. | +| `rotationTime` | *NA* | *NA* | **Deprecated**. Use `timings` instead. | | `timings` | `object` | `{ default: 0 }` | An object whose keys define the rotation time of the pages in milliseconds.
Example, where each page is 3 seconds, except page 3 which is 20 seconds:
`{ default: 3000, 2: 20000 }`
If a page is not defined, it will use the `default` value.
*Note:* Remember that the numbering starts at 0, so the first page is `0`, the second page is `1`, and so forth. | | `rotationDelay` | `int` | `10000` | Time, in milliseconds, of how long should a manual page change linger before returning to automatic page changing. In other words, how long should the timer wait for after you manually change a page. This does include the animation time, so you may wish to increase it by a few seconds or so to account for the animation time. | | `rotationHomePage` | `int` | `0` | Time, in milliseconds, before automatically returning to the home page. If a home page is not set, this returns to the leftmost page instead. |