@2bad/onvif

中文文档
2.3.0发布于 2026/10/12MITTypeScriptES Module零依赖构建来源已验证近 30 天下载 5061

无运行时间依赖的 TypeScript 的高性能 ONVIF 客户端

中文使用文档
文档目录5 节
  1. 安装
  2. 快开始
  3. 实例
  4. API 密码
  5. 许可证

@ 2bad/ onvif

没有运行时间依赖的 TypeScript 的 ONVIF 客户端 .

安装

npm install @2bad/onvif

需要节点.js 26或后. 仅限无害环境管理.

发现、事件、成像、设备管理、媒体和PTZ @2bad/onvif-discovery, (中文(简体) ), @2bad/onvif-events, (中文(简体) ), @2bad/onvif-imaging, (中文(简体) ), @2bad/onvif-management, (中文(简体) ), @2bad/onvif-media 财务报告和审定财务报表 @2bad/onvif-ptz。 。 。 .

快开始

import { Device } from '@2bad/onvif'

using device = await Device.connect({ hostname: '192.0.2.10', username: 'admin', password: 'secret' })
const info = await device.getDeviceInformation()
console.log(info.manufacturer, info.model, info.firmwareVersion) // DVC DCN-BM2220LPR 2.1.0

using 关闭块尾的闲置连接.

实例

  • 连接中: 每一个 Device.connect() 选项
  • 呼叫业务: 请求、超时和取消
  • 错误: 错误类别及其所载内容
  • 警卫: 认证、 TLS 和服务地址
  • 成套服务:设备上的管理、媒体和事件方法
  • 从 onvif数字 : Cam 财务报告和审定财务报表 Onvif 2.x中的呼叫和选项

API 密码

class Device {
  static connect(options: ConnectOptions): Promise<Device>

  getCapabilities(request?, options?: CallOptions): Promise<GetCapabilitiesResponse>
  getDeviceInformation(request?, options?: CallOptions): Promise<GetDeviceInformationResponse>
  getHostname(request?, options?: CallOptions): Promise<GetHostnameResponse>
  getNetworkInterfaces(request?, options?: CallOptions): Promise<GetNetworkInterfacesResponse>
  getScopes(request?, options?: CallOptions): Promise<GetScopesResponse>
  getServiceCapabilities(request?, options?: CallOptions): Promise<GetServiceCapabilitiesResponse>
  getServices(request, options?: CallOptions): Promise<GetServicesResponse>
  getSystemDateAndTime(request?, options?: CallOptions): Promise<GetSystemDateAndTimeResponse>
  systemReboot(request?, options?: CallOptions): Promise<SystemRebootResponse>

  call(operation: Operation, request?: Request, options?: CallOptions): Promise<Response>
  use(extension: (device: Device) => Extension): Device & Extension
  download(address: string | URL, options?: { signal; timeoutMs }): Promise<{ contentType; body: Uint8Array }>
  synchronizeClock(options?: { signal; timeoutMs }): Promise<void>
  resolveAddress(address: string): URL // the URL a reported address is sent to
  close(): void // closes idle connections, the device still works after it

  readonly address: URL // URL of the device service
  get services(): ReadonlyMap<string, URL> // service namespace to URL
  get clock(): { skewMs: number; source: 'device' | 'local' } // camera time minus local time
  get timeoutMs(): number
  get serviceAddresses(): 'rewrite' | 'sameHost' | 'reject'
}

每一个错误都是 OnvifError 与 host, (中文(简体) ), service 财务报告和审定财务报表 action。 。 。 .

许可证

麻省理工学院

版本与发布记录

@2bad/onvif 共发布 12 个版本,首次发布于 2024/09/03;过去 12 个月发布了 9 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.3.0latest2026/10/1226 天前
2.2.02026/10/1226 天前
2.1.02026/10/1226 天前
2.0.02026/10/051 个月前
2.0.0-alpha.22026/10/041 个月前
2.0.0-alpha.12026/10/021 个月前

关于 @2bad/onvif 的常见问题

@2bad/onvif 是什么?

无运行时间依赖的 TypeScript 的高性能 ONVIF 客户端

如何安装 @2bad/onvif?

在项目目录运行 npm install @2bad/onvif,或使用 pnpm add / yarn add / bun add。

@2bad/onvif 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@2bad/onvif 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@2bad/onvif 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=26。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@2bad/onvif 可以商用吗?

@2bad/onvif 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@2bad/onvif 的下载量有多少?

根据 npm 官方下载统计,@2bad/onvif 在 2026/10/05 – 2026/11/03 这 30 天内被下载 5,061 次,日均约 169 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@2bad/onvif 还在维护吗?

最新版本 2.3.0 发布于 2026/10/12(26 天前);至今共发布 12 个版本,其中过去 12 个月发布了 9 个;首次发布于 2024/09/03。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。