https://github.com/agsh/onvif

ONVIF node.js implementation
https://github.com/agsh/onvif

hacktoberfest javascript nvt onvif ptz

Last synced: about 1 month ago
JSON representation

ONVIF node.js implementation

• Host: GitHub
• URL: https://github.com/agsh/onvif
• Owner: agsh
• License: mit
• Created: 2014-12-08T10:35:09.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T08:24:50.000Z (6 months ago)
• Last Synced: 2024-10-29T09:46:46.637Z (6 months ago)
• Topics: hacktoberfest, javascript, nvt, onvif, ptz
• Language: JavaScript
• Homepage: https://onvif.pages.dev
• Size: 2.34 MB
• Stars: 699
• Watchers: 47
• Forks: 240
• Open Issues: 54
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ip-camera - onvif - Javascript client (Generic software / ONVIF)

README

        
# ONVIF

[![Coverage Status](https://img.shields.io/coveralls/agsh/onvif.svg)](https://coveralls.io/r/agsh/onvif?branch=master)

[![NPM version](https://img.shields.io/npm/v/onvif.svg)](https://www.npmjs.com/package/onvif)

ONVIF Client protocol Profile S (Live Streaming) and Profile G (Replay) Node.js implementation.

This is a wrapper to ONVIF protocol which allows you to get information about your NVT (network video transmitter)

device, its media sources, control PTZ (pan-tilt-zoom) movements and manage presets, detect devices in your network and control its events.

It will also allow you to get information about your NVR (network video recorder) Profile G device and obtain a list of recordings.

The library uses NodeJS. And works on the server-side.

[![ONVIF](https://www.onvif.org/wp-content/themes/onvif-public/images/logo.png)](http://onvif.org)

## Troubleshooting

The library is tested on a test bed with 5 x Axis, 2 x Bosch, 1 x Canon, 2 x Hanwha, 4 x HikVision, 1 x Panasonic, 2 x Sony and 2 x unknown vendor cameras. There is a mix of PTZ and Fixed cameras and a mix of Pre-Profile, Profile S, Profile G and Profile T devices.

It is also tested with some Analogue Encoders from Avigilon, Axis, Bosch and HikVision including testing the RS485 output.

We welcome any donations or long term loans cameras from other vendors to test compatibility especially when testing the Media2 API, ONVIF Events and OSD.

## Installation

### NPM

`npm install onvif` - install latest stable version

`npm install agsh/onvif` - install latest version from GitHub

`npm install agsh/onvif#v1` - install latest development version

### Clone the latest version from github

`git clone https://github.com/agsh/onvif.git`

### Tests

In the library directory run `npm test`

By default the tests use a mockup server to generate ONVIF replies.

To test with the real device, set appropriate environment variables `HOSTNAME`, `USERNAME`, `PASSWORD`, `PORT` and run

tests.

### Documentation

To build jsdoc for the library with default theme run `npm run jsdoc`. Otherwise use `jsdoc` with sources from

`./lib/*.js`

## Quick example

Special teasing example how to create little funny video server (http://localhost:6147) with 1 ffmpeg and 3 node.js libraries:

```shell

sudo apt install ffmpeg

npm install onvif socket.io rtsp-ffmpeg

```

```js

const server = require('http').createServer((req, res) =>

        res.end(`

  const socket = io(), ctx = document.getElementsByTagName('canvas')[0].getContext('2d');

  socket.on('data', (data) => {

    const img = new Image;    

    const url = URL.createObjectURL(new Blob([new Uint8Array(data)], {type: 'application/octet-binary'}));

    img.onload = () => {

      URL.revokeObjectURL(url, {type: 'application/octet-binary'});

      ctx.drawImage(img, 100, 100);

    };

    img.src = url;

  });