OpenDataCam 项目安装与使用指南

1. 项目目录结构及介绍

OpenDataCam 项目的目录结构如下：

opendatacam/
├── components/
├── docker/
├── pages/
├── public/
├── scripts/
├── server/
├── spec/
├── statemanagement/
├── styles/
├── utils/
├── .dockerignore
├── .env.example
├── .eslintrc.json
├── .gitignore
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── apidoc.json
├── config.json
├── package-lock.json
├── package.json
├── postcss.config.js
├── server.js
└── tailwind.config.js

目录介绍：

• components/: 包含项目的前端组件。
• docker/: 包含 Docker 相关的配置文件和脚本。
• pages/: 包含 Next.js 页面组件。
• public/: 包含静态资源文件。
• scripts/: 包含项目的脚本文件。
• server/: 包含服务器端代码。
• spec/: 包含项目的测试文件。
• statemanagement/: 包含状态管理相关的代码。
• styles/: 包含样式文件。
• utils/: 包含工具函数和辅助代码。
• .dockerignore: Docker 忽略文件。
• .env.example: 环境变量示例文件。
• .eslintrc.json: ESLint 配置文件。
• .gitignore: Git 忽略文件。
• CODE_OF_CONDUCT.md: 行为准则文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明文件。
• apidoc.json: API 文档配置文件。
• config.json: 项目配置文件。
• package-lock.json: npm 锁定文件。
• package.json: npm 包管理文件。
• postcss.config.js: PostCSS 配置文件。
• server.js: 服务器启动文件。
• tailwind.config.js: Tailwind CSS 配置文件。

2. 项目启动文件介绍

项目的启动文件是 server.js，该文件负责启动服务器并初始化 OpenDataCam 应用。以下是 server.js 的主要功能：

• 初始化 Express 服务器。
• 配置路由和中间件。
• 启动 WebSocket 服务器以支持实时数据传输。
• 加载配置文件并应用配置。

3. 项目的配置文件介绍

项目的配置文件是 config.json，该文件包含了 OpenDataCam 的所有配置选项。以下是 config.json 的主要配置项：

{
  "VIDEO_INPUT": "file",
  "VIDEO_FILEPATH": "demo.mp4",
  "NEURAL_NETWORK": "yolov4",
  "DISPLAY_CLASSES": ["car", "bus", "person"],
  "COUNTER_LOGIC": "fine_grained",
  "TRAJECTORY_ANALYSIS": true,
  "REAL_TIME_VIDEO": true,
  "DEVICE": "jetson_nano",
  "PORT": 8080
}

配置项介绍：

• VIDEO_INPUT: 视频输入源，可以是 file、usbcam、raspberrycam 等。
• VIDEO_FILEPATH: 视频文件路径，当 VIDEO_INPUT 为 file 时有效。
• NEURAL_NETWORK: 使用的神经网络模型，如 yolov4。
• DISPLAY_CLASSES: 需要检测和显示的对象类别。
• COUNTER_LOGIC: 计数逻辑，如 fine_grained。
• TRAJECTORY_ANALYSIS: 是否启用轨迹分析。
• REAL_TIME_VIDEO: 是否启用实时视频分析。
• DEVICE: 运行设备，如 jetson_nano。
• PORT: 服务器端口。

通过修改 config.json 文件，可以自定义 OpenDataCam 的行为和功能。