ZoneMinder Wiki - User contributions [en]

Foscam Clones

2012-06-17T17:35:40Z

Cbagwell: /* Overview */

===Overview===

Foscam is one of the more popular makers of wireless IP Cameras priced towards the lower end of price ranges. Any other IP cameria that is compatible with Foscam tend to be called Foscam clones because of their popularity. Its also common to see compatible cameras called Unbranded IP Cameras or Chinese IP Cameras.

You can often tell the clones based on feature set alone. Cameras in this class support 3 resolutions (640x480, 320x240, 160x120), 3 frame rates (60Hz, 50Hz, and Outdoor), Pan+Tilt and either Zoom or Nightvision or both, ability to email and FTP images during motion detection, and streaming video to VLC client. There are more optional features but these are usually enough to detect clones.

These cameras tend to use similar set of hardware components and share a once common firmware code base. You can search for "Open IP Camera" for more information related to firmware and hardware.

Most information about interacting with these cameras can be found by searching for a PDF called "IPCAM CGI SDK 2.1". I also found it useful to use Firefox to monitor the requests posted to camera as I clicked on its web interface. You can do this by enabling Web Developer->Web Console menu option.

The following was tested on a Agasio a622w but should work with other brands of wireless IP cameras such as Foscam, EasyN, Wansview, and more.

===General Zoneminder Setup===

;General:
:Name: IPCAM
:Source Type: Remote
:Function: Modect
:Enabled: Tick
:Maximum FPS: Empty
:Alarm Maximum FPS: Empty
;Source
:Remote Protocol: HTTP
:Remote Method: Simple
:Remote Host Name: x.x.x.x (The IP used by camera)
:Remote Host Port: 99 (The Port used by camera)
:Remote Host Path: /videostream.cgi?user=admin&pwd= (default user account)
:Remote Image Colours: 24 bit colour
:Capture Width: 320 (You could use 640 x 480, I found 320 to be better on wireles)
:Capture Height: 240
;Control
:Controllable: Tick
:Control Type: IPCAM (need to create this first using Edit link)
:Control Device: user=admin&pwd=
:Control Address: x.x.x.x:yy

===Control Setup===

Create /usr/share/perl5/vendor_perl/ZoneMinder/Control/IPCAM.pm with following contents. This script supports a superset of camera controls and should work with any Foscam compatible camera. If your camera doesn't have all features then they will be disabled in Zoneminder.

<pre>
# ==========================================================================
#
# ZoneMinder IPCAM Control Protocol Module, $Date: 2009-11-25 09:20:00 +0000 (Wed, 04 Nov 2009) $, $Revision: 0001 $
# Copyright (C) 2001-2008 Philip Coombes
# Modified for use with Foscam FI8918W IP Camera by Dave Harris
# Modified Feb 2011 by Howard Durdle (http://durdl.es/x) to:
# fix horizontal panning, add presets and IR on/off
# use Control Device field to pass username and password
# Modified June 5th, 2012 by Chris Bagwell to:
# Rename to IPCAM since its common protocol with wide range of cameras.
# Work with Logger module instead of Debug module.
# Fix off-by-1 preset bug.
# Support optional autostop timeout.
# Add Zoom, Brightness, and Contrast support.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
# ==========================================================================
#
# This module contains the implementation of the IPCAM camera control
# protocol.
#
# This is a protocol shared by a wide range of affordable cameras that
# appear to share similar reference design and software. Examples
# include Foscam, Agasio, Wansview, etc.
#
# The basis for CGI based API can be found on internet by searching for
# "IPCAM CGI SDK 2.1". Here is sample site that also developes replacement
# firmware for some hardware versions.
#
# http://www.openipcam.com/files/Manuals/IPCAM%20CGI%20SDK%202.1.pdf
#
package ZoneMinder::Control::IPCAM;

use 5.006;
use strict;
use warnings;

require ZoneMinder::Base;
require ZoneMinder::Control;

our @ISA = qw(ZoneMinder::Control);

our $VERSION = $ZoneMinder::Base::VERSION;

# ==========================================================================
#
# IPCAM Control Protocol
#
# ==========================================================================

use ZoneMinder::Logger qw(:all);
use ZoneMinder::Config qw(:all);

use Time::HiRes qw( usleep );

sub new
{
my $class = shift;
my $id = shift;
my $self = ZoneMinder::Control->new( $id );
my $logindetails = "";
bless( $self, $class );
srand( time() );
return $self;
}

our $AUTOLOAD;

sub AUTOLOAD
{
my $self = shift;
my $class = ref($self) || croak( "$self not object" );
my $name = $AUTOLOAD;
$name =~ s/.*://;
if ( exists($self->{$name}) )
{
return( $self->{$name} );
}
Fatal( "Can't access $name member of object of class $class" );
}

sub open
{
my $self = shift;

$self->loadMonitor();

use LWP::UserAgent;
$self->{ua} = LWP::UserAgent->new;
$self->{ua}->agent( "ZoneMinder Control Agent/".ZM_VERSION );

$self->{state} = 'open';
}

sub close
{
my $self = shift;
$self->{state} = 'closed';
}

sub printMsg
{
my $self = shift;
my $msg = shift;
my $msg_len = length($msg);

Debug( $msg."[".$msg_len."]" );
}

sub sendCmd
{
my $self = shift;
my $cmd = shift;
my $result = undef;
printMsg( $cmd, "Tx" );

my $req = HTTP::Request->new( GET=>"http://".$self->{Monitor}->{ControlAddress}."/$cmd".$self->{Monitor}->{ControlDevice} );
my $res = $self->{ua}->request($req);

if ( $res->is_success )
{
$result = $res->decoded_content;
}
else
{
Error( "Error check failed:'".$res->status_line()."'" );
}

return( $result );
}

# Turn IO on (can be internally wired to IR's)
sub wake
{
my $self = shift;
Debug( "Wake - IO on" );
my $cmd = "decoder_control.cgi?command=95&";
$self->sendCmd( $cmd );
}

# Turn IO off (can be internally wired to IR's)
sub sleep
{
my $self = shift;
Debug( "Sleep - IO off" );
my $cmd = "decoder_control.cgi?command=94&";
$self->sendCmd( $cmd );
}

sub reset
{
my $self = shift;
Debug( "Camera Reset" );
my $cmd = "reboot.cgi?";
$self->sendCmd( $cmd );
}

