reference
manual
Contents
Notices
8
1: About This Manual
9
1.1 General
1.2 What You Need to Know for This Manual
2: Getting Started
9
10
11
2.1 Overview
2.2 Connect to the IQeye
11
11
2.2.1 Telnet Connection
2.2.2 Privileged User
11
12
2.3 About Commands
12
2.3.1 Command Display
2.3.2 Strings
2.3.3 Command Types
2.3.4 Command Line Interface
13
14
14
15
3: Image Commands
16
3.1 Overview
3.2 Image Commands
16
16
3.2.1 Set/Define Image Compression
3.2.2 Set/Define Image JPEGquality
3.2.3 Set/Define Image Downsample
3.2.4 Set/Define Image Factory
3.2.5 Set/Define Image Flip
3.2.6 Set/Define Image Gain (brightness)
3.2.7 Set/Define Image Gain Preference
3.2.8 Set/Define Image Gain Speed
3.2.9 Set/Define Image Gain Window
3.2.10 Set/Define Image Gamma
3.2.11 Set/Define Image LED
3.2.12 Set/Define Image Lighting
3.2.13 Set/Define Image Lighting Auto
3.2.14 Set/Define Image Lighting Bloom
3.2.15 Set/Define Image Lighting (frequency)
3.2.16 Set/Define Image Monochrome
3.2.17 Set/Define Image Overlay
contents
16
17
18
19
19
21
22
23
24
27
28
28
29
30
31
32
33
2
3.2.18 Set/Define Image Sharpen
3.2.19 Set/Define Image Window
37
38
3.3 Save Image
3.4 Show/List Image
3.5 Test Focus
40
41
41
3.5.1 The LED method
3.5.2 The Telnet Window method
42
42
4: Custom Web Pages
43
4.1 Overview
4.2 HTML
43
44
4.2.1 General Programming
4.2.2 Adding Live Images to Other Web Pages
4.2.3 Special Web Parsing
4.2.4 Image Hosting on Alternate Servers
4.2.5 Server Push with a Java Applet
4.2.6 Dynamic Print
4.3 Transferring Files to the Camera
44
45
45
47
50
51
53
4.3.1 FTP-Client Applications
4.3.2 Command Line FTP
4.3.3 Modifying Permissions for Secure Pages
5: Security Commands
53
53
55
56
5.1 Overview
56
5.1.1 Important Security Configurations
5.2 Login Control
56
56
5.2.1 Remote Console Port
57
5.3 Privileged Mode
58
5.3.1 Privileged User
5.3.2 Privileged User Override
58
59
5.4 Security Commands (general)
59
5.4.1 Set/Define Server Hours
5.4.2 Set/Define Server Login Password
5.4.3 Set/Define Server Incoming Password
5.4.4 Set/Define Server Password Limit
5.4.5 Set/Define Server Privileged Password
5.5 IP Security Commands
59
61
61
62
63
64
5.5.1 Configuring the Security Table
5.5.2 Using the Security Table
5.5.3 Set/Define IP Security
64
64
65
contents
3
5.5.4 Show/List IP Security
65
5.6 Port Security Commands
66
5.6.1 Set/Define Port Password
5.6.2 Set/Define Port Security
66
66
6: Trigger & Relay Commands
6.1 Overview
68
68
6.1.1 Trigger Events
6.1.2 Initiating a Trigger Event
68
69
6.2 Trigger Commands
70
6.2.1 Set/Define Trigger Action
6.2.2 Set/Define Trigger Factory
6.2.3 Set/Define Trigger Idletime
6.2.4 Set/Define Trigger Input
6.2.5 Set/Define Trigger Periodic
6.2.6 Set/Define Trigger Pre/Post
6.2.7 Set/Define Trigger Script
70
71
71
72
73
73
74
6.3 Show/List Trigger
6.4 Test Trigger Input
6.5 Output/Relay
75
75
76
6.5.1 Set/Define Trigger Output
6.5.2 Test Trigger Output
76
77
7: FTP, Scripts, & E-mail
78
7.1 Overview
7.2 FTP
78
78
7.2.1 Verify FTP Settings
7.2.2 Save FTP Settings
7.2.3 Set/Define FTP Site
7.2.4 Set/Define FTP Factory
7.2.5 Save FTP
7.2.6 Clear/Purge FTP Site
7.2.7 Show/List FTP
7.2.8 FTP Transfers
81
81
82
85
85
86
86
88
7.3 Scripts
89
7.3.1 Overview
7.3.2 Start-up Scripts
7.3.3 Trigger Event Scripts
7.3.4 Cron Scripts
89
89
90
92
7.4 E-mail
93
contents
4
7.4.1 Email
7.4.2 Set/Define Email Site
7.4.3 Save Email
7.4.4 Clear/Purge Email Site
7.4.5 Set/Define Email Factory
7.4.6 Show/List Email
93
94
96
96
97
97
8: Network Commands
99
8.1 Overview
8.2 IP Commands
99
99
8.2.1 Set/Define IP Domain
8.2.2 Set/Define IP Gateway
8.2.3 Set/Define IP IPaddress
8.2.4 Define IP Loadhost
8.2.5 Set/Define IP Nameserver
8.2.6 Set/Define IP Subnet Mask
8.2.7 Set/Define IP Timeserver
8.2.8 Set/Define ONIP Action
99
100
101
101
102
102
103
104
8.3 Logging Commands
106
8.3.1 Set/Define Logging
106
8.4 Port Commands
109
8.4.1 Set/Define Port Access
8.4.2 Set/Define Port CDlogout
8.4.3 Set/Define Port Character Size
8.4.4 Set/Define Port Flow Control
8.4.5 Set/Define Port Inactivity Logout
8.4.6 Set/Define Port Parity
8.4.7 Set/Define Port Speed
8.4.8 Set/Define Port Stop
8.5 Server Commands
109
110
110
111
111
112
112
113
113
8.5.1 Define Server BOOTP
8.5.2 Set/Define Server Clock
8.5.3 Set/Define Server DHCP
8.5.4 Define Server Ethernet
8.5.5 Set/Define Server Identification
8.5.6 Set/Define Server Inactivity (Timer)
8.5.7 Set/Define Server Incoming
8.5.8 Set/Define Server Name
8.5.9 Set/Define Server RARP
8.5.10 Set/Define Server Retransmit (Limit)
8.5.11 Set/Define Server SilentBoot
contents
113
114
115
115
116
116
117
117
118
119
119
5
8.5.12 Set/Define Server Software
8.5.13 Set/Define Server Startupfile
8.5.14 Set/Define Server Timezone
120
120
121
8.6 Web Commands
122
8.6.1 Set/Define Web Defaultpage
8.6.2 Set/Define Web Port
122
123
8.7 Purge Port
8.8 Save
8.9 Show/List IP
8.10 Show/List Port
8.11 Show/List Server
8.12 Show/List Users
8.13 Show/List Web
123
124
125
125
126
128
128
9: File System & Miscellaneous
Commands
129
9.1 Overview
9.2 Apropos
9.3 Disk Commands
129
129
130
9.3.1 Overview
9.3.2 Command Conventions
9.3.3 Permissions
9.3.4 Disk CAT (Concatenate)
9.3.5 Disk CD (Change Directory)
9.3.6 Disk CHMOD (Change Modes)
9.3.7 Disk CP (Copy)
9.3.8 Disk DF (Free Disk Blocks)
9.3.9 Disk Format Flash
9.3.10 Disk FSCK (FS-Check)
9.3.11 Disk LN (Link)
9.3.12 Disk LS (List)
9.3.13 Disk MKDIR (Make Directory)
9.3.14 Disk More
9.3.15 Disk MV (Move)
9.3.16 Disk OD (Octal Dump)
9.3.17 Disk Path
9.3.18 Disk PWD (Print Working Directory)
9.3.19 Disk RM (Remove)
9.3.20 Disk RMDIR (Remove Directory)
9.3.21 Disk Sync
9.4 Finger
130
130
131
132
132
133
134
135
135
136
136
137
137
138
138
139
140
140
141
141
142
142
contents
6
9.5 Help
9.6 Initialize
9.7 Logout
9.8 Netstat
9.9 Ping
9.10 Source
9.11 Zero Counters
10: Modems
10.1 Overview
10.1.1 Supported Modems
10.1.2 Outgoing Connections
10.1.3 Incoming Calls
10.2 Connect a Modem
10.3 Configure the Camera Via the Modem
10.4 Modem Commands
10.4.1 Set Modem
10.4.2 Set Dial-in
10.4.3 Set Dial-out
10.5 Show Dial-in/Dial-out
10.6 Show/List Modem
143
143
144
145
145
146
147
148
148
148
148
149
149
150
152
152
153
153
154
155
A: Technical Support
156
B: Troubleshooting
157
C: Focus Utilities
160
D: Pinouts
164
Certifications
167
Index
168
contents
7
Notices
© 2001, IQinVision. All rights reserved. No part or contents of this manual may be transmitted
or reproduced without written permission from IQinVision.
The release date for this manual is March 13, 2001. Due to updates in the camera’s operating
software, this manual will change periodically and may change without notice. Current versions
of the manual are kept at the IQinVision web site (www.IQeye.com).
The screenshots in this manual are used for explanatory purposes. Your actual screens may
differ from the screenshots included in this manual.
This product is partially based on source code appearing in “The Working Programmer's Guide
to Serial Protocols,” Copyright (c) 1995 Tim Kientzle and Coriolis Group, Inc.
Portions Copyright Netscape Communications Corporation, 1999. All Rights Reserved.
Netscape Navigator and the Netscape N Logo are registered trademarks of Netscape in the
United States and other countries. Microsoft Windows and Internet Explorer are registered
trademarks of Microsoft Corporation. Other company or product names are trademarks or
registered trademarks of their respective owners.
manual version 2.0/—1
notices
1: About This Manual
1.1 General
This manual documents the advanced features and commands that are available on all versions
of the IQeye Internet camera. Advanced users who have a detailed understanding of digital
imaging and computer networking concepts can use this manual to optimize the performance of
their camera.
Note:
This manual does not contain information for the installation procedure
nor does it discuss basic configuration. To install your camera and make
it operational, refer to the IQeye User’s Guide that corresponds to your
particular camera.
All of the commands used by the IQeye line of cameras are documented in this manual. Most of
the camera’s features are included in the command explanations. Unique camera features that
do not require a command line connection are explained in their own chapters.
The manual consists of the following chapters:
Getting Started
Explains how to use the IQeye Reference Manual and
provides instructions for using the camera’s command line
environment.
Image Commands
Contains information on how to adjust and optimize the
image settings. Also includes information about adding
overlays to your camera’s images.
Custom Web Pages
Contains information on how to customize the camera’s
internal web pages using basic HTML, special web parsing,
and dynamic print. Also includes information about hosting
images on alternate web servers and transferring files to your
camera via FTP.
Security Commands
Contains instructions for changing your Login and Privileged
passwords, and for optimizing the security of your camera.
Trigger & Relay Commands
Provides information for configuring the camera to capture
image during events, operating either with a relay device or at
specified intervals.
FTP, Scripts, & Email
Details how to transfer images to an FTP serverhow to use
scripts, how to automate camera features, and how to use the
email command to establish communications between the
camera and remote users.
Network Commands
Contains all commands for configuring your camera to
communicate with other devices over an Ethernet. Also
includes information about configuring the camera’s serial
port.
Management Commands
Details each of the commands used for managing information
and files on the camera.
Modem Commands
Explains how to configure an IQeye camera to operate with
a compatible external modem.
about this manual
9
Appendices
Contain information on technical support, troubleshooting,
software updates, and the camera’s pinouts.
For the on-line version of this manual, all cross-references to other chapters, sections, and pages
are highlighted in blue. These highlighted words are links to the indicated section. Navigate to
the section indicated in the cross-reference by clicking on the highlighted word.
1.2 What You Need to Know for This Manual
While the IQeye camera is a “plug and play” device, optimizing the camera requires a general
knowledge of computer networking and an understanding of command line environments.
Therefore, the instructions and explanations contained in this manual assume that you are
comfortable issuing networking commands at a command line prompt.
Most of the features described in this manual are also configurable via the camera’s embedded
HTML interface, which provides easier access for personalizing the camera. Refer to the IQeye
User’s Guide for more information on using the camera’s browser-based configuration pages.
about this manual
10
2: Getting Started
2.1 Overview
Not only are the IQeye cameras powerful digital imaging tools, they are also very sophisticated
network devices. This manual documents all facets of IQeye cameras.
In this manual, the camera’s features are described within the explanations of the commands.
You may adjust the features by issuing the appropriate commands in a command line
environment. To issue commands, you must connect to the camera.
2.2 Connect to the IQeye
2.2.1 Telnet Connection
To adjust the features of the camera by using the commands listed in this manual, you must
establish a Telnet connection with the camera.
Note:
To use Telnet, your camera must have a unique IP address on your
network. Refer to the IQeye User’s Guide for information on installing
your camera and assigning an IP address.
Telnet is an industry-standard network protocol that enables users anywhere on a network to
access a remote host and start a terminal session. Telnet connections do not require that either
end of the connection know the hardware/software used on the other end.
Note:
All Telnet commands also control the camera’s Rlogin features. Rlogin
connections are similar to Telnet connections, however, Rlogin enables
trusted users to log into a host without password verification.
To Telnet to the camera, issue a Telnet command using your camera’s previously-assigned IP
address.
Note:
The example below uses a hypothetical IP address. Use your camera’s IP
address when opening a Telnet connection with your camera.
getting started
11
When you connect to the camera, you will see a Username> prompt. Enter a username to
identify yourself as the current user.
Note:
This username is not associated with authentication.
After you identify yourself as the current user, you will see a Local> prompt. From this prompt,
the unprivileged prompt, you can issue some commands. Most commands require privileged
user status.
2.2.2 Privileged User
Changing most settings on the camera requires privileged user or “Superuser” status. To become
the privileged user, you must issue a command and enter a password. After you establish a
Telnet connection with the camera, issue the SET PRIVILEGED command at the Local>
prompt.
Note:
You may also enter the command SU, which is an alias to the SET
PRIVILEGED command.
At the resulting Password> prompt, enter system, the default privileged password.
Note:
If you have changed the default privileged password, you must enter the
new password. Refer to Section 5.4.5 on page 63 for more information
on personalizing the default password.
A privileged prompt (usually Local>>) will appear. At the privileged prompt, enter the
commands as they appear in the command descriptions.
2.3 About Commands
Entering commands at the command line is a powerful way to control your camera. Once you
have connected to the camera via Telnet, enter the commands at the appropriate prompt.
Note:
Most commands require privileged user status. Refer to the instructions
above for becoming the privileged user.
getting started
12
2.3.1 Command Display
The following conventions will be used in this manual to display the commands:
•
Each command will be shown in diagram form, as follows:
COMMAND
parameter1
parameter2 string
•
The command itself appears in all capital letters.
•
The parameters for the command appear in brackets [ ].
Parameters define the scope of the command. An explanation of each parameter will
appear below the command diagram, including:
Note:
•
❍
A description of how the parameter functions,
❍
Whether the command requires privileged user status,
❍
The default settings for the command, if applicable, and
❍
Examples of the command.
You should only enter one of the bracketed parameters per command
entry.
Optional information will appear in braces { }. For example, the word “TIMER” is
optional in the command below. All commands that have items displayed in { } will
function whether the optional keyword is included or not.
SET
DEFINE
•
SERVER INACTIVITY
{ TIMER }
limit
An italicized parameter or string indicates that a user must provide additional input. In the
example above, the user must specify a value for limit. The range of input possibilities
will be included with the explanation of the italicized parameter.
Note:
When a string calls for a user-entered fraction, be certain not to use any
spaces within the fraction, and do not include zeros as a fraction
denominator.
getting started
13
2.3.2 Strings
Strings are parts of a command that require users to enter their own input. When a command
calls for a string, the following two things must be considered:
•
Any user-entered strings should be enclosed in quotes to retain the case entered. If a string
is not enclosed in quotes, it will be changed to all uppercase characters, and any spaces will
cause the camera to interpret the different parts of the string as different command
parameters.
•
Strings are generally limited in length depending on the command. Each string’s
limitations are noted in the description of the parameter.
2.3.3 Command Types
There are subtle differences between certain command groups:
2.3.3.1 Set, Define, and Save
SET changes the unit immediately but not permanently. All changes made using the SET
command become the operational settings. If the settings are not saved, however, the camera
will revert to the previous settings at reboot. To make the change permanent, use the SAVE
command.
Note:
Using the SET command is a good way to experiment with certain
features without changing the camera’s permanent settings.
DEFINE changes the camera’s permanent settings, but does not change them immediately.
Most settings will change when the camera is rebooted. All port commands will take effect
once the port is logged out. The SET and DEFINE commands generally correspond and are
therefore listed together in this manual.
SAVE writes to permanent memory all settings that were changed using the SET command,
making them permanent. When you issue a Save command, all Set commands entered since
the last reboot will be saved.
2.3.3.2 Clear and Purge
CLEAR removes an item immediately, but does not make a permanent change. When the
camera is rebooted, it will revert to the old settings.
PURGE removes an item permanently but does not take effect until the camera is rebooted.
Note:
Most PURGE commands are listed with their corresponding CLEAR
commands, but some are listed separately.
2.3.3.3 Show and List
SHOW displays the current settings, those changed using the SET command but not
permanently defined or saved.
LIST displays settings that will take effect when the camera is rebooted, those changed using
the DEFINE command).
getting started
14
2.3.4 Command Line Interface
Command line entry is both simple and powerful. Users can enter up to 132 characters on a
command line, or they can abbreviate commands to a sequence of the smallest unique keywords
that will clearly identify the command (sometimes single characters). Commands are executed
when the Return key is pressed or when the command line exceeds 132 characters.
2.3.4.1 Command Abbreviation
The IQeye cameras support a time saving mechanism that allows the camera to properly
execute a partially-typed command, which can both save time and reduce errors.
Because of command abbreviation, the following two examples are equal:
2.3.4.2 Command Line Editing
The following table lists the special keys used for command line editing.
Table 2-1: Line Editing Keys
Key
Purpose
Return
Executes the current command line
Delete
Deletes the character before the cursor
Ctrl-A
Toggles insert/overstrike modes (overstrike is the default)
Ctrl-D or Ctrl-Z
Logs out of the Server
Ctrl-E
Moves cursor to end of line
Ctrl-H or Backspace
Moves cursor to the beginning of the line
Ctrl-R
Re-displays the current command
Ctrl-U
Deletes the entire current line
Up Arrow or Ctrl-P
Recalls the previous commands
Down Arrow or Ctrl-N
Recalls the subsequent previous command
!text <Return>
Recalls command starting with text
!! <Return>
Recalls and executes the last command
getting started
15
3: Image Commands
3.1 Overview
This chapter documents each of the commands used to adjust and define the image settings and
features for IQeye cameras. To see the changes that result from issuing the commands, you will
also need to open a browser window that shows your camera’s live image.
Note:
Many image settings can be adjusted from inside a web browser using the
browser-based Image Settings page. Refer to the IQeye User’s Guide for
more information on using the browser-based Image Settings page.
3.2 Image Commands
3.2.1 Set/Define Image Compression
The Image Compression command adjusts the level of JPEG compression applied to your
camera’s image. The level of compression applied to an image affects the quality of the image.
Low levels of compression result in higher quality images, larger file sizes, and decreased
network traffic. Conversely, higher levels of compression yield poorer image quality, smaller file
sizes, and increased network transmission. Your ideal compression setting will depend on the
minimum image quality and maximum transmission time that you find acceptable.
Note:
Image compression has an inverse relationship to image quality. If you
adjust the amount of compression applied to your image, you will affect
the quality of your image. See SET/DEFINE IMAGE JPEGQUALITY
below for more information about the camera’s image quality settings.
SET
DEFINE
IMAGE COMPRESSION
XHIGH
HIGH
MEDIUM
LOW
XLOW
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
XHIGH
Sets the highest level of compression, which results in the
smallest file size, poorest image quality, and fastest
transmission times. Use this setting only if you cannot
transmit images with less compression.
image commands
16
HIGH
Sets a high level of compression, which results in a smaller file
size and faster transmission times. High compression can also
result in poor image quality.
MEDIUM
Sets a moderate level of image size and quality.
LOW
Sets a low level of compression, which results in a larger file
size, better quality image, and slower transmission time.
XLOW
Sets the lowest level of compression, which results in the
largest file size, best quality image, and slowest transmission
times. Typically, the file size of these images is very large. Use
this setting only if file size and transmission time are not
important.
Defaults
low
Examples
Local>> SET IMAGE COMPRESSION HIGH
See Also
Set/Define Image JPEGquality
3.2.2 Set/Define Image JPEGquality
The Image JPEGquality command adjusts the quality of your camera’s JPEG images by directly
adjusting the quality number as defined in the JPEG specification. This command allows more
precise adjustments than the SET/DEFINE IMAGE COMPRESSION command (see above).
Image quality has an inverse relationship to image compression. For example, high quality
images have low compression. See the SET/DEFINE IMAGE COMPRESSION command for
more information about the camera’s image compression settings.
SET
DEFINE
IMAGE JPEGQUALITY
number
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
number
Sets the image quality to a specific value. Enter an integer
between 8 (lowest quality) and 92 (highest quality).
Defaults
60
Examples
Local>> SET IMAGE JPEGQUALITY 65
See Also
Set/Define Image Compression
image commands
17
3.2.3 Set/Define Image Downsample
The Image Downsample command downsamples, or shrinks, the size of the image the camera
outputs. Since smaller images are calculated and transmitted faster, this feature is important if
you need to transmit more images per second or if you need smaller images for display reasons.
Note:
After you issue the SET IMAGE DOWNSAMPLE command, you must also
resize the image in your browser. If you have a Netscape connection open
with the camera, press the STOP button and then press the RELOAD
button.
The Downsample feature always affects the size of the image window. If no subwindow is set,
the SET/DEFINE IMAGE DOWNSAMPLE command will shrink the size of the entire image.
However, if you have specified a subwindow with the SET/DEFINE IMAGE WINDOW
command, then the SET/DEFINE IMAGE DOWNSAMPLE command will shrink only the
windowed portion of your image.
SET
DEFINE
IMAGE DOWNSAMPLE num
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
num
Specifies the factor by which the image size will decrease. For
example, entering the number 2 would downsample the
image to a new image 1/2 of the original size. Enter
1,2,3,4,6,8,12, or 16.
Defaults
1
Examples
To specify a downsampled image that is 1/4 the size of the
original image, enter the following command:
Local>> SET IMAGE DOWNSAMPLE 4
image commands
18
3.2.4 Set/Define Image Factory
The Image Factory command returns all image settings to their factory defaults. Use this
command with care.
SET
DEFINE
IMAGE FACTORY
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Examples
Local>> SET IMAGE FACTORY
3.2.5 Set/Define Image Flip
The Image Flip command allows you to reorient your camera’s image. Occasionally, the place
where you mount your IQeye camera will not match the default setting for vertical/horizontal
image orientation. To fix this problem, you must tell your camera which side is “up” by
adjusting the Image Flip setting. The Image Flip command can also be used to display a reverse
image, which is helpful if your camera is pointed at a mirror.
The default orientation setting assumes the camera is mounted with the 1/4 - 20 threaded camera
mount on the bottom of the camera.
Note:
When you select certain Image Flip settings, the resulting image will
require additional processing by the camera, which will slow down the
overall processing time. These settings are noted below.
SET
DEFINE
Restrictions
IMAGE FLIP
VERTICAL
HORIZONTAL
90
180
270
BLTR
TLBR
NONE
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
image commands
19
Parameters
VERTICAL
Reflects your image vertically.
HORIZONTAL
Reflects your image horizontally.
90
Rotates your image 90 degrees clockwise. The resulting
image requires additional processing.
180
Rotates your image 180 degrees clockwise.
270
Rotates your image 270 degrees clockwise. The resulting
image requires additional processing.
BLTR
Flips your image across a diagonal line starting at the bottom
left corner and extending to the top right corner. The
resulting image requires additional processing.
image commands
20
TLBR
Flips your image across a diagonal line starting at the top left
corner and extending to the bottom right corner. The
resulting image requires additional processing.
NONE
Returns your camera to the default image orientation.
Examples
Local>> SET IMAGE FLIP VERTICAL
3.2.6 Set/Define Image Gain (brightness)
The Image Gain command adjusts the gain, or brightness, of your image. You can also specify
a gain control window to control the brightness relative to an important area of the image. See
Set/Define Image Gain Window on page 24 for more information.
SET
DEFINE
IMAGE GAIN
AUTO ENABLED
DISABLED
TARGET value
HOLD number
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
AUTO ENABLED
Sets the camera for automatic gain control, so that the camera
will monitor lighting conditions and dynamically adjust the
gain setting to the best possible value.
AUTO DISABLED
Specifies that the gain will hold at its current value. Use SHOW
IMAGE to see the current value (see Section 3.4 on page 41).
TARGET value
Sets an average brightness for the gain control. Enter a value
between 0 (darkest) and 1.0 (brightest), in tenths, which will
correspond to the shade of gray of the gain correction. For
example, 0.4 = 40% gray.
image commands
21
HOLD number
Specifies an exact value for the gain control. Enter a value
between 0 (darkest) and 1.0 (brightest) in tenths. Decimals
and fractions are accepted.
Note:
Using the HOLD feature automatically disables the Autogain control.
Defaults
Auto Enabled, Target = 0.5
Examples
Local>> SET IMAGE GAIN HOLD .3
See Also
Set/Define Image Gain Window
3.2.7 Set/Define Image Gain Preference
The Image Gain Preference command tells the camera which parameter to use when deciding
how to adjust gain. If the specified shutter speed is too fast for getting high quality images, the
Gain Preference command will maintain the balance between quality images and the chosen
shutter speed.
Note:
The SET/DEFINE IMAGE GAIN SPEED command controls the
camera’s shutter, which provides for quality images depending on the
activity of the subject. Refer to the Set/Define Image Gain Speed section
below.
Note:
On the browser-based settings pages, gain preference is controlled by the
Subject Motion setting. The Subject Motion setting controls both gain
preference and gain speed.
SET
DEFINE
IMAGE GAIN PRFERENCE
SPEED
QUALITY
NORMAL
FORCE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
SPEED
Sets the camera to remain at the chosen shutter speed at the
expense of image quality. The chosen speed will remain until
the resulting image is too overly bright or dark, at which time
the camera will slowly adjust the shutter speed to improve the
quality of the image.
QUALITY
Specifies that the camera will disregard the target shutter
speed, instead varying the speed so that the camera will
capture higher quality images.
image commands
22
NORMAL
Sets the camera to choose a gain that is between QUALITY
and SPEED.
FORCE
Sets the camera to permanently remain at the selected shutter
speed. Image quality will suffer as a result.
Defaults
Normal
Examples
Local>> SET IMAGE GAIN PREFERENCE FORCE
3.2.8 Set/Define Image Gain Speed
The Image Gain Speed command controls the preferred amount of time that the camera’s shutter
remains open. This command allows you to customize your camera according to the activity of
the subject. Subjects that are in motion will require a faster shutter speed to prevent the image
from becoming blurred.
The Image Gain Speed command sets the target shutter speed. The camera will use the specified
figure as the centerpoint for interpreting the optimal gain for the image.
Note:
On the browser-based settings pages, gain speed is controlled by the
Subject Motion setting. The Subject Motion setting controls both gain
speed and gain preference.
SET
DEFINE
IMAGE GAIN SPEED
XHIGH
HIGH
NORMAL
LOW
XLOW
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
XHIGH
Sets the shutter to open and close at intervals of roughly 240
Hz, or approximately every 1/240 second.
HIGH
Sets the shutter to open and close at intervals of roughly 120
Hz, or approximately every 1/120 second.
NORMAL
Sets the shutter to open and close at intervals of roughly 60
Hz, or approximately every 1/60 second.
image commands
23
LOW
Sets the shutter to open and close at intervals of roughly 15
Hz, or approximately every 1/15 second.
LOW
Sets the shutter to open and close at intervals of roughly 3.75
Hz, or approximately every 1/3.75 second.
Note:
The shutter speeds above indicate how quickly the shutter will operate
when the camera is operating in 60Hz mode. If your camera is set to
50Hz mode, your shutter speeds are roughly 5/6 of the values above.
Refer to the Set/Define Image Lighting (frequency) section below.
Defaults
Normal
Examples
Local>> SET IMAGE GAIN SPEED XHIGH
3.2.9 Set/Define Image Gain Window
The Gain Window command allows you to define a rectangular area within your image that will
become the gain control, or backlight correction area. You can select just the region of interest
and the gain control will use only that area to calculate the gain correction, which is useful if
some parts of your image are excessively bright or dark. Remember that the entire image will
become brighter or darker as a result.
Gain Control Window
You can specify a gain control window with two origin points: either a top left coordinate or a
center coordinate. You can then either specify a width and height calculated from the top left
point or you can enter a width and height that will center around the center coordinate.
When setting the gain control window according to a top left coordinate, keep in mind that the
top left corner of an unwindowed image has the coordinates (0,0). You will use the TOP, LEFT,
RAWHEIGHT, and RAWWIDTH parameters.
image commands
24
When setting a gain control window around a center point, specify a center coordinate by
entering the amount of offset to the right and above the absolute center of the image. The
absolute center has the coordinates (0,0). You will use the X, Y, HEIGHT, and WIDTH
parameters.
In all of the parameters below, the range of input for number varies
between each parameter and also varies depending on the current image
settings. When you specify a value for number, the camera will
automatically adjust the value to the nearest appropriate value.
Note:
TOP number
LEFT number
RAWHEIGHT number
RAWWIDTH number
SET
DEFINE
X number
IMAGE GAIN WINDOW
Y number
HEIGHT number
WIDTH number
NONE
FACTORY
MAX
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
TOP number
Specifies the y-axis pixel coordinate of the top edge of the
gain control window.
LEFT number
Specifies the x-axis pixel coordinate of the left edge of the
gain control window.
RAWHEIGHT number
Specifies the vertical size in pixels of the gain control window.
This height will be calculated according to the TOP variable.
RAWWIDTH number
Specifies the horizontal size in pixels of the gain control
window. This width will be calculated according to the LEFT
variable.
X number
Specifies the x-axis pixel coordinate of the center coordinate
of the gain control window.
image commands
25
Y number
Specifies the y-axis pixel coordinate of the center coordinate
of the gain control window.
HEIGHT number
Specifies the vertical size in pixels of the gain control window.
This height will be calculated according to the Y offset
variable.
WIDTH number
Specifies the horizontal size in pixels of the gain control
window. This width will be calculated according to the X
offset variable.
NONE
Specifies that the gain window will cover the entire image that
is configured using the SET/DEFINE IMAGE WINDOW
command. Setting the gain window to NONE disables the use
of a separate gain window.
FACTORY
Specifies that the gain control window will be a 512 by 384
image that is centered on the camera’s imager.
Note:
If your image window is set to MAX, setting your gain control window to
DEFAULT will result in a gain control window that is centered on your
camera’s imager. Refer to the Set/Define Image Window section below.
MAX
Specifies that the gain control window will cover the entire
640 by 480 image.
Note:
Unless your image window is also set to MAX, setting the gain control
window to MAX will create a gain control window that is larger than
your image. Refer to the
Set/Define Image Window section below.
Defaults
NONE
Examples
To set a small gain control window near the upper left corner
of your image, enter all of the following commands:
Local>>
Local>>
Local>>
Local>>
See Also
SET
SET
SET
SET
IMAGE
IMAGE
IMAGE
IMAGE
GAIN
GAIN
GAIN
GAIN
WINDOW
WINDOW
WINDOW
WINDOW
TOP 15
LEFT 15
RAWHEIGHT 150
RAWWIDTH 150
Set/Define Image Gain (brightness)
image commands
26
3.2.10 Set/Define Image Gamma
The Image Gamma command allows you to correct the gamma value of your image. The level
of gamma correction characterizes how a particular monitor displays pixels of different
brightnesses, which is useful for accurately displaying images on many types of computer
screens.
Computers send image data to a monitor with a particular gamma value. Typically, certain
computers have specified gamma values (although graphics cards can change the gamma
correction). For PC and Sun systems, the gamma value is normally 2.5. SGI machines use a
gamma value of 1.5. Macintosh systems ordinarily use a value of 1.8.
The IQeye camera implements gamma correction in increments of 1/100. If you know the
gamma value of your monitor, insert the inverse of that value (1/value) into the number
parameter of the Image Gamma command.
Note:
On the browser-based settings pages, gamma is controlled by the
Contrast setting.
SET
DEFINE
IMAGE GAMMA number
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
number
Sets the image gamma value. Enter a value between 0.01 and
2.55. Decimals and fractions are accepted.
Defaults
1/50
Examples
Local>> SET IMAGE GAMMA 1.8
image commands
27
3.2.11 Set/Define Image LED
The Image LED command controls the function of the Red “Image Capture” LED on the front
of the camera.
SET
DEFINE
IMAGE LED
ACTIVITY
ON
OFF
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ACTIVITY
Specifies that the LED will light briefly each time an image is
taken when a user is connected to the camera.
ON
Sets the LED to be permanently on.
OFF
Sets the LED to be permanently off.
Defaults
Activity
Examples
Local>> SET IMAGE LED ON
3.2.12 Set/Define Image Lighting
The Image Lighting command controls the color corrections that are needed to account for the
specific type of lighting that illuminates your camera’s environment. Each category of lighting
correction will change the basic color matrix the camera uses to process its images.
SET
DEFINE
IMAGE LIGHTING
FLUORESCENT
MIXED
INCANDESCENT
SUNLIGHT
RAW
image commands
28
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
FLUORESCENT
Adjusts the color settings to best accommodate fluorescent
lighting, as found in many commercial buildings.
MIXED
Adjusts the color settings to account for a mix of fluorescent
and natural lighting.
INCANDESCENT
Adjusts for ordinary indoor lighting, as found in most homes.
SUNLIGHT
Adjusts the color settings to accommodate outdoor lighting
conditions.
RAW
Specifies no color correction.
Defaults
Mixed
Examples
Local>> SET IMAGE LIGHTING RAW
See Also
Set/Define Image Lighting Auto
3.2.13 Set/Define Image Lighting Auto
The Auto Lighting feature sets the IQeye to dynamically maintain the proper color balance in
your image according to the type of lighting you specified with the SET/DEFINE IMAGE
LIGHTING command. When this feature is enabled, the camera will attempt to recognize the
appropriate lighting balance and will automatically adjust the color matrix of the image to
match the current LIGHTING setting.
SET
DEFINE
IMAGE LIGHTING AUTO
ENABLED
DISABLED
WIDE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ENABLED
Activates the auto lighting feature.
DISABLED
Deactivates the auto lighting feature. No dynamic colorbalancing will occur.
image commands
29
WIDE
Activates the auto lighting feature with a wider threshold for
white values.
Defaults
Enabled
Examples
Local>> SET IMAGE LIGHTING AUTO ENABLED
See Also
Set/Define Image Lighting
3.2.14 Set/Define Image Lighting Bloom
The Lighting Bloom feature sets the IQeye to dynamically correct the coloration of the image in
areas where there is a large variation in brightness. In such areas, the camera may suppress some
color information, resulting in images that are improperly colored. Ordinarily, the improper
coloration occurs in lighter areas, adding a slight tint to the entire light area. When the Bloom
feature is used, the camera will attempt to recognize the appropriate color balance and will
automatically adjust the image to restore the proper coloration.
SET
DEFINE
Note:
IMAGE LIGHTING BLOOM
CLEAN
FAST
NONE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
CLEAN
Detects and corrects for most areas that could result in
improper coloration.
Although CLEAN is the best setting for adjusting color between bright
and dark areas, this setting adds time to the overall image processing.
FAST
Efficiently detects and corrects for areas that could result in
improper coloration. FAST does not affect the image
processing time.
Note:
The FAST setting may suppress color information incorrectly. If true
coloration is more important than image processing time, select the
CLEAN setting.
NONE
Deactivates all detection/correction for inappropriate
coloration.
Defaults
FAST
Examples
Local>> SET IMAGE LIGHTING BLOOM FAST
See Also
Set/Define Image Lighting
image commands
30
3.2.15 Set/Define Image Lighting (frequency)
The Lighting Frequency command sets the frequency of your camera’s imager to match the
frequency of indoor light sources in your camera’s surroundings (especially fluorescent lighting).
If the camera’s imager doesn’t match the indoor light source, faint bars may appear in your
images where the image looks slightly darker or brighter. This setting is not critical, but can
improve the quality of your image.
Set your camera’s lighting frequency to match your country’s power frequency. The following
table lists the power frequencies used by several major countries. For more information about
the appropriate frequency you should use, contact your energy provider.
50
Argentina, Australia, Brazil (also 60), Europe, Hong Kong, India, Japan
(also 60), Mexico (also 60), South Africa
60
Brazil (also 50) Canada, Ecuador, Japan (also 50), Mexico (also 60),
Taiwan, USA
SET
DEFINE
IMAGE LIGHTING
50HZ
60HZ
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
50HZ
Specifies that the frequency of nearby light sources is at
50 Hz.
60HZ
Specifies that the frequency of nearby light sources is at
60 Hz.
Defaults
60Hz
Examples
Local>> SET IMAGE LIGHTING FREQUENCY 50HZ
image commands
31
3.2.16 Set/Define Image Monochrome
The Image Monochrome command discards all color information, essentially creating greyscale
images. Use this command when your camera needs to capture images in poorly lit areas. In dark
scenes, there is often little or no useful color information, so image quality will improve with
monochrome images. Additionally, monochrome images compress better than comparable
quality color images.
SET
DEFINE
IMAGE MONOCHROME
ENABLED
DISABLED
AUTO
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ENABLED
Activates the monochrome feature.
DISABLED
Deactivates the monochrome feature.
AUTO
Automatically enables monochrome mode when the scene is
too dark to transmit high quality color images, and disables
monochrome mode when the scene becomes bright enough
for color images.
Defaults
Disabled
Examples
Local>> SET IMAGE MONOCHROME AUTO
image commands
32
3.2.17 Set/Define Image Overlay
Overlays, also called watermarks, are images or text messages that appear on your camera’s
image. You can use the overlays to place a logo on your camera’s image or to display a time
stamp or the camera name. Your camera’s image can have up to three overlays, as shown below,
and you can position each one separately.
OVERLAYS
To place an overlay on your image, you must first specify the image or text that will appear as
an overlay (which automatically enables that overlay position), then you must position the
overlay on your image. Multiple commands are necessary. The examples used for the commands
in this section are all needed to place the one overlay that appears in the top left corner of the
image above (“KinetiCam”).
Note:
You will always need to specify which overlay you wish to format. Each
command asks for a num parameter as part of the command. The num
parameter specifies which overlay the current command will change.
The browser-based configuration pages include an interface for creating and placing text
overlays on your image. Consult the IQeye User’s Guide for more information.
image commands
33
3.2.17.1 Set/Define Image Overlay (general)
To apply an overlay to your image, you must first enable or disable the overlay position in
which you will place the overlay. You cannot specify an overlay unless the overlay position has
been activated. If another overlay already occupies the position, the new overlay settings will
overwrite the previous settings.
num DISABLED
SET
DEFINE
IMAGE OVERLAY
num ENABLED
{ num }FACTORY
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
num ENABLED
Activates a specific overlay. Enter a number from 1 to 3.
num DISABLED
Deactivates a specific overlay. Enter a number from 1 to 3.
num FACTORY
Returns the overlay settings of a specific overlay position to
the factory default settings. This parameter will overwrite a
previously formatted overlay occupying that overlay
position.
Note:
If no num is entered, all overlay settings will be returned to their factory
defaults.
Defaults
Time and Date stamp in lower left hand corner.
Examples
Local>> SET IMAGE OVERLAY 1 ENABLED
image commands
34
3.2.17.2 Set/Define Image Overlay (contents)
The camera supports image overlays in both X-bitmap (.XBM) and Portable-pixmap (.PPM)
image formats. It also supports text overlays, which are text fields entered into the camera.
BACKGROUND
SET
DEFINE
shade
TRANSPARENT
IMAGE OVERLAY num
FOREGROUND shade
TEXT text
FILE filename
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
BACKGROUND shade
Sets the background of a specific text overlay to a shade of
grey. For shade, enter a number from 0 (black) to 1 (white)
in tenths (For example, 0.4 = 40% gray). Fractions and
decimals accepted.
BACKGROUND TRANSPARENT
Sets the background of a text overlay to be transparent.
FOREGROUND shade
Sets the foreground of a specific text overlay to a shade of
grey. For shade, enter a number from 0 (black) to 1 (white).
Fractions and decimals are accepted.
TEXT “text”
Places text in an overlay position. For text, enter the text,
surrounded by quotation marks. Text can also include one or
more of the following dynamic print variables. When the
server on the camera encounters a dynamic print variable, it
will replace the variable with the appropriate information in
the display.
$SD Adds a date stamp to the overlay in the Day, Month
Date, Year format (i.e., Tue Mar 5, 1999).
$SH Substitutes the camera’s hardware address.
$SI Specifies the camera’s IP address.
$SN Specifies the camera name, as configured with the
Set/Define Server Name command (see page 117).
$ST Adds a time stamp to the overlay in the
hour:minutes:seconds format (i.e., 12:42:08).
image commands
35
FILE “filename”
Places an image file in an overlay position. For filename,
enter the path to the file that will become the overlay.
Note:
This file must reside on the camera. Refer to Transferring Files to the
Camera, Section 4.3 on page 53, for instructions on how to place a file
on the camera.
Examples
To place a white date overlay on a transparent background,
issue all of the following commands:
Local>> SET IMAGE OVERLAY 1 BACKGROUND TRANSPARENT
Local>> SET IMAGE OVERLAY 1 FOREGROUND 1
Local>> SET IMAGE OVERLAY 1 TEXT “KinetiCam”
See Also
Dynamic Print, Section 4.2.6 on page 51.
3.2.17.3 Set/Define Image Overlay (position)
The image overlay positioning commands tell the camera where to position the overlay within
the image frame.
XOFFSET
XOFFSET
value value
CENTERED CENTERED
XPOSXPOSITION
RIGHT
RIGHT
LEFT
LEFT
SET SETIMAGE
IMAGE
OVERLAY
OVERLAY
num num
DEFINE
DEFINE
YOFFSET
YOFFSET
value value
CENTERED CENTERED
YPOSYPOSITION
TOP
TOP
BOTTOM
Note:
BOTTOM
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
XOFFSET value
Sets a specific overlay to be horizontally offset a certain
distance, in pixels, from the left or right edge of the image.
Experiment with different values to determine your ideal
offset.
To avoid creating noise within your image, specify offset values that are
a multiple of 8.
XPOS CENTERED
Centers a specific overlay horizontally.
image commands
36
XPOS LEFT
Aligns a specific overlay to the left side of the image.
XPOS RIGHT
Aligns a specific overlay to the right side of the image.
YOFFSET value
Sets a specific overlay to be vertically offset a certain distance,
in pixels, from the top or bottom edge of the image.
Experiment with different values to determine your ideal
offset.
Note:
To avoid creating noise within your image, specify offset values that are
a multiple of 8.
YPOS CENTERED
Centers a specific overlay vertically.
YPOS BOTTOM
Aligns a specific overlay to the bottom of the image.
YPOS TOP
Aligns a specific overlay to the top of the image.
Examples
To properly position an overlay, you will ordinarily need to
issue a series of commands. For example, an image overlay
placed in the bottom left corner of an image requires all of the
following commands:
local>>
local>>
local>>
local>>
SET
SET
SET
SET
IMAGE
IMAGE
IMAGE
IMAGE
OVERLAY
OVERLAY
OVERLAY
OVERLAY
1
1
1
1
XPOS LEFT
YPOS TOP
XOFFSET 8
YOFFSET 8
3.2.18 Set/Define Image Sharpen
The Image Sharpen command adjusts areas of an image where brightness changes significantly.
Increasing the sharpness will make the edges appear more defined. Conversely, decreasing
sharpness will make the edges of objects appear softer.
SET
DEFINE
IMAGE SHARPEN number
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
number
Sets the sharpness to a specific value. Enter a value, in tenths,
between 0 (no adjustment) and 10 (very sharp). Decimals and
fractions are accepted.
image commands
37
Defaults
1.0
Examples
Local>> SET IMAGE SHARPNESS 3.5
3.2.19 Set/Define Image Window
The Image Window command allows you to crop your image to make a smaller viewing area.
This feature dramatically decreases file size and increases the transmission speed when you only
want to monitor a small area of the larger picture.
Note:
The browser-based configuration pages contained on IQeye cameras
allow you to create a hot-spot, or picture-in-picture area. This area of
your image will update more rapidly that the rest of the image, although
the area outside of the hotspot will still be visible. Both the window and
the hot-spot features allow you to optimize the speed at which your
images will transmit and, if necessary, to remove unnecessary parts of
your image to improve the aesthetic quality.
original image
window
You can specify a window with two origin points: either a top left coordinate or a center
coordinate. You can then either specify a width and height calculated from the top left point or
you can enter a width and height that will center around the center coordinate.
When setting the window according to a top left coordinate, keep in mind that the top left corner
of an unwindowed image has the coordinates (0,0). You will use the TOP, LEFT,
RAWHEIGHT, and RAWWIDTH parameters.
To set a window around a center point, specify a center coordinate by entering the amount of
offset to the right and above the absolute center of the image. The absolute center has the
coordinates (0,0). You will use the X, Y, HEIGHT, and WIDTH parameters.
To properly set a window, it might be necessary to experiment with different coordinates.
image commands
38
Note:
In all of the parameters below, the range of input for number varies
between each parameter and also varies depending on the current image
settings. When you specify a value for number, the camera will
automatically adjust the value to the nearest appropriate value.
TOP number
LEFT number
RAWHEIGHT number
RAWWIDTH number
SET
DEFINE
IMAGE WINDOW
X number
Y number
HEIGHT number
WIDTH number
FACTORY
MAX
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
TOP number
Specifies the y-axis pixel coordinate of the top edge of the
window.
LEFT number
Specifies the x-axis pixel coordinate of the left edge of the
window.
RAWHEIGHT number
Specifies the vertical size in pixels of the window. This height
will be calculated according to the TOP variable.
RAWWIDTH number
Specifies the horizontal size in pixels of the window. This
width will be calculated according to the LEFT variable.
Y number
Specifies the y-axis pixel coordinate of the center coordinate
of the window.
X number
Specifies the x-axis pixel coordinate of the center coordinate
of the window.
HEIGHT number
Specifies the vertical size in pixels of the window. This height
will be calculated according to the Y offset variable.
image commands
39
WIDTH number
Specifies the horizontal size in pixels of the window. This
width will be calculated according to the X offset variable.
FACTORY
Specifies that the image window will be a 512 by 384 image
that is centered on the camera’s imager.
MAX
Specifies that the image window will use the entire imager
area. For IQeye cameras, this value creates a 640 by 480
image.
Note:
The IQeye default image size of 512 x 384 is optimal for most web
browsers. Increasing the size of your images to the MAX value may affect
some of your camera’s viewers.
Defaults
Factory
Examples
To set a small viewing window near the upper left corner,
enter all of the following commands:
Local>>
Local>>
Local>>
Local>>
SET
SET
SET
SET
IMAGE
IMAGE
IMAGE
IMAGE
WINDOW
WINDOW
WINDOW
WINDOW
HEIGHT 128
WIDTH 124
TOP 8
LEFT 8
3.3 Save Image
The Save Image command writes any of the temporary image changes (changes made using the
SET command) to permanent memory.
Note:
To save changes made to the overlay settings, you must specify OVERLAY
within the SAVE IMAGE command.
SAVE IMAGE
{ OVERLAY }
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
OVERLAY
Saves the overlay settings.
Examples
Local>> SAVE IMAGE
Local>> SAVE IMAGE OVERLAY
image commands
40
3.4 Show/List Image
Use the Show and List commands to view your camera’s current image specifications. Refer to
Section 2.3.3.3 on page 14 for a list of the differences between Show and List.
To view the current settings for either the overlays or the lighting, include OVERLAY or
LIGHTING as a parameter in the SHOW/LIST IMAGE command.
LIST
SHOW
IMAGE



