ONVIF Node.js 项目教程

2025-04-19 18:12:05作者：温玫谨Lighthearted

1. 项目目录结构及介绍

ONVIF Node.js 项目是一个用于与 ONVIF 协议兼容的设备进行交互的 Node.js 库。以下是项目的目录结构及其介绍：

.
├── .github/                  # GitHub 仓库配置文件
├── examples/                 # 示例代码文件夹
├── lib/                      # 项目核心代码库
├── promises/                 # 使用 Promise API 的相关代码
├── test/                     # 测试代码文件夹
├── .coveralls.yml             # Coveralls 配置文件
├── .eslintrc.json            # ESLint 配置文件
├── .gitignore                # Git 忽略文件
├── .mocharc.js               # Mocha 配置文件
├── .npmignore                # npm 忽略文件
├── .travis.yml               # Travis CI 配置文件
├── CHANGELOG.md              # 更新日志
├── CONTRIBUTING.md           # 贡献指南
├── LICENSE                   # 许可证文件
├── README.md                 # 项目自述文件
├── package-lock.json         # npm 锁定文件
├── package.json              # npm 包配置文件
└── startServerMockup.js      # 启动模拟服务器的脚本

.github/：存放与 GitHub 仓库相关的配置文件，如 issue 模板等。
examples/：包含项目使用示例的代码。
lib/：存放项目的主要 JavaScript 源文件。
promises/：存放使用 Promise API 封装的相关代码。
test/：包含对项目进行单元测试的代码。
其他文件：包括项目配置文件、许可证、自述文件等。

2. 项目的启动文件介绍

项目的启动文件是 startServerMockup.js。该脚本的主要目的是启动一个模拟服务器，用于在开发和测试过程中模拟 ONVIF 设备的行为。以下是启动文件的主要内容：

// 引入所需的 Node.js 模块
const http = require('http');
const Cam = require('onvif/promises');
const io = require('socket.io');
const rtsp = require('rtsp-ffmpeg');

// 创建 HTTP 服务器
const server = http.createServer((req, res) => {
  // 返回 HTML 客户端页面
  res.end('<!DOCTYPE html><body><canvas width="640" height="480" /></body></html>');
});

// 将 socket.io 中间件应用到服务器
const ioServer = io(server);

// 配置并启动服务器
server.listen(6147);

// 创建摄像头实例
const cam = new Cam({
  username: 'username',
  password: 'password',
  hostname: '192.168.0.116',
  port: 2020
});

// 连接摄像头
cam.connect().then(() => {
  // 获取流媒体 URI
  return cam.getStreamUri({ protocol: 'RTSP' });
}).then(input => {
  // 创建 FFMpeg 流
  const stream = new rtsp.FFMpeg({
    input: input.uri.replace('://', `://${cam.username}:${cam.password}@`),
    resolution: '320x240',
    quality: 3
  });

  // 处理客户端连接
  ioServer.on('connection', socket => {
    const pipeStream = socket.emit.bind(socket, 'data');
    stream.on('disconnect', () => stream.removeListener('data', pipeStream));
    stream.on('data', pipeStream);
  });
});

3. 项目的配置文件介绍

项目的配置文件包括 .eslintrc.json、.mocharc.js 和其他一些配置文件。

.eslintrc.json：ESLint 配置文件，用于定义代码风格和规则，确保代码质量和一致性。
.mocharc.js：Mocha 配置文件，用于配置单元测试框架的行为。

这些配置文件通常不需要用户直接修改，它们在项目开发过程中提供标准和自动化配置。如果需要自定义项目配置，可以参考相应配置文件的文档进行修改。

onvif

ONVIF node.js implementation

项目地址：https://gitcode.com/gh_mirrors/onvi/onvif

登录后查看全文

ONVIF Node.js 项目教程

1. 项目目录结构及介绍

2. 项目的启动文件介绍

3. 项目的配置文件介绍

项目优选