sub moveConUp
{
my $self = shift;
my $params = shift;
Debug( "Move Up" );
my $cmd = "decoder_control.cgi?command=0&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConDown
{
my $self = shift;
my $params = shift;
Debug( "Move Down" );
my $cmd = "decoder_control.cgi?command=2&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConRight
{
my $self = shift;
my $params = shift;
Debug( "Move Right" );
my $cmd = "decoder_control.cgi?command=6&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConLeft
{
my $self = shift;
my $params = shift;
Debug( "Move Left" );
my $cmd = "decoder_control.cgi?command=4&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConUpLeft
{
my $self = shift;
my $params = shift;
Debug( "Move Diagonally Up Left" );
my $cmd = "decoder_control.cgi?command=90&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConDownLeft
{
my $self = shift;
my $params = shift;
Debug( "Move Diagonally Down Left" );
my $cmd = "decoder_control.cgi?command=92&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConUpRight
{
my $self = shift;
my $params = shift;
Debug( "Move Diagonally Up Right" );
my $cmd = "decoder_control.cgi?command=91&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConDownRight
{
my $self = shift;
my $params = shift;
Debug( "Move Diagonally Down Right" );
my $cmd = "decoder_control.cgi?command=93&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

# command=1 is technically Up Stop but seems to work for all stops.
sub moveStop
{
my $self = shift;
Debug( "Move Stop" );
print("autostop\n");
my $cmd = "decoder_control.cgi?command=1&";
$self->sendCmd( $cmd );
}

sub zoomConTele
{
my $self = shift;
my $params = shift;
Debug( "Zoom Tele" );
my $cmd = "decoder_control.cgi?command=16&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$cmd = "decoder_control.cgi?command=17&";
$self->sendCmd( $cmd );
}
}

sub zoomConWide
{
my $self = shift;
my $params = shift;
Debug( "Zoom Wide" );
my $cmd = "decoder_control.cgi?command=18&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$cmd = "decoder_control.cgi?command=19&";
$self->sendCmd( $cmd );
}
}

sub zoomConStop
{
my $self = shift;
my $params = shift;
Debug( "Zoom Stop" );
my $cmd = "decoder_control.cgi?command=17&";
$self->sendCmd( $cmd );
}

# Increase Brightness
sub irisAbsOpen
{
my $self = shift;
my $params = shift;
my $step = $self->getParam( $params, 'step' );
my $brightness = 100;

my $cmd = "get_camera_params.cgi?";
my $resp = $self->sendCmd( $cmd );

$brightness = int($1) if ( $resp =~ m/var brightness=([0-9]*);/ );
$brightness += $step;
$brightness = 255 if ($brightness > 255);
Debug( "Iris Open $brightness" );
$cmd = "camera_control.cgi?param=1&value=".$brightness."&";
$self->sendCmd( $cmd );
}

# Decrease Brightness
sub irisAbsClose
{
my $self = shift;
my $params = shift;
my $step = $self->getParam( $params, 'step' );
my $brightness = 100;

my $cmd = "get_camera_params.cgi?";
my $resp = $self->sendCmd( $cmd );

$brightness = int($1) if ( $resp =~ m/var brightness=([0-9]*);/ );
$brightness -= $step;
$brightness = 0 if ($brightness < 0);
Debug( "Iris Close $brightness" );
$cmd = "camera_control.cgi?param=1&value=".$brightness."&";
$self->sendCmd( $cmd );
}

sub whiteAbsIn
{
my $self = shift;
my $params = shift;
my $step = $self->getParam( $params, 'step' );
my $contrast = 5;

my $cmd = "get_camera_params.cgi?";
my $resp = $self->sendCmd( $cmd );

$contrast = int($1) if ( $resp =~ m/var contrast=([0-9]*);/ );
$contrast += $step;
$contrast = 6 if ($contrast > 6);
Debug( "White In $contrast" );
$cmd = "camera_control.cgi?param=2&value=".$contrast."&";
$self->sendCmd( $cmd );
}

# Decrease Contrast
sub whiteAbsOut
{
my $self = shift;
my $params = shift;
my $step = $self->getParam( $params, 'step' );
my $contrast = 5;

my $cmd = "get_camera_params.cgi?";
my $resp = $self->sendCmd( $cmd );

$contrast = int($1) if ( $resp =~ m/var contrast=([0-9]*);/ );
$contrast -= $step;
$contrast = 0 if ($contrast < 0);
Debug( "White Out $contrast" );
$cmd = "camera_control.cgi?param=2&value=".$contrast."&";
$self->sendCmd( $cmd );
}

sub presetHome
{
my $self = shift;
Debug( "Home Preset" );
my $cmd = "decoder_control.cgi?command=25&";
$self->sendCmd( $cmd );
}

sub presetSet
{
my $self = shift;
my $params = shift;
my $preset = $self->getParam( $params, 'preset' );
my $presetCmd = 30 + (($preset-1)*2);
Debug( "Set Preset $preset with cmd $presetCmd" );
my $cmd = "decoder_control.cgi?command=$presetCmd&";
$self->sendCmd( $cmd );
}

sub presetGoto
{
my $self = shift;
my $params = shift;
my $preset = $self->getParam( $params, 'preset' );
my $presetCmd = 31 + (($preset-1)*2);
Debug( "Goto Preset $preset with cmd $presetCmd" );
my $cmd = "decoder_control.cgi?command=$presetCmd&";
$self->sendCmd( $cmd );
}
1;
__END__
# Below is stub documentation for your module. You'd better edit it!

=head1 NAME

ZoneMinder::Database - Perl extension for blah blah blah

=head1 SYNOPSIS

use ZoneMinder::Database;
blah blah blah

=head1 DESCRIPTION

Stub documentation for ZoneMinder, created by h2xs. It looks like the
author of the extension was negligent enough to leave the stub
unedited.

Blah blah blah.

=head2 EXPORT

None by default.

=head1 SEE ALSO

Mention other useful documentation such as the documentation of
related modules or operating system documentation (such as man pages
in UNIX), or any relevant external documentation such as RFCs or
standards.

If you have a mailing list set up for your module, mention it here.

If you have a web site set up for your module, mention it here.

=head1 AUTHOR

Philip Coombes, E<lt>philip.coombes@zoneminder.comE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2001-2008 Philip Coombes

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.3 or,
at your option, any later version of Perl 5 you may have available.

=cut
</pre>

From here, Zoneminder must be configured to know about IPCAM controls. This is done by clicking the "Edit" link pointed out during general setup and then on the "Add New Control" button on new window.

;Main
:Name: IPCAM
:Type: Remote
:Protocol: IPCAM
:Can Wake: Tick
:Can Sleep: Tick
:Can Reset: Tick
;Move
:Can Move: Tick
:Can Move Diagonally: Tick
:Can Move Continous: Tick
;Pan
:Can Pan: Tick
;Tilt
:Can Tilt: Tick
;Zoom
:Can Zoom: Tick
:Can Zoom Continous: Tick
;White
:Can White Balance: Tick
:Can White Balance Absolute: Tick
:Min White Bal. Range: 1
:Max White Bal. Range: 255
:Min White Bal. Step: 1
:Max White Bal. Step: 255
;Iris
:Can Iris: Tick
:Can Iris Absolute: Tick
:Min Iris Range: 1
:Max Iris Range: 6
:Min Iris Step: 1
:Max Iris Step: 6
;Presets
:Has Presets: Tick
:Num Presets: 16
:Has Home Preset: Tick
:Can Set Presets: Tick

Wake/Sleep control is mapped to IO ON/OFF Control. IO Control is sometimes used for IR LED Controls. If your camera does not support IO ON/OFF Control then leave the Wake/Sleep boxes unticked.

If your camera does not support Zoom then leave Has Zoom unticked.

The camera Tilt/Pan will work different then cameras Web interface. It will continously move until you click the middle circle to stop movement. If you prefer, you can set a non-zero value in the "Track Delay" box on Control tab so that movement will automatically stop after specified delay.

It would require an update to Zoneminder to behave like stock web interface. It sends Start Move on initial click and then Stop Move upon click release. That seems like a nice feature to build into Zoneminder to me.

Foscam Clones

2012-06-17T17:31:11Z

Cbagwell: /* Control Setup */

===Overview===

Foscam is one of the more popular makers of wireless IP Cameras priced towards the lower end of price ranges. Any other IP cameria that is compatible with Foscam tend to be called Foscam clones because of their popularity. Its also common to see compatible cameras called Unbranded IP Cameras or Chinese IP Cameras.

You can often tell the clones based on feature set alone. Cameras in this class support 3 resolutions (640x480, 320x240, 160x120), 3 frame rates (60Hz, 50Hz, and Outdoor), Pan+Tilt and either Zoom or Nightvision or both, ability to email and FTP images during motion detection, and streaming video to VLC client. There are more optional features but these are usually enough to detect clones.

These cameras tend to use similar set of hardware components and share a once common firmware code base. You can search for "Open IP Camera" for more information related to firmware and hardware.

Most information about interacting with these cameras can be found by searching for a PDF called "IPCAM CGI SDK 2.1". I also found it useful to use Firefox to monitor the requests posted to camera as I clicked on its web interface. You can do this by enabling Web Developer->Web Console menu option.

===General Zoneminder Setup===

;General:
:Name: IPCAM
:Source Type: Remote
:Function: Modect
:Enabled: Tick
:Maximum FPS: Empty
:Alarm Maximum FPS: Empty
;Source
:Remote Protocol: HTTP
:Remote Method: Simple
:Remote Host Name: x.x.x.x (The IP used by camera)
:Remote Host Port: 99 (The Port used by camera)
:Remote Host Path: /videostream.cgi?user=admin&pwd= (default user account)
:Remote Image Colours: 24 bit colour
:Capture Width: 320 (You could use 640 x 480, I found 320 to be better on wireles)
:Capture Height: 240
;Control
:Controllable: Tick
:Control Type: IPCAM (need to create this first using Edit link)
:Control Device: user=admin&pwd=
:Control Address: x.x.x.x:yy

===Control Setup===

Create /usr/share/perl5/vendor_perl/ZoneMinder/Control/IPCAM.pm with following contents. This script supports a superset of camera controls and should work with any Foscam compatible camera. If your camera doesn't have all features then they will be disabled in Zoneminder.

<pre>
# ==========================================================================
#
# ZoneMinder IPCAM Control Protocol Module, $Date: 2009-11-25 09:20:00 +0000 (Wed, 04 Nov 2009) $, $Revision: 0001 $
# Copyright (C) 2001-2008 Philip Coombes
# Modified for use with Foscam FI8918W IP Camera by Dave Harris
# Modified Feb 2011 by Howard Durdle (http://durdl.es/x) to:
# fix horizontal panning, add presets and IR on/off
# use Control Device field to pass username and password
# Modified June 5th, 2012 by Chris Bagwell to:
# Rename to IPCAM since its common protocol with wide range of cameras.
# Work with Logger module instead of Debug module.
# Fix off-by-1 preset bug.
# Support optional autostop timeout.
# Add Zoom, Brightness, and Contrast support.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
# ==========================================================================
#
# This module contains the implementation of the IPCAM camera control
# protocol.
#
# This is a protocol shared by a wide range of affordable cameras that
# appear to share similar reference design and software. Examples
# include Foscam, Agasio, Wansview, etc.
#
# The basis for CGI based API can be found on internet by searching for
# "IPCAM CGI SDK 2.1". Here is sample site that also developes replacement
# firmware for some hardware versions.
#
# http://www.openipcam.com/files/Manuals/IPCAM%20CGI%20SDK%202.1.pdf
#
package ZoneMinder::Control::IPCAM;

use 5.006;
use strict;
use warnings;

require ZoneMinder::Base;
require ZoneMinder::Control;

our @ISA = qw(ZoneMinder::Control);

our $VERSION = $ZoneMinder::Base::VERSION;

# ==========================================================================
#
# IPCAM Control Protocol
#
# ==========================================================================

use ZoneMinder::Logger qw(:all);
use ZoneMinder::Config qw(:all);

use Time::HiRes qw( usleep );

sub new
{
my $class = shift;
my $id = shift;
my $self = ZoneMinder::Control->new( $id );
my $logindetails = "";
bless( $self, $class );
srand( time() );
return $self;
}

our $AUTOLOAD;

sub AUTOLOAD
{
my $self = shift;
my $class = ref($self) || croak( "$self not object" );
my $name = $AUTOLOAD;
$name =~ s/.*://;
if ( exists($self->{$name}) )
{
return( $self->{$name} );
}
Fatal( "Can't access $name member of object of class $class" );
}

sub open
{
my $self = shift;

$self->loadMonitor();

use LWP::UserAgent;
$self->{ua} = LWP::UserAgent->new;
$self->{ua}->agent( "ZoneMinder Control Agent/".ZM_VERSION );

$self->{state} = 'open';
}

sub close
{
my $self = shift;
$self->{state} = 'closed';
}

sub printMsg
{
my $self = shift;
my $msg = shift;
my $msg_len = length($msg);

Debug( $msg."[".$msg_len."]" );
}

sub sendCmd
{
my $self = shift;
my $cmd = shift;
my $result = undef;
printMsg( $cmd, "Tx" );

my $req = HTTP::Request->new( GET=>"http://".$self->{Monitor}->{ControlAddress}."/$cmd".$self->{Monitor}->{ControlDevice} );
my $res = $self->{ua}->request($req);

if ( $res->is_success )
{
$result = $res->decoded_content;
}
else
{
Error( "Error check failed:'".$res->status_line()."'" );
}

return( $result );
}

# Turn IO on (can be internally wired to IR's)
sub wake
{
my $self = shift;
Debug( "Wake - IO on" );
my $cmd = "decoder_control.cgi?command=95&";
$self->sendCmd( $cmd );
}

# Turn IO off (can be internally wired to IR's)
sub sleep
{
my $self = shift;
Debug( "Sleep - IO off" );
my $cmd = "decoder_control.cgi?command=94&";
$self->sendCmd( $cmd );
}

sub reset
{
my $self = shift;
Debug( "Camera Reset" );
my $cmd = "reboot.cgi?";
$self->sendCmd( $cmd );
}

sub moveConUp
{
my $self = shift;
my $params = shift;
Debug( "Move Up" );
my $cmd = "decoder_control.cgi?command=0&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConDown
{
my $self = shift;
my $params = shift;
Debug( "Move Down" );
my $cmd = "decoder_control.cgi?command=2&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConRight
{
my $self = shift;
my $params = shift;
Debug( "Move Right" );
my $cmd = "decoder_control.cgi?command=6&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConLeft
{
my $self = shift;
my $params = shift;
Debug( "Move Left" );
my $cmd = "decoder_control.cgi?command=4&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConUpLeft
{
my $self = shift;
my $params = shift;
Debug( "Move Diagonally Up Left" );
my $cmd = "decoder_control.cgi?command=90&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConDownLeft
{
my $self = shift;
my $params = shift;
Debug( "Move Diagonally Down Left" );
my $cmd = "decoder_control.cgi?command=92&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConUpRight
{
my $self = shift;
my $params = shift;
Debug( "Move Diagonally Up Right" );
my $cmd = "decoder_control.cgi?command=91&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConDownRight
{
my $self = shift;
my $params = shift;
Debug( "Move Diagonally Down Right" );
my $cmd = "decoder_control.cgi?command=93&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

# command=1 is technically Up Stop but seems to work for all stops.
sub moveStop
{
my $self = shift;
Debug( "Move Stop" );
print("autostop\n");
my $cmd = "decoder_control.cgi?command=1&";
$self->sendCmd( $cmd );
}

sub zoomConTele
{
my $self = shift;
my $params = shift;
Debug( "Zoom Tele" );
my $cmd = "decoder_control.cgi?command=16&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$cmd = "decoder_control.cgi?command=17&";
$self->sendCmd( $cmd );
}
}

sub zoomConWide
{
my $self = shift;
my $params = shift;
Debug( "Zoom Wide" );
my $cmd = "decoder_control.cgi?command=18&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$cmd = "decoder_control.cgi?command=19&";
$self->sendCmd( $cmd );
}
}

sub zoomConStop
{
my $self = shift;
my $params = shift;
Debug( "Zoom Stop" );
my $cmd = "decoder_control.cgi?command=17&";
$self->sendCmd( $cmd );
}

# Increase Brightness
sub irisAbsOpen
{
my $self = shift;
my $params = shift;
my $step = $self->getParam( $params, 'step' );
my $brightness = 100;

my $cmd = "get_camera_params.cgi?";
my $resp = $self->sendCmd( $cmd );

$brightness = int($1) if ( $resp =~ m/var brightness=([0-9]*);/ );
$brightness += $step;
$brightness = 255 if ($brightness > 255);
Debug( "Iris Open $brightness" );
$cmd = "camera_control.cgi?param=1&value=".$brightness."&";
$self->sendCmd( $cmd );
}

# Decrease Brightness
sub irisAbsClose
{
my $self = shift;
my $params = shift;
my $step = $self->getParam( $params, 'step' );
my $brightness = 100;

my $cmd = "get_camera_params.cgi?";
my $resp = $self->sendCmd( $cmd );

$brightness = int($1) if ( $resp =~ m/var brightness=([0-9]*);/ );
$brightness -= $step;
$brightness = 0 if ($brightness < 0);
Debug( "Iris Close $brightness" );
$cmd = "camera_control.cgi?param=1&value=".$brightness."&";
$self->sendCmd( $cmd );
}

sub whiteAbsIn
{
my $self = shift;
my $params = shift;
my $step = $self->getParam( $params, 'step' );
my $contrast = 5;

my $cmd = "get_camera_params.cgi?";
my $resp = $self->sendCmd( $cmd );

$contrast = int($1) if ( $resp =~ m/var contrast=([0-9]*);/ );
$contrast += $step;
$contrast = 6 if ($contrast > 6);
Debug( "White In $contrast" );
$cmd = "camera_control.cgi?param=2&value=".$contrast."&";
$self->sendCmd( $cmd );
}

# Decrease Contrast
sub whiteAbsOut
{
my $self = shift;
my $params = shift;
my $step = $self->getParam( $params, 'step' );
my $contrast = 5;

my $cmd = "get_camera_params.cgi?";
my $resp = $self->sendCmd( $cmd );

$contrast = int($1) if ( $resp =~ m/var contrast=([0-9]*);/ );
$contrast -= $step;
$contrast = 0 if ($contrast < 0);
Debug( "White Out $contrast" );
$cmd = "camera_control.cgi?param=2&value=".$contrast."&";
$self->sendCmd( $cmd );
}

sub presetHome
{
my $self = shift;
Debug( "Home Preset" );
my $cmd = "decoder_control.cgi?command=25&";
$self->sendCmd( $cmd );
}

sub presetSet
{
my $self = shift;
my $params = shift;
my $preset = $self->getParam( $params, 'preset' );
my $presetCmd = 30 + (($preset-1)*2);
Debug( "Set Preset $preset with cmd $presetCmd" );
my $cmd = "decoder_control.cgi?command=$presetCmd&";
$self->sendCmd( $cmd );
}

sub presetGoto
{
my $self = shift;
my $params = shift;
my $preset = $self->getParam( $params, 'preset' );
my $presetCmd = 31 + (($preset-1)*2);
Debug( "Goto Preset $preset with cmd $presetCmd" );
my $cmd = "decoder_control.cgi?command=$presetCmd&";
$self->sendCmd( $cmd );
}
1;
__END__
# Below is stub documentation for your module. You'd better edit it!

=head1 NAME

ZoneMinder::Database - Perl extension for blah blah blah

=head1 SYNOPSIS

use ZoneMinder::Database;
blah blah blah

=head1 DESCRIPTION

Stub documentation for ZoneMinder, created by h2xs. It looks like the
author of the extension was negligent enough to leave the stub
unedited.

Blah blah blah.

=head2 EXPORT

None by default.

=head1 SEE ALSO

Mention other useful documentation such as the documentation of
related modules or operating system documentation (such as man pages
in UNIX), or any relevant external documentation such as RFCs or
standards.

If you have a mailing list set up for your module, mention it here.

If you have a web site set up for your module, mention it here.

=head1 AUTHOR

Philip Coombes, E<lt>philip.coombes@zoneminder.comE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2001-2008 Philip Coombes

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.3 or,
at your option, any later version of Perl 5 you may have available.

=cut
</pre>

From here, Zoneminder must be configured to know about IPCAM controls. This is done by clicking the "Edit" link pointed out during general setup and then on the "Add New Control" button on new window.

;Main
:Name: IPCAM
:Type: Remote
:Protocol: IPCAM
:Can Wake: Tick
:Can Sleep: Tick
:Can Reset: Tick
;Move
:Can Move: Tick
:Can Move Diagonally: Tick
:Can Move Continous: Tick
;Pan
:Can Pan: Tick
;Tilt
:Can Tilt: Tick
;Zoom
:Can Zoom: Tick
:Can Zoom Continous: Tick
;White
:Can White Balance: Tick
:Can White Balance Absolute: Tick
:Min White Bal. Range: 1
:Max White Bal. Range: 255
:Min White Bal. Step: 1
:Max White Bal. Step: 255
;Iris
:Can Iris: Tick
:Can Iris Absolute: Tick
:Min Iris Range: 1
:Max Iris Range: 6
:Min Iris Step: 1
:Max Iris Step: 6
;Presets
:Has Presets: Tick
:Num Presets: 16
:Has Home Preset: Tick
:Can Set Presets: Tick

Wake/Sleep control is mapped to IO ON/OFF Control. IO Control is sometimes used for IR LED Controls. If your camera does not support IO ON/OFF Control then leave the Wake/Sleep boxes unticked.

If your camera does not support Zoom then leave Has Zoom unticked.

The camera Tilt/Pan will work different then cameras Web interface. It will continously move until you click the middle circle to stop movement. If you prefer, you can set a non-zero value in the "Track Delay" box on Control tab so that movement will automatically stop after specified delay.

It would require an update to Zoneminder to behave like stock web interface. It sends Start Move on initial click and then Stop Move upon click release. That seems like a nice feature to build into Zoneminder to me.

Foscam Clones

2012-06-17T17:16:26Z

Cbagwell: Created page with "===Overview=== Foscam is one of the more popular makers of wireless IP Cameras priced towards the lower end of price ranges. Any other IP cameria that is compatible with Foscam..."

===Overview===

Foscam is one of the more popular makers of wireless IP Cameras priced towards the lower end of price ranges. Any other IP cameria that is compatible with Foscam tend to be called Foscam clones because of their popularity. Its also common to see compatible cameras called Unbranded IP Cameras or Chinese IP Cameras.

You can often tell the clones based on feature set alone. Cameras in this class support 3 resolutions (640x480, 320x240, 160x120), 3 frame rates (60Hz, 50Hz, and Outdoor), Pan+Tilt and either Zoom or Nightvision or both, ability to email and FTP images during motion detection, and streaming video to VLC client. There are more optional features but these are usually enough to detect clones.

These cameras tend to use similar set of hardware components and share a once common firmware code base. You can search for "Open IP Camera" for more information related to firmware and hardware.

Most information about interacting with these cameras can be found by searching for a PDF called "IPCAM CGI SDK 2.1". I also found it useful to use Firefox to monitor the requests posted to camera as I clicked on its web interface. You can do this by enabling Web Developer->Web Console menu option.

===General Zoneminder Setup===

;General:
:Name: IPCAM
:Source Type: Remote
:Function: Modect
:Enabled: Tick
:Maximum FPS: Empty
:Alarm Maximum FPS: Empty
;Source
:Remote Protocol: HTTP
:Remote Method: Simple
:Remote Host Name: x.x.x.x (The IP used by camera)
:Remote Host Port: 99 (The Port used by camera)
:Remote Host Path: /videostream.cgi?user=admin&pwd= (default user account)
:Remote Image Colours: 24 bit colour
:Capture Width: 320 (You could use 640 x 480, I found 320 to be better on wireles)
:Capture Height: 240
;Control
:Controllable: Tick
:Control Type: IPCAM (need to create this first using Edit link)
:Control Device: user=admin&pwd=
:Control Address: x.x.x.x:yy

===Control Setup===

Create /usr/share/perl5/vendor_perl/ZoneMinder/Control/IPCAM.pm with following contents. This script supports a superset of camera controls and should work with any Foscam compatible camera. If your camera doesn't have all features then they will be disabled in Zoneminder.

<pre>
# ==========================================================================
#
# ZoneMinder IPCAM Control Protocol Module, $Date: 2009-11-25 09:20:00 +0000 (Wed, 04 Nov 2009) $, $Revision: 0001 $
# Copyright (C) 2001-2008 Philip Coombes
# Modified for use with Foscam FI8918W IP Camera by Dave Harris
# Modified Feb 2011 by Howard Durdle (http://durdl.es/x) to:
# fix horizontal panning, add presets and IR on/off
# use Control Device field to pass username and password
# Modified June 5th, 2012 by Chris Bagwell to:
# Rename to IPCAM since its common protocol with wide range of cameras.
# Work with Logger module instead of Debug module.
# Fix off-by-1 preset bug.
# Support optional autostop timeout.
# Add Zoom, Brightness, and Contrast support.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
# ==========================================================================
#
# This module contains the implementation of the IPCAM camera control
# protocol.
#
# This is a protocol shared by a wide range of affordable cameras that
# appear to share similar reference design and software. Examples
# include Foscam, Agasio, Wansview, etc.
#
# The basis for CGI based API can be found on internet by searching for
# "IPCAM CGI SDK 2.1". Here is sample site that also developes replacement
# firmware for some hardware versions.
#
# http://www.openipcam.com/files/Manuals/IPCAM%20CGI%20SDK%202.1.pdf
#
package ZoneMinder::Control::IPCAM;

use 5.006;
use strict;
use warnings;

require ZoneMinder::Base;
require ZoneMinder::Control;

our @ISA = qw(ZoneMinder::Control);

our $VERSION = $ZoneMinder::Base::VERSION;

# ==========================================================================
#
# IPCAM Control Protocol
#
# ==========================================================================

use ZoneMinder::Logger qw(:all);
use ZoneMinder::Config qw(:all);

use Time::HiRes qw( usleep );

sub new
{
my $class = shift;
my $id = shift;
my $self = ZoneMinder::Control->new( $id );
my $logindetails = "";
bless( $self, $class );
srand( time() );
return $self;
}

our $AUTOLOAD;

sub AUTOLOAD
{
my $self = shift;
my $class = ref($self) || croak( "$self not object" );
my $name = $AUTOLOAD;
$name =~ s/.*://;
if ( exists($self->{$name}) )
{
return( $self->{$name} );
}
Fatal( "Can't access $name member of object of class $class" );
}

sub open
{
my $self = shift;

$self->loadMonitor();

use LWP::UserAgent;
$self->{ua} = LWP::UserAgent->new;
$self->{ua}->agent( "ZoneMinder Control Agent/".ZM_VERSION );

$self->{state} = 'open';
}

sub close
{
my $self = shift;
$self->{state} = 'closed';
}

sub printMsg
{
my $self = shift;
my $msg = shift;
my $msg_len = length($msg);

Debug( $msg."[".$msg_len."]" );
}

sub sendCmd
{
my $self = shift;
my $cmd = shift;
my $result = undef;
printMsg( $cmd, "Tx" );

my $req = HTTP::Request->new( GET=>"http://".$self->{Monitor}->{ControlAddress}."/$cmd".$self->{Monitor}->{ControlDevice} );
my $res = $self->{ua}->request($req);

if ( $res->is_success )
{
$result = $res->decoded_content;
}
else
{
Error( "Error check failed:'".$res->status_line()."'" );
}

return( $result );
}

# Turn IO on (can be internally wired to IR's)
sub wake
{
my $self = shift;
Debug( "Wake - IO on" );
my $cmd = "decoder_control.cgi?command=95&";
$self->sendCmd( $cmd );
}

# Turn IO off (can be internally wired to IR's)
sub sleep
{
my $self = shift;
Debug( "Sleep - IO off" );
my $cmd = "decoder_control.cgi?command=94&";
$self->sendCmd( $cmd );
}

sub reset
{
my $self = shift;
Debug( "Camera Reset" );
my $cmd = "reboot.cgi?";
$self->sendCmd( $cmd );
}

sub moveConUp
{
my $self = shift;
my $params = shift;
Debug( "Move Up" );
my $cmd = "decoder_control.cgi?command=0&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConDown
{
my $self = shift;
my $params = shift;
Debug( "Move Down" );
my $cmd = "decoder_control.cgi?command=2&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConRight
{
my $self = shift;
my $params = shift;
Debug( "Move Right" );
my $cmd = "decoder_control.cgi?command=6&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConLeft
{
my $self = shift;
my $params = shift;
Debug( "Move Left" );
my $cmd = "decoder_control.cgi?command=4&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConUpLeft
{
my $self = shift;
my $params = shift;
Debug( "Move Diagonally Up Left" );
my $cmd = "decoder_control.cgi?command=90&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConDownLeft
{
my $self = shift;
my $params = shift;
Debug( "Move Diagonally Down Left" );
my $cmd = "decoder_control.cgi?command=92&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConUpRight
{
my $self = shift;
my $params = shift;
Debug( "Move Diagonally Up Right" );
my $cmd = "decoder_control.cgi?command=91&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

sub moveConDownRight
{
my $self = shift;
my $params = shift;
Debug( "Move Diagonally Down Right" );
my $cmd = "decoder_control.cgi?command=93&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$self->moveStop( $params );
}
}

# command=1 is technically Up Stop but seems to work for all stops.
sub moveStop
{
my $self = shift;
Debug( "Move Stop" );
print("autostop\n");
my $cmd = "decoder_control.cgi?command=1&";
$self->sendCmd( $cmd );
}

sub zoomConTele
{
my $self = shift;
my $params = shift;
Debug( "Zoom Tele" );
my $cmd = "decoder_control.cgi?command=16&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$cmd = "decoder_control.cgi?command=17&";
$self->sendCmd( $cmd );
}
}

sub zoomConWide
{
my $self = shift;
my $params = shift;
Debug( "Zoom Wide" );
my $cmd = "decoder_control.cgi?command=18&";
$self->sendCmd( $cmd );
my $autostop = $self->getParam( $params, 'autostop', 0 );
if ( $autostop && $self->{Monitor}->{AutoStopTimeout} )
{
usleep( $self->{Monitor}->{AutoStopTimeout} );
$cmd = "decoder_control.cgi?command=19&";
$self->sendCmd( $cmd );
}
}

sub zoomConStop
{
my $self = shift;
my $params = shift;
Debug( "Zoom Stop" );
my $cmd = "decoder_control.cgi?command=17&";
$self->sendCmd( $cmd );
}

# Increase Brightness
sub irisAbsOpen
{
my $self = shift;
my $params = shift;
my $step = $self->getParam( $params, 'step' );
my $brightness = 100;

my $cmd = "get_camera_params.cgi?";
my $resp = $self->sendCmd( $cmd );

$brightness = int($1) if ( $resp =~ m/var brightness=([0-9]*);/ );
$brightness += $step;
$brightness = 255 if ($brightness > 255);
Debug( "Iris Open $brightness" );
$cmd = "camera_control.cgi?param=1&value=".$brightness."&";
$self->sendCmd( $cmd );
}

# Decrease Brightness
sub irisAbsClose
{
my $self = shift;
my $params = shift;
my $step = $self->getParam( $params, 'step' );
my $brightness = 100;

my $cmd = "get_camera_params.cgi?";
my $resp = $self->sendCmd( $cmd );

$brightness = int($1) if ( $resp =~ m/var brightness=([0-9]*);/ );
$brightness -= $step;
$brightness = 0 if ($brightness < 0);
Debug( "Iris Close $brightness" );
$cmd = "camera_control.cgi?param=1&value=".$brightness."&";
$self->sendCmd( $cmd );
}

sub whiteAbsIn
{
my $self = shift;
my $params = shift;
my $step = $self->getParam( $params, 'step' );
my $contrast = 5;

my $cmd = "get_camera_params.cgi?";
my $resp = $self->sendCmd( $cmd );

$contrast = int($1) if ( $resp =~ m/var contrast=([0-9]*);/ );
$contrast += $step;
$contrast = 6 if ($contrast > 6);
Debug( "White In $contrast" );
$cmd = "camera_control.cgi?param=2&value=".$contrast."&";
$self->sendCmd( $cmd );
}

# Decrease Contrast
sub whiteAbsOut
{
my $self = shift;
my $params = shift;
my $step = $self->getParam( $params, 'step' );
my $contrast = 5;

my $cmd = "get_camera_params.cgi?";
my $resp = $self->sendCmd( $cmd );

$contrast = int($1) if ( $resp =~ m/var contrast=([0-9]*);/ );
$contrast -= $step;
$contrast = 0 if ($contrast < 0);
Debug( "White Out $contrast" );
$cmd = "camera_control.cgi?param=2&value=".$contrast."&";
$self->sendCmd( $cmd );
}

sub presetHome
{
my $self = shift;
Debug( "Home Preset" );
my $cmd = "decoder_control.cgi?command=25&";
$self->sendCmd( $cmd );
}

sub presetSet
{
my $self = shift;
my $params = shift;
my $preset = $self->getParam( $params, 'preset' );
my $presetCmd = 30 + (($preset-1)*2);
Debug( "Set Preset $preset with cmd $presetCmd" );
my $cmd = "decoder_control.cgi?command=$presetCmd&";
$self->sendCmd( $cmd );
}

sub presetGoto
{
my $self = shift;
my $params = shift;
my $preset = $self->getParam( $params, 'preset' );
my $presetCmd = 31 + (($preset-1)*2);
Debug( "Goto Preset $preset with cmd $presetCmd" );
my $cmd = "decoder_control.cgi?command=$presetCmd&";
$self->sendCmd( $cmd );
}
1;
__END__
# Below is stub documentation for your module. You'd better edit it!

=head1 NAME

ZoneMinder::Database - Perl extension for blah blah blah

=head1 SYNOPSIS

use ZoneMinder::Database;
blah blah blah

=head1 DESCRIPTION

Stub documentation for ZoneMinder, created by h2xs. It looks like the
author of the extension was negligent enough to leave the stub
unedited.

Blah blah blah.

=head2 EXPORT

None by default.

=head1 SEE ALSO

Mention other useful documentation such as the documentation of
related modules or operating system documentation (such as man pages
in UNIX), or any relevant external documentation such as RFCs or
standards.

If you have a mailing list set up for your module, mention it here.

If you have a web site set up for your module, mention it here.

=head1 AUTHOR

Philip Coombes, E<lt>philip.coombes@zoneminder.comE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2001-2008 Philip Coombes

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.3 or,
at your option, any later version of Perl 5 you may have available.

=cut
</pre>

Foscam

2012-06-17T16:47:45Z

Cbagwell: Add clone instructions

==Model specific wikis==
[[Foscam_FI8918W|Foscam FI8918W Pan/Tilt Camera]]

[[Foscam_FI8910W|Foscam FI8910W Pan/Tilt Camera]]

[[Foscam FI8904W|Foscam FI8904W Outdoor IP camera]]

[[Foscam FI8905W|Foscam FI8905W Outdoor IP camera]]

[[Foscam FI8602W|Foscam FI8602W Outdoor IP camera]]

[[Foscam Clones]]

==General Foscam directions==

(This was very helpful for me, but instead of 'videostream' below I believe
it should be 'snapshot'. Using videostream my wifi, using iptraf to monitor
it, was fluctuating wildly from zero to 5 mbps and lots of events were missed.
Now that I'm using the snapshot cgi (/snapshot.cgi?user=mine&pwd=mine)
iptraf shows a steady stream that behaves as expected, jumps up when alarmed,
am getting the performance from zoneminder other are, where using the
videostream as below got nothing but furstration... Best to y'all, gsx)

'''Foscam FI8908W IP Camera with PT (no Z) Working in ZM 1.24.2'''

Firmware 11_14_2_28 with presets working. --[[User:Lowbayer|Lowbayer]] 21:39, 12 March 2011 (UTC)

(This also works with the Foscam FI8918W camera. No sound though.)

See here for detail on [[Foscam_FI8918W]] with presets working. [[User:Hdurdle|Hdurdle]] 23:18, 26 February 2011 (UTC)

Just thought this might be useful for anybody using the Foscam IP FI8908W Cameras.

They can be bought on eBay for around £50 and for that money they are a great buy. (Beware of fakes, see here: http://www.gadgetvictims.com/2009/09/yet-another-firmware-for-foscam-fi8908w.html)

A firmware upgrade can be performed to allow Server Push Mode, for FireFox etc.

See here for a instructions and a link to the firmware file:
http://www.gadgetvictims.com/2009/07/foscam-ip-camera-part-two.html

I recommend firmware V11.14.1.42 and Web UI V2.4.8.11

Once that is done you can proceed to add the camera into ZoneMinder with the following settings:

;General:
:Name: x
:Source Type: Remote
:Function: Modect (up to you though)
:Enabled: Tick
:Maximum FPS: Empty (I had some issues with it lagging when I used values here)
:Alarm Maximum FPS: Empty
;Source
:Remote Protocol: HTTP
:Remote Method: Simple
:Remote Host Name: x.x.x.x (The IP of the camera)
:Remote Host Port: 80
:Remote Host Path: /videostream.cgi?user=admin&pwd= (assuming you have an admin user on the cam with no password)
:Remote Image Colours: 24 bit colour
:Capture Width: 320 (You could use 640 x 480, I found 320 to be better)
:Capture Height: 240

----
{|border="1"
|Video Stream Url and Parameter
|-
|http://<IP-CAM>/||videostream.cgi?||user=A&||pwd=B&||resolution=C||&rate=D
|-
| || || User || Password || 8 => 320x240|| 0 => maxframe
|-
| || || || || 32 => 640x480|| 1 => 20 fps
|-
| || || || || || 3 => 15 fps
|-
| || || || || || 6 => 10 fps
|-
| || || || || || 11 => 5 fps
|-
| || || || || || 12 => 4 fps
|-
| || || || || || 15 => 3 fps
|-
| || || || || || 14 => 2 fps
|-
| || || || || || 15 => 1 fps
|-
| || || || || || 17 => 1 fps/2s
|-
| || || || || || 19 => 1 fps/3s
|-
| || || || || || 21 => 1 fps/4s
|-
| || || || || || 23 => 1 fps/5s
|}

;Example
:http://<ip-webcam>/videostream.cgi?user=admin&pwd=geheim&resolution=32&rate=6
--[[User:Lowbayer|Lowbayer]] 08:05, 11 April 2011 (UTC)
----

The other settings are for personal preference only – so I haven’t listed them.

I modified an existing camera control file to create this file which will allow you to pan and tilt the camera from the web interface (working in ZM V1.24.2)

Save the following in the same location as the other .pm files. You can search for “PanasonicIP.pm” on your machine and see where that is. In my case it is:

/usr/share/perl/5.10/ZoneMinder/Control

From a terminal window run:

sudo gedit

Which will open up your text editor in admin mode. Then paste the following between the +++ (excluding the +++) into the text editor:

+++

# ==========================================================================
#
# ZoneMinder Foscam FI8908W IP Control Protocol Module, $Date: 2009-11-25 09:20:00 +0000 (Wed, 04 Nov 2009) $, $Revision: 0001 $
# Copyright (C) 2001-2008 Philip Coombes
# Modified for use with Foscam FI8908W IP Camera by Dave Harris
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
# ==========================================================================
#
# This module contains the implementation of the Foscam FI8908W IP camera control
# protocol
#
package ZoneMinder::Control::FoscamFI8908W;

use 5.006;
use strict;
use warnings;

require ZoneMinder::Base;
require ZoneMinder::Control;

our @ISA = qw(ZoneMinder::Control);

our $VERSION = $ZoneMinder::Base::VERSION;

# ==========================================================================
#
# Foscam FI8908W IP Control Protocol
#
# ==========================================================================

use ZoneMinder::Debug qw(:all);
use ZoneMinder::Config qw(:all);

use Time::HiRes qw( usleep );

sub new
{

my $class = shift;
my $id = shift;
my $self = ZoneMinder::Control->new( $id );
my $logindetails = "";
bless( $self, $class );
srand( time() );
return $self;
}

our $AUTOLOAD;

sub AUTOLOAD
{
my $self = shift;
my $class = ref($self) || croak( "$self not object" );
my $name = $AUTOLOAD;
$name =~ s/.*://;
if ( exists($self->{$name}) )
{
return( $self->{$name} );
}
Fatal( "Can't access $name member of object of class $class" );
}
our $stop_command;

sub open
{
my $self = shift;

$self->loadMonitor();

use LWP::UserAgent;
$self->{ua} = LWP::UserAgent->new;
$self->{ua}->agent( "ZoneMinder Control Agent/".ZM_VERSION );

$self->{state} = 'open';
}

sub close
{
my $self = shift;
$self->{state} = 'closed';
}

sub printMsg
{
my $self = shift;
my $msg = shift;
my $msg_len = length($msg);

Debug( $msg."[".$msg_len."]" );
}

sub sendCmd
{
my $self = shift;
my $cmd = shift;
my $result = undef;
printMsg( $cmd, "Tx" );

my $req = HTTP::Request->new( GET=>"http://".$self->{Monitor}->{ControlAddress}."/$cmd" );
my $res = $self->{ua}->request($req);

if ( $res->is_success )
{
$result = !undef;
}
else
{
Error( "Error check failed:'".$res->status_line()."'" );
}

return( $result );
}

sub reset
{
my $self = shift;
Debug( "Camera Reset" );
my $cmd = "reboot.cgi?user=admin&pwd=";
$self->sendCmd( $cmd );
}

#Up Arrow
sub moveConUp
{
my $self = shift;
$stop_command = "1";
Debug( "Move Up" );
my $cmd = "decoder_control.cgi?command=0&user=admin&pwd=";
$self->sendCmd( $cmd );
}

#Down Arrow
sub moveConDown
{
my $self = shift;
$stop_command = "1";
Debug( "Move Down" );
my $cmd = "decoder_control.cgi?command=2&user=admin&pwd=";
$self->sendCmd( $cmd );
}

#Left Arrow
sub moveConLeft
{
my $self = shift;
$stop_command = "1";
Debug( "Move Left" );
my $cmd = "decoder_control.cgi?command=4&user=admin&pwd=";
$self->sendCmd( $cmd );
}

#Right Arrow
sub moveConRight
{
my $self = shift;
$stop_command = "1";
Debug( "Move Right" );
my $cmd = "decoder_control.cgi?command=6&user=admin&pwd=";
$self->sendCmd( $cmd );
}

#Diagonally Up Right Arrow
sub moveConUpRight
{
my $self = shift;
$stop_command = "1";
Debug( "Move Diagonally Up Right" );
my $cmd = "decoder_control.cgi?command=91&user=admin&pwd=";
$self->sendCmd( $cmd );
}

#Diagonally Down Right Arrow
sub moveConDownRight
{
my $self = shift;
$stop_command = "1";
Debug( "Move Diagonally Down Right" );
my $cmd = "decoder_control.cgi?command=93&user=admin&pwd=";
$self->sendCmd( $cmd );
}

#Diagonally Up Left Arrow
sub moveConUpLeft
{
my $self = shift;
$stop_command = "1";
Debug( "Move Diagonally Up Left" );
my $cmd = "decoder_control.cgi?command=90&user=admin&pwd=";
$self->sendCmd( $cmd );
}

#Diagonally Down Left Arrow
sub moveConDownLeft
{
my $self = shift;
$stop_command = "1";
Debug( "Move Diagonally Down Left" );
my $cmd = "decoder_control.cgi?command=92&user=admin&pwd=";
$self->sendCmd( $cmd );
}

#Stop
sub moveStop
{
my $self = shift;
Debug( "Move Stop" );
my $cmd = "decoder_control.cgi?user=admin&pwd=&command=1";
$self->sendCmd( $cmd );
}

#Move Camera to Home Position
sub presetHome
{
my $self = shift;
Debug( "Home Preset" );
my $cmd = "decoder_control.cgi?command=25&user=admin&pwd=";
$self->sendCmd( $cmd );
}

1;

+++

Now save that as ‘FoscamFI8908W.pm’ in the same location where you found the PanasonicIP.pm file.

(This file also assumes there is a user with the name admin and no password. If your setup is different, you will need to change this file). This is a first draft working version, I’ll tidy it up once ive learnt a bit more about perl 

Next you need to add the Control Type.

Click on edit and add a new control with these details:

Main:
Name: Foscam FI8908W
Type: Remote
Protocol: FoscamFI8908W (No space in there)
Move:
Can Move: Tick
Can Move Diagonally: Tick
Can Move Continuous: Tick
Pan:
Can Pan: Tick
Tilt:
Can Tilt: Tick
Presets:
Has Presets: Tick
Num Presets: 0
Has Home Presets: Tick

Add the IP address of the camera to the '''Control Address''' field in the '''Control''' tab of camera settings

Save all that and you should be up and running.

----

;Here a list of more feature from decoder_control.cgi with the Firmware 11.14.2.28 (found: http://www.gadgetvictims.com/2010/10/fi8908w-old-and-new.html) --[[User:Lowbayer|Lowbayer]] 21:39, 12 March 2011 (UTC)

Example: http://<IP_CAM>/decoder_control.cgi?command=30&user=<user>&pwd=<pass> = Set the preset 0

Parameters value

:0 up
:1 Stop up
:2 down
:3 Stop down
:4 left
:5 Stop left
:6 right
:7 Stop right
: ... Reserved
:25 center
:26 Vertical patrol
:27 Stop vertical patrol
:28 Horizon patrol
:29 Stop horizon patrol
:30 Set preset 0
:31 Go preset 0
:32 Set preset 1
:33 Go preset 1
:34 Set preset 2
:35 Go preset 2
: ....
:62 Set preset 16
:63 Go preset 16
:And the list goes further until preset 16
:94 IO output high
:95 IO output low

----

A few more notes that I found useful:

Turning off the annoying green LED: (where x.x.x.x is the IP of your camera)

http://x.x.x.x/set_misc.cgi?led_mode=2&user=admin&pwd=

:led_mode=0 - the green led blinks only once connected.
:led_mode=1 - the green led blinks while searching for a connection and when connected.
:led_mode=2 - the green led is always off.

Stop the camera moving around when you reboot it:

http://x.x.x.x/set_misc.cgi?ptz_center_onstart=0&user=admin&pwd=

I initially had some issues with no images displaying in ZM. I found this to be a shared memory issue, see here:

http://www.zoneminder.com/wiki/index.php -> FAQ#What_does_a_.27Can.27t_shmget:_Invalid_argument.27_error_in_my_logs_mean.3F_and_my_cameras_won.27t_display_video_at_higher_resolutions.

;Here a list of interesting feature: --[[User:Lowbayer|Lowbayer]] 21:39, 12 March 2011 (UTC)

http://[ipcam]/get_misc.cgi ->Returns all the current values for the functions above.

http://[ipcam]/get_log.cgi -> Displays the visits log

http://[ipcam]/get_params.cgi ->Returns the complete configuration of the camera.

https://docs.google.com/fileview?id=0B-yhhBvC0DSlNWExZDU0NTQtMDlmZi00YzkzLWFkNDAtMGU4MTA1MDg2YjMz&hl=en

The feature list from the IPCAM CGI SDK V1.7

http://www.notesco.net/download/ipcamcgisdk21.pdf

The feature list from the IPCAM CGI SDK V2.1

----

I found this guide useful for getting ZM 1.24.2 installed in the first place on my ubuntu box:

http://www.howtoforge.com/video_surveillance_zoneminder_ubuntu

I replaced:

ftp://www.northern-ridge.com.au/zoneminder/ubuntu/dapper/zoneminder_1.22.3-8_i386.deb

with

ftp://www.northern-ridge.com.au/zoneminder/1.24/ubuntu/jaunty/zoneminder_1.24.2-1_i386.deb

I have also heard of people replacing the existing lens in the Foscam Camera (it simply unscrews) with a 160° Wide Angle lens to give a better view. (Search eBay for ‘2.1mm CCTV Lens’). I haven’t tried this myself yet, but will at some point in the future.

On more thing to add. Since upgrading to 1.24.2 (I was originally on 1.23) I have had a few issues with apache locking up. I followed the recommended fix in this thread:

http://www.zoneminder.com/forums/viewtopic.php?p=51045

Which has helped a little but I’m still having a few issues. I have to run this command:

sudo apache2ctl restart

every now and then on the box (which I VNC into from my windows box) to restart apache.

Hope this is useful to some people.

Cheers,

DAVE.

PS - As I'm not always on the forum, I tend to update my blog first (and the forum later - sorry!), it's here: http://dave.harris.net/foscam-fi8908w-ip-camera-with-pt-no-z-working-in-zoneminder/ :)