MMM-pages 项目教程

MMM-pages 项目教程

MMM-pages Add pages to your MagicMirror²! 项目地址: https://gitcode.com/gh_mirrors/mm/MMM-pages

1. 项目的目录结构及介绍

MMM-pages 项目的目录结构如下：

MMM-pages/
├── CODE_OF_CONDUCT.md
├── LICENSE
├── MMM-pages.js
├── README.md
├── example.webp
├── pages.css
└── github/
    └── ISSUE_TEMPLATE/
        └── eslintrc.json
        └── gitignore

目录结构介绍

• CODE_OF_CONDUCT.md: 项目的行为准则文件。
• LICENSE: 项目的开源许可证文件。
• MMM-pages.js: 项目的主启动文件，负责页面管理和切换。
• README.md: 项目的说明文档，包含项目的介绍、安装和使用方法。
• example.webp: 项目的示例图片。
• pages.css: 项目的样式文件，定义页面的样式。
• github/ISSUE_TEMPLATE/: 包含项目的 Issue 模板文件，用于规范化用户提交的问题。

2. 项目的启动文件介绍

MMM-pages.js

MMM-pages.js 是 MMM-pages 项目的主启动文件，负责页面的管理和切换。该文件主要包含以下功能：

• 页面初始化: 初始化页面配置，加载页面模块。
• 页面切换: 根据配置文件中的设置，自动或手动切换页面。
• 通知处理: 处理来自其他模块的通知，如 PAGE_CHANGED、PAGE_INCREMENT 等。
• 自动旋转: 根据配置文件中的 rotationTime 参数，自动切换页面。

3. 项目的配置文件介绍

config.js

config.js 是 MagicMirror² 项目的配置文件，用于配置 MMM-pages 模块。以下是 MMM-pages 模块的主要配置选项：

modules: [
  {
    module: 'MMM-pages',
    config: {
      modules: [
        ["newsfeed"],
        ["calendar", "compliments"]
      ],
      fixed: ["clock", "weather", "MMM-page-indicator"],
      hiddenPages: {
        "screenSaver": ["clock", "MMM-SomeBackgroundImageModule"],
        "admin": ["MMM-ShowMeSystemStatsModule", "MMM-AnOnScreenMenuModule"]
      },
      animationTime: 1000,
      rotationTime: 0,
      rotationDelay: 10000,
      rotationHomePage: 0,
      homePage: 0,
      useLockString: true
    }
  }
]

配置选项介绍

• modules: 定义每个页面包含的模块，使用二维字符串数组表示。
• fixed: 定义始终显示的模块。
• hiddenPages: 定义特殊隐藏页面，这些页面不参与正常页面轮换。
• animationTime: 页面切换动画时间，单位为毫秒。
• rotationTime: 自动页面切换的时间间隔，单位为毫秒。
• rotationDelay: 手动页面切换后，自动页面切换的延迟时间，单位为毫秒。
• rotationHomePage: 自动返回首页的时间间隔，单位为毫秒。
• homePage: 定义首页的索引。
• useLockString: 是否使用锁字符串来显示或隐藏页面，高级用户选项。

通过以上配置，您可以根据需要自定义 MMM-pages 模块的行为和显示内容。

MMM-pages Add pages to your MagicMirror²! 项目地址: https://gitcode.com/gh_mirrors/mm/MMM-pages