OVERLAY
LIGHTING



Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
OVERLAY
Displays the current settings for all of the overlays.
LIGHTING
Displays detailed information about the current lighting and
color settings.
Examples
Local>> SHOW IMAGE OVERLAY
Local>> LIST IMAGE
3.5 Test Focus
The Test Focus command initiates the camera’s focus utility. Once you issue the command, the
utility will start. It will stop automatically after three minutes. To stop it manually, press any
key in the Telnet window.
Note:
For additional focus methods, refer to the IQeye User’s Guide.
TEST FOCUS
image commands
41
The utility supports two methods for focussing the camera:
1
The LED method, and
2
The Telnet Window method.
Note:
The focus utility does not work for focusing a motorized zoom lens.
3.5.1 The LED method
Once you issue the TEST FOCUS command:
1
Slowly rotate your lens (or focus-ring) as you watch the Red “Image Capture”
LED on the front of the camera or the Yellow “Link and Activity” LED on the
back of the camera.
Both LEDs will remain lit when the lens is out of focus. As you reach the proper
focus, the LEDs will turn off.
2
Once the LED turns off, continue to rotate the lens (or focus-ring) in the same
direction until the LED turns on again.
3
Reverse the direction in which you turn the lens (or focus-ring) until the LED
again turns off then on.
4
Reverse the direction again, rotating the lens (or focus-ring) slower than before,
until the LED again turns off then on.
5
Repeat steps 3 and 4 above, using slower and slower motion, until there is little
movement necessary until the LED turns on.
Note:
You will want to verify the focus by looking at an image from your
camera.
3.5.2 The Telnet Window method
Once you issue the TEST IMAGE FOCUS command, your Telnet window will begin to display
lines of numbers that correspond to the camera’s level of focus. Watch the numbers while slowly
rotating your lens (or focus-wheel). Larger numbers indicate that the camera is closer to being
properly focused.
It may be easiest to rotate the lens all the way in one direction, the rotate it slowly in the other
direction as you watch the numbers.
image commands
42
4: Custom Web Pages
4.1 Overview
Since the camera’s on-board web-server supports most programming conventions used on the
World Wide Web, experienced web programmers can personalize the look and feel of the
camera’s interface by placing their own web pages on the camera.
Note:
You should not attempt to overhaul the functionality of the web pages.
Many of the camera’s features, such as password protection and on-line
image settings, rely on sophisticated programming conventions that are
beyond the scope of this manual. Additionally, you should only attempt
to modify the camera’s pages if you are an experienced web programmer.
Experienced programmers can also take advantage of the camera’s unique features: dynamic
print, special web parsing, and the multiple-user script. Additionally, programmers can add
images from the camera to other web sites.
Throughout this chapter, the following personalized index page will be used to demonstrate
your possibilities for customizing the camera:
This page retains the functionality of the interface, but reorganizes the content of the page.
References to the source code for this page will illustrate the possible changes you can make to
the camera’s internal pages.
custom web pages
43
4.2 HTML
The HTML mark-up language is a method for coding text and images for viewing in a web
browser. Coding pages for the World Wide Web, however, involves much more than simply
marking-up text and images. It includes issues of aesthetics, organization, and usability, which
are topics that are outside the scope of this manual. This section will only discuss the unique
features of the camera. You should familiarize yourself with HTML programming before you
continue.
4.2.1 General Programming
Each page on the camera was carefully designed for optimum functionality. Other than text and
images, which you can add, delete, or reorganize without harming functionality, you should
never delete anything. Moreover, you should never replace a current page with one you coded
entirely yourself.
You can replace or reorganize text and images by referencing the HTML source for the page you
want to customize. Edit the HTML source either in a simple text editor or in an application
designed to assist with HTML programming (a WYSIWYG program).
Locate the material you want to edit and then substitute the new material without deleting any
of the behaviors programmed into the page. As you can see in the source code for the camera’s
original index page, there are certain behaviors attached to several of the images. If you choose
to replace any of these images, make sure that you carry the behaviors to the new image. For
example:
To replace the image “playon.gif,” which is the button that users click to restart the camera’s
live image stream, substitute the appropriate new image name for the “playon.gif” part of the
<img src=“...”> tag. Do not delete the entire image and rewrite the <img src=“...”> tag.
Note:
If you delete the entire image and the corresponding HTML code, you
will also delete the JavaScript that controls whether users access the
proper live image stream.
custom web pages
44
When adding new material to the current pages, you should keep the file sizes as small as
possible. Pages with large graphics, for example, will harm the camera’s performance.
Also, when creating new files that need password protection, such as settings pages, you should
change the permissions on the file after loading it onto the camera. The camera uses disk
permissions to determine secure pages. When a page is secure, users must enter the privileged
username and password to access the page. See Section 9.3.6 on page 133 for more information
on changing permissions.
4.2.1.1 Client Pull vs. Server Push
Client Pull and Server Push are two methods with which web browsers update material on a web
page. Client Pull updates are initiated by the user’s browser, which will update the entire web
page at a given interval. The interval is defined within the page’s HTML source code. Server
Push updates are made by the remote server that hosts the web page. The server will update the
information on the page as the information changes.
IQeye cameras support both Client Pull and Server Push; however, Server Push is more effective
at updating the live images transmitted by the camera.
Both Netscape Navigator and Microsoft Explorer support Client Pull, but only Netscape
Navigator supports Server Push. To allow users with Microsoft Explorer to display updated
material via Server Push, you must install the IQeye Server Push Java Applet on your web pages.
4.2.2 Adding Live Images to Other Web Pages
You can add the camera’s images to another web page external to the camera by referencing the
camera’s current image with an <img src=“...”> tag. On IQeye cameras, the latest still image is
titled “now.jpg.” Place “now.jpg” on an external page by creating an absolute link to the
camera.
For example, the following HTML code will reference the latest still image from the camera
http://192.168.123.234:
<img src=“http://192.168.123.234/now.jpg”>
Note:
The IP address above is used only as an example. Be sure to use your
camera’s IP address or text-based name in the <img src=“...”> tag.
4.2.3 Special Web Parsing
You can modify many qualities of “now.jpg” by issuing a special parsing variable within the
<img src=“...”> tag. The special web parsing variables allow you to manipulate a particular
“now.jpg” image as if you had issued a SET IMAGE command. You can control many of the
image’s qualities with the special web parsing variables.
Issue a special parsing function by appending one or more variables to “now.jpg,” as in the
following example:
<img src=“now.jpg?ds=4?ov=0?fl=180”>
The special parsing variables shown above will create an image that is downsampled by a factor
of 4, has overlays disabled, and is flipped 180 degrees.
custom web pages
45
Note:
Refer to the Image Commands chapter for detailed explanations of the
commands that correspond to the special web parsing variables.
Table 4-1: Special Web Parsing Variables
Variable
Parsing Function
?ds=#
Sets the downsample factor of “now.jpg” to #. Enter 1, 2, 3, 4, 6,
8, 12, or 16.
?ov=#
Enables or disables overlays. Enter 0 (disabled) or 1 (enabled).
?mo=#
Enables or disables the image monochrome feature. Enter 0 (disabled)
or 1 (enabled).
?sh=#
Sets the image sharpness. Enter a number between 0 and 100,
including fractions and decimals.
?fl=#
Adjusts the orientation, or flip, of the image. Enter one of the
following: none, 90, 180, 270, horiz, vert, bltr, tlbr.
?gm=#
Sets the gamma correction to float around a value. Enter a number
between 1/32 and 4.
?jq=#
Sets the quality of the JPEG. Enter a number between 8 and 92.
?ww=#
Sets the width of a subwindow. Enter a number less than the width of
your image.
?wh=#
Sets the height of a subwindow. Enter a number less than the height
of your image.
?wt=#
Sets the top edge of the subwindow. Enter a number less than the
width of you image.
?wl=#
Sets the left edge of a subwindow. Enter a number less than the
height of your image.
?wx=#
Sets the x-value origin of a subwindow. Enter a number that
corresponds to the x-axis pixel coordinate of the center (x, y) of
the subwindow.
?wy=#
Sets the y-value origin of a subwindow. Enter a number that
corresponds to the y-axis pixel coordinate of the center (x, y) of
the subwindow.
?wrw=#
Sets the rawwidth—calculated from the left edge—of a subwindow.
Enter a number less than the width of your image.
?wrh=#
Sets the rawheight—the height from the top edge—of a subwindow.
Enter a number less than the height of your image.
?wm=max
Sets the subwindow to the maximum window size.
?snap=X
Sets the type of “now.jpg” image that will be transferred. Enter:
pre takes an image and then transfers it.
post transfers an image and then takes a new image to update the
camera’s cache.
spush# enables a server-push connection. Follow spush with a number
from 1 to 60 that will dictate how many images the camera will take
in that number of seconds.
custom web pages
46
For example, this special web parsing code will place a server push image on the web page:
<img src=”http:.//192.168.123.234/now.jpg?snap=spush”>
4.2.4 Image Hosting on Alternate Servers
IQeye cameras function best when the camera is supplying images to a small number of users.
When many users attempt to access the camera simultaneously, the camera’s performance
suffers. To better accommodate many users, you can add an external server machine to function
along with your camera. The camera will transfer live images to the server and the server can
then support any number of outside connections.
There are many ways to configure an external server to operate with your camera. IQinVision
recommends that you install either a Java Servlet or two custom Perl scripts on your server. Both
methods access the camera and then serve images to users. The Java Servlet is faster than the Perl
scripts and can be installed on any platform. The Perl scripts can only be installed on UNIX
servers at this time.
Note:
You should consult your system administrator before you reconfigure
your server.
4.2.4.1 Multiple User Java Servlet
A Java servlet is an object used by a Java Server to extend the capabilities of a web server.
Servlets are the server-side equivalent of a Java applet. To use the IQinVision Multiple User Java
servlet on an external server, you must first install the Java Web Server on your external server.
Sun Microsystems offers several versions of the Java Web Server. The commercial versions,
which can be downloaded after purchase, contain complete feature sets and use GUI
configuration screens. Purchase and download these versions of the Java Web Server from the
software section of the Sun Microsystems web site (www.sun.com). The JavaServer Web
Development Kit, which is free to download, has limited functionality and must be configured
at the command line. Download the JavaServer Web Development Kit and the corresponding
installation instructions from the products section of Sun Microsystems’ Java resource web site
(java.sun.com). The IQeye Multiple User Java Servlet runs on all versions of the Java Web
Server.
All versions of the Java Web Server include detailed installation and configuration instructions
in the download. Review these written materials for information on how to install both the Java
Web Server and corresponding servlets.
To install the IQeye Multiple User Servlet:
1
Download the Java Web Server of your choice.
2
Review the installation instructions and the ReadMe and FAQ files that are
included in the download.
3
Install the Java Web Server on your server.
custom web pages
47
4
Download the servlet class files from either the IQeye Operating Materials CDROM or from the IQinVision web site (www.IQeye.com). These class files are
contained in a .jar archive file called GrabPush.jar. The .jar package is
located within the Java folder in the utilities section of the CD-ROM/website.
5
Use the JAR utility to decompress the servlet archive file. Decompress the file by
issuing the following command:
After you decompress the archive file, you should receive the following Java
Servlet class files:
6
•
GrabPush$GrabberThread.class
•
GrabPush$Image.class
•
GrabPush$ServerPush.class
•
GrabPush.class
Install the servlet class files according to the instructions included with your
version of the Java Web Server.
4.2.4.2 Multiple User Perl Scripts
To use the Perl scripts on an external UNIX server, you must install a server with PERL
capabilities on your network, and then install the IQinVision multiple users scripts on the server.
(These scripts are supplied free from IQinVision at www.IQeye.com.) These scripts, grab.pl and
push.pl will continually transfer images from your camera to your server.
Refer to the Perl web site (www.perl.org) for more information on how to configure your server
to run Perl scripts. To install the multiple-user script:
Download grab.pl and push.pl from either the IQeye Operating Materials CD-ROM or from
the IQinVision web site (www.IQeye.com).
7
Set up a cgi-bin directory on your server (a location that is configured to run
scripts). Ask your system administrator for more information about this process.
8
Install all appropriate Perl modules on your server. These modules include: MD5,
libnet, URI, MIME-Base G4, HTML-Parser, and libwww. All of these modules
are included in Bundle::LWP.
Note:
The Perl on your server may not include all necessary modules for
operating the grab.pl and push.pl scripts.
To install the modules, Telnet to your server from a UNIX terminal or DOS
prompt and issue the following command:
custom web pages
48
9
Place the files grab.pl and push.pl in the cgi-bin directory.
10
Create a directory on the server for the scripts to store information, such as logs
and temporary files. Give this directory a name that reflects its usage.
11
Open either script in a text editor and insert the name of this directory in the area
titled my $dir = “...” Do the same for the other script.
For example, in grab.pl:
12
For security purposes, create a symbolic link to your the grab.pl file that has the
name of your camera as the filename. During connection attempts, the push.pl
script will reference the link.
From a UNIX terminal or DOS prompt, Telnet to your server and change your
current working directory to the cgi-bin. Then, issue the following command,
substituting the name or IP address of your camera for camname.
13
Change the modes of the scripts so that they are executable.
From a UNIX terminal or DOS prompt, Telnet to your server and change your
current working directory to the cgi-bin. Then, issue the following command:
14
Change the e-mail address that will receive error messages and specify which
version of UNIX is operating on your server.
custom web pages
49
The areas that require these changes are noted within the push.pl script, as in the
following example:
# the two lines below and the $pscommand line at line 19
# are all that need to change between implementations
my $dir = “/n/lens1/www/spush”;
my $emailaddress = ________ # to whom error messages should be sent
# place the correct “ps” command switch for your system here
# choose the switches that give the full process names of all processes
# for example, on a linux or freebsd machine this is: ps -ax
my $pscommand = “ps -ax”;
Note:
15
When entering multiple email addresses into the script, separate each
address with a space.
Create an HTML page that has an <img src=“...”> tag linking to the push.pl
script. This link must be an absolute link directly to the location of the push.pl
script.
Also within the <img src=“...”>, issue a command to the camera by placing a
variable, similar to one of the special web parsing variables mentioned earlier.
This variable, however, will be a direct link to your camera.
For example, the following HTML code will link to the push.pl script and tell the
script to reference the camera 192.186.123.234:
<img src=”http://www.ABC.com/cgi-bin/push.pl?192.168.123.234”>
4.2.5 Server Push with a Java Applet
To replicate a live server push image within browsers that do not support server push
connections, such as Internet Explorer, you can add a Java applet to your web pages. (This
applet is already programmed into the camera’s internal web pages.) The applet will allow users
to see a server push image in any browser that supports Java.
Note:
Since browsers must start Java before they can load an applet, the image
from an applet takes longer to load than an ordinary server push image.
Server push connections are the optimum method for viewing images
from IQeye cameras.
To add the applet to your server:
1
Download the applet class files from either the IQeye Operating Materials CDROM or from the IQinVision web site (www.IQeye.com). These class files are
contained in a .jar archive file called ShowServerPush.jar. The .jar package,
is located within the Java folder in the utilities section of the CD-ROM/website.
Use the JAR utility to decompress the applet archive file. Decompress the file by
issuing the following command:
custom web pages
50
After you decompress the archive file, you should receive the following Java
Applet class files:
2
Note:
•
ShowServerPush.class
•
ShowServerPush$ByteBuffer.class
Create an HTML page that has an <applet=“...”> tag linking to the
ShowServerPush.class file.
If the ShowServerPush.class file does not reside in the same directory as
the HTML file, reference the directory with the codebase= variable.
Also within the <applet=“...”>, tag, use the value= text of the
<param name=”url” > tag to reference the source of the server push image.
The source of this server push image may be either a camera:
http://cameraname.companyname.com/cameraname/now.jpg?snap=spush
Or it may be a URL on a server that is delivering images from a camera:
http://servername.companyname.com/cgi-bin/push.pl?cameraname
For example, the following HTML code will reference the class file that resides in
the java directory of server ABC.com and then reference a server push image from
camera 192.168.123.234:
<applet codebase=”http://www.ABC.com/java
archive=ShowServerPush.jar
code=ShowServerPush.class width=512 height=384>
<param name=url value=”http://www.ABC.com/192.168.123.234/now.jpg?snap=spush2”>
3
Note:
Place the class files in the same directory as the HTML page that will reference
the applet.
You can place the class files in another directory and then use the
CODEBASE variable (see below.)
4.2.6 Dynamic Print
IQeye cameras support a unique feature called dynamic print. Dynamic print consists of
variables that are embedded into the HTML source for the camera’s web pages. When the web
server on the camera encounters one of these variables, it will replace the variable with the
appropriate information.
Note:
You can also embed dynamic print variables into certain text strings
within a command. Such commands are noted in the description of the
parameter that supports dynamic print.
For example, the date stamp on the example home page results from the dynamic print variable
shown below:
<p>Today is $D.</p>
custom web pages
51
For the camera to recognize HTML pages that use dynamic print, the HTML file must end with
the “.html.dp“ suffix. For example, the title of the page above, as it appears on the camera
is: “index.html.dp.“
When the server on the camera encounters a page the ends in “.html.dp,“ the camera will
recognize the dynamic print variables in the file and will replace each variable with the
corresponding text. The resulting HTML page will thus display the appropriate messages.
The following table lists all of the dynamic print variables and their functions. To use dynamic
print, embed these variables within the HTML page.
Important:
Dynamic print variables are case sensitive. You must use all capital letters
in the variables to avoid problems.
Table 4-2: Dynamic Print Variables
Variable
Parsing Function
$FN
Displays the file name currently being accessed.
$SC
Prints IQinVision.
$SD
Adds a date stamp to the web page in the Day Month
Date, Year format (i.e. Tue Jun 8, 1999).
$SH
Substitutes the camera’s hardware address.
$SI
Prints the camera’s IP address.
$SM
Prints the domain name of the network the camera
is on, as specified with the SET SERVER DOMAIN
command.
$SN
Prints the camera’s name, as specified with the
SET SERVER NAME command.
$SP
Prints the product name of the camera.
$ST
Adds a time stamp to the web page in the
Hour:Minutes:Seconds format (i.e. 12:42:08).
$SV
Prints the version of operating software the
camera is currently using.
Note:
If you would like a dollar sign to appear anywhere on a page that is saved
on the camera, you must type the dollar sign twice. For example: $$5.25
results in $5.25.
custom web pages
52
4.3 Transferring Files to the Camera
Transfer revised web pages to the camera using FTP (File Transfer Protocol). You can transfer
the files by using a graphical FTP-client application, such as Fetch or FTP Voyager, or by issuing
commands at a command line interface.
Note:
Once you transfer files to the camera, you can arrange and reorganize
them in a UNIX-like environment. Refer to the Disk Commands chapter
for information on managing files on the camera.
If you are transferring a file that needs password protection, such as settings page, you should
change the permissions on the file after loading it onto the camera. Use the DISK CHMOD
command to change the permissions on the file (see Section 4.3.3 on page 55).
4.3.1 FTP-Client Applications
There are numerous FTP-client applications available to simplify the FTP process, and they
often have a graphical user interface. If you would prefer to use such an application to transfer
your files to the camera, consult the documentation included with the application for details on
the FTP process.
When transferring files using an FTP-client application, you must place your files on the
camera’s Flash disk (/flash) and transfer the files in binary mode to ensure that the images are
properly formatted.
4.3.2 Command Line FTP
To place a file on the camera during a command line FTP session:
1
Open an FTP session with your camera by issuing the FTP command from an
appropriate prompt followed by the IP address of your camera:
2
Provide the Privileged Username and Password. Defaults are used in the example
below -- if you have changed your privileged password, enter the new password.
custom web pages
53
3
Note:
4
Note:
5
Change to the Flash disk, if necessary:
The default working directory for all external connections is /RAM. To
place a file on the Flash disk, you may need to change your working
directory.
Convert to binary transfer mode.
You do not need to complete this step if you are only transferring textbased files to the camera.
Issue a PUT command to place the file on the camera’s Flash disk:
If the file you wish to place is not stored in the directory from which you
established the FTP connection, you must specify a path to the file in the PUT
command.
6
Exit the FTP session:
custom web pages
54
4.3.3 Modifying Permissions for Secure Pages
When personalizing secure pages, or when creating new secure pages, you must change the
permissions of the HTML file to add password protection to the file. The DISK CHMOD
command allows you to make a password protected page.
1
Note:
2
Open a Telnet session with the camera:
The example below uses a hypothetical IP address. Use your camera’s IP
address when opening a Telnet connection with your camera.
Become the privileged user:
At the resulting Password> prompt, enter system, the default privileged
password.
Note:
3
Note:
If you have changed the default privileged password, enter the new
password.
Issue the DISK CHMOD command followed by the appropriate permission group
and the name of the HTML file. The example below specifies Read permission
only for all users except the owner or Superuser:
Refer to Section 9.3.6 on page 133 for more information on permissions
and available permission groups.
custom web pages
55
5: Security Commands
5.1 Overview
The IQeye camera server has two sets of password-based features: login control and privileged
mode. The camera also supports password protection for the camera’s serial port and an IP
security table, which allows administrators to restrict incoming TCP/IP connections based on
the source IP address of the incoming attempt.
5.1.1 Important Security Configurations
To enable a basic level of security for your camera, you should do the following:
•
Personalize your login password (see Section 5.4.2 on page 61),
•
Personalize your privileged password (Section 5.4.5 on page 63), and
Note:
•
IQinVision strongly recommends that you change the default passwords.
Disable incoming Telnet and Rlogin connections (see the Network Commands chapter).
Administrators will still be able to log in via the Remote Console Port.
You can change the passwords either through the browser-based security settings page (Refer to
the IQeye User’s Guide) or at the command line.
5.2 Login Control
Login control enables a general password protection for your entire camera. When the login
control is active, no one can gain access to your camera or view images without entering the
appropriate username and password. Login control applies to all incoming connection attempts
(FTP, HTTP, Telnet, etc.).
The default login control username and password are:
name = login
password = access
To change the Login Password, enter the following command during a privileged Telnet session
with the camera. See Section 2.2.1 on page 11 for information on establishing a privileged Telnet
session.
security commands
56
Activate login control with the SET/DEFINE SERVER INCOMING PASSWORD ENABLED
command (see Section 5.4.3 on page 61). Once login control is enabled, users will need to issue
a login password for all incoming connection attempts, including web sessions.
To disable incoming Telnet and Rlogin attempts, which will still allow web sessions without
requiring a password, issue the SET/DEFINE SERVER INCOMING NONE command. Users can
still Telnet to the camera’s remote console port, which is always password protected and cannot
be disabled.
5.2.1 Remote Console Port
The remote console port, designated as port 7000, provides users with a fail-safe way to log into
the camera. Remote console logins cannot be disabled, therefore, if incoming logins are disabled,
a remote console login will be the only way to remotely access the camera. Only one remove
console port connection is allowed at a time.
To Telnet to the remote console port, specify the IP address of the camera followed by 7000, the
number for the remote console port. Separate the remote console number from the IP address
with a space.
At the # prompt, type the login password. The default login password is access. (The text you
type will not appear on the screen.)
Note:
To change this password, see SET/DEFINE SERVER LOGIN
PASSWORD, Section 5.4.2 on page 61.
After you issue the appropriate password, you will see a Username> prompt. Enter a username
to identify yourself as the current user, then proceed as you would in the camera’s command line
environment.
Note:
This username is arbitrary and used only for convenience. It is not
associated with authentication.
security commands
57
5.3 Privileged Mode
Privileged mode permanently enables password protection for any areas of the camera where
settings can be adjusted. Privileged mode cannot be disabled. For web sessions, users can access
your images, but no one can change any of your settings without entering the appropriate
username and password.
Note:
Privileged User mode was also discussed in Section 2.2.2 on page 12.
Privileged mode also controls password protection during Telnet and Rlogin connections.
During such connections, users must enter the appropriate password to change any of the
camera’s settings. When a user becomes the privileged user, the privileged prompt (usually
Local>>) will appear.
The default privileged mode username and password are:
name = root
password = system
Personalize this password at the command line using the SET/DEFINE SERVER PRIVILEGED
PASSWORD command (see Section 5.4.5 on page 63).
5.3.1 Privileged User
After you establish a Telnet connection with the camera, become the privileged user. Issue the
SET PRIVILEGED command at the Local> prompt.
Note:
You may also enter the command SU, an alias to the SET PRIVILEGED
command.
At the resulting Password> prompt, enter system, the default privileged password.
Note:
If you have changed the default privileged password, enter the new
password.
A privileged prompt (usually Local>>) will appear. At the privileged prompt, enter the
commands as they appear in the command descriptions.
security commands
58
5.3.2 Privileged User Override
Only one user at a time can be the privileged user. If another user is already logged in as the
privileged user, you can issue the SET PRIVILEGED OVERRIDE command to end the other
privileged session:
At the resulting Password> prompt, enter system, the default privileged password.
Note:
If you have changed the default privileged password, enter the new
password.
A privileged prompt (usually Local>>) will appear. At the privileged prompt, enter the
commands as they appear in the command descriptions.
Note:
After the authentication override, the previous privileged user will be
returned to non-privileged status.
5.4 Security Commands (general)
The Set/Define Server Security commands configure the hours of availability and the camera’s
password-based security features.
5.4.1 Set/Define Server Hours
The Server Hours command configures the hours of availability for the camera, letting you
restrict access to the camera at certain times of day and on particular days of the week. If the
camera is “off,” non-privileged users cannot view the camera’s images. Instead, the camera will
display a default image informing the non-privileged users that the camera is not accessible.
Trigger events are also disabled when the camera is “off.”
When setting the access hours, you have three choices for hours of operation: always on, on
during specified hours, or always off. You can individually specify any of these three options for
each day within a seven day week.
security commands
59
ON
time
OFF
SET
DEFINE
SERVER HOURS
ON
day
OFF
TIME
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ON / OFF time
Sets the time at which the camera will permit (ON) or restrict
(OFF) access by non-privileged users. Enter the time value in
the hours.minutes.seconds format according to the 24 hour
clock: 00:00:00 (midnight) to 23:59:59 (1 second before
midnight).
day ON / OFF
Configures the camera to be ON or OFF at all times during
the specified day.
day TIME
Sets the camera to operate according to the time setting
during the specified day.
Defaults
ON for all days
Examples
To set the camera to operate only during business hours
(9 AM to 5 PM, Monday through Friday), enter the following
commands:
DEFINE
DEFINE
DEFINE
DEFINE
DEFINE
DEFINE
DEFINE
DEFINE
DEFINE
SERVER
SERVER
SERVER
SERVER
SERVER
SERVER
SERVER
SERVER
SERVER
HOURS
HOURS
HOURS
HOURS
HOURS
HOURS
HOURS
HOURS
HOURS
ON 09:00:00
OFF 17:00:00
MONDAY TIME
TUESDAY TIME
WEDNESDAY TIME
THURSDAY TIME
FRIDAY TIME
SATURDAY OFF
SUNDAY OFF
security commands
60
5.4.2 Set/Define Server Login Password
The Login Password command specifies the password for the login control. When the Login
Password is enabled (see the SET/DEFINE SERVER PASSWORD below), users must enter a
password to gain access to the camera.
By default, the login password is access. You should personalize this
password to ensure password protection for your cameras.
Note:
SET
DEFINE
SERVER LOGIN
{ PASSWORD }
password
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
password
Sets the login password to a new value. Enter a string of up
to 7 alphanumeric and/or punctuation characters (ASCII
0x21 to 0x7e) with no spaces. You do not need to use
quotation marks, because this password is case-independent.
Defaults
access
Examples
Local>> DEFINE SERVER LOGIN PASSWORD PMH99
Local>> DEFINE SERVER LOGIN PASSWORD goodgnu
5.4.3 Set/Define Server Incoming Password
The Incoming Password command enables or disables the login control feature, which provides
general password protection for the entire camera. When this feature is enabled, all users,
including web users, will need to authenticate before accessing the camera.
SET
DEFINE
SERVER INCOMING PASSWORD
ENABLED
DISABLED
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ENABLED
Requires all login attempts to supply the camera’s login
password before the connection is accepted.
security commands
61
DISABLED
Specifies that incoming logins will be permitted without
having to enter the login password at connection time.
Defaults
Disabled
Examples
Local>> SET SERVER INCOMING PASSWORD ENABLED
5.4.4 Set/Define Server Password Limit
The Password Limit command limits the number of failures allowed when a Telnet- or Rloginbased user tries to enter a password. If the user does not enter the correct password within a
certain number of attempts, the camera will automatically close the user’s connection attempt.
SET
DEFINE
SERVER PASSWORD
{ LIMIT }
num
NONE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
num
Specifies the password retry limit. Enter a number between 0
and 100. If 0 is specified, the password limit feature will be
disabled.
NONE
Sets the permitted number of attempts to the default limit.
Defaults
3
Examples
Local>> DEFINE SERVER PASSWORD 12
security commands
62
5.4.5 Set/Define Server Privileged Password
The Privileged Password command sets the password for privileged mode. Users must enter this
password to adjust many features of the camera. By entering the password, users become
privileged users, or “Superusers.”
If you forget your privileged password, you will need to initialize the camera by depressing the
camera’s Focus/Factory Reset Button as you supply power to the camera. After initialization, all
camera settings will revert to the factory defaults, including the privileged password.
Note:
By default, the privileged password is system. You should personalize
this password to ensure password protection for your cameras.
Note:
You cannot disable the privileged password.
SET
DEFINE
SERVER PRIVILEGED
{ PASSWORD }
password
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
password
Sets the privileged password to a new value. Enter a string of
up to 7 alphanumeric and/or punctuation characters (ASCII
0x21 to 0x7e) with no spaces.
Defaults
system
Examples
Local>> SET SERVER PRIVILEGED I8fish
security commands
63
5.5 IP Security Commands
IP security allows an administrator to restrict incoming and outgoing TCP/IP sessions.
Connections are allowed or denied based upon the source IP address for incoming connections.
IP security will not affect the remote console port. To secure the remote console port, ensure that
the login password has been changed from the default login password.
5.5.1 Configuring the Security Table
To add an entry to the table, specify an IP address and what type of restriction is desired. The
IP address must be four segments of 0-255 each; for example, 131.67 is not a valid IP address.
A 255 in any segment is a wildcard, which applies to all numbers in that range— 192.0.1.255
includes 192.0.1.1, 192.0.1.2, and so on. For example, the following command affects addresses
from 192.0.1.1 through 192.0.1.254 using the 255 “wildcard” network address segment:
5.5.2 Using the Security Table
Applying the entries in the table may look confusing at first, but the process is rather
straightforward. There are two basic rules for checking a TCP/IP connection for legality. First,
a more specific rule takes precedence over a less specific one. For example, if connections to
192.0.1.255 are disabled but connections to 192.0.1.78 are enabled, a connection to 192.0.1.78
will succeed. Second, in the absence of any rule that applies to a connection, access is allowed.
If this is not desired, include an entry of the following form:
This is the least specific rule in the table, and will ensure that connections fail unless otherwise
allowed by another entry.
If no entries are defined in the table, all connection attempts will succeed. Also, if the user
making the connection is the privileged user, the connection will be allowed regardless of the
entries in the table
security commands
64
5.5.3 Set/Define IP Security
IP security allows you to restrict incoming TCP/IP sessions based on the source IP address of the
incoming connections. With this command, you construct an IP security table, which will
maintain the list of restricted IP addresses.
The IP security command is used to add or change entries in the IP security table. By default,
there are no IP security restrictions.
SET
{ PROTOCOLS } IP SECURITY address
DEFINE
ENABLED
DISABLED
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
address
The IP address to be restricted. The address can be a full IP
address, such as 192.0.1.80, to restrict one address; it can
also be expressed as a partial address, such as 192.0.1.255, to
restrict whole subnetworks.
An address with a 255 in any segment means the restriction
applies to all the addresses in that range. Any address with a
0 in any segment implies that incoming will be disabled.
Defaults
Incoming Enabled, all addresses Enabled
Examples
Local>> SET IP SECURITY ADDRESS 192.0.1.255 ENABLED
Local>> SET IP SECURITY 134.0.1.255
5.5.4 Show/List IP Security
The Show/List IP Security command displays the current settings for the IP security table.
SHOW
IP SECURITY
LIST
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Examples
Local>> SHOW IP SECURITY
security commands
65
5.6 Port Security Commands
Port security allows an administrator to require a password for incoming connection attempts
through the serial port. Administrators can also enable port security which will disable all
privileged commands on the port.
5.6.1 Set/Define Port Password
The Port Password command controls whether or not a password is required when logging into
the server through the serial port. Use the SET/DEFINE SERVER LOGIN PASSWORD command
to set the password (see Section 5.4.2 on page 61).
SET
DEFINE
PORT 1 PASSWORD
ENABLED
DISABLED
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ENABLED
Requires users to supply a password during serial port
connection attempts.
DISABLED
Specifies that no password is necessary for serial port
connections.
Defaults
Disabled.
Examples
Local>> SET PORT 1 PASSWORD DISABLED
5.6.2 Set/Define Port Security
The Port Security command enables or disables security on the camera’s serial port, which
restricts access to camera commands through the port.
SET
DEFINE
PORT 1 SECURITY
ENABLED
DISABLED
security commands
66
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ENABLED
Restricts access to issuing commands through the serial port,
even to privileged users.
DISABLED
Allows privileged users to issue commands through the serial
port.
Defaults
Disabled.
Examples
Local>> DEFINE PORT 1 SECURITY ENABLED
security commands
67
6: Trigger & Relay Commands
6.1 Overview
An IQeye camera normally captures and processes images continuously and displays them on
the web. But, by using a trigger, you can configure the camera to save image sequences prior to
processing. This allows you to capture frame rates much faster than you can in normal mode,
where each image is processed before the next image is captured. After a trigger event the camera
processes the image sequence to JPEG files and saves the images either to internal memory, to
an external FTP server, or in an e-mail message.
Triggers can be controlled by external events, such as a motion detector connected to the
camera's relay port, or they can be periodic, timer-based events. In either case, the camera will
act according to the trigger settings each time an event occurs. The camera is capturing raw
images continuously in trigger mode, so images both pre-event and post-event can be processed
and saved.
The camera also has a built-in relay, or switch, that can control external devices. Refer to the
Output/Relay section later in this chapter for information on controlling external devices with
the camera.
6.1.1 Trigger Events
A trigger event is an action that causes the camera to store a particular sequence of images.
When such an action occurs, the camera will act according to the settings specified with the
SET/DEFINE TRIGGER commands.
The camera can store a limited number of trigger event images in memory. To store numerous
event sequences, the camera can either FTP or e-mail files to remote servers. Refer to the FTP,
Scripts, & E-mail chapter for details on configuring the camera to transfer images to an external
server via FTP or e-mail.
The settings that are configurable with the SET/DEFINE TRIGGER commands include:
•
The number of images the camera will save from before the trigger event.
Since the camera is continually capturing images, it can save a specified number of images
that were taken just prior to the trigger event. The camera will include these pre-trigger
images in the complete image sequence that it saves to memory.
Note:
•
For IQeye1 cameras, the maximum number of full sized, trigger images
must not exceed six. You can enter a higher quantity of pre- and postevent images if your image is downsampled or cropped.
The number of images the camera will save after the trigger event.
trigger commands
68
Once a trigger event occurs, the camera will start to save the images taken just after the
trigger event. The camera will then process and save these post-trigger images together
with the pre-trigger images. The total number of images must not exceed the total number
of trigger images allowed on the IQeye camera (8).
•
The amount of time that occurs between the images within a trigger event.
Since the camera does not process the images into the JPEG format until after the trigger
event occurs, you can specify the interval between individual trigger images. This interval
can range from 1/10 of a second to one hour.
•
The amount of time that will elapse between one trigger event and the next.
When the camera is connected to an external sensor device, the camera will save image
sequences each time the sensor is activated. Often, this method will create redundant
image sequences. To avoid redundancy, users can set a period between trigger events
during which time the camera will remain idle.
•
The amount of time that will pass between software-initiated trigger events.
By issuing the SET/DEFINE TRIGGER PERIODIC command, users can configure the
camera to undergo a trigger event at regular intervals.
•
The type of sensor attached to the camera.
With the SET/DEFINE TRIGGER ONOPEN/ONCLOSE command, you can specify
whether your sensor will activate a trigger event when the switch opens or when it closes.
•
The functionality of the relay.
The camera contains a built-in relay for controlling external devices during trigger events.
For example, the trigger may cause the camera to save 6 images and turn on a security
light.
6.1.2 Initiating a Trigger Event
A trigger event can be initiated either through hardware, such as when an infrared motion sensor
activates a trigger event, or by software, such as when a user manually forces a trigger event.
6.1.2.1 Hardware Trigger Events
Hardware-initiated trigger events involve an external device. Each time the device activates, it
can initiate a trigger event.
To connect a sensor to the camera, attach the sensor to the camera’s Relay I/O port as described
in Your User Guide or in the Pinouts appendix. The camera will supply power to and
communicate with the sensor over this port. Any security sensor that has an insolated relay
output and accepts 12V should be compatible with the IQeye camera.
6.1.2.2 Software Trigger Events
Software-initiated trigger events force the camera to save image sequences at specified intervals.
You can specify the interval with the SET/DEFINE TRIGGER PERIODIC command.
Additionally, you can initiate an immediate trigger event by issuing the TEST TRIGGER INPUT
command.
trigger commands
69
6.2 Trigger Commands
Use the following commands to configure the trigger features.
6.2.1 Set/Define Trigger Action
The Trigger Action command sets the camera to initiate an FTP connection with a specified
server and/or send an E-mail message after a trigger event occurs. Use this command for
transferring files from trigger events and for alerting remote users that a trigger event has
occurred.
Note:
This command and Set/Define Trigger Script are mutually exclusive.
EMAIL
SET
DEFINE
TRIGGER ACTION
FTP
BOTH
NONE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
EMAIL
Specifies that after a trigger event occurs, the camera will send
an e-mail to the default trigger e-mail site. Refer to the Set/
Define Email Site section on page 94 for information on
configuring the default e-mail site.
FTP
Specifies that after a trigger event occurs, the camera will
make an FTP connection with the default FTP site. Refer to
the Set/Define FTP Site section on page 82 for information on
configuring the default e-mail site.
BOTH
Configures the camera to both send an e-mail and make an
FTP connection after a trigger event occurs.
NONE
Sets the camera to disregard the trigger event. The camera
will not perform an action after the event occurs.
Defaults
None
Examples
Local> SET TRIGGER ACTION BOTH
trigger commands
70
6.2.2 Set/Define Trigger Factory
The Trigger Factory command returns all trigger settings to the factory default settings, which
will erase any previously configured settings.
SET
DEFINE
Restrictions
TRIGGER FACTORY
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
6.2.3 Set/Define Trigger Idletime
The Trigger Idletime command sets the amount of time that must occur between trigger events.
When this feature is activated, the camera will not recognize the next trigger event until the
specified amount of time has elapsed after the last post-trigger image of the previous event. This
feature allows the camera to ignore trigger events that may create redundant image data.
SET
DEFINE
TRIGGER IDLETIME number
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
number
Adjusts the amount of time that must elapse between trigger
events. Enter a number from 0 to 3600, which represents
values in seconds. Decimals and fractions are accepted.
Examples
Local>> SET TRIGGER IDLETIME 120
trigger commands
71
6.2.4 Set/Define Trigger Input
The Trigger Input command allows you to specify when the input from an attached device will
cause a trigger event. Since the input is connected to a switch, the input has two states during a
trigger event: open and closed. Normally Open switch devices can cause a trigger event either
when the switch closes, which happens once the trigger event occurs, or when the switch opens
again, which happens when the device returns to normal. Likewise, Normally Closed switch
devices can cause a trigger event either when the switch opens or when it closes again.
SET
DEFINE
TRIGGER INPUT
ONOPEN
ONCLOSE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ONCLOSE
Sets the camera to react when the input becomes closed. For
Normally Open switch devices, the input initiates a trigger
event once the event occurs. For Normally Closed devices, the
input initiates a trigger once the device stops signalling an
event.
ONOPEN
Sets the camera to react when the input becomes open. For
Normally Open switch devices, the input initiates a trigger
event after the trigger device stops signalling an event. For
Normally Closed devices, the input initiates a trigger event
once the event occurs.
Defaults
OnOpen
Examples
Local>> SET TRIGGER INPUT ONOPEN
trigger commands
72
6.2.5 Set/Define Trigger Periodic
The Trigger Periodic command tells the camera to automatically initiate trigger events at certain
intervals. Once you issue the command, the camera will initiate periodic trigger events.
SET
DEFINE
TRIGGER PERIODIC
number
DISABLED
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
number
Sets the interval at which the camera will initiate periodic
trigger events. The interval between events is measured from
the end of the preceding event. Enter a number from 0.1 to
3600, which represents values in seconds. Decimals and
fractions are accepted.
DISABLED
Turns the periodic triggering feature off. The camera will not
save periodic trigger images.
Examples
Local>> SET TRIGGER PERIODIC 900
6.2.6 Set/Define Trigger Pre/Post
The Pre- and Post-trigger commands specify the number of images the camera will save from a
trigger event. PRE sets the number of images the camera will retrieve from just prior to the
trigger event, and POST sets the number of images the camera will save after a trigger event
occurs. This command also specifies the interval at which the camera will capture trigger images
during the pre/post sequence.
SET
DEFINE
Note:
TRIGGER
PRE
COUNT num
POST INTERVAL num
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
COUNT num
Specifies the number of images the camera will take before or
after the trigger event.
The number of pre-trigger images combined with the number of posttrigger images must not exceed the total number of trigger images for
your camera (8).
trigger commands
73
INTERVAL num
Sets the frame rate of the pre- and post-trigger images. Enter
a number from 0.1 to 3600, which represents values in
seconds. Decimals and fractions are accepted.
Note:
Entering 0 disables the pre- or post-trigger feature.
Examples
Local>> SET TRIGGER PRE COUNT 6
Local>> SET TRIGGER POST COUNT 2
Local>> SET TRIGGER PRE INTERVAL 1/15
Local>> SET TRIGGER POST INTERVAL 1.4
6.2.7 Set/Define Trigger Script
The Trigger Script command defines the name of a script file that the camera will execute after
each trigger event. The source file for the script contains standard camera commands that the
camera will perform prior to any outgoing FTP sessions. Typically, the source file will hold
commands that will prompt the camera to send an e-mail after each trigger event.
Note:
This command and Set/Define Trigger Action are mutually exclusive.
The source file for the trigger script is a text-based file consisting of camera commands. This file
should have the .cmd extension. Refer to the Trigger Event Scripts section of the FTP, Scripts,
& E-mail chapter for more information on writing the source file for a trigger script.
SET TRIGGER SCRIPT file
DEFINE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
“file”
Specifies the name of the source file for the trigger script.
Defaults
None
Examples
Local>> SET TRIGGER SCRIPT “trigfile.cmd”
trigger commands
74
6.3 Show/List Trigger
Use the Show and List Trigger commands to view all of your camera’s current trigger settings.
For a description of the differences between Show and List, refer to Section 2.3.3.3 on page 14.
SHOW
TRIGGER
LIST
6.4 Test Trigger Input
The Test Trigger Input command forces an immediate trigger event, which is useful when you
want to test functionality of your trigger commands. After the trigger event is forced, the camera
will behave according to your settings for the SET/DEFINE TRIGGER commands. You can
then look at the images captured by the trigger event to ensure that the camera transferred the
appropriate images.
TEST TRIGGER INPUT
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Examples
Local>> TEST TRIGGER INPUT
trigger commands
75
6.5 Output/Relay
The camera contains a Normally Closed switch that is controlled by the commands below. Use
the switch to control communication between the camera and another electronic device, such as
an alarm panel. Use the SET/DEFINE TRIGGER INPUT ONOPEN/ONCLOSE command to set
the sense of the external device, if any.
6.5.1 Set/Define Trigger Output
The Trigger Output command sets the output to be in an open or closed state.
Note:
If power is removed from the camera, the switch will always go to the
open state.
OPEN
SET
DEFINE
TRIGGER OUTPUT
CLOSED
IMAGE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
OPEN
Sets the output to be in an open state.
CLOSED
Sets the output to be in a closed state.
IMAGE
Sets the state of the relay output to match the state of the Red
“Image” LED. When the LED is lit, the relay will be closed.
Conversely, when the LED is off, the relay will be closed.
Set the relay to IMAGE when using an external audible
continuity checker for focusing the camera. Refer to the
Audible Focus Utility appendix for details on connecting an
audible device to the camera.
Defaults
Closed
Examples
Local> SET TRIGGER OUTPUT OPEN
trigger commands
76
6.5.2 Test Trigger Output
Use the Test commands to test functionality of the relay and the external device.
TEST TRIGGER OUTPUT
{ number }
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
number
Toggles the output relay between OPEN and CLOSED state
for a specified amount of time. For number, enter an integer
between 1 and 60 (seconds). If no number is specified, 1
second will be used.
Examples
Local>> TEST TRIGGER OUTPUT 5
trigger commands
77
7: FTP, Scripts, & E-mail
7.1 Overview
The camera can internally store a limited number of images from trigger events. To extend the
storage capabilities for trigger events, you can configure the camera to transfer event images to
an external server. There are basically three methods of transferring images: FTP, e-mail, and
scripts.
The SET/DEFINE FTP SITE commands control the location, username, password, and
method for saving images that the camera will use when logging into the external FTP server.
The SET/DEFINE EMAIL SITE commands to configure the necessary settings for e-mail.
Scripts allow you to specify a series of commands that the camera will perform at boot time, at
regular intervals (using a script called crontab), or when a trigger event occurs. The trigger
scripts also control how the camera will transfer images via FTP and e-mail.
When scripts are combined with the FTP and e-mail capabilities, the IQeye can communicate
with remote users at regular intervals, notify users whenever it reboots, or alert users each time
a trigger event occurs.
7.2 FTP
By using the SET/DEFINE FTP SITE commands, you can specify an external FTP server to
which the camera can automatically transfer image sequences from trigger events. The SET/
DEFINE FTP SITE commands allow you to customize FTP locations that are called sites. Sites
are individually named configurations that contain a list of settings particular to one FTP server.
Unless it is configured to use different FTP site information, the camera will transfer images to
the default FTP location each time a trigger event occurs. Complete the settings of this default
location by reconfiguring the site named “trigger.”
Note:
This external server must be an FTP server. Consult a system
administrator for more information on setting up an FTP server on your
host machine.
Additionally, you can enter multiple FTP locations by using the SET/DEFINE FTP SITE
commands to define multiple site files. After configuring the sites, compose a custom command
file that can extend the possibilities for FTP. Refer to the Trigger Scripts section below for
complete information on how to transfer trigger images to multiple locations using FTP.
FTP, scripts & email
78
Configure your camera to transfer trigger event images to one external server by opening a
privileged Telnet session with the camera and then completing the following steps:
Note:
1
Review Section 2.2.1 on page 11 for instructions on how to open a
privileged Telnet connection.
Reconfigure the default trigger FTP site by referencing the “trigger” site and then
specifying the appropriate FTP server:
The default FTP site controls the camera’s behavior after a trigger event occurs,
unless you use the trigger event script feature described in the Trigger Event Scripts
section later in this chapter. Personalize this default site by entering the word
“trigger” into the sitename field of the SET/DEFINE FTP SITE commands. By
entering “trigger,” you will access the settings particular to that site.
Note:
2
Pay attention to the file size of your images and the space available on
the server when specifying your external FTP server. Specify an FTP
server that has space to store numerous trigger event image sequences.
Configure the username and password:
FTP servers normally require a username and password, which the camera will
issue to the server during its login attempt.
3
Specify the folder into which the camera will save the trigger event images:
The camera will gain access to the FTP server once it issues the appropriate
username and password. After the camera gains access, it will save the image
sequences in a specified folder.
Note:
The $SD variable above is the dynamic print variable for the current
date. When you issue this variable within the PATH command, the
camera will create a new folder daily with that date as the folder’s title.
Once the camera creates the folder, it will save all subsequent trigger
images from that date in the same folder. Refer to Dynamic Print section
of the Custom Web Pages chapter for a complete list of dynamic print
variables.
FTP, scripts & email
79
Dynamic print variables are case sensitive. You must use all capital letters
in the variables to avoid problems.
Important:
Set the filename for the trigger images by issuing the SET FTP SITE FSPEC
command:
When the camera saves image sequences on an external server, it will name the
images during the FTP. When you specify the filename with the $FN variable, the
camera will name the images according to their base file name (trig.jpg) and their
location in the trigger sequence. Additional characters in the FSPEC will be added
to the base file name. For example, the FSPEC above will save the images as
time.trig#.jpg in which time is the exact time (in hour.minutes.seconds format) that
the images were taken.
If you have configured your camera to capture trigger images at less than
one second intervals, you will receive numerous images with the same
time stamp.
Note:
The following images will result from a trigger event with the FSPEC above:
•
10.30.14.trig-4.jpg (pre-trigger image)
•
10.30.14.trig-3.jpg (pre-trigger image)
•
10.30.14.trig-2.jpg (pre-trigger image)
•
10.30.14.trig-1.jpg (pre-trigger image)
•
10.30.14.trig+0.jpg (the image from the moment the trigger was detected)
•
10.30.14.trig+1.jpg (post-trigger image)
•
10.30.14.trig+2.jpg (post-trigger image)
•
10.30.14.trig+3.jpg (post-trigger image)
These images are the post-trigger images.
4
If desired, enable the unique naming feature by issuing the following command.
Otherwise, newer files will overwrite older files that have the same filename.
Note:
When the unique naming feature is enabled, the camera will dynamically
rename new images if it encounters older images with the same names.
(Ex: trig+3.jpg.1) The new name with which the images will be
saved depends on your server.
FTP, scripts & email
80
5
Note:
Activate the FTP feature by specifying the action that the camera should complete
following a trigger event.
Refer to Section 6.2.1 on page 70 for more details about the
SET/DEFINE TRIGGER ACTION command.
7.2.1 Verify FTP Settings
Once you reconfigure the “trigger” FTP Site settings, verify that they function properly with the
TEST TRIGGER INPUT command. This command will manually initiate a trigger event.
Use the test to verify that the camera logged in to the external FTP server properly; that an image
sequence was placed on the external FTP server; and that the images were placed in the
appropriate folder with the appropriate name.
7.2.2 Save FTP Settings
After you have ensured that the FTP Site settings work properly, save the settings to overwrite
the previous “trigger” site. The new settings will become the default FTP configuration for the
trigger FTP feature.
FTP, scripts & email
81
7.2.3 Set/Define FTP Site
The settings for each FTP server are defined within a site. The number of sites a user can have
is limited only by NVR size, which is needed to store site configurations. Each site is a
configuration that contains all of the necessary settings particular to the specified FTP server.
After configuring one or more sites, enable the FTP feature in one of two ways:
•
Reconfigure the default FTP site “trigger,” and then choose either FTP or Both
within the SET/DEFINE TRIGGER ACTION command.
The camera contains a default FTP site named “trigger.” Although this site cannot
be deleted, its settings are modifiable. Refer to the default parameters of “trigger”
by issuing the SHOW FTP command. Personalize this default site by entering the
word “trigger” into the sitename field of the SET/DEFINE FTP SITE commands.
By entering “trigger,” you will access the settings particular to that site file.
The camera also contains a default FTP site that is used in conjunction
with the DHCP notification feature. This site is named “new_ip.”Refer
to Section 8.2.8 on page 104 for details on using this feature.
Note:
•
Add a new site configuration and then write a trigger script containing an
FTP sitename filename command that references the new configuration.
After defining all of the necessary information for a new FTP site, create a trigger
script that includes an FTP command referencing the proper FTP site. Then, use
the SET/DEFINE TRIGGER SCRIPT command (see below) to specify the trigger
script that the camera will access after a trigger event occurs. Once a trigger event
occurs, the camera will access the specified trigger script and follow all of the
commands contained in the script.
To test the FTP site configurations, add the FTP site to a trigger script, set the camera to access
that script after trigger events, and then prompt the camera to initiate a trigger event. When all
of the settings below are properly configured, images should appear on the FTP server specified
within the particular site.
The FTP Site commands configure how the camera transfers trigger event images from its
memory to an external FTP server. Use them to specify one or more FTP locations and to control
the file naming and settings needed for the camera to place images on the FTP server.
HOST string
USERNAME string
PASSWORD string
SET
DEFINE
FTP SITE sitename
PATH string
FSPEC string
UNIQUE
ENABLED
DISABLED
FTP, scripts & email
82
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
HOST string
Specifies the name or IP address of the remote FTP server to
which the camera will transfer the trigger images. For
string, enter a hostname of up to 31 characters. Use quotes
to preserve case.
Note:
For the camera to use a text-based name for connection attempts, you
must specify a nameserver (see SET/DEFINE IP NAMESERVER, Section
8.2.5 on page 102).
Note:
If the specified FTP server is not on the same network, you must properly
configure the TCP/IP Gateway (see SET/DEFINE IP GATEWAY,
Section 8.2.2 on page 100).
USERNAME “string”
Defines the username that the camera will use when logging
into the FTP server. For string, enter the appropriate
username of up to 31 alphanumeric characters. Do not use
spaces.
PASSWORD “string”
Defines the password that the camera will use when logging
into the FTP server. For string, enter the appropriate
password of up to 31 alphanumeric characters.
PATH “string”
Sets the path the camera will take to access the specified
folder on the FTP server. For string, enter a pathname, in
quotes, of up to 31 alphanumeric characters.
Note:
The path variable supports dynamic print. Refer to Section 4.2.6 on page
51 for a list of dynamic print variables.
FSPEC “string”
Defines the name with which the camera will save the trigger
images. Also specifies the base name of the file for use with
UNIQUE ENABLED. For string, enter a filename, in
quotes, of up to 31 alphanumeric characters.
Note:
The fspec variable supports dynamic print. Refer to Section 4.2.6 on page
51 for a list of dynamic print variables.
UNIQUE ENABLED / DISABLED
Turns the unique naming feature on (Enabled) or off
(Disabled). When this feature is enabled, the camera will
rename the current file if it encounters an older file that has
the same name. When it is disabled, it will overwrite an older
file that has the same name.
Note:
The convention used to rename the file depends on the operating system
of the FTP server.
FTP, scripts & email
83
Defaults
The camera has two default trigger configurations: trigger
and new_ip. For both default configurations, you can only
modify the settings. You cannot delete or rename the site.
TRIGGER
sitename = trigger
host is undefined
path = “$SN.$FD”
(Places images in a directory named after the camera and then
within a directory named for the date of the FTP)
FSPEC = “$ST.$FN”
(Names the file after the time the image was taken, its
position in the trigger sequence, and appends .JPG to the
image.)
Unique is disabled
Important:
Dynamic print variables are case sensitive. You must use all capital letters
in the variables to avoid problems.
Note:
The default file name for trigger images is trig#.jpg
NEW_IP
sitename = new_ip
host is undefined
path = “$FN”
(Names the file after the time the image was taken, its
position in the trigger sequence, and appends .JPG to the
image.)
Unique is disabled
Examples
Local>>
Local>>
Local>>
Local>>
Local>>
SET
SET
SET
SET
SET
FTP
FTP
FTP
FTP
FTP
SITE
SITE
SITE
SITE
SITE
ftp2
ftp2
ftp2
ftp2
ftp2
HOST root.bigcorp.com
USERNAME “bob”
PASSWORD “8Trexes”
PATH “$SD/$SN”
This command will create a folder named for the current date
within a folder named after the camera (see Dynamic Print,
Section 4.2.6 on page 51).
Local>> SET FTP SITE ftp2 FSPEC “$ST.$SF”
This command will name the images according to the current
time and will append the default file name (trig#.jpg) (see
Dynamic Print, Section 4.2.6 on page 51).
Use the same method to create an additional FTP site
configuration:
Local>>
Local>>
Local>>
Local>>
SET
SET
SET
SET
FTP
FTP
FTP
FTP
SITE
SITE
SITE
SITE
ftp3
ftp3 HOST images.mycorp.com
ftp3 USERNAME “anonymous”
ftp3 PASSWORD “[email protected]”
FTP, scripts & email
84
7.2.4 Set/Define FTP Factory
The FTP Factory command returns all FTP settings to their factory defaults, which will erase
any previously-configured settings. It removes the preconfigured sites “Trigger” and “New_IP,”
and returns the settings for each preconfigured site to the factory defaults.
SET
DEFINE
Restrictions
FTP FACTORY
You must be a privileged user to use this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
7.2.5 Save FTP
The Save command writes any changes to the FTP configurations, those made using the SET
command, to permanent memory.
SAVE FTP
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
FTP, scripts & email
85
7.2.6 Clear/Purge FTP Site
The Clear/Purge FTP Site command removes any configured FTP site.
CLEAR
PURGE
FTP SITE sitename
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
“sitename”
Specifies a site to remove. You cannot remove the default
sites.
Examples
Local>> CLEAR FTP SITE “mysite”
7.2.7 Show/List FTP
Use the Show and List FTP commands to view the all of your camera’s current FTP settings. You
can display the settings for a particular site by specifying the site within the SHOW/LIST FTP
command. You can display the settings for all FTP site configurations by omitting a sitename.
These settings include FTP host, username, password, path, filename, and unique naming. For
a description of the differences between Show and List, refer to Section 2.3.3.3 on page 14.
SHOW
LIST
Restrictions
FTP sitename
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
FTP, scripts & email
86
The Show and List FTP command also displays the latest status message for FTP:
Result
Meaning
Success
The last FTP sent properly.
Login
Login failed. Username and/or password is incorrect.
CWD
The camera failed to change directories into the one
specified in the FTP path setting. Verify that the
camera has access to the specified directory.
Send
The camera failed to send the file. This error is
usually caused by a network error or a full disk.
MKD
The camera failed to make the directory specified in
the FTP path setting. Either permission was denied,
the disk was full, or the path contained invalid
characters for the FTP host.
Memory
The camera is out of memory. Check the memory
statistics by issuing a SHOW SERVER command
during a command line connection.
Connect
The camera failed to connect to the FTP server.
Check that the name or IP address for the FTP server
is correct and verify that the IP gateway setting on
the camera is properly configured. If the name or IP
address is correct, use another device to try to
establish a connection with the FTP server to verify
that FTP is enabled on that server.
Name
Resolution
The camera could not resolve the FTP host name to
an IP address. Check nameserver and domain name
settings on the camera. Use another device to try to
establish a connection with the FTP server by the
FTP server name.
Socket Create
The camera could not create a network socket.
Open
The camera could not open the local trigger file.
Either no image was taken or the disk is full. Do a
DISK LS -L on the /ram disk to see if the trigger
file(s) update when you issue a TEST TRIGGER
INPUT command.
Configuration
The FTP settings are not configured properly (For
example, when something is not filled in).
None
The camera has not made an FTP attempt yet.
Command
The specified FTP host did not understand one or
more of the commands issued by the camera.
FTP, scripts & email
87
7.2.8 FTP Transfers
The FTP command initiates an outgoing FTP session with the remote FTP server specified in the
command. Once the FTP command is issued, the camera will establish a connection with the
specified FTP server to transfer images from a trigger event.
Note:
Configure the correct FTP site using the SET/DEFINE FTP SITE
command.
FTP sitename filename
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
“sitename”
Specifies the site to which the camera will FTP the specified
file.
“filename”
Specifies the filename of a local file that the camera will
transfer to the FTP server.
Examples
Local>> FTP “ftpsite2” “trig+0.jpg”
FTP, scripts & email
88
7.3 Scripts
7.3.1 Overview
The IQeye camera supports three types of scripts. Each type automatically executes a userspecified sequence of commands on either an event driven or a periodic basis.
•
Start-up scripts cause the camera to perform tasks each time the camera reboots.
•
Trigger scripts configure the camera to execute commands after a trigger event
occurs.
•
Cron scripts automate regular tasks by programming a time and date for command
execution. Users specify the tasks by creating a source-file particular to each script.
The source-file contains all of the information necessary for the IQeye to
dynamically execute commands.
Script files run commands, and commands support the UNIX wildcard (*) convention. When
you enter a * into a command in a script, it specifies that the command will react to any file
having a similar extension, prefix, suffix, or pattern. For example, the command FTP
sitename *.jpg will transfer all of the files from your current working directory that contain
the extension .jpg. This usually means that the images resulted from a recent trigger event.
Insert comments into scripts by entering the pound sign (#) as the first non-space character on
a line. Any text following the pound sign will be ignored when the camera executes the script.
Use the comments to create human readable explanations of the tasks contained within the
scripts.
7.3.2 Start-up Scripts
A start-up script is a text-based file that the camera accesses during the boot process. The file
contains a list of commands that the camera will perform before any connectivity is available.
The script can be stored locally, or it can reside on an external server.
To use the start-up script feature:
1
Compose a text-based command file.
To compose a start-up script, use a text editor to write a text-based file consisting
of camera commands. Enter a carriage return after each command so that each
command is listed on its own line, as follows:
FTP, scripts & email
89
2
Save the file with a .cmd extension.
3
Transfer the file to the camera (optional).
Unless you plan to have multiple cameras access the same start-up script, you
should store the file locally on the camera. The camera can reference a start-up file
that is stored on any Internet-accessible server; however, the camera performs
faster if the file is stored on the camera. When the start-up script is stored locally,
the camera does not need to negotiate a network connection prior to performing
the intended commands.
Note:
Store a file on a remote server if you want multiple cameras to reference
the same script or if you plan to change the start-up parameters
frequently.
To transfer a start-up script to the camera, use FTP to place the script on the
camera’s /Flash disk. Refer to the Transferring Files to the Camera section of the
Custom Web Pages chapter for details on how to transfer files using FTP.
4
Configure the camera to reference the script during the boot process.
To configure the camera to access a local start-up script, enter the following
command during a privileged Telnet session with the camera. See Section 2.2.1 on
page 11 for information on establishing a privileged Telnet session.
If your start-up script is saved on a remote server, refer to the Set/Define Server
Startupfile section of the Network Commands chapter for details on how to
configure the camera to access the remote script.
7.3.3 Trigger Event Scripts
A trigger event script is a text-based file that specifies actions to perform after every trigger
event. Usually, these actions consists of an e-mail, or other notification, informing remote users
that a trigger event has taken place.
The source-file for the trigger event script has the same format as the source-file for start-up
scripts. For example, the script below causes the camera to e-mail one event image to two
different sites and to FTP all event images to a third site. These sites were configured using the
SET/DEFINE EMAIL SITE and SET/DEFINE FTP SITE commands.
email robert trig+0.jpg
email nathaniel trig+0.jpg
ftp remoteftp *.jpg
FTP, scripts & email
90
To configure your camera to run a series of commands after each trigger event:
1
2
Compose the trigger event script using the method detailed above for writing a
start-up script.
A
Compose a text-based command file, and
B
Save the file with a.cmd extension.
Transfer the script to the camera using FTP (optional).
The trigger script follows the same methods as the start-up script. Unless you plan
to have multiple cameras access the same trigger script, you should store the file
locally on the camera.
Note:
Store a file on a remote server if you want multiple cameras to reference
the same script or if you plan to change the trigger script parameters
frequently.
To transfer a trigger script to the camera, use FTP to place the script on the
camera’s /Flash disk. Refer to the Transferring Files to the Camera section of the
Custom Web Pages chapter for details on how to transfer files using FTP.
3
Configure the camera to reference the script after every trigger event.
The camera will automatically reference a trigger event script once you configure
the source-file. Issue the SET/DEFINE TRIGGER SCRIPT command during a
privileged Telnet session with the camera. See Section 2.2.1 on page 11 for
information on establishing a privileged Telnet session.
FTP, scripts & email
91
7.3.4 Cron Scripts
Cron scripts configure the camera to perform tasks at specified times and dates. The instructions
for executing particular tasks are contained within a file called Crontab, which must be stored
locally on the camera. This file holds all of the commands and also indicates when each
command should execute. Once every minute, the camera will look for a Crontab file to
determine if it should execute commands at that point in time.
Note:
For Cron to operate properly, the camera’s clock must be set to the
correct time. Refer to the Set/Define Server Clock section of the Network
Commands chapter for details on setting the camera’s clock.
Crontab is simply a text file that lists tasks. Each task contains both a time and date field and a
corresponding command. You can use a wildcard (*) in any field mto tell teh camera to disrgard
that field. The time and date fields are (in order from left to right):
Minute (0-59)
Hour (0-23)
Day of the month (1-31)
Month of the year (1-12)
Day of the week (0-6 with 0=Sunday)
For example, the following task will take place at O minutes after 0 hours on the 25th day of
the 12th month of the year, regardless of what day it happens to be. In simpler terms, the
command will execute at the beginning of the day on December 25th.
You can program numerous timed tasks within one Crontab file. For example, the following
Crontab file will change the text overlays on a daily basis.
Each task within the Crontab ends when a line is completed. Enter as many commands per line
as are necessary to complete the desired task, with each command separated by a semicolon.
FTP, scripts & email
92
7.4 E-mail
The e-mail commands configure the camera for sending e-mail to remote users. Once the
necessary settings are configured within the SET/DEFINE EMAIL command, users can insert
the EMAIL command into any of the scripts above to create dynamic notification of camera
events. The e-mail capabilities of the IQeye increase the range of communication possible over
the Internet.
For e-mail to operate properly, the domain name on the camera must be
set properly. Refer to SET/DEFINE IP DOMAIN, Section 8.2.1 on page
99.
Note:
The camera contains a default e-mail site named “trigger.” Although this file cannot be deleted,
its settings are modifiable. Refer to the default parameters of “trigger” by issuing the SHOW
EMAIL command. Personalize this default site by entering the word “trigger” into the sitename
field of the SET/DEFINE EMAIL SITE commands. By entering “trigger,” you will access the
settings particular to that site file.
The camera also contains a default e-mail site that is used in conjunction
with the DHCP notification feature. This site is named “new_ip.”Refer
to Section 8.2.8 on page 104 for details on using this feature.
Note:
7.4.1 Email
The Email command initiates an outgoing e-mail to any remote user who has a viable e-mail
address on the Internet. The camera can e-mail an image or text file based on what is specified
in the filename parameter.
Note:
Configure the correct mail settings for the camera using the
SET DEFINE EMAIL SITE command immediately below.
EMAIL sitename filename
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
“sitename”
Specifies the site to which the camera will e-mail the specified
file.
“filename”
Specifies the filename of a local file that the camera will
include in the outgoing e-mail.
Examples
Local>> EMAIL “new_ip” “new_ip.html.dynamic”
FTP, scripts & email
93
7.4.2 Set/Define Email Site
The Email Site command defines the name for a new e-mail configuration file and lets you
specify information necessary to send e-mail messages (text information or files from the
camera) to any valid Internet address. The number of sites a user can have is limited only by
NVR size, which is needed to store site configurations.
Enable the e-mail feature by creating a script that contains the proper e-mail commands. Then,
use one of the script configurations mentioned above to reference the file containing the e-mail
settings.
Note:
You must specify the name of a site when configuring any of the e-mail
Site settings.
Note:
For the e-mail feature to work properly, the domain name on the camera
MUST be set. Otherwise, the mailhost will deny the mail and/or not
forward it to the appropriate destination. Refer to the SET/DEFINE IP
DOMAIN command, Section 8.2.1 on page 99.
TO address
SET
DEFINE
EMAIL SITE sitename
MAILHOST hostname
FROM address
SUBJECT text
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
“sitename”
Defines a site for the e-mail configurations. All of the
remaining e-mail parameters will be particular to this site.
TO
Specifies the recipient of the e-mail. Enter address in standard
e-mail format: [email protected] (For example.
[email protected]). You can omit the domain name if the address
is in the same domain as the camera.
MAILHOST “hostname”
Defines the name or IP address of the SMTP (Simple Mail
Transfer Protocol) server on the camera’s network. The mail
server must be an SMTP server. Refer to your network
administrator for the network address of the appropriate
SMTP server.
Note:
For the camera to use a text-based name for the mailhost, you must first
specify a nameserver. Refer to the SET/DEFINE IP NAMESERVER
command, Section 8.2.5 on page 102.
FTP, scripts & email
94
FROM “address”
Sets the return address for the e-mail. Enter address in
standard e-mail format: [email protected] (for example.
[email protected]). You can omit the domain name if
the address is in the same domain as the camera.
Note:
The FROM variable supports dynamic print. Refer to Section 4.2.6 on
page 51 for a list of dynamic print variables.
SUBJECT “text”
Defines the text message that will appear in the subject line of
the e-mail.
Note:
The SUBJECT variable supports dynamic print. Refer to Section 4.2.6 on
page 51 for a list of dynamic print variables.
Defaults
The camera has two default e-mail site configurations:
“trigger” and “new_ip.” For both default configurations, you
can only modify the settings. You cannot delete or rename the
site.
TRIGGER
sitename = trigger
mailhost = mail
To = undefined
From = “$SN@$SM”
(camera name@domain name)
Subject = “Message from $SN@$SM”
(Message from camera name@domain name)
NEW_IP
sitename = new_ip
mailhost = mail
To = undefined
From = “$SN@$SM”
(camera name@domain name)
Subject = “New IP address from $SI”
(The camera will resolve the $SI variable to contain the
camera’s new IP address. The camera will send the new
address each time it receives a new address from the DHCP
server on its network. Refer to SET/DEFINE ONIP
ACTION, Section 8.2.8 on page 104, for additional details.)
Examples
Local>> DEFINE EMAIL SITE “email2”
Local>> DEFINE EMAIL SUBJECT “Hello from $SN”
FTP, scripts & email
95
7.4.3 Save Email
The Save command writes any of the temporary image changes to the e-mail configurations
(changes made using the SET command) to permanent memory.
SAVE EMAIL
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
7.4.4 Clear/Purge Email Site
The Clear/Purge Email Site command removes any configured e-mail site.
CLEAR
PURGE
EMAIL SITE sitename
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
“sitename”
Specifies a site to remove. You cannot remove the default
sites.
Examples
Local>> CLEAR EMAIL SITE “mysite”
FTP, scripts & email
96
7.4.5 Set/Define Email Factory
The Email Factory command returns all e-mail settings to the factory default settings, which will
erase any previously configured settings. It also returns the settings for the preconfigured sites
to the factory defaults.
SET
DEFINE
EMAIL FACTORY
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Restrictions
7.4.6 Show/List Email
Use the Show and List Email commands to view the all of your camera’s current e-mail settings.
These settings include mailhost, to, from, and subject. For a description of the differences
between Show and List, refer to Section 2.3.3.3 on page 14.
SHOW
EMAIL
LIST
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
The Show Email command also displays the latest result message. Refer to the table below for
an explanation of the result message if your e-mail is not operating properly.
Result
Meaning
Success
The last e-mail sent properly.
No Mailhost
No mailhost is specified. Enter a mailhost using the
SET/DEFINE MAILHOST command. Verify that the
specified mailhost is an SMTP mailserver.
File Open
The camera could not open the local file. Verify that
the file exists and is not corrupted.
Connect
The camera could not connect to the specified
mailhost.
FTP, scripts & email
97
Result
Meaning
Negotiation
The camera could not negotiate SMTP with the
specified mailhost. Verify that the specified server is
an SMTP server and check that the domain name for
the camera is properly configured.
Send
The camera could not send the file.
None
No e-mails have been attempted.
Name
Resolution
The camera could not resolve the FTP host name to
an IP address. Check nameserver and domain name
settings on the camera. Use another device to try to
establish a connection with the FTP server by the
FTP server name.
Socket Create
The camera could not create a network socket.
Open
The camera could not open the local trigger file.
Either no image was taken or the disk is full. Do a
DISK LS -L on the /ram disk to see if the trigger
file(s) update when you issue a TEST TRIGGER
INPUT command.
Configuration
The FTP settings are not configured properly (For
example, swhen something is not filled in).
None
The camera has not made an FTP attempt yet.
Command
The specified FTP host did not understand one or
more of the commands issued by the camera.
FTP, scripts & email
98
8: Network Commands
8.1 Overview
This chapter lists each of the networking commands used by IQeye cameras. The commands are
grouped into feature set sections and are listed alphabetically within each section.
8.2 IP Commands
The Set/Define IP commands configure how the camera operates during TCP/IP connections.
8.2.1 Set/Define IP Domain
The IP Domain command sets the default domain suffix. The camera will append this suffix to
host names before sending them to a nameserver for name resolution.
SET
IP DOMAIN
DEFINE
Note:
name
NONE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
name
Enter a domain name of up to 64 alphanumeric characters.
You must use quotes if you wish to preserve the case of the name you
enter.
NONE
Clears a previously entered domain name suffix. There is no
domain configured by default.
Examples
Local>> SET IP DOMAIN “yourdomain.com”
network commands
99
8.2.2 Set/Define IP Gateway
The IP Gateway command specifies the host to be used as a TCP/IP gateway between networks.
Packets destined for another network will be routed to the gateway and then forwarded to their
destination.
SET
DEFINE
IP GATEWAY
ipaddress
DIALOUT
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Errors
If no gateway is defined, the camera will attempt to find one
by listening to routing packets on the Ethernet. If it can’t find
one, an error message will be returned.
Parameters
ipaddress
Defines the network location of the gateway. Enter an IP
address in standard numeric form (nnn.nnn.nnn.nnn).
DIALOUT
Sets the camera to use a modem-based, dial-out connection.
The camera will then assume a gateway from the Internet
service provider configured using the SET/DEFINE
DIALOUT commands. Refer to the Modems chapter for
details on setting up the camera to work with a modem.
Important:
After setting the gateway to DIALOUT, you will no longer be able to
access the camera over the Internet. To connect to the camera, you must
use a PC with dial-up capabilities or connect via Ethernet using a device
that sits on the same network as the camera.
Examples
Local>> SET IP GATEWAY 192.0.1.24
network commands
100
8.2.3 Set/Define IP IPaddress
The IPaddress command sets the camera’s IP address, which must be configured before any TCP/
IP connectivity will be available (such as WWW sessions and Telnet). The IP address cannot be
changed with the SET command while there are active TCP/IP sessions.
If you change your camera’s IP address, you will need to reboot the camera before the new IP
address is functional.
Note:
A default subnet mask will be created when you first set the IP address.
Change the subnet mask with the Set/Define IP Subnet Mask
command (see page 102).
SET
IP IPADDRESS ipaddress
DEFINE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ipaddress
Specifies the camera’s IP address. Enter an IP address in
standard numeric form (nnn.nnn.nnn.nnn).
NONE
Removes the IP address setting for DHCP, BOOTP or RARP
servers.
Examples
Local>> SET IP IPADDRESS 192.168.123.45
8.2.4 Define IP Loadhost
The IP Loadhost sets the TCP/IP host from which the IQeye will request its operating code. The
specified loadhost must be a TFTP server.
DEFINE IP LOADHOST ipaddress
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ipaddress
Specifies the IP address of the loadhost. Enter an IP address
in standard numeric form (nnn.nnn.nnn.nnn).
Examples
Local>> DEFINE IP LOADHOST 192.0.2.18
network commands
101
8.2.5 Set/Define IP Nameserver
The IP Nameserver command specifies the IP address of the external nameserver (if any) the
camera will use when it attempts a TCP/IP connection with another host.
An external nameserver must be specified for the camera to access an FTP server by using a textbased name (see SET/DEFINE FTP SITE Section 7.2.3 on page 82). Since network devices
can only recognize numeric IP addresses, a nameserver is needed to resolve the correct numeric
IP address from a text-based name.
SET
DEFINE
IP NAMESERVER ipaddress
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ipaddress
Specifies the IP address of the nameserver. Enter an IP address
in standard numeric form (nnn.nnn.nnn.nnn).
Examples
Local>> SET SERVER NAMESERVER 192.2.1.12
8.2.6 Set/Define IP Subnet Mask
The IP Subnet Mask command specifies the subnet mask, or netmask, that the camera should
use. IP networks can be divided into several smaller networks by subnetting. When a network
is subnetted, you must specify a subnet mask which tells network devices which smaller network
they belong to. If you do not specify the correct subnet, your camera will have problems
communicating with other network devices.
SET
IP SUBNET
DEFINE
{ MASK }
address
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
address
Specifies the subnetting value of the subnetwork.
Examples
Local>> DEFINE IP SUBNET MASK 255.255.0.0
network commands
102
8.2.7 Set/Define IP Timeserver
The IP Timeserver command sets the method that the camera will use to update its internal
clock. The command supports the most widely recognized protocols for transferring time
information over a network: Daytime and NTP. Configure your camera according to the
protocol used by your network timeserver.
Note:
You must use the SET/DEFINE SERVER TIMEZONE command to
configure your camera’s local timezone (see Section 8.5.14 on page 121).
Except for Daytime, all updates sent from a timeserver are expressed in
the Greenwich Mean Time (GMT). Daytime expresses time relative to
the camera’s timezone setting.
DAYTIME ipaddress
SET
IP TIMESERVER
DEFINE
NTP
BROADCAST
PASSIVE
IP ipaddress
NONE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
DAYTIME ipaddress
Specifies the IP address of the timeserver that is using the
Daytime protocol. Enter an IP address in standard numeric
form (nnn.nnn.nnn.nnn).
When using the Daytime protocol, the camera will send a
request to the external timeserver and the timeserver will
respond by sending the correct time.
Note:
The Daytime protocol and the Timeserver (or Time) protocol are
interchangeable. If the timeserver on your network uses the Timeserver
protocol, configure your camera to use the Daytime option.
NTP BROADCAST
Specifies that the camera will send one network-wide
broadcast to find an NTP server. Once the camera receives
the first response, it will assume that server as its NTP server.
The camera will then send direct requests to that server.
If the timeserver does not respond to four consecutive
requests, the camera will then broadcast another networkwide request to locate a new NTP server.
NTP PASSIVE
Specifies that the camera will monitor the network listening
for NTP broadcasts. The camera will not send any
broadcasts.
network commands
103
NTP IP ipaddress
Specifies the IP address of the timeserver that is using the NTP
protocol. Enter an IP address in standard numeric form
(nnn.nnn.nnn.nnn).
NONE
Specifies that the camera will not use a timeserver.
Defaults
NONE
Examples
Local>> SET IP TIMESERVER NTP IP 192.2.8.99
See Also
Set/Define Server Timezone (Section 8.5.14 on page 121)
8.2.8 Set/Define ONIP Action
The ONIP Action command sets the camera to notify users when it is assigned a new IP address
via DHCP. When the camera is connected to a DHCP network that assigns dynamic IP
addresses, the camera will receive a new IP address after each reboot. To make its identity
known to outside users, the camera can send an e-mail that contains its new address to other
devices on the network, it can FTP an HTML file to a remote server that will serve as a bridge
to the camera, or it can do both.
The camera contains default site configurations that control the e-mail and FTP actions. One
site corresponds to e-mail, and the other to FTP. Both default sites are named “new_ip.”
Reconfigure these sites according to your requirements to enable the DHCP notification feature.
Refer to the FTP, Scripts, & E-mail chapter for details on reconfiguring the default site
specifications.
There are two pre-written HTML files contained on the camera’s ROM disk. Reconfigure the
new_ip site to include either of these files in the DHCP notification. Both files contain a link to
the new IP address of the camera.
•
new_ip.html.dp
The new_ip.html.dp file contains a standard text link to the new address of the
camera. Users must click this link to access the camera.
•
new_ip_js.html.dp
The new_ip_js.html.dp file uses a javascript to automatically redirect users (and
other web servers) to the camera’s new IP address. Embed this link into existing
HTML code to dynamically maintain a link between the camera and HTML files
on a known server.
Note:
For the DHCP notification feature to operate, you must enable DHCP
queries by using the SET/DEFINE SERVER DHCP command. Refer to
Section 8.5.3 on page 115 for more information on enabling DHCP
queries.
network commands
104
EMAIL
SET
ONIP ACTION
DEFINE
FTP
BOTH
NONE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
EMAIL
Specifies that after the camera receives a new IP address via
DHCP, the camera will send an e-mail to the default new_ip
e-mail site. The e-mail will contain an html link to the
camera’s new IP address. Refer to the Set/Define Email Site
section on page 94 for information on configuring the default
e-mail site.
FTP
Specifies that after the camera receives a new IP address via
DHCP, the camera will FTP a file to the default new_ip FTP
site. The file that is transferred contains a JavaScript redirect
to the camera’s new IP address. Use this file within existing
HTML source to link a web server to a camera that receives
its IP address via DHCP. Refer to the Set/Define FTP Site
section on page 82 for information on configuring the default
FTP site.
BOTH
Configures the camera to send both an e-mail and an FTP
after it receives a new IP address via DHCP.
NONE
Sets the camera to disregard the new IP address assignment.
The camera will not send the notification after the new
address is assigned.
Defaults
None
Examples
Local> SET ONIP ACTION EMAIL
network commands
105
8.3 Logging Commands
8.3.1 Set/Define Logging
The Logging command controls error and event logging on the camera. Events can be logged
directly to the camera or to a network host (via TCP/IP).
The host must be configured to support logging. If you’re using a TCP/IP host, the host’s syslog
facility must be configured; make sure all priorities equal to or higher than *.notice are being
logged. The syslog file is typically located in the /etc directory; see your host’s documentation
on syslogd for more information.
Note:
Logging levels are cumulative; setting logging to level 4 includes levels 1
through 3 as well.
DESTINATION
SET
DEFINE
LOGGING
location
NONE
AUTHENTICATION
IP
MODEM
PPP
SITE
COMMANDS
NETWORK
SYSTEM
num
MAX
NONE
ENABLED
DISABLED
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
Destination
Specifies a destination for the log messages. Must be used in
conjunction with the Location parameter or the None
parameter.
location
Where to store the log. Enter hostname: for a TCP/IP host,
or MEMORY to save the log to NVR.
None
Disables logging.
network commands
106
Authentication
Logs events associated with authentication. Must be used
with the num parameter (one of the options listed below) or
None (to specify no Authentication logging).
Table 8-1: Authentication Logging
Num
Information
1
System Problems
2
Failures and Successes
3
All Logins and Logouts
4
Incorrect Passwords
5
All Passwords
IP
Traces the activities of the IP router. Must be used with the
num parameter (one of the options listed below) or None (to
specify no IP logging).
Table 8-2: IP Logging
Note:
Num
Information
1
Errors
2
Packets triggering remote connections
3
Routing table/interface changes
4
Incoming/outgoing RIP packets
5
Resulting routing table (verbose)
6
Contents of all RIP packets (verbose)
7
Routed packets (verbose)
Setting the IP logging level to 2 or greater results in a syslog that prints
the source/destination IP address, protocol, and TCP/UDP source/
destination ports.
Modem
Logs modem activity, including modem jobs (incoming and
outgoing). Must be used with the num parameter (one of the
options listed below) or None (to specify no modem logging).
Table 8-3: Modem Logging
Num
Information
1
Problems
2
Call Statistics Dump From Modem
3
Setup
network commands
107
PPP
Logs events associated with PPP. Must be used with the num
parameter (one of the options listed below) or None (to
specify no PPP logging).
Table 8-4: PPP Logging
Num
Information
1
Local System Problems
2
Remote System Problems
3
Negotiation Failures
4
Negotiation Data
5
State Transitions
6
Full Debugging
Site
Logs events associated with sites. Must be used with the num
parameter (one of the options listed below) or None (to
specify no site logging).
Table 8-5: Site Logging
Num
Information
1
Errors
2
State Transitions
3
Chat Scripts
4
Modem Dialing
5
Port Connections
6
Connection Failures
7
Usage Summary
Commands
When enabled, logs all commands users type.
Network
When enabled, logs network events. This is useful for
diagnosing network-related problems.
System
When enabled, logs server boots, log file openings/closings,
and other system related activity.
Defaults
Destination: None
Logging Options: None (logging turned off)
Examples
Local>> SET LOGGING AUTHENTICATION 5
network commands
108
8.4 Port Commands
The camera’s serial port supports an external modem connection to add dial-up connectivity to
the camera. The Port commands configure the port to receive such a connection.
8.4.1 Set/Define Port Access
The Port Access command specifies the type of login connections that will be available through
the port.
SET
DEFINE
PORT 1 ACCESS
DYNAMIC
LOCAL
NONE
REMOTE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Errors
If a port is active, its access cannot be set.
Autobaud must be disabled for Remote and Dynamic ports.
Parameters
Dynamic
Specifies that the port can receive connection requests from
both Local and Remote users.
Local
Specifies that the port can only accept connection requests
from local users (those connected directly to the serial port).
No remote logins are permitted.
None
Prevents all incoming and outgoing connections, making the
port unusable.
Remote
Specifies that the port can only accept only incoming
connection requests from the network. No local logins are
permitted.
Defaults
Dynamic
Examples
Local>> DEFINE PORT 1 ACCESS LOCAL
network commands
109
8.4.2 Set/Define Port CDlogout
When enabled, the port will be logged out when the port’s CD signal is dropped. This usually
only occurs when the attached modem is powered off or disconnected. Any open connections
will be closed before logging out.
SET
DEFINE
PORT 1 CDLOGOUT
ENABLED
DISABLED
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Defaults
Disabled
8.4.3 Set/Define Port Character Size
The Port Character Size command sets the number of bits per character for the serial port.
SET
DEFINE
PORT 1 CHARACTER SIZE
7
8
Restrictions
You must be the privileged user to use this command on ports
other than your own. Non-secure users, those who are not
privileged, may not use this command.
Parameters
Size
Enter a character size that is either 7 or 8 bits.
Defaults
8 bits
Examples
Local>> SET PORT CHARACTER SIZE 7
network commands
110
8.4.4 Set/Define Port Flow Control
The Port Flow Control command sets the type of flow control on the port.
SET
DEFINE
PORT 1 FLOW
{ CONTROL }
NONE
CTS
XON
Restrictions
You must be the privileged user to use this command on ports
other than your own.
Parameters
NONE
No flow control will be performed.
CTS
Sets the flow control type to CTS/RTS.
XON
Sets the flow control type to XON/XOFF.
Defaults
XON
Examples
Local>> SET PORT FLOW CONTROL CTS
8.4.5 Set/Define Port Inactivity Logout
The Port Inactivity Logout command enables automatic logout of the camera’s serial port if it
has been “inactive” for a set period of time. Inactive is defined as having no keyboard or
network activity on the port. The port’s open connections (if any) will be closed before logging
out.
Note:
The inactive period is configured using the SET/DEFINE SERVER
INACTIVITY TIMER command (see Section 8.5.6 on page 116).
This command is ignored for remote networking connections.
SET
DEFINE
PORT 1 INACTIVITY { LOGOUT } ENABLED
DISABLED
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Defaults
Disabled
network commands
111
8.4.6 Set/Define Port Parity
The Port Parity command sets the serial port’s parity to Odd, Even, or None (no parity). Note
that changing the parity may affect the configured character size.
SET
DEFINE
PORT 1 PARITY
ODD
EVEN
NONE
Restrictions
You must be the privileged user to use this command on ports
other than your own. Non-secure users, those who are not
privileged, may not use this command.
Defaults
None (no parity)
8.4.7 Set/Define Port Speed
The Port Speed command specifies the baud rate of the port.
SET
DEFINE
PORT 1 SPEED speed
Restrictions
You must be the privileged user to use this command on ports
other than your own. Non-secure users, those who are not
privileged, may not use this command.
Errors
An error is displayed for illegal baud rates.
Parameters
speed
One of the following baud rates: 300, 600, 1200, 2400 4800,
9600, 19200, 38400, 57600, 115200.
Defaults
9600
Examples
Local>> SET PORT SPEED 2400
network commands
112
8.4.8 Set/Define Port Stop
The Port Stop command specifies the stop bit count for the port.
SET
DEFINE
PORT 1 STOP
1
2
Restrictions
You must be the privileged user to use this command on ports
other than your own. Non-secure users, those who are not
privileged, may not use this command.
Errors
An error is displayed if an invalid stop bit number is entered.
Defaults
1
Examples
Local>> SET PORT 1 STOP 2
8.5 Server Commands
8.5.1 Define Server BOOTP
The Server BOOTP command enables or disables querying for a BOOTP host when the camera
boots. If the camera sits on a network that uses a BOOTP server, the BOOTP host can supply
the camera’s IP address at boot time. Refer to your BOOTP server documentation for
information on configuring the server to respond to the camera.
Note:
BOOTP must be enabled to assign the camera’s IP address using
VisiCon.
DEFINE SERVER BOOTP
ENABLED
DISABLED
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ENABLED
Activates BOOTP queries. When enabled, the camera will
look for a BOOTP host at boot time.
network commands
113
DISABLED
Deactivates BOOTP queries.
Defaults
Enabled
Examples
Local>> SET SERVER BOOTP DISABLED
8.5.2 Set/Define Server Clock
The Server Clock command manually sets the date and time information for the camera’s
internal clock.
Because an external timeserver will keep more accurate time than the camera’s clock, you should
also configure the camera to periodically update its clock according to the external timeserver.
(see SET/DEFINE IP TIMESERVER, Section 8.2.7 on page 103).
Note:
Before you set the clock, you must specify your appropriate timezone
with the SET/DEFINE SERVER TIMEZONE command (See page 121.).
Do not compensate for an incorrect timezone by adjusting the clock time.
SET
DEFINE
SERVER CLOCK time date
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
time
Enter the time in 24-hour hh:mm:ss format.
Entering seconds is optional.
date
Enter the date in mm/dd/yyyy format.
Examples
Local>> SET SERVER CLOCK 11:54:31 01/31/99
See Also
Set/Define IP Timeserver (Section 8.2.7 on page 103)
Set/Define Server Timezone (Section 8.5.14 on page 121)
network commands
114
8.5.3 Set/Define Server DHCP
The Server DHCP command enables or disables querying for a DHCP host when the camera
boots. If the camera exists on a network that uses a DHCP server, the DHCP host can supply
the camera’s IP addresses at boot time. Refer to your DHCP server documentation for
information on configuring the server to respond to the camera.
DEFINE SERVER DHCP
ENABLED
DISABLED
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ENABLED
Activates DHCP queries.
DISABLED
Deactivates DHCP queries.
Defaults
Enabled
Examples
Local>> DEFINE SERVER DHCP DISABLED
8.5.4 Define Server Ethernet
The Server Ethernet command adjusts how the camera transmits data on a network.
DEFINE SERVER ETHERNET
AUTO
10MBIT
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
AUTO
Configures the camera to choose the higher of 10Mb or
100Mb for transmission, depending on what the network can
handle.
10MBIT
Forces the camera into 10Mb mode.
Note:
If you have an IQeyeXT model, the camera’s built-in thermometer will
automatically specify 10MBIT if the temperature drops below 0˚ C.
Defaults
Auto
Examples
Local>> DEFINE SERVER ETHERNET 10MBIT
network commands
115
8.5.5 Set/Define Server Identification
The Identification command specifies the identification string that appears on the SHOW
SERVER screens.
SET
DEFINE
SERVER IDENTIFICATION IDstring
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
IDstring
Enter up to 40 characters of identification data in quotes.
Examples
Local>> DEFINE SERVER IDENTIFICATION “My camera 1”
8.5.6 Set/Define Server Inactivity (Timer)
The Inactivity Timer sets how long the server can remain idle (with no user input or network
activity) before logging out user connections.
SET
DEFINE
SERVER INACTIVITY
{ TIMER }
limit
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
limit
Sets the interval of inactivity in minutes after which the
camera will log the user out. Enter a number between 1 and
120.
Defaults
30 (minutes)
Examples
Local>> DEFINE SERVER INACTIVITY 60
network commands
116
8.5.7 Set/Define Server Incoming
The Server Incoming command allows or denies incoming Telnet connections. If desired, you
can set password protection for incoming connection attempts by enabling the SET/DEFINE
SERVER INCOMING PASSWORD command (see Section 5.4.3 on page 61). The status of
Incoming Telnet also controls incoming Rlogin sessions web sessions.
Note:
To view the status of incoming connection parameters, issue a
SHOW SERVER command (see Section 8.11 on page 126).
SET
DEFINE
SERVER INCOMING
TELNET
NONE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
TELNET
Enables incoming Telnet and Rlogin connections (logins) to
the server.
NONE
Prevents incoming Telnet and Rlogin attempts.
Note:
When Telnet and Rlogin connections are disabled, you must connect to
the camera through the remote console port. Remote console logins
cannot be disabled. See Section 5.2.1 on page 57 for information about
using the remote console port.
Defaults
Telnet
Examples
Local>> SET SERVER INCOMING NONE
See Also
Set/Define Server Incoming Password
8.5.8 Set/Define Server Name
The Server Name command sets a unique text name for the camera. This name will appear when
you request information from the camera, such as a LIST SERVER command (see Section 8.11
on page 126). Setting a unique name for the camera allows you to recognize the camera by name
rather than IP address.
Note:
This command does not allow a user to access the camera by entering a
text-based name in the URL/Location field of their web browser. For
this, the user’s browser must be connected to a nameserver and the
camera must be entered in a host table.
network commands
117
Note:
This command is different from Set/Define Server Identification, which
allows you to give the camera a long, descriptive name so you can tell it
apart from other cameras.
SET
DEFINE
SERVER NAME name
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
name
Sets the name for the camera. Enter a descriptive name of up
to 16 characters composed of alphanumerics and the
underscore (“_”) character. If the name is not enclosed in
quotation marks, it will be converted to upper case.
Defaults
IQeyeXX-XX-XX, where XX-XX-XX is the last 6 digits of
the hardware address.
Examples
Local>> DEFINE SERVER NAME “Warehouse_1”
8.5.9 Set/Define Server RARP
The Server RARP command enables or disables querying for a RARP host when the camera
boots. If the camera exists on a network that uses a RARP server, the RARP host can supply the
camera’s IP address at boot time. Refer to your RARP server documentation for information on
configuring the server to respond to the camera.
DEFINE SERVER RARP
ENABLED
DISABLED
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ENABLED
Activates RARP queries.
DISABLED
Deactivates RARP queries.
Defaults
Enabled
Examples
Local>> DEFINE SERVER RARP DISABLED
network commands
118
8.5.10 Set/Define Server Retransmit (Limit)
The Server Retransmit Limit command specifies the number of times that a TCP packet will be
re-sent if it is not acknowledged.
SET
DEFINE
SERVER RETRANSMIT
{ LIMIT }
num
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
num
Sets the number of retransmit attempts. Enter a value
between 4 and 100.
Defaults
10
Examples
Local>> SET SERVER RETRANSMIT LIMIT 75
8.5.11 Set/Define Server SilentBoot
The Silent Boot command controls whether or not the camera sends status messages to the serial
port during its boot process.
Note:
SilentBoot should be enabled whenever a modem is connected to the
serial port, because modems may have problems when receiving and
attempting to decipher the diagnostic status messages.
SET
DEFINE
SERVER SILENTBOOT
ENABLED
DISABLED
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
ENABLED
Enables the Silent Boot feature. The camera will only send
diagnostic logs to the serial port if there are boot problems.
DISABLED
Disables the Silent Boot feature. The camera will send normal
diagnostic logs to the serial port.
Defaults
Enabled
Examples
Local>> DEFINE SERVER SILENTBOOT DISABLED
network commands
119
8.5.12 Set/Define Server Software
The Server Software command specifies the name of the download software file (if any) the
server will attempt to load when a reload command is issued (see INITIALIZE RELOAD,
Section 9.6 on page 143).
For TFTP loading, the complete path of the file can also be specified if the file is located in a
directory other than the default directory specified in your TFTP server. The full path must be
enclosed in quotes to preserve case.
This command is only useful if it is Defined; if it is Set, it will be cleared/
reset at boot time.
Note:
DEFINE SERVER SOFTWARE filename
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
filename
Specifies the desired loadfile name of up to 11 characters or
the path name of up to 31 characters. Names should be
entered in quotes to preserve case.
If your server has the absolute path properly configured, pathnames can
be relative.
Note:
Examples
Local>> DEFINE SERVER SOFTWARE “/software/IQeye.sys”
8.5.13 Set/Define Server Startupfile
The Server Startupfile command tells the camera where to find the configuration file to load at
boot time. When a startupfile is specified using this command, the camera will attempt to find
the specified file during its boot process. This file contains the camera commands that will
configure the camera before the users and services are started.
Refer to the FTP, Scripts, & E-mail chapter for more information on writing, configuring, and
using a start-up script.
Note:
SET
DEFINE
If no retry limit is specified in the command, the camera will retry failed
attempts to find a startupfile forever; otherwise it will retry the specified
number of times and then boot normally.
SERVER STARTUPFILE
host:filename
{ RETRY
retrynum }
NONE
network commands
120
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
host
An IP address, or a text host name that is resolvable at boot
time.
To load from a TCP/IP host via TFTP, use the host:filename
format. If loading a file stored locally on the camera’s /Flash
disk, enter /flash:filename.
filename
A startup file name of up to 47 characters, including the path.
RETRY
Configures the server retry limit. Must be used with the
retrynum parameter.
retrynum
The number of times to retry the download attempt. The
maximum number of retries is 1000. If a retrynum is not
specified, the camera will retry 5 times (the default).
None
Clears any specified startup file.
Defaults
Startupfile: none
Retries: 5
Examples
DEFINE SERVER STARTUPFILE “/flash:bob.cmd” RETRY 6
8.5.14 Set/Define Server Timezone
The Server Timezone command sets the timezone in which the camera is located. By specifying
the appropriate timezone, you also ensure that your camera will make the proper adjustments
for Daylight Savings Time.
Note:
Accurate timezone settings are very important for communications
between network devices. Ensure that this setting is correct on your
camera. Do not set your timezone by adjusting the time manually.
SET
DEFINE
SERVER TIMEZONE
timezone
NONE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
timezone
Specifies a pre-configured timezone (for example,
AMERICA/PACIFIC for Pacific Standard Time).
network commands
121
Note:
Issue the SHOW TIMEZONE command to see a list of available timezones.
Choose from among this list when specifying the timezone for your
camera.
None
Specifies that no timezone will be used.
Defaults
America/Pacific
Examples
Local>> DEFINE SERVER TIMEZONE AUSTRALIA/HOBART
8.6 Web Commands
The Set/Define Web commands enable you to configure how the web server on your camera
responds to incoming HTTP connection attempts.
8.6.1 Set/Define Web Defaultpage
The Web Defaultpage command lets you choose the HTML file that the camera will display as
its default home page. This is useful for users who wish to show customized web pages when
users log into the camera.
SET
DEFINE
WEB DEFAULTPAGE
htmlfile
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
htmlfile
Specifies the web page that the camera will display as the
default home page. Enter a file name that ends in either
.html or .htm.
Examples
Local>> SET WEB DEFAULTPAGE IMAGES.HTML
network commands
122
8.6.2 Set/Define Web Port
The Web Port command sets the TCP/IP port number used for incoming web connections.
Change this setting if the firewall on your network does not accept the default port setting.
SET
WEB PORT portnumber
DEFINE
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
portnumber
Enter the web port number appropriate to your firewall.
Defaults
80
Examples
Local>> DEFINE WEB PORT 8080
8.7 Purge Port
The Purge Port command removes the configured modem profile and resets the camera’s serial
port to the factory default settings.
PURGE PORT 1
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
network commands
123
8.8 Save
The Save command writes any of the temporary image changes to the network configurations
(changes made using the SET command) to permanent memory. Specify a parameter to save the
settings of that particular category of commands.
IP
PORT
SAVE
LOGGING
SERVER
WEB
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
IP
Saves the settings changed using the SET IP command.
PORT
Saves the settings changed using the SET PORT command.
LOGGING
Saves the settings changed using the SET LOGGING
command.
SERVER
Saves the settings changed using the SET SERVER command.
WEB
Saves the settings changed using the SET WEB command.
Examples
Local>> SAVE IP
network commands
124
8.9 Show/List IP
Use the Show and List IP commands to view all of your camera’s current IP settings. These
settings include domain, IP address, nameserver, subnet mask, and timeserver. For a description
of the differences between Show and List, refer to Section 2.3.3.3 on page 14.
SHOW
IP
LIST
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
IP
Displays the current settings for the IP features.
Examples
Local>> SHOW IP
8.10 Show/List Port
These commands display information about the camera’s serial port and Telnet/RLogin
connections. If no keywords are added to the command, the serial port’s Characteristics will be
shown. For a description of the differences between Show and List, refer to Section 2.3.3.3 on
page 14
SHOW
PORT 1
LIST





CHARACTERISTICS
COUNTERS
STATUS
SUMMARY





Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
Characteristics
Displays the operational settings for the serial port. Displayed
settings include: baud rate, parity, preferred services, name,
and username.
Counters
Displays the port’s local and remote accesses as well as any
communication errors.
network commands
125
Status
Displays information regarding the port’s serial connections,
including the current flow control state.
Summary
Displays a one-line summary of information about the
specified ports. The information includes type of access, login
status, and services offered.
Examples
Local>> SHOW PORT COUNTERS
8.11 Show/List Server
Use the Show and List Server commands to view all or your camera’s current server settings. For
a description of the differences between Show and List, refer to Section 2.3.3.3 on page 14.
Issue the command with or without a parameter. Issuing the SHOW SERVER command without
a parameter will display the basic operational status for the camera. Adding one of the
parameters below will display only the information indicated by the parameter.
SHOW
LIST
SERVER





BOOTPARAMS
CLOCK
COUNTERS
TIMEZONE





Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
<no parameter>
Shows the camera’s basic server settings.
BOOTPARAMS
Displays parameters related to rebooting the unit and
reloading the software including the loadfile name and the
loadhost path.
CLOCK
Displays the local time and date and the Greenwich Mean
Time (GMT/UTC) time and date.
network commands
126
COUNTERS
Displays the accumulated error counters for the Ethernet and
TCP/IP protocols. The number that appears with the error
message represents the corresponding network error below:
Table 8-6: Counter Errors
Note:
Bit
Send Failure Reason
Receive Failure Reason
1
Always 0.
Packet received with CRC error.
2
At least one collision has occurred
while transmitting.
Received packet did not end on
byte boundary.
3
Transmit aborted due to excessive
(more than 16) network collisions.
FIFO overrun: Could not write
received data before new data
arrived.
4
Carrier sense was lost during
transmission.
Receive packet could not be
accommodated due to lack of
receive buffers.
5
FIFO underrun: Ethernet controller
could not access transmit data in
time to send it out.
Received a packet larger than the
maximum Ethernet size (1536
bytes).
6
CD heartbeat not received after
transmission.
Always 0.
7
Out-of-window collision detected.
Always 0.
Counters can be reset to zero with the ZERO COUNTERS ALL command.
TIMEZONE
Displays the currently-set timezone. (see SET/DEFINE
SERVER TIMEZONE, Section 8.5.14 on page 121).
Examples
Local>> SHOW SERVER COUNTERS
network commands
127
8.12 Show/List Users
Displays the current users logged onto the server. For each user, the camera displays the port,
username, and current connection information.
SHOW
USERS
LIST
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Examples
Local>> SHOW USERS
8.13 Show/List Web
Displays which web page is the camera’s default home page and also displays the TCP/IP port
number that the camera will use for incoming web connections.
SHOW
WEB
LIST
Examples
Local>> SHOW WEB
network commands
128
9: File System &
Miscellaneous
Commands
9.1 Overview
To manage files on any of the camera’s disks, you must open a Telnet session with the camera.
Review Section 2.2.1 on page 11 for instructions on how to open a Telnet connection.
9.2 Apropos
The Apropos command displays commands containing the specified keyword. If a command
containing the keyword cannot be found, the IQeye will display “nothing appropriate.”
The IQeye will not display all relevant commands. If there are analogous commands, such as
SET PORT and DEFINE PORT, only one will be shown (in this case, SET PORT).
APROPOS keyword
Restrictions
Privileged commands containing the specified keyword will
only be displayed if you are currently the privileged user.
Parameters
keyword
An alphanumeric string. You do not have to type the
complete command keyword in order to get a response;
partial strings will yield appropriate commands that contain
that string.
Examples
APROPOS SITE
file system & miscellaneous commands
129
9.3 Disk Commands
9.3.1 Overview
IQeye cameras contain three disks:
RAM
The RAM disk stores all of the camera’s temporary information, such
as image sequences and temporary changes. The camera will hold
information stored on this disk until it is turned off or rebooted.
Flash
Flash is re-writable memory that allows you to customize your
camera. Any change that you want the camera to recognize after it is
rebooted should be put on the Flash disk.
ROM
The ROM disk is read-only and cannot be modified. All default
HTML pages are stored on the ROM disk.
Anytime you access the camera, it will scan through the disks in the following order:
1
RAM
At start-up, RAM will be empty.
2
Flash
Depending on your custom settings, the Flash disk may contain new settings for
the camera. At start-up, the camera will recognize any changes contained on the
Flash disk.
3
ROM
If the camera does not find any new information on the Flash disk, it will use the
default settings contained in ROM.
Note:
FTP, Telnet, and Rlogin connections automatically use the /RAM disk as
the default working directory.
Important:
When saving files to the camera, preserve case by using quotes. When
accessing the files, however, you do not need to enter the proper case.
9.3.2 Command Conventions
The Disk commands are very similar to the file management commands in UNIX environments.
If you are not familiar with UNIX environments, refer to an introduction to UNIX before you
proceed.
Note:
Unlike the similar UNIX commands, each disk command for IQeye
cameras must be preceded by the word DISK.
Each of the camera’s disks support all of the commands listed in this section, unless otherwise
noted. Some of the Disk commands support the various flags used by the same UNIX command.
Additionally, flags can be grouped together. For example, -lt is equivalent to -l and -t.
file system & miscellaneous commands
130
Some of the Disk commands also support the UNIX wildcard (*) convention. When you enter
a * into a command, it specifies that the command will react to any file having a similar
extension, prefix, suffix, or pattern. For example, the command DISK LS *.html will list
all of the files from your current working directory that contain the extension .html.
Commands that support the wildcard will be noted.
9.3.3 Permissions
To manipulate files within the camera’s disks, users need to have the appropriate permission, of
which there are three possibilities: read (r), write (w), and execute (x). Read permission allows
users to read the file; write permission allows users to change the file; and execute permission
allows users to run executable files. Users who have r, w, and x permissions are said to have
“universal” permissions.
The permission group is made up of three 3-character triplets. The triplets denote owner, group,
and world permissions. Each triplet can contain an r (read), w (write), x (execute), or dashes (no
permissions).
rwx rw- r-owner
world
group
In the example above, the user (owner) has full permissions, the group has read and write
permissions, and the world has only read permissions.
By default, the privileged user has universal permissions. The privileged user can use the CHMOD
command to set specific files and directories to have different levels of permission. For example,
the privileged user can set up the /RAM disk so that all users can read and write to the disk (see
Section 9.3.6 on page 133).
Note:
Unlike UNIX environments, the camera only has user privileges and
other, or world, privileges. The camera does not support group
privileges, only owner and world privileges.
file system & miscellaneous commands
131
9.3.4 Disk CAT (Concatenate)
The CAT command allows you to display an entire file in your terminal window.
DISK CAT file
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
file
Specifies the file that will display in your terminal window.
Examples
Local>> DISK CAT /flash/index.html.dynamic
9.3.5 Disk CD (Change Directory)
The Change Directory command allows you to switch your current working directory.
DISK CD directory
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
directory
Specifies the directory to which you wish to navigate.
Examples
Local>> DISK CD /FLASH
file system & miscellaneous commands
132
9.3.6 Disk CHMOD (Change Modes)
The Change Modes command allows you to specify the level of privileges users will have on a
file or directory.
DISK CHMOD permission file
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
permission
Specifies the types of privileges for a particular file. To assign
permissions, enter a three digit number comprised of the
numbers 0 through 7. The first digit represents the owner, the
second represents the group, and the third represents the
world:
Table 9-1: Permission Codes
Digit
Permissions
0
No permissions.
1
Execute permission only.
2
Write permission only.
3
Write and Execute permissions.
4
Read permission only.
5
Read and Execute permissions.
6
Read and Write permissions.
7
Full permissions.
For example, entering 754 results in full permissions for the
owner, read and execute permissions for the group, and read
only permissions for the world.
Note:
Even though the camera does not support group privileges, you must
enter the full triplet. The group portion will be ignored.
file
Specifies the file or directory on which the permission will
change.
Examples
Local>> DISK CHMOD 744 index.html.dynamic
file system & miscellaneous commands
133
9.3.7 Disk CP (Copy)
The Copy command copies one or more files to a destination. If the destination is an existing
file, the existing file will be overwritten. Usually, however, the destination is a directory, in
which case the file(s) will be saved under the same names in the new directory. A source and a
destination cannot be the same.
Note:
After you copy a file to Flash with the DISK CP command, it can take
up to 5 seconds for the data to be written into Flash. To write
immediately, use the DISK SYNC command (see Section 9.3.21 on page
142).
DISK
CP
sourcefile destination
files directory
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
sourcefile destination
Specifies that the sourcefile will be copied to the destination
file or directory. If the destination is a file, it will be
overwritten.
files directory
Specifies that one or more files will be copied to the specified
directory.
Examples
To copy all files with the suffix “.html” to the Flash directory,
enter the following command:
Local>> DISK CP *.html /FLASH
file system & miscellaneous commands
134
9.3.8 Disk DF (Free Disk Blocks)
The Disk Free command displays the blocks of free disk space and inodes that are available on
the camera’s disks or on the diskname specified in the command.
DISK
DF
{ flags } { diskname }
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
flags
Specifies the type of display. For example, -i includes in the
display the number of inodes used and the number available.
diskname
Specifies the name of the disk for displaying its available
blocks of space.
Examples
Local>> DISK DF /FLASH
9.3.9 Disk Format Flash
The Format command allows you to format, or erase, the camera’s Flash disk. All files on the
Flash disk will be lost.
DISK FORMAT FLASH
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
file system & miscellaneous commands
135
9.3.10 Disk FSCK (FS-Check)
The FS-Check command runs a diagnostic check of the camera’s filesystems and corrects any
problems it finds.
DISK FSCK
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
9.3.11 Disk LN (Link)
The Link command allows you to create hard and soft links for files, thus linking a particular
file, or set of files, to another file.
Note:
If you do not specify the flag -s in the LN command, a hard link will be
created. A hard link creates a direct alias for a file, allowing it to be
accessed by two different names.
DISK LN flag file1 file2
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
flags
Specifies the type of link. For example, -s creates a soft link.
file1
Specifies the file that will be linked.
file2
Specifies the new file name for the link. File2 can also be a
directory inside which links will be created.
Examples
Local>> DISK LN -s index.html.dynamic testdirectory
file system & miscellaneous commands
136
9.3.12 Disk LS (List)
The List command lists the contents of a directory.
DISK LS flags filename
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
filename
Specifies the name of the disk or file you will list.
flags
Specifies how to list the files. Possible flags include:
-l
Returns a list in long form, which includes information
about modification date, size, owner, and permissions.
-t
Sorts the list by modification date, with the newest file
appearing first.
-r
Reverses the order of the file listing. For example, if -t was
also specified, -r would list the oldest file first.
Examples
Local>> DISK LS -tl /RAM/*.jpg
9.3.13 Disk MKDIR (Make Directory)
The Make Directory command allows you to make one or more directories on either the
camera’s /RAM or /Flash disks.
DISK MKDIR directoryname
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
file system & miscellaneous commands
137
Parameters
directoryname
Specifies the name of the directory you will create.
Examples
Local>> DISK MKDIR /FLASH/IMAGES
9.3.14 Disk More
The More command displays the contents of a file on the terminal, 24 lines of text at a time. It
normally pauses after each screen, and prints “--More--” at the bottom of the screen. To access
the next screen, press the SPACE bar. To abort, press CTRL-C.
DISK MORE filename
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
filename
Specifies the name of the disk or file to read.
Examples
Local>> DISK MORE sprouts.txt
9.3.15 Disk MV (Move)
The Move command allows you to move files and directories on the cameras /RAM and /Flash
disks. You can also rename files on these disks with the Move command.
DISK MV file target
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
file
Specifies the file that will be moved or renamed.
target
Specifies either the destination of the file if it is being moved,
or the new name of the file if it is being renamed.
Examples
Local>> DISK MV proposal /RAM
file system & miscellaneous commands
138
9.3.16 Disk OD (Octal Dump)
The Octal Dump command will display the characters of a specified file in their octal bytes
format.
DISK OD flags file
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
file
Specifies the file you will view as an octal dump.
flags
Specifies the type of octal dump. Possible flags include:
-b
Prints the bytes in octal form.
-c
Prints the bytes in ASCII form.
-x
Prints the bytes in hexadecimal form.
Examples
Local>> DISK OD -x /FLASH/index.html.dynamic
file system & miscellaneous commands
139
9.3.17 Disk Path
The Path command allows you to specify the order in which the camera will search its disks for
files such as web pages, graphics, overlay files, etc.
Since this command specifies the order in which the camera will find and display custom web
pages, the Path sequence is especially important during the boot process.
DISK PATH
WEB path
SHOW
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Errors
If you specify an invalid path, web pages and FTP transfers
will likely fail.
Parameters
WEB “path”
Configures the order in which the camera will scan its disks
and directories for files.
Separate each directory and subdirectory in the “path”
setting by inserting a semicolon between each directory. Refer
to the example below for details.
SHOW
Displays the current configurations for the Path settings.
Examples
Local>> DISK PATH WEB “/FLASH;/FLASH/WEB/;ROM;/RAM
9.3.18 Disk PWD (Print Working Directory)
The Print Working Directory command shows you the full pathname of your current directory.
DISK PWD
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Examples
Local>> DISK PWD
file system & miscellaneous commands
140
9.3.19 Disk RM (Remove)
The Remove command removes files and/or directories from the camera’s /RAM and /Flash
disks.
DISK RM
{ flags }
files
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
flags
Specifies how the files or directories will be removed. Possible
flags include:
-i
Prompts for a yes (‘y’) or no (‘n’) before the file is removed.
-r
Removes an entire directory and all of its subdirectories.
files
Specifies the name of the disk or file(s) you will remove.
Examples
Local>> DISK RM -i *.jpg
9.3.20 Disk RMDIR (Remove Directory)
The Remove Directory command allows you to remove an empty directory on the camera’s /
RAM and /Flash disks.
Note:
To remove a directory and its contents, issue a
DISK RM -r directory command.
DISK RMDIR directory
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
directory
Specifies the directory that will be removed.
Examples
Local>> DISK RMDIR RECENT_PICS
file system & miscellaneous commands
141
9.3.21 Disk Sync
When rewriting files to the Flash disk, IQeye cameras can accumulate, or buffer, data before
they initiate a write sequence. Pending write sequences automatically occur after 5 seconds of
disk inactivity. The Sync command forces all files to be written to Flash immediately.
DISK SYNC
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Examples
local>> DISK SYNC
9.4 Finger
This command is based on the UNIX Finger command that displays local and remote users.
FINGER
 username@host 


finger


Restrictions
Secure users cannot use the finger command.
Errors
An error is displayed if the host cannot be accessed.
Parameters
username@host
If a username is specified, information about that username
will be displayed. If @host is specified, information about all
users on that host will be displayed. If username@host is
specified, information regarding that user on that TCP/IP
host will be displayed.
finger
Displays a list of current processes.
Examples
Local> FINGER bob
(shows user bob on host IQeye)
Local> FINGER @hydra
(shows all current users on host hydra)
Local> FINGER bob@hydra
(shows user bob on host hydra)
file system & miscellaneous commands
142
9.5 Help
The Help command accesses the IQeye help system. Issue the help command followed by a
parameter to learn the proper syntax of a command. Using the Help command without any
parameters displays all available commands. Enter a partially completed command or parameter
to learn its complete syntax.
HELP
command
parameter
Restrictions
You must be the privileged user to view all Help text.
Parameters
command
An IQeye command name.
parameter
An IQeye parameter name. More than one parameter can be
added to the Help command.
Examples
Local> HELP
Local> HELP CONNECT
9.6 Initialize
The Initialize command reboots the camera and controls how the camera behaves when booting
Note:
When you initialize the camera (except for INITIALIZE FACTORY),
changes made using the SET command will be lost unless the
corresponding DEFINE or SAVE commands were also issued.
CANCEL
DELAY time
INITIALIZE { SERVER }
FACTORY
NOBOOT
RELOAD
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
CANCEL
Stops any pending initialization procedures.
file system & miscellaneous commands
143
DELAY time
Schedules a reboot to occur after a specified number of
seconds. To specify the time, enter an integer between 0
(immediate reboot) and 240 (reboot after 4 minutes).
FACTORY
Returns all settings to the factory defaults. All custom
configurations will be removed and any files on the camera’s
/Flash disk will be erased.
Important:
To ensure that you do not delete your only copy of custom files, like
overlays and html pages, be sure to keep a backup copy of any file you
place on the camera.
Note:
This command is identical to the factory reset that occurs after you use
the Factory Reset button. See the IQeye User’s Guide for more
information on using the Factory Reset button.
NOBOOT
Forces the camera to remain in the Boot Configuration
Program when it powers up. Boot configuration is only
available through the serial port. The camera will return to
regular mode after it is rebooted.
RELOAD
Reboots the camera and forces it to attempt to download the
IQeye operating software when it boots.
Examples
Local>> INITIALIZE RELOAD DELAY 30
9.7 Logout
Logs out the camera’s serial port. Active sessions are disconnected, and all modem circuits are
closed.
LOGOUT PORT 1
Restrictions
Only privileged users can log out a port.
Examples
Local> LOGOUT
file system & miscellaneous commands
144
9.8 Netstat
Displays the currently-active TCP/IP network connections. Information is displayed for all
supported protocols; the IQeye currently supports the TCP/IP protocols. This information is
primarily meant for debugging network problems.
NETSTAT
Restrictions
Secure users may not use this command.
9.9 Ping
Sends a TCP/IP request for an echo packet to another network host. This provides an easy way
to test network connections to other TCP/IP hosts. In general, any host that supports TCP/IP
will respond to the request if it is able, regardless of login restrictions, job load, or operating
system.
Note:
If there is no reply from the host, this may indicate a network or TCP/IP
configuration problem.
PING hostname
Parameters
hostname
Text name or IP address of the network host.
Examples
Local> PING 192.0.1.23
Local> PING HYDRA.LOCAL.NET
See Also
IQeye User’s Guide.
file system & miscellaneous commands
145
9.10 Source
The Source command attempts to download a configuration file from a TFTP host. The file is
assumed to be lines of server commands which will be executed when the file is downloaded.
The Source command is most useful for trying out a configuration file before using the SET/
DEFINE SERVER STARTUPFILE command (see Section 8.5.13 on page 120).
To use TFTP, use the hostname:filename format.
SOURCE host:filename
VERIFY
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
host
Specifies a TFTP host (text host name or IP address).
filename
Sets the download path and filename, 22 characters
maximum.
Note:
If filename contains lower-case letters, it must be enclosed in quotation
marks.
VERIFY
Displays each command from the configuration file before
executing it.
Examples
Local> SOURCE “labsun:start.com”
file system & miscellaneous commands
146
9.11 Zero Counters
This command is used to reset the counters for errors and other network and server events.
ALL
ZERO COUNTERS
ETHERNET
PORT 1
Restrictions
You must be the privileged user to zero all counters or
counters on a port other than your own.
Parameters
All
Zeroes all Ethernet, TCP/IP, and serial port counters.
Ethernet
Zeroes only Ethernet counters.
Port 1
Zeroes only the counters for events associated with the
camera’s serial port.
Examples
Local> ZERO COUNTERS ALL
file system & miscellaneous commands
147
10: Modems
10.1 Overview
The IQeye Serial Port supports an external modem connection, which enables the camera to
initiate a dial-up connection to an Internet Service Provider (ISP), or to accept incoming dial-up
connections. The camera uses the Point-to-Point Protocol (PPP) to talk to the remote host.
10.1.1 Supported Modems
Due to the tremendous differences in communication methods among various modems, IQeye
cameras only support a limited number of modems. Issue the SHOW MODEM command to see a
list of compatible modems.
10.1.2 Outgoing Connections
For outgoing connections, the camera will dial an ISP and then FTP images to the remote host
specified with the Trigger FTP command.
Note:
The ISP is a service that provides access to the Internet. However, you
can also specify a router that is connected to the Internet as your
camera’s ISP.
ISP
telephone line
Ethernet
modem
remote server
Note:
To set the telephone number, use the SET/DEFINE MODEM DIALOUT
command (see below).
modem commands
148
10.1.3 Incoming Calls
For incoming connections, the camera will detect an incoming call when the serial port receives
a Ring string from the modem. The port will then be in a “ringing” state; outgoing calls cannot
be made from the port during this period. The camera will send the Command string followed
by the Answer string forcing the modem to answer the call.
telephone line
modem
remote user
To protect your camera from outside users, you should configure dial-in security for your
camera. Refer to the SET DIALIN PASSWORD command below.
10.2 Connect a Modem
If your modem is among the list of modems supported by the camera, you can connect the
modem to the camera through the camera’s Serial Port. You will need a custom cable for this
connection. Contact IQinVision for more information about the modem cable.
To connect a supported modem to the camera:
1
Turn the camera off,
2
Turn the modem on,
3
Connect an active phone line,
4
Connect the modem to the camera using the IQeye Modem Cable, and
5
Turn the camera back on.
6
Configure the modem and camera for dial-up connectivity by dialing into the
modem and then selecting the appropriate modem profile.
modem commands
149
10.3 Configure the Camera Via the Modem
You can connect to the camera’s modem to configure the camera for dial-up connectivity. To
connect to the camera via the modem:
1
Dial into the modem using a terminal program such as Hyperterminal. Use the
phone number that corresponds with the phone line connected to the modem.
2
Once you access the modem, press Return to access the Local> prompt.
3
Become the privileged user.
Changing most settings on the camera requires privileged user or “Superuser”
status. To become the privileged user, you must issue a command and enter a
password. Issue the SET PRIVILEGED command at the Local> prompt.
Note:
You may also enter the command SU, an alias to the SET PRIVILEGED
command.
At the resulting Password> prompt, enter system, the default privileged
password.
Note:
If you have changed the camera’s default privileged password, enter the
new password.
A privileged prompt (usually Local>>) will appear. At the privileged prompt,
enter the commands as they appear in the command descriptions.
4
Select a modem profile.
To communicate with a modem, the camera consults a list of commands and
responses that are particular to that modem. This compilation is called a modem
profile. Preconfigured profiles are available for several of the most common
modem types. Each profile contains all settings necessary to appropriately
configure that type of modem. View the profile numbers by issuing the SHOW
MODEM command.
Note:
You must connect a modem that is listed in the SHOW MODEM command.
IQeye cameras do not support other brands of modems.
modem commands
150
5
Configure the modem type.
To configure your modem type, assign the proper modem profile number to the
camera using the SET MODEM command.
6
Assign an IP address to the camera.
To receive network and/or modem connections, your camera must have a valid
IP address. If your camera does not sit on a network, its IP address can be any
number that is in the proper IP address format (###.###.###.###, with no series
of numbers exceeding 255). However, if your camera sits on a network, then you
must assign an IP address that is valid on the network.
Note:
Ask your system administrator for an available, valid IP address.
To assign an IP address, you must first issue the SET IP IPADDRESS command
to temporarily assign the IP address.
Permanently assign the address using the DEFINE IP IPADDRESS command.
Note:
7
After setting the IP address, you may need to set a subnet mask for the
camera. Ask your system administrator for an appropriate subnet mask.
Once you know the appropriate subnet mask, specify it by using the
SET/DEFINE IP SUBNET MASK command (see Section 8.2.6 on page
102).
If your camera does not sit on a network that has a DHCP, BOOTP, or RARP
server, you can reduce boot time by disabling queries for alternate boot servers
(optional).
modem commands
151
8
Exit the privileged session with the camera.
The Logout command will close that privileged session with the camera, which
ensures that no one else can access the privileged features of your camera from
that computer without logging in.
10.4 Modem Commands
The Set Modem commands below specify how the camera will act when a modem is connected
to the Serial Port.
Note:
All SET MODEM commands automatically perform the SAVE operation,
similar to a DEFINE command.
10.4.1 Set Modem
The Set Modem command specifies a profile for the type of modem connected to the camera.
Note:
By specifying a modem, you also enable modem handling on the
camera’s serial port. You can disable modem handling by changing the
modem profile to NONE.
SET MODEM
Note:
number
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
number
Specifies the profile for the modem. Enter the number of the
profile that corresponds to your modem.
You must connect a modem that is listed in the SHOW MODEM command.
IQeye cameras do not support other brands of modems.
Examples
Local>> SET MODEM 4
modem commands
152
10.4.2 Set Dial-in
The Dial-in command configures whether the camera will accept incoming dial-up connection
attempts without a password, and how long the camera will remain idle before logging out the
connection.
SET DIALIN
PASSWORD password
IDLE seconds
Note:
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
PASSWORD “password”
Specifies the password that the camera will accept for
incoming dial-up attempts. For password, enter an
alphanumeric password up to 10 characters long. Use quotes
to preserve case.
The dial-in username is dialin, and cannot be changed.
IDLE seconds
Specifies the time, in seconds, that the dial-up connection can
remain idle before the camera automatically logs out the
serial port. For seconds, enter an integer between 10 and
600 (seconds).
Examples
Local>> SET DIALIN PASSWORD “ZIPdooDA”
10.4.3 Set Dial-out
The Dial-out command configures the camera to make outgoing dial-up connection attempts.
NUMBER phonenumber
SET DIALOUT
USERNAME username
PASSWORD password
IDLE seconds
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
modem commands
153
Parameters
NUMBER phonenumber
Specifies the phone number of the ISP that the camera will use
for a dial-up connection. For phonenumber, enter a
telephone number of up to 24 numbers (no dashes, spaces, or
parentheses).
USERNAME “username”
Sets the username that the camera will use when logging into
the ISP. For username, enter a name up to 10 characters
long.
Note:
The dial-out username is case-sensitive. Use quotes to preserve the case
entered.
PASSWORD “password”
Specifies the password that the camera will use when logging
into the ISP. For password, enter an alphanumeric
password up to 10 characters long.
Note:
The dial-out password is case-sensitive. Use quotes to preserve the case
entered.
IDLE seconds
Specifies the time, in seconds, that the dial-up connection can
remain idle before the camera automatically logs out. For
seconds, enter an integer between 10 and 600 (seconds).
Examples
Local>> SET DIALOUT NUMBER 12125455309
Local>> SET DIALOUT USERNAME “althea”
Local>> SET DIALOUT PASSWORD “toldME”
10.5 Show Dial-in/Dial-out
The Show Dial-In/Dial-Out commands display the current settings for the camera’s dial-up
connectivity.
SHOW
DIALIN
DIALOUT
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
modem commands
154
DIALIN
Displays the IP address that the camera uses for PPP
connections, whether the dial-in password is defined, the
status of the dial-in, and the time, in seconds, that the dial-up
connection can remain idle before the camera automatically
logs out.
Parameters
DIALOUT
Displays the phone number and username that the camera
will use for dial-out connections. Also displays whether the
dial-out password is defined and the time, in seconds, that the
dial-up connection can remain idle before the camera
automatically logs out.
Examples
Local>> SHOW DIALIN
10.6 Show/List Modem
The Show/List Modem command displays the modem configuration used by the camera.
SHOW
MODEM
LIST
Restrictions
You must be a privileged user to enter this command.
Refer to page 12 of this manual for instructions on becoming
the privileged user.
Parameters
MODEM
Displays the current modem profile.
Examples
Local>> SHOW MODEM
modem commands
155
A: Technical Support
IQinVision maintains an online support section. If you are experiencing problems with your
IQeye camera, please visit the technical support section of the web site, located at
www.IQeye.com
If you cannot find an answer to your technical problem by referencing either the
Troubleshooting section of this manual or the support FAQs on the IQinVision web site, you
can contact an IQinVision representative for technical support.
IQinVision
e-mail: [email protected]
toll free 877.850.0805
When you contact IQinVision Technical Support, please make sure that you have the following
information available:
•
Your name, phone number, and e-mail address,
•
Your company name, if applicable, and its address and telephone number,
•
The IQeye product hardware number (printed on the label affixed to the
rear cap of the camera), and
•
A detailed description of the problem.
156
B: Troubleshooting
B.1 General Problems
Most problems can be solved by making sure that the camera has been installed properly and
assigned a valid, unique IP address. Before proceeding to specific troubleshooting sections,
please check the items listed in Table A-1.
Table B-1: General Troubleshooting
Area to Check
Explanation
Physical
connections
Ensure that the physical connections are secure. The cables
should be gently but firmly seated into their connectors.
Check your cables and connectors for missing or bent pins or
other damage. Replace them if necessary. If the IQeye
connectors are damaged, return the unit to IQinVision for
service.
Ensure that the device connectors and cables comply with the
Serial or relay
IQeye pin connections as shown in the Pinouts appendix.
device connections
IP address
The camera must have a unique IP address on the LAN.
Duplicate IP addresses can result in many errors, such as lost
data.
B.2 Power-up Problems
Table B-2: Power-up Troubleshooting
Problem
Suggestion
I plugged everything in
properly, but the Green
“Status” LED on the back
of the camera doesn’t
flash.
Ensure that you are using the supplied power supply or
a good quality power supply that meets the input
specifications. Using any other power supply can
damage the camera.
I can’t access the camera,
and the OK LED is
blinking very rapidly.
There is probably a boot error. Check the cabling.
Unplug the camera and plug it back in to force the
camera to reboot. If the problem persists, proceed to the
Boot Related Problems section.
Ensure that the power supply is in working condition.
Try connecting it to a voltmeter to see if it works on that
device. If not, contact IQinVision to get a replacement
power supply.
troubleshooting
157
B.3 Boot-related Problems
Before troubleshooting boot problems, ensure that you are using a valid software loadfile. The
IQEYE.SYS loadfile should not be altered. If necessary, download a new boot file from the
IQinVision web site (www.IQeye.com).
Note:
Always transfer files in binary mode.
Table 3 lists other areas to check to ensure that the IQeye can read and use the loadfile.
Table B-3: Boot-related Troubleshooting
Protocol
What to Check
TFTP
Check file and directory permissions. The file should be world-readable.
Ensure the loadhost name and address are specified correctly. Ensure the
file and pathnames are enclosed in quotes to preserve case.
Ensure that TFTP is enabled on the host; several major UNIX vendors
ship their systems with TFTP disabled by default.
MOP
Ensure that the files were transferred in Binary mode.
Ensure that the MOM$LOAD search path includes the directory
containing the loadfile (IQEYE.SYS).
B.4 Operational Problems
Table B-4: Operational Troubleshooting
Problem
Suggestion
The camera appears
to be working
(LEDs blinking
intermittently), but
I can’t access it to
get an image.
Ensure that the camera has an IP address. Ping the IP address
that you think belongs to the camera and wait for a reply. For
example:
(UNIX) % ping 192.0.1.123
(DOS) C: PING 192.0.1.123
Ensure that the camera’s IP address is unique to the network.
You may need to consult your system administrator for
assistance. Also, check your host’s ARP table for an entry that
includes the camera’s hardware address, and make sure the IP
address of that entry matches the address you are using to access
the IQeye.
Check the Activity LED. If it only blinks once every thirty
seconds, there is probably a problem with your Ethernet
connection. Check your cable connections and hardware.
If you are connecting to the Ethernet via a hub or repeater, ensure
that you are using a functional port and that the hub or repeater
is connected properly to the network.
Ensure that you are using Netscape Navigator 3.0 or higher or
Microsoft Internet Explorer 4.0 or higher. Most other newer
browsers also support IQeye cameras.
troubleshooting
158
Table B-4: Operational Troubleshooting (Continued)
Problem
Suggestion
I can access the
camera and get an
image, but the
image is blank/all
black/all white.
Ensure that there is a lens attached to the camera. The imager
cannot function without a lens.
Ensure that the lens cap is off and that there is nothing blocking
the lens. If necessary, unscrew your lens and ensure that there is
nothing inside the lens mount area obscuring the imager.
Note: Do not touch the imager.
Ensure that the lens is in a location that receives at least some
light, but is not in the direct path of a strong light source.
If the lens has an iris, make sure that it is at least partially open.
There are spots/
streaks/horizontal
lines in my images.
Try changing the Image Settings, especially SET/DEFINE
IMAGE LIGHTING FREQUENCY. (See the Image Commands
chapter.)
Check your camera’s lens for dust, scratches, smudges, or other
problems. If necessary, clean the lens with a piece of lens paper.
There is static in my Increase the amount of light in your camera’s environment. Static
most often appears in dark scenes.
images.
Check for electromagnetic interference. Excess interference can
lead to poor image acquisition and/or processing as well as
visible static.
Check your image resolution and compression settings. Lowresolution, high-compression imaging may result in pixellation
or “noise”.
My images are too
red/green/blue.
Adjust the default lighting settings. Set the value to match the
light source that illuminates your camera’s surroundings. If this
value is set improperly, the colors in your image may appear out
of balance.
Try changing the Image Settings, especially the auto color
correction command SET/DEFINE IMAGE LIGHTING AUTO
ENABLED. (See the Image Commands chapter.)
My images are
blurry.
Focus the camera. Refer to Section 3.5 on page 41 for
information.
Fast-moving subjects may appear blurred as a result of imaging
hardware limitations.
Once I connected a Check to make sure that your sensor device is not taking more
than 50 mA of current from the Relay Power Out pin of the
trigger to my
screw terminal. If so, choose a new trigger device.
camera, the camera
no longer functions
properly.
troubleshooting
159
C: Focus Utilities
C.1 Overview
The preferred focus method for IQeye1 and IQeye2 cameras is to use the Focus Window
contained on the camera’s internal Setup page. For IQeye3 cameras, a focusing ring is provided
on the front cap. Several other methods are available for focusing the camera.
•
The LED Focus Utility,
•
The Telnet Focus Utility,
•
The Audible Focus Utility, and
•
The IQeye3 Lens Selection Utility.
C.2 LED Focus Utility
For situations when you must focus the IQeye without having access to a monitor, use the IQeye
Focus Utility. Initiate the camera’s focus utility by inserting the end of a bent paperclip into the
Focus/Factory Reset slot on the back of the camera to depress the button.
Note:
Before pressing the Focus/Factory Reset button, ensure that the camera
is in its normal operating cycle, indicated by the Green “Status” LED
flashing at two second intervals.
Once you initiate the IQeye Focus Utility, the Red “Image Capture” LED on the front of the
camera and the and the Yellow “Link and Activity” LED on the back of the camera will begin
to show focus information. Both LEDs show the same information. While using the focus utility,
if an LED is “on,” your camera is going out of focus. When an LED is “off,” your camera should
be coming into focus. You can verify focus at any time by looking at an image from your camera.
Note:
Do not block the camera’s view while using the IQeye Focus Utility.
1
Completely but gently rotate your lens (or focus-ring) in either direction. The
LED should be lit to show that the lens is out of focus.
2
Slowly rotate your lens (or focus-ring) in the opposite direction until the LED
turns off. This means your lens is near focus.
3
Continue to rotate the lens (or focus-ring) in the same direction as #2 until the
LED turns on again. This is the point at which your lens goes out of focus.
4
Reverse the direction, rotating the lens (or focus-ring) slower than before, until
the LED again turns off and then on.
5
Repeat step 4 above, switching directions and using slower and slower motion,
until there is little movement necessary until the LED turns on.
6
Stop the IQeye Focus Utility by pressing the Focus/Factory Reset button.
Otherwise, the utility will stop after three minutes.
Note:
If the utility stops before your camera is in focus, press the Focus/Factory
Reset button to start the utility again.
focus utilities
160
C.3 Telnet Focus Utility
The Test Focus command initiates the camera’s Telnet Focus Utility. Once you issue the
command, the utility will start to display numbers in your Telnet window. Use these numbers
to properly focus your camera. The utility will stop either when you press any key in the Telnet
window, or after three minutes pass.
To begin the Telnet Focus Utility
1
Telnet to your camera.
2
Become the privileged user.
3
Issue the TEST IMAGE FOCUS command.
Once you issue the TEST IMAGE FOCUS command, your Telnet window will
begin to display lines of numbers that correspond to the camera’s level of focus.
Larger numbers indicate that the camera is closer to being properly focused.
4
Rotate your lens (or focus-wheel) until you maximize the numbers in your Telnet
window.
C.4 Audible Focus Utility
The relay/output on the camera supports a connection to an audible continuity checker. After
connecting an audible continuity checker to the camera, you can focus your camera by listening
to tones.
Note:
Audible continuity checkers, or audible multimeters, are available at
most electronic equipment supply stores.
To attach the continuity checker to the camera, connect the positive and negative wires of the
continuity checker to pins five and six of the camera’s Relay I/O port, as shown below.
1
2
3
5
4
1
2
6
3
4
5
6
Relay Out (Zone + )
Relay Out (Zone - )
Once the continuity checker is properly connected, you must configure the camera’s relay to
open and close according to the Red “Image Capture” LED, which enables the Audible Focus
Utility.
focus utilities
161
To configure the camera’s relay:
1
Telnet to your camera.
2
Become the privileged user.
3
Issue the TEST IMAGE FOCUS command.
Initiate the camera’s focus utility by inserting the end of a bent paperclip into the Focus/Factory
Reset slot on the back of the camera to depress the Focus/Factory Reset button.
Note:
Be certain that the camera is not in its boot process before you press the
button. The camera should be in its normal operating cycle, indicated by
the Green “Status” LED flashing at two second intervals, when you
depress the Focus/Factory Reset button.
Once you initiate the IQeye Focus Utility, the continuity checker should begin to beep. While
using the focus utility, if the continuity checker is making a noise, your camera is going out of
focus. When the continuity checker is silent, your camera should be close to being in focus.
Note:
1
Be sure not to block the camera’s view while using the IQeye Focus
Utility.
Slowly rotate your lens (or focus-ring) as you listen to the continuity checker.
The continuity checker will beep when the lens is going out of focus. As the image
comes into focus, the continuity checker will become silent.
2
Once the continuity checker becomes silent, continue to rotate the lens (or focusring) in the same direction until the continuity checker begins to beep again.
3
Reverse the direction, rotating the lens (or focus-ring) slower than before, until
the continuity checker again turns off then on.
4
Repeat step 3 above, switching directions and using slower and slower motion,
until there is little movement necessary until the continuity checker makes a noise.
Note:
You can verify the focus by looking at an image from your camera.
focus utilities
162
C.5 IQeye3 Lens Selection Utility
The IQeye3 includes a lens selection device that moves the imaging chip toward or away from
the lens as needed to achieve proper focus. As you rotate the focus wheel, the pointer moves,
along with the entire imager assembly.
focus wheel
pointer
CS
C
•
You can achieve near-perfect focus by moving the pointer to the line that corresponds with the
type of lens being used. Some fine-tuning may be needed. For C-mount lenses, ensure that the
pointer is closer to the line marked C before attempting to fine-tune the focus. For CS-mount
lenses, ensure that the pointer is closer to CS before attempting to fine-tune the focus.
Note:
For micro-mount lenses, move the pointer to CS and use the IQinVision
micro-mount adapter.
focus utilities
163
D: Pinouts
The following charts show the pin configurations for each of the three connectors on the IQeye1
camera. Refer to this section for the appropriate Ethernet pin configuration, instructions on
attaching a security sensor to the camera, or instructions on connecting an external modem to
the camera.
The diagrams below appear as they would if you are looking at the IQeye1 with the threaded
camera mount positioned on the bottom of the camera.
D.1 Ethernet Connector
The IQeye1 uses a standard RJ45 Ethernet connector. The pin connections are shown below.
87654321
1 - TX (+)
2 - TX (-)
3 - RX (+)
6 - RX (-)
D.2 Serial Connectors
D.2.1 IQeye1/IQeye2 Serial Connector
The DIN-8 Serial port is used to connect a modem to the camera. Refer to the Modems chapter
for more information about attaching a modem.
2
1
4
3
6
7
5
8
1 - RTS
2 - CTS
3 - TX
4 - GND
5 - RX
6 - DTR
7 - DCD
8 - Ring
pinouts
164
D.2.2 IQeye3 Serial Connector
The DB9 Serial port is used to connect a modem to the camera. Refer to the Modems Chapter
of the Reference Manual for more information about attaching a modem.
1 - DCD
2 - RX
3 - TX
4 - DTR
5 - GND
6 - DSR
7 - RTS
8 - CTS
9 - RING
5
1
6
9
D.2.3 Cable Wiring - IQeye serial to IBM PC comm1
This diagram is provided for convenience only. IQinVision does not make the necessary cable.
IQeye 8-pin mini-Din
male, front view
IBM PC 9-pin “D”
female, front view
5
4
5
1
1
2
8
7
9
3
6
6
9-pin “D”
8-pin mini-Din
CD
1
n/c
RXD
2
3
TX
TXD
3
5
RX
DTR
4
n/c
Gnd
5
4
Gnd
DSR
6
6
DTR
RTS
7
2
CTS
CTS
8
1
RTS
RI
9
n/c
n/c
7
DCD
n/c
8
RI
pinouts
165
D.3 Relay I/O Connector
The screw terminal supports a connection to a security sensor. By adding an ordinary sensor
device to an IQeye camera, you can trigger the camera to operate when a sensor is activated.
6
5
4
3
2
1 - Relay Power Output
2 - Ground
3 - Sensor In (-)
4 - Sensor In (+)
5 - Relay Out (-)
6 - Relay Out (+)
1
The Relay Power Output is normally 12V DC. However, it can be lower than 12V DC if the
input voltage is less than 13V DC. Externally-connected equipment is allowed to pull at most
50mA off the relay power output.
D.4 IQeye3 Iris Connector
The IQeye3 can be used to control the aperture of certain lenses.
2
1
4
3
1
2
3
4
Brake Brake +
Drive +
Drive -
Brake is sometimes referred to as “damp,” “dump,” or “control.” Drive is sometimes referred
to as “iris.”
D.5 IQeye3 Power Connector
The IQeye3 receives its power from a 3-terminal screw terminal.
1
2
3
1 V in 2 Gnd
3 V in +
D.6 IQeye3 Mic In and Audio Out
The IQeye3 can use a microphone connected to the Mic In jack to capture audio and then relay
the audio through the Audio Out jack. Both jacks accept center-positive miniplugs.
pinouts
166
Certifications
FCC compliance and advisory
This equipment has been tested and found to comply with the limits for a Class B digital device
pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection
against harmful interference in a residential installation. This equipment generates, uses, and can
radiate radio frequency energy, and if not installed and used in accordance with the instructions,
may cause harmful interference to radio communications. However, there is no guarantee that
interference will not occur in a particular installation. If this equipment does cause harmful
interference to radio or television reception, which can be determined by turning the equipment
off and on, the user is encouraged to try to correct the interference by one or more of the
following measures:
•
Reorient or relocate the receiving antenna.
•
Increase the separation between the equipment and the receiver.
•
Connect the equipment into an outlet on a circuit different from that to which the receiver
is connected.
•
Consult the dealer or an experienced radio/TV technician for help.
Any changes or modifications not expressly approved by the manufacturer void the user’s
authority to operate the equipment.
Please note: The use of non-shielded interference cable with this equipment is prohibited.
Canadian DOC statement
This digital apparatus does not exceed the Class B limits for radio noise emissions from a digital
apparatus set out in the Radio Interference Regulations of the Canadian Department of
Communications.
Le présent appareil numérique n’émet pas de bruits radioélectriques dépassant les limites
applicables aux appareils numériques de la classe B prescrites dans le Règlement sur le brouillage
radioéletrique édicté par le ministère des Communications du Canada.
UL
This product is intended to be supplied by a Listed Power Source marked “Class 2,” “Limited
Power Source,” or “LPS” and rated 12-33 V DC or 12 - 24 V AC, minimum 300 mA.
certifications
167
Index
A
D
Apropos
automatic lighting correction
129
29, 31
B
bootgateway
BOOTP
bootparams
88, 93
88, 93, 152
127
brightness
21
browser-based configuration
16
C
camera name
117
CDlogout
110
change directory
132
change modes
132
Clear
14
client pull
45
clock
C-mount
color correction
command
display
parameter
114, 127
compression
16
concatenate
131
copy
134
counters
CP
127, 146
137
cropping
38
CS-mount
163
Define
14
DHCP
114
Din-8 serial port
148
Disk commands
CAT (concatenate)
CD (change directory)
CHMOD (change modes)
CP
CP (copy)
DF (free disk blocks)
format
FSCK (FS-check)
LN (link)
LS
LS (list)
MKDIR (make directory)
More
MV (move)
OD (octal dump)
PWD (print working directory)
RM (remove)
RMDIR (remove directory)
Searchpath
SYNC
Sync
129
131
132
132
137
134
135
135
136
136
137
137
137
137
137
139
141
141
141
141
142
137
99
downsample
28, 30
command line editing
13
domain
163
13
13
15
default settings
19
dynamic print
35, 51, 80, 94
external relay
72
file transfer
53
E
F
Finger
Flash
142
130, 135
flip/rotate
focus
LED method
Telnet method
focus wheel
19, 21
41, 160
41
41
163
index
168
Focus/Factory Reset button
160
format
135
FS-check
136
FTP
53, 130
gain
21, 24
incoming connections
disabled
modem
password
Initialize
cancel
delay
factory
noboot
reload
G
gain preference
22
IP address
gain speed
23
IP commands
domain
gateway
IP address
loadhost
nameserver
subnet mask
timeserver
gain window
24, 27
gamma
27
gateway
99
grab.pl Perl script
48
H
hard link
136
Help
143
HTML
link
image hosting
image orientation
image settings
compression
downsample
factory
flip
gain (brightness)
gain preference
gain speed
gain window
gamma
JPEGquality
LED
lighting
lighting auto
lighting bloom
lighting frequency
lighting source
monochrome
overlay
save
sharpen
subwindow
64
47, 50
Java
Servlet
Web Server
165
47
16
19
19
19, 21
21
22
23
24, 27
27
17
28
28
29, 31
30
31, 32
29
32
33, 34, 35, 36, 37
40
37, 38
38
IP segments
JAR package
44
45
19, 21
IP security
99
99
101
101
101
102
102
64
J
I
IBM PC Comm port
117, 130
57
149
61, 117
143, 144
144
144
144
144
144
11, 101, 114, 152
Java Applet
47
47
50
JPEG quality
17
LED control
28
L
lighting
28, 29, 30
lighting frequency
32
links
136
List
list
14
41
125
125
126
128
137
loadhost
101
image
IP
Port
Server
Users
Local>> prompt
12, 59, 152
logging controls
106
login control
57
index
169
enable/disable
passwords
Logout
LS
limit
login
login control
port
privileged
61
56, 61
144, 152
137
Perl scripts
grab.pl script
push.pl script
M
63
56, 61
61
66
56, 58, 59, 63
47
48
48
131, 132
make directory
137
permissions
memory
130
picture-in-picture
modem cable
149
Ping
145
modems
connect
incoming connections
outgoing connections
profile
supported
port access
109
monochrome
148
149
149
148
149
148
32
More
137
power frequencies
31
68
Privileged
12
137
privileged
user
13
motion detector
move
multiple user Java Servlet
multiple user Perl scripts
Port commands
CDlogout
47
N
101
netmask
102
Netstat
145
normally closed switch
normally open switch
O
ports , modem
150
Privileged user
push.pl Perl script
14
123
48
RAM
130
117, 152
R
octal dump
139
RARP
outgoing modem connections
148
Relay I/O
port
output/relay
75
overlay
contents
general
position
33
34, 35, 36
34
36, 37
P
152
59
56, 58, 59, 63
59
152
12
Purge
port
70, 72, 75, 76
70, 72, 76
port security
110
66
privileged mode
default password
override
passwords
prompt
user
47, 48
nameserver
38
Relay I/O FTP
75
69
68
remote console port
57
remove directory
141
remove file
141
retransmit limit
119
parameter
13
Rlogin
passwords
61
ROM
11, 130
130
index
170
S
static IP address
Save
image settings
searchpath
security
sensor
table
serial port
Server commands
bootgateway
BOOTP
clock
DHCP
identification
inactivity timer
incoming
name
RARP
retransmit limit
silent boot
software
startup file
timezone
server push
Java Applet
Set
Dial-in
Dial-out
Modem
Set/Define
IP commands
Logging
Port
Server
Web
sharpness
Show
image
IP
Port
Server
Users
shutter speed
strings
case-sensitive
length
14
41
141
56, 58, 59
69
64
165
subnet mask
102, 152
subwindow
superuser
38
12, 152
Sync
88, 93
88, 93
114
114
116
116
117
117
117
119
119
120
120
121
45
45, 50
14
153
153
152
99
106
109
88, 93
122
38
14
41
125
125
126
128
22, 23
Table, IP security
11, 130, 152
TFTP
120, 146
timeserver
102
timezone
121
Trigger commands
factory
FTP
idletime
input onopen/onclose
output
periodic
pre/post
test input
test output
94
94
71, 72
72
70, 76
73
73
75
77
68, 72
69
69
69
69
trigger event
FTP
hardware
periodic
software
U
UNIX
130
W
watermarks
soft link
136
software
120
working directory
Source
146
120, 146
64
Telnet
Web commands
default page
port
45
137
T
119
startup file
14
14
22, 23
subject motion
silent boot
special web parsing
114
33
122
123
130, 141
Z
Zero (counters)
146
index
171