Firescrew 项目使用教程

1. 项目目录结构及介绍

Firescrew 的项目目录结构如下：

firescrew/
├── assets/               # 存放静态资源，如图标等
├── demoStream/           # 演示流相关文件
├── doc/                  # 文档资料
├── docker/               # Docker 相关配置和脚本
├── getDimensions/        # 尺寸获取工具
├── legacy/               # 旧版本模型和代码
│   └── models/           # 旧版本模型文件
├── media/                # 存放媒体文件，如视频、图片等
├── pkg/                  # 包含可执行文件和二进制文件
├── .gitignore            # Git 忽略文件列表
├── LICENSE               # 开源协议文件
├── README.md             # 项目说明文件
├── env.sh                # 环境变量设置脚本
├── firescrew.go          # 主程序文件
├── go.mod                # Go 依赖管理文件
└── go.sum                # Go 依赖校验文件

2. 项目的启动文件介绍

项目的启动文件是 firescrew.go，这是 Go 语言编写的程序入口。该文件包含了主要的逻辑，用于初始化和运行程序。以下是启动文件的基本结构：

• 初始化配置
• 设置日志
• 创建 HTTP 服务器
• 启动 RTSP 流处理
• 处理命令行参数

运行程序时，可以通过命令行参数来指定配置文件，或者使用默认配置。

3. 项目的配置文件介绍

项目的配置文件是一个 JSON 文件，通常在运行程序时指定。如果没有指定，程序会使用默认的配置。配置文件包含了以下内容：

• General：通用设置，如日志级别、MQTT 配置等
• Camera：摄像头配置，包括摄像头列表和每个摄像头的具体设置
• Model：模型配置，指定使用的对象识别模型和相应参数
• WebUI：Web 界面配置，包括端口、认证等
• Storage：存储配置，定义了事件和媒体文件的存储路径

配置文件的结构示例如下：

{
  "General": {
    "LogLevel": "info",
    "MQTT": {
      "Enabled": true,
      "Server": "mqtt.example.com",
      "Port": 1883,
      "Topic": "firescrew/events"
    }
  },
  "Camera": [
    {
      "Name": "Camera1",
      "RTSP": "rtsp://camera1.example.com/stream",
      "Resolution": "1280x720",
      "FPS": 30,
      "Model": "YOLOv8"
    }
  ],
  "Model": {
    "Type": "YOLOv8",
    "Path": "/path/to/model"
  },
  "WebUI": {
    "Port": 8080,
    "Auth": {
      "Username": "admin",
      "Password": "password"
    }
  },
  "Storage": {
    "Events": "/path/to/events",
    "Media": "/path/to/media"
  }
}

使用配置文件启动程序时，可以通过命令行参数 config.json 来指定配置文件的路径。