edward/MMM-pages
1
0
Fork 0
mirror of https://github.com/edward-shen/MMM-pages.git synced 2025-03-31 10:08:19 -07:00
Code Issues Projects Releases Packages Wiki Activity

Use timings object

Browse source
This commit is contained in:
Kristjan ESPERANTO 2025-03-23 22:56:01 +01:00
parent 82b6aebb8f
commit acf468651f
No known key found for this signature in database
2 changed files with 15 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
MMM-pages.js
View file

@ -12,7 +12,7 @@ Module.register('MMM-pages', {
hiddenPages: {},
animationTime: 1000,
rotationTime: 0,
individualRotationTimes: [],
timings: { default: 0 },
rotationFirstPage: 0, // Keep for compatibility
rotationHomePage: 0,
rotationDelay: 10000,
@ -53,8 +53,13 @@ Module.register('MMM-pages', {
this.config.rotationHomePage = this.config.rotationFirstPage;
}
if (this.config.rotationTime) {
Log.warn('[MMM-pages] The config option "rotationTime" is deprecated. Please used "rotationHomePage" instead.');
this.config.timings.default = this.config.rotationTime;
}
// Disable rotation if an invalid input is given
this.config.rotationTime = Math.max(this.config.rotationTime, 0);
this.config.timings.default = Math.max(this.config.timings.default, 0);
this.config.rotationDelay = Math.max(this.config.rotationDelay, 0);
this.config.rotationHomePage = Math.max(this.config.rotationHomePage, 0);
@ -222,14 +227,14 @@ Module.register('MMM-pages', {
* @param {number} delay the delay, in milliseconds.
*/
resetTimerWithDelay(delay) {
if (this.config.rotationTime > 0 || this.config.individualRotationTimes.length) {
if (this.config.timings.default > 0 || Object.keys(this.config.timings).length > 1) {
// This timer is the auto rotate function.
clearInterval(this.timer);
// This is delay timer after manually updating.
clearInterval(this.delayTimer);
let currentRotationTime = this.config.rotationTime;
if (this.config.individualRotationTimes[this.curPage]) {
currentRotationTime = this.config.individualRotationTimes[this.curPage];
let currentRotationTime = this.config.timings.default;
if (this.config.timings[this.curPage]) {
currentRotationTime = this.config.timings[this.curPage];
}
const self = this;

8
README.md
View file

@ -158,15 +158,15 @@ You have to add the class name to the config of the module you want to show on a
### Configuration options
| Option | Type | Default Value | Description |
| --- | --- | --- | --- |
| Option | Type | Default Value | Description |
| ------------------- | -------------------------- | ------------------------ | ----------- |
| `modules` | `[[String...]...]` | `[]` | A 2D String array of what each module should be on which page. Note that all entries must take their class name (e.g. this module's class name is `MMM-pages`, while the default modules may just have `newsfeed`, without the `MMM-` prefix. |
| `fixed` | `[String...]` | `["MMM-page-indicator"]` | Which modules should show up all the time. |
| `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` | Time, in milliseconds, between automatic page changes. |
| `individualRotationTimes` | `[int, int, int...]` | `[]` | An array of integers (milliseconds) that define the rotation time of each page. If the array is shorter than the number of pages, `rotationTime` will be used for the remaining pages. You only need this if you want different rotation times for each page. |
| `rotationTime` | `int` | `0` | **Deprecated**. Use `timings` instead. |
| `timings` | `object` | `{ default: 0 }` | An object whose keys define the rotation time of the pages in milliseconds. <br>Example, where each page is 3 seconds, except page 3 which is 20 seconds:<br>`{ default: 3000, 2: 20000 }`<br>If a page is not defined, it will use the `default` value. <br> *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. |
| `rotationFirstPage` | *NA* | *NA* | **Deprecated**. Use `rotationHomePage` instead. |