MMM-SUSI-AI 开源项目教程

MMM-SUSI-AI 开源项目教程

MMM-SUSI-AISUSI.AI implementation for Magic Mirror项目地址:https://gitcode.com/gh_mirrors/mm/MMM-SUSI-AI

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

MMM-SUSI-AI 项目的目录结构如下：

MMM-SUSI-AI/
├── config/
├── resources/
├── src/
├── styles/
├── typings/
├── .gitignore
├── .travis.yml
├── LICENSE
├── MMM-SUSI-AI.js
├── README.md
├── install_flite.sh
├── node_helper.js
├── package.json
├── tsconfig.json
└── tslint.json

目录介绍

• config/: 包含项目的配置文件。
• resources/: 包含项目所需的资源文件。
• src/: 包含项目的源代码文件。
• styles/: 包含项目的样式文件。
• typings/: 包含 TypeScript 类型定义文件。
• .gitignore: Git 忽略文件列表。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证文件。
• MMM-SUSI-AI.js: 项目的主文件。
• README.md: 项目说明文档。
• install_flite.sh: 安装 Flite TTS 的脚本。
• node_helper.js: Node 助手文件。
• package.json: 项目的依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。
• tslint.json: TypeScript 代码风格检查配置文件。

2. 项目的启动文件介绍

项目的启动文件是 MMM-SUSI-AI.js。这个文件是 Magic Mirror 模块的主入口点，负责初始化和启动 SUSI AI 模块。

启动文件主要功能

• 初始化模块配置。
• 设置热词检测。
• 配置语音识别和文本转语音服务。
• 处理用户请求并调用 SUSI API 获取回答。
• 显示回答和执行相应的动作。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.js。这个文件包含了 Magic Mirror 的配置信息，包括 SUSI AI 模块的配置。

配置文件示例

{
  module: "MMM-SUSI-AI",
  position: "top_bar",
  config: {
    hotword: "Susi"
  }
}

配置项说明

• module: 指定模块名称，这里是 MMM-SUSI-AI。
• position: 指定模块在 Magic Mirror 中的显示位置，例如 top_bar。
• config: 包含模块的具体配置项。
  • hotword: 设置热词，例如 Susi。

高级配置

如果需要使用带有人脸识别的认证模式，可以按照以下步骤进行配置：

1. 安装 MMM-Facial-Recognition 模块。
2. 在 config.js 文件中添加以下配置：

{
  module: "MMM-SUSI-AI",
  position: "top_bar",
  config: {
    hotword: "Susi",
    users: [
      {
        username: "user1",
        password: "password1"
      },
      {
        username: "user2",
        password: "password2"
      }
    ]
  }
}

配置项说明

• users: 包含多个用户对象，每个用户对象包含 username 和 password 字段。

通过以上配置，可以实现 SUSI AI 模块在 Magic Mirror 中的集成和使用。

MMM-SUSI-AISUSI.AI implementation for Magic Mirror项目地址:https://gitcode.com/gh_mirrors/mm/MMM-SUSI-AI