MMM-GooglePhotos 项目安装与使用教程
1. 项目目录结构及介绍
MMM-GooglePhotos/
├── node_helper.js
├── package.json
├── package-lock.json
├── README.md
├── config.js
├── google_auth.json
├── jsconfig.json
├── shuffle.js
└── INSTALL.md
目录结构说明
- node_helper.js: 项目的辅助模块,用于处理与Google Photos的交互。
- package.json: 项目的依赖配置文件,定义了项目所需的Node.js模块。
- package-lock.json: 锁定项目依赖版本的文件。
- README.md: 项目的说明文档,包含项目的简介、安装和配置说明。
- config.js: 项目的配置文件,定义了模块的各项参数。
- google_auth.json: Google Photos的认证配置文件。
- jsconfig.json: JavaScript配置文件,用于IDE的代码提示和自动补全。
- shuffle.js: 用于随机排序照片的脚本。
- INSTALL.md: 项目的安装说明文档。
2. 项目的启动文件介绍
项目的启动文件主要是 node_helper.js
,它负责与Google Photos API进行交互,获取照片并将其显示在MagicMirror上。启动时,MagicMirror会加载这个文件,并通过配置文件中的参数来决定显示哪些照片。
3. 项目的配置文件介绍
项目的配置文件是 config.js
,它定义了模块的各项参数。以下是配置文件的主要内容:
{
module: "MMM-GooglePhotos",
position: "top_right",
config: {
albums: [], // 设置你的相册名称,例如 ["My wedding", "family share", "Travle to Paris"]
updateInterval: 1000 * 60, // 最小10秒
sort: "new", // 可以是 "old" 或 "random"
uploadAlbum: null, // 仅适用于通过 `create_uploadable_album.js` 创建的相册
condition: {
fromDate: null, // 或者 "2018-03",RFC 格式可用
toDate: null, // 或者 "2019-12-25"
minWidth: null, // 或者 400
maxWidth: null, // 或者 8000
minHeight: null, // 或者 400
maxHeight: null, // 或者 8000
minWHRatio: null,
maxWHRatio: null // WHRatio = 宽度/高度比率 ( ==1 : 方形照片, < 1 : 竖向照片, > 1 : 横向照片)
},
showWidth: 1080, // 这些值将用于下载照片的质量,建议使用MagicMirror区域的实际尺寸
showHeight: 1920,
timeFormat: "YYYY/MM/DD HH:mm" // 或者 `relative` 可以用于相对时间格式
}
}
配置文件说明
- albums: 指定要显示的Google Photos相册名称。
- updateInterval: 照片更新的时间间隔,最小为10秒。
- sort: 照片的排序方式,可以是 "new"(最新)、"old"(最旧)或 "random"(随机)。
- uploadAlbum: 仅适用于通过
create_uploadable_album.js
创建的相册。 - condition: 照片的筛选条件,包括日期范围、尺寸和宽高比。
- showWidth 和 showHeight: 照片显示的宽度和高度,建议使用MagicMirror区域的实际尺寸。
- timeFormat: 照片的时间格式,可以是绝对时间或相对时间。
通过以上配置,你可以自定义MMM-GooglePhotos模块在MagicMirror上的显示效果。