This package has been deprecated

Author message:

This package is no longer maintained

foscam

nodejs-foscam

Remote control, view and config a Foscam/Tenvis IP camera.

All included methods are based on Foscam's (fragmented) API documentation. Some features may not be supported by non-pan/tilt, older cameras or old firmware. So make sure you keep a backup of your camera settings, just in case.

Usage

The installation and loading are simple with NPM.

npm install foscam

var cam = require('foscam')
 
cam.setup({
  host: 'mycamera.lan',
  port: 81,
  user: 'admin'
  pass: ''
})
 
// start rotating left
cam.control.decoder( 'left', function() {
  
  // stop rotation
  cam.control.decoder( 'stop left', function() {
    
    // take a picture and store it on your computer
    cam.snapshot( '/path/to/save.jpg', console.log )
  
  })
  
})

Or directly from Github

git clone https://github.com/fvdm/nodejs-foscam.git

var cam = require('./nodejs-foscam')

Methods

Every method takes a callback function as last parameter. The callbacks are the only way to procedural scripting.

NOTE: Some methods require a certain access-level, i.e. admins can do everything, but a visitor can only view.

Basic

setup

( properties, [callback] )

In order to connect to the camera you first need to provide its access details. You can either do this by setting the properties below directly in cam.settings, but better is to use cam.setup(). When the callback function is provided, setup() will attempt to connect to the camera and retrieve its status, returned as object to the callback. When it fails the callback gets false.

setting	description	default
host	IP-address or hostname	192.168.1.239
port	port number	81
user	username	admin
pass	password	[empty]

cam.setup(
    {
        host: 'mycamera.lan',
        port: 81,
        user: 'admin'
        pass: ''
    },
    function( status ) {
        if( !status ) {
            console.error( 'ERROR: can\'t connect' )
        } else {
            console.log( status )
        }
    }
)

status

( callback )

Permission: everyone

Get basic details from the camera.

cam.status( console.log )

{ id: '001A11A00A0B',
  sys_ver: '0.37.2.36',
  app_ver: '3.2.2.18',
  alias: 'Cam1',
  now: '1343304558',
  tz: '-3600',
  alarm_status: '0',
  ddns_status: '0',
  ddns_host: '',
  oray_type: '0',
  upnp_status: '0',
  p2p_status: '0',
  p2p_local_port: '23505',
  msn_status: '0',
  alarm_status_str: 'no alarm',
  ddns_status_str: 'No Action',
  upnp_status_str: 'No Action' }

camera_params

( callback )

Permission: visitor

Get camera sensor settings.

cam.camera_params( console.log )

{ resolution: 32,
  brightness: 96,
  contrast: 4,
  mode: 1,
  flip: 0,
  fps: 0 }

Camera

snapshot

( [filename], callback )

Take a snapshot. Either receive the binary JPEG in the callback or specify a filename to store it on your computer.

When a filename is provided the callback will return either the filename on success or false on faillure.

// custom processing
cam.snapshot( function( jpeg ) {
    // add binary processing here
})
 
// store locally
cam.snapshot( './my_view.jpg', console.log )

preset.set

( id, [cb] )

Save current camera position in preset #id. You can set presets 1 to 16.

cam.preset.set( 3, console.log )

preset.go

( id, [cb] )

Move camera to the position as stored in preset #id. You can use presets 1 to 16.

cam.preset.go( 3, console.log )

control.decoder

( command, [callback] )

Control camera movement, like pan and tilt.

command - The command to execute. This can be a string (see below) or number.

Commands

command	api id	description
up	0	start moving upwards
stop up	1	stop moving upwards
down	2	start moving downwards
stop down	3	stop moving downwards
left	4	start moving left
stop left	5	stop moving left
right	6	start moving right
stop right	7	stop moving right
center	25	move to center
vertical patrol	26	start moving vertical (y-axis)
stop vertical patrol	27	stop moving vertical (y-axis)
horizontal patrol	28	start moving horizontal (x-axis)
stop horizontal patrol	29	stop moving horizontal (x-axis)
io output high	94	iR on *(some cameras)*
io output low	95	iR off *(some cameras)*

control.camera

( name, value, [callback] )

Change a camera (sensor) setting.

name - the parameter name or id. value - its replacement value.

Parameters

name	id	values
brightness	1	0-255
contrast	2	0-6
resolution	0	value (aliases) id 320, 320x240, 320*240 8 640, 640x480, 640*480 32
mode	3	value (aliases) id 50, 50hz, 50 hz 0 60, 60hz, 60 hz 1 outdoor, outside 2
flipmirror	5	value (aliases) id default 0 flip 1 mirror 2 flipmirror, flip+mirror 3

System

reboot

( [callback ] )

Reboot the device

restore_factory

( [callback ] )

Reset all settings back to their factory values.

talk

( propsObject )

Directly communicate with the device.

properties

name	required	description	value	default
path	required	the method path	ie. `get_params.cgi`
fields	optional	object with method parameters	ie. {ntp_enable: 1, ntp_svr: 'ntp.xs4all.nl'}	{}
encoding	optional	response encoding to expect	ie. `utf8` or `binary`
callback	optional	(trimmed) output will be send to the callback *function*

Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org/