Cybele项目使用教程

1. 项目目录结构及介绍

Cybele项目是一个用于将蓝牙低功耗（BLE）设备桥接至MQTT的开源应用，其目录结构如下：

.
├── deployment           # 部署相关文件
├── docs                # 文档资料
├── lib                 # 项目库文件
├── .automated.eslintrc.json  # ESLint配置文件
├── .eslintrc.json      # ESLint配置文件
├── LICENSE             # 项目许可证文件
├── Readme.md           # 项目说明文件
├── app.js              # 项目主入口文件
├── config.default.json # 默认配置文件
├── package-lock.json   # 依赖锁文件
├── package.json        # 项目依赖及配置

• deployment: 包含部署项目所需的配置文件和脚本。
• docs: 存放与项目相关的文档资料。
• lib: 项目的主要库文件，包含项目的核心代码。
• .automated.eslintrc.json 和 .eslintrc.json: ESLint的配置文件，用于保持代码风格的一致性。
• LICENSE: Apache-2.0许可证文件，说明项目的开源协议。
• Readme.md: 项目说明文件，介绍项目的相关信息。
• app.js: 项目的主入口文件，负责启动整个应用程序。
• config.default.json: 默认的配置文件，作为配置信息的起点。
• package-lock.json 和 package.json: 包含项目的依赖关系和配置信息，package-lock.json 用于锁定依赖版本。

2. 项目的启动文件介绍

项目的启动文件是app.js。该文件负责初始化和运行Cybele应用程序。要启动项目，可以使用以下命令：

node app.js

如果希望项目在系统启动时自动运行，可以使用systemd单元文件，该文件通常位于/etc/systemd/system/目录下。需要确保文件中的路径与项目实际路径一致。

3. 项目的配置文件介绍

项目的配置文件是config.default.json。在项目部署时，需要将此文件复制为config.json，并根据实际情况进行编辑。

配置文件包含项目运行所需的各种设置，如MQTT服务器的地址、端口、认证信息以及BLE设备的相关配置。

编辑config.json时，请确保所有必要的配置项都已正确填写，例如：

{
  "mqtt": {
    "host": "mqtt.example.com",
    "port": 1883,
    "username": "user",
    "password": "password"
  },
  // 其他配置...
}

在完成配置文件的修改后，即可启动app.js来运行整个项目。