ONVIF Client protocol 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.
npm install onvif
In the library directory run npm run-script test
This example asks your camera to look up and starts a web server at port 3030 that distributes a web page with vlc-plugin container which translates video from the camera.
var
http = require('http'),
Cam = require('onvif').Cam;
new Cam({
hostname: CAMERA_HOST,
username: USERNAME,
password: PASSWORD
}, function(err) {
this.absoluteMove({x: 1, y: 1, zoom: 1});
this.getStreamUri({protocol:'RTSP'}, function(err, stream) {
http.createServer(function (req, res) {
res.writeHead(200, {'Content-Type': 'text/html'});
res.end('<html><body>' +
'<embed type="application/x-vlc-plugin" target="' + stream.uri + '"></embed>' +
'</body></html>');
}).listen(3030);
});
});
Different cameras have different ONVIF implementation. I've tested this module only with a couple of devices. So if you've experience different problems with this library, please let me know via e-mail. Else please just send the model of your camera to me.
var Cam = require('onvif').Cam;
Options are:
Callback (optional) executes when the cam is initialised. Single argument for this function is possible error.
When the cam object creates it automatically sends three command to the ONVIF device:
getCapabilities, getVideoSources and getProfiles. After that it fills correspondent properties of an object:
Connect to the camera and fill device information properties with getCapabilities, getVideoSources, getProfiles methods
See more detailed information at http://www.onvif.org/ver10/media/wsdl/media.wsdl
After cam initialisation we can run several ONVIF commands.
There are several common methods that work without credentials. Here are they: getSystemDateAndTime.
Returns a Date object with current camera datetime in the callback.
Works without credentials (passed username and password arguments).
Device. Returns a device information, such as manufacturer, model and firmware version in the callback
Works without credentials (passed username and password arguments).
Device. Returns in callback and assigns to #services property an array consists of objects with properties: namespace, XAddr, version
Device. Returns in callback and assigns to #serviceCapabilities property the capabilities of the device service (not media):
network, security and system. If your device supports some auxiliary capabilities they will be there too.
Media. Returns a URI that can be used to initiate a live media stream using RTSP as the control protocol The options are:
stream (optional) - defines if a multicast or unicast stream is requested. Possible values are: 'RTP-Unicast' (default), 'RTP-Multicast'protocol (optional) - defines the network protocol for streaming. Possible values are: 'UDP', 'TCP', 'RTSP' (default), 'HTTP'profileToken (optional) - defines media profile to use and will define the configuration of the content of the stream. Default is #activeSource.profileTokenReturns the saved presets as an a key-value object where the key is the name of a preset and a value is a preset token.
This method also stores the presets information in a #presets property of an object.
The options are:
profileToken (optional) - defines media profile to use and will define the configuration of the content of the stream. Default is #activeSource.profileTokenOperation to go to a saved preset position for the PTZ node in the selected profile.
The options are:
profileToken (optional) - defines media profile to use and will define the configuration of the content of the stream. Default is #activeSource.profileTokenpreset - the name of preset. List of presets you can get by #getPresets method or in #presets property.PTZ. Returns the properties of the current PTZ node, if it exists.
Use this function to get maximum number of presets, ranges of admitted values for x, y, zoom, iris, focus.
Sets all information into #nodes property.
PTZ. This is a relative pan-tilt-zoom method. Options for this method is a delta between desired and current position of the camera.
The options are:
x Pan, number or a string within -1 to 1, optional
y Tilt, number or a string within -1 to 1, optional
zoom Zoom, number or a string within -1 to 1, optional
speed An object with properties
x Pan speedy Tilt speedzoom Zoom speedIf the speed option is omitted, the default speed set by the PTZConfiguration will be used.
Callback is optional and means essentially nothing
PTZ. This is an absolute pan-tilt-zoom method. Options for this method is an absolute position of the camera.
The options are:
x Pan, number or a string within -1 to 1, optional
y Tilt, number or a string within -1 to 1, optional
zoom Zoom, number or a string within -1 to 1, optional
speed An object with properties
x Pan speedy Tilt speedzoom Zoom speedIf the speed option is omitted, the default speed set by the PTZConfiguration will be used.
Callback is optional and means essentially nothing
PTZ. Returns an object with the current PTZ values.
{
position: {
x: 'pan position'
, y: 'tilt position'
, zoom: 'zoom'
}
, moveStatus: {} // camera moving
, utcTime: 'current camera datetime'
}
PTZ. Get all the existing PTZConfigurations from the device. Configurations saved into #configurations property
PTZ. Get supported coordinate systems including their range limitations for selected configuration. Extends corresponding configuration object
PTZ. Send raw auxiliary commands to the PTZ device mapped by the PTZNode in the selected profile.
The options are:
profileToken (optional) - defines media profile to use and will define the configuration of the content of the stream. Default is #activeSource.profileTokendata - data for the auxiliary command, you can get it, for example, in the #serviceCapabilities.auxiliaryCommands propertyWSDL schemes and docs:
FAQs
Client to ONVIF NVT devices Profile S: cameras
The npm package onvif receives a total of 2,943 weekly downloads. As such, onvif popularity was classified as popular.
We found that onvif demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.