Unconditionally execute the motion_email_script. This will generally result in an email message being generated (if all of the email settings have been correctly configured).
returns: Binary on success; throws a fault on error.
Transfers a single image as a JPEG.
Immediately after a change in the image geometry (x, y, width, and/or height) one should apply a delay of 2*(1/framerate) to issue the next image request. Otherwise, the image command may fail with an error.
returns: Binary on success; throws a fault on error.
Transfers a single image in Abekas YUV format. number_of_buffers_raw must be set to a value greater than 2 or the camera must be stoped for this function to be successful.
number_of_buffers_raw must be set to a value greater than 2 or the camera must be stoped for this function to be successful.
returns: Binary on success; throws a fault on error.
When raw_mode is enabled, this function provides access to the raw pixel data from the imager. Each 12 bit pixel is stored in 2 bytes LSB first, and the pixels are arranged in the imager's Bayer pattern.
number_of_buffers_raw must be set to a value greater than 2 or the camera must be stoped for this function to be successful.
returns: Binary on success; throws a fault on error.
Transfers a single sub-image in Abekas YUV format by default or optionally in YUY2 format. For this function to work, number_of_buffers_raw must be set to a value larger than 2.
Returns the content of /proc/uptime
Returns a string describing the camera hardware and software. This includes the camera name, firmware version, and firmware build date.
Stops the image processing pipeline in the camera.
Starts the image processing pipeline in the camera.
Change the size and position of the image. Width must be a multiple of 32, height a multiple of 8, and x and y must be even. If a value of -1 is specified for a parameter, the current value is maintained.
This function is retained for backwards compatibility reasons. Instead of using this function, you may use the 'set' function to set the subsampled, width, height, x and y properties simultaneously.
Causes a single strobe to occur on the GPIO output. output_select should be set to 'alarm' or 'on' or 'off' or side effects may occur.
Reboots the camera. The camera will be incommunicando for approximately 30 seconds until it has finished rebooting.
Saves the current camera settings to non-volatile memory. The settings may be saved to a user-defined filename so that they may be reloaded via load_settings, or the special filename 'persistent' may be used. The special filename 'persistent' defines the set that will be automatically loaded by the camera when rebooted.
Loads camera settings from a file in non-volatile memory. The filename can be any arbitrary name that was created using 'save_settings' or one of two special filenames.There are two special filenames that may be useful. The two special filenames are:'persistent' and 'factory_defaults'. The filename 'persistent' specifies the current power on defaults, and 'factory_defaults' specifies the settings with which the camera shiped.
Setting a parameter that does not exist results in an error. This command lets you add parameters to the system. By using save_settings, these parameters can be save across camera reboots. This function allows a user to save user defined parameters on the camera. Once parameters have been added to the camera, the set command can be used to change their value
This command returns an array of parameter/value pairs representing all of the current settings in the camera. Each parameter/value pair is separated from the next pair by the user definable delimeter string.
Sets multiple properties in a single call. This has the same effect as calling set with each parameters. Each parameter name/value pair must be separated from the next pair by the user defined delimeter. The first equals sign in a name/value pair separates the name from the value. It's legal for the value to contain equals signs.
Care must be taken when doing a transfer. It's recommended that the delimeter not contain CRLF as text translation may occur. If using the CGI interface or the command line, standard URI escapes are used.
Sets multiple properties in a single call. This has the same effect as calling set with each parameters. It is different from put_settings in that it only sets the properties and does not ake any action for the properties. Each parameter name/value pair must be separated from the next pair by the user defined delimeter. The first equals sign in a name/value pair separates the name from the value. It's legal for the value to contain equals signs.
Care must be taken when doing a transfer. It's recommended that the delimeter not contain CRLF as text translation may occur. If using the CGI interface or the command line, standard URI escapes are used.
Like put_settings this sets multiple properties in a single call. However this function gets the settings from an existing property. For example, the default_image_params property contains a set of parameter name/value pairs that will reset the camera's image parameters. Using the add_parameter command, additional custom property sets could be created that would store small sets of parameters. This command provides a way to apply those sets to the camera.
This is a very useful command. If you inadvertently mess up your camera settings, just issue the command 'put_settings_from_property default_image_params' and the camera will be restored. This would be similar to 'load_settings factory_default' except that none of the network settings would be affected.
For Canon lenses only, put the iris full open and synchronize the aperture control of the lens.
Sends a ptz command to the controller board via the serial console.
Sends a ptz command to the controller board via the serial console.
Transfers a stream of JPEG images.
Immediately after a change in the image geometry (x, y, width, and/or height) one should apply a delay of 2*(1/framerate) to issue the next video request. Otherwise, the image command may fail with an error.
Transfers an image or a stream of JPEG images to an ftp server.
Immediately after a change in the image geometry (x, y, width, and/or height) one should apply a delay of 2*(1/framerate) to issue the next ftp_images request. Otherwise, the image command may fail with an error.
Stops an ftp stream
Returns true if an asynchronous stream is running, false otherwise. It also returns true if the stream has produced an error, but will be retried. In this case, ftp_stream_last_error will return the value of the last error.
Returns the last error, if any, from an asynchronous stream. This stream may or may not still be running.
Stops all ftp streams
Transfers an image or a stream of JPEG images to a udp client.
Immediately after a change in the image geometry (x, y, width, and/or height) one should apply a delay of 2*(1/framerate) to issue the next udp_stream request. Otherwise, the image command may fail with an error.
Stops any udp streams
Stops any udp streams
boolean
Enable and disable motion detection alarms. Motion is defined as a minimum number of pixels changing (motion_alarm_area) by a minimum amount (motion_sensitivity) in a specified area (motion_map). The area of interest is a grid of rectangular areas. Each area can be independently enabled or disabled. Only enabled areas will be tested for motion.
boolean
Enable and disable IO IN detection alarms. IO IN detection is affected by io_in_debounce_time, io_in_trigger_edge, io_in_trigger_neg.
boolean
Trigger IO IN on edge rather than level. IO IN triggering is enabled by io_in_alarm_enable.
boolean
Trigger IO IN on negative level or negative-going edge rather than positive level or positive-going edge. IO IN triggering is enabled by io_in_alarm_enable.
int
Set the IO IN trigger debounce time in milliseconds. IO IN triggering is enabled by io_in_alarm_enable.
boolean
Enable and disable motion detection alarms via email. Motion is defined as a minimum number of pixels changing (motion_alarm_area) by a minimum amount (motion_sensitivity) in a specified area (motion_map). The area of interest is a grid of rectangular areas. Each area can be independently enabled or disabled. Only enabled areas will be tested for motion.
string
This is the script that is executed when a motion alarm is detected. The default value of this script uses the additional parameters motion_email_subject, motion_email_server, motion_email_recipient and alarm_delay to create and send an email message when motion is detected. If you wish to modify the body of the message, take additional actions or include variable parameters in the subject line, you can modify this script directly.
string
If you are using the default motion_email_script, this is the subject that is used when a motion detection alarm email is sent.
string
If you are using the default motion_email_script, this is the server that is used to send the emails.
string
If you are using the default motion_email_script, this is the email address that receives motion detection alarm emails.
int
Alarm notifications will not occur more often than once every alarm_delay seconds.
boolean
Enable and disable motion detection alarms via ftp.
string
This is the target server that will receive FTP alarm files.
string
This is the target user on the alarm_ftp_server that will receive FTP alarm files.
string
This is the password of the alarm_ftp_user account that will receive FTP alarm files.
string
This is the pathname to store the FTP alarm files. This parameter may include timestamps. See
ftp_images for more details.
double
The number of seconds worth of images from before an alarm that should be transferred when an alarm is triggered. The maxmimum value for this parameter is related to number_of_buffers and the global framerate.
double
The number of seconds after an alarm to transfer images to the ftp server.
boolean
If set, use passive mode FTP for transferring the alarm files.
double
The framerate of the stream desired. If this value is larger than the camera's current framerate, images will be transferred as fast as the camera can generate them, assuming sufficient network bandwidth is available.
boolean
Enable and disable motion detection alarms via udp.
If enabled, when an alarm occurs, a UDP packet is sent to alarm_udp_client on alarm_udp_port. The packet is in human readable format using CRLF as the separator:
To acknowledge the alarm packet, send a UDP packet containing the event number in human readable format to the source address and port of the alarm packet. If not acknowledged, the alarm packet will be resent at one second intervals, to a maximum of three packets.
string
This is the comma-separated list of target client addresses that will receive UDP alarm packets. Errors appear in /var/log/messages. Each client address can take an optional appended port number, delimited by a colon.
If this address is the broadcast address for the subnet, the alarm is broadcast.
int
This is the default target client port that will receive UDP alarm packets. Errors appear in /var/log/messages.
string, read-only
*
The date and time of the last alarm trigger. It is a text-formatted date in ISO8601 format. If no alarm has occurred since boot, the value will be "none".
string, read-only
Returns a string describing the bootloader version.
string
The timezone, in standard Unix (SUSv2) format. Some examples follow.
JST-9 This means that Japanese Standard Time (JST) is 9 hours later than Coordinated Universal Time (UTC) and does not have daylight saving time.
MST7MDT This means that Mountain Standard Time (MST) is 7 hours earlier than Coordinated Universal Time (UTC). Both standard time and daylight saving time apply to this locale. By default Mountain Daylight Time (MDT) is one hour ahead of MST.
NST3:30NDT2:30 This means that Newfoundland Standard Time (NST) is 3.5 hours earlier than Coordinated Universal Time (UTC). Both standard time and daylight saving time apply to this locale. Newfoundland Daylight Time is 2.5 hours earlier than Coordinated Universal Time (UTC).
string
Get the current date in RFC 2822 format. Example: Mon, 10 Nov 2003 15:48:06 -0500
string, read-only
Get the current UTC date in RFC 2822 format. Example: Mon, 10 Nov 2003 15:48:06 +0000
boolean, read-only
Returns the state of the push button switch attached to the camera.
boolean
Controls the orange LED on the network connector. Setting to a one (led=1) turns the LED on. The current state of the LED may also be read using the get command.
string
The type of the test pattern to be used when test_pattern is set. The possible values are "static" and "moving".
boolean
Enable or disable the camera test pattern. If the test_pattern=1, then a diagonal, repeating, gray scale gradient will be output from the camera. motion_gap must be set to 0 for the test_pattern to function correctly.
boolean, read-only
True if the frame grabber is converting images into JPEGs. If a stop command is executed, this will return 0.
boolean, read-only
True if the sensor is a mono imager, false if it is color.
double
The amount of time that the entire image exposes simultaneously.
double, read-only
The frame rate of the camera. This may be affected by the image width, height, exposure and maximum_exposure. Network bandwidth may also affect perceived framerate independent of this parameter.
double
The camera's maximum framerate, set to 0 to disable. width, height and exposure also implicitly define other maximum framerates, so framerate may be less than maximum_framerate.
string
The output pin internal connection. Valid settings:
on: current can flow through the output connection
off: output transistor is turned off
alarm: strobe output when alarm occurs
start_of_readout: strobe output when imager starts transferring data to the CODEC.
strobe: strobe output when imager signals that all pixels are being exposed. This is the appropriate setting to use for external strobe lighting.
watchdog_ping: strobe output when watchdog_ping fails.
double
The amount of time in milliseconds that the output is on during strobe or an alarm.
double
Frequency of the light in Hz. 60 is typical in North America, 50 in Europe, 0 for sunlight or DC lighting. This parameter limits the exposure time to a multiple of a single cycle time (16.66ms for 60Hz, 20.0ms for 50Hz). This prevents dark and light bands from appearing in the image. If the camera is placed indoors and any type of gas discharge lighting (fluorescent, HID, etc.) is used, this parameter should be configured.
double
This parameter limits the gain when in autogain mode. High gains result in brighter images, but also create noisier images. Compression algorithms do not like noisy images: for a fixed jpeg_quality, a noisier image is larger.
double
If both autoexposure and autogain are set, the camera may adjust luminance by adjusting either exposure or gain. The algorithm's primary guidance is that it prefers settings with exposure less than autoexposure_knee and gain less than autogain_knee. Secondarily, it prefers to lower the gain rather than lower exposure, and it prefers to raise exposure rather than raise gain.
If set to zero (0), this parameter has the special meaning 'the maximum exposure that does not slow down the frame rate'.
double
If both autoexposure and autogain are set, the camera may adjust luminance by adjusting either exposure or gain. The algorithm's primary guidance is that it prefers settings with exposure less than autoexposure_knee and gain less than autogain_knee. Secondarily, it prefers to lower the gain rather than lower exposure, and it prefers to raise exposure rather than raise gain.
double
The luminance target. If autoiris or autoexposure or autogain are enabled, the camera will adjust the iris diameter and/or exposure and/or gain to achieve an image with a luminance at or near the autoexposure_target value. The luminance will be calculated using the auto_algorithm parameter.
double
This is the default luminance target value when auto_algorithm is set to dark
double
This is the default luminance target value when auto_algorithm is set to average
double
This is the default luminance target value when auto_algorithm is set to median
double
This is the default luminance target value when auto_algorithm is set to peak
string
This property selects one of several factory whitebalance configurations pre-tuned for common scenes. The available presets are default, fluorescent, daylight, wide, and user.
string
This parameter can be one of four values (average, peak, median, dark).
The value of the parameter defines how the luminance value for the image is
calculated. If auto_algorithm=average, the luminance is calculated as the mean
brightness of the whole auto control window. If auto_algorithm=peak, the
luminance is calculated using only the brightest areas of the auto control
window. If auto_algorithm=median, the luminance is calculated as the median
brightness of the whole auto control window. If the auto_algorithm=dark, the
luminance is calculated using only the darkest areas of the auto control
window. See auto_window_enable, auto_width, auto_height, auto_x, auto_y for information on
defining the auto control window.
boolean
Enable or disable the auto exposure functionality. If autoexposure is enabled (autoexposure=1), then the camera will attempt to adjust the exposure to match the requested luminance (autoexposure_target) using the currently specified algorithm (auto_algorithm). The camera will also use the lighting_frequency parameter to limit the exposure value to certain values. If autoexposure is disabled (autoexposure=0), the exposure time is strictly controlled by the value of the exposure parameter. Also see the autogain parameter, which can automatically adjust the gain of the imaging sensor instead of, or in addition to, the exposure time.
boolean
Enable or disable the auto iris functionality. If autoiris is enabled, if the exposure drops below minimum_exposure, then the camera will attempt to adjust the aperture of a lens with DC iris control to acheive the requested luminance (autoexposure_target) using the aperature setting to try and achieve the desired luminance as specified by the autoexposure_target. If this cannot be achieved due to low light conditions, the autoexposure and autogain functionality is triggered assuming that they are enabled.
double
This parameter specifies the JPEG quality level using a value between 0.2 and 100. 100 gives very large, high quality files, and 0.2 gives the smallest possible files. This value is used as recommended by the Independent JPEG group and specified in RFC 2435. This is exactly the same function as the compression parameter. When auto_jpeg_quality is set, this is a read only parameter. Setting the value too high may cause frames to be lost to buffer size overflows, network bandwidth limitations or image complexity errors.
double
This parameter specifies the JPEG quality level using a value between 0.2 and 100. 100 gives very large, high quality files, and 0.2 gives the smallest possible files. This value is used as recommended by the Independent JPEG group and specified in RFC 2435. This is exactly the same function as the jpeg_quality parameter. When auto_jpeg_quality is set, this is a read only parameter.
boolean
The median filter is used to filter hot pixels in an image. This is typically
used in high gain situations arising from low-light settings. It compares
each pixel to its neighbors to determine if it is representative of its
surroundings. If not, it will replace the value of the pixel by the mean of
its neighbours.
int, read-only
This parameter specifies the amount of SDRAM that has been initialized.
double
Increasing the gain increases the brightness of the image, which can help in low light conditions; however, a higher gain also substantially increases the noise in the image. Noisy images compress poorly. It is recommended that this value be kept as low as possible. Gain may be adjusted from 1 to at least 75 depending on your camera model. This parameter has only a very temporary effect if autogain is on.
boolean
Enable or disable the autogain circuitry. [The autogain target may be set using the exposure command.] If autogain is enabled (autogain=1). The autogain circuitry will adjust the gain of the sensor in an attempt to match the requested luminance (autoexposure_target), using the currently specified algorithm (auto_algorithm). Unlike the autoexposure function, exposure and lighting_frequency have no effect on the autogain. If autogain is disabled (autogain=0), the gain is strictly controlled by the value of the gain parameter. Also see the autoexposure parameter, which can be used instead of, or in addition to, the autogain parameter. If both autoexposure and autogain are enabled, then the system gives priority to keeping the gain low. If the image needs to be brighter, exposure will be increased first. If the image needs to be darker, then gain will be lowered first.
double
This parameter provides manual control of the red channel gain. See the whitebalance command.
double
This parameter provides manual control of the blue channel gain. See the whitebalance command.
double
This parameter provides manual control of the green channel gain. See the whitebalance command.
double
The maximum value for gain_red.
double
The minimum value for gain_red.
double
The maximum value for gain_green.
double
The minimum value for gain_green.
double
The maximum value for gain_blue.
double
The minimum value for gain_blue.
string
This parameter specifies the current whitebalance algorithm: single, continuous or off. If whitebalance is off (whitebalance="off"), then each color channel's gain is controlled manually (gain_red, gain_blue, gain_green). If whitebalance is set to single (whitebalance="single") then exactly one whitebalance correction is performed when the whitebalance parameter is set. Multiple calls to set whitebalance to "single" will cause multiple corrrections. If whitebalance is set to continuous (whitebalance="continuous") then the color channel gains will be continuously adjusted to keep the image's whitebalance correct.
double
This parameter limits the exposure when in auto exposure mode. If the target is moving, long exposures may cause the image to blur. As well, long exposures have an impact upon frame rates: the frame rate is limited to 1/maximum_exposure. If set to zero (0), this parameter has the special meaning 'limit the camera to exposures that do not slow down the frame rate'.
double
This parameter is part of the auto DC iris control feature.
if autoexposure=0 this parameter is ignored.
if autoiris=1 and autoexposure=1 this parameter is used as the lower limit for the exposure value. Where the scene brightness forces image luminance above the Target Luminance and where this would require a lower exposure time than the value in the Minimum Exposure parameter, the Autoiris feature will attempt to use the DC Iris lens to achieve the Luminance Target (autoexposure_target). If no DC Iris lens is attached, the Minimum Exposure will be limited to this value and image luminance may increase beyond the target.
int
Retrieve or set the current height of the image. This must be a multiple of 8, if it is not a multiple of 8, the camera will round down to the next lowest multiple of 8. The minimum value is 16.
int
Retrieve or set the current width of the image. This must be a multiple of 32, if it is not a multiple of 32, the camera will round down to the next lowest multiple of 32.
int
Retrieve or set the current horizontal offset of the image, from the left edge of the sensor. This must be an even number, if it is not, the camera will round down.
int
Retrieve or set the current vertical offset of the image, from the bottom of the sensor. This must be an multiple of 8, if it is not, the camera will round down.
int
Retrieve or set the current image downsampled setting. This specifies the number of pixels that should be skipped for each pixel that is displayed. Can be adjusted through the window command. On LE165 cameras, subsampled can be 0, 1, 2 or 3 and on all other camera variants, subsampled can be 0, 1, 3 or 7.
On LE165 cameras, subsampling is done via binning: adjacent pixels are summed, resulting in increased sensitivity. This operation also affects the color response, resulting in less saturated images.
Unless specified, the height parameter is independent of the subsampled value. For LE165 cameras, each subsampled value greater than 0 needs a specific and immutable value for the height parameter. These subsampled, height values pairs are subsampled=1,height=512; subsampled=2,height=336; subsampled=3,height=248.
int, read-only
The maximum width supported by the imager.
int, read-only
The maximum height supported by the imager.
int, read-only
The maximum subsampling factor supported by the imager. The number returned is the number of pixels skipped for every one displayed. The ratio between no subsampling and max subsampling would then be 1/(1+max_subsample)
double, read-only
The current luminance value expressed as a percentage of full bright. This parameter is affected by the settings for auto_x, auto_y, auto_width, and auto_height.
double
The current exposure value being used by the imager. If autoexposure is off, this parameter sets the current exposure.
int
The number of JPEG images the rolling buffer can hold. This is inversely proportional to jpeg_buffer_size. If it is set higher, the imager may appear to go off-line until the jpeg_quality is notched down enough to fit into jpeg_buffer_size. Changes to this parameter only take effect on a reset. The maximum value of this parameter depends on the setting for number_of_buffers_raw. If auto_jpeg_quality is set to off, raising the number_of_buffers may make images temporarily unavailable until the image content is simplified, or the jpeg_quality is lowered. It is recommended to turn on auto_jpeg_quality.
int
The number of images the raw rolling buffer can hold. This must be set to a number larger than 2 for the image_raw or image_yuv functions to take effect. Changes to this parameter only take effect on a reset. The maximum value of this parameter depends on the setting for number_of_buffers.
int, read-only
The maximum size of each image in the rolling buffer. This is inversely proportional to number_of_buffers.
boolean
If enabled, jpeg_quality is automatically adjusted to keep the file size between max_jpeg_size and min_jpeg_size. The file size is also kept below projected_network_bandwidth/min(projected_network_framerate, framerate).
int
The maximum jpeg size used by the auto_jpeg_quality algorithm is min(max_jpeg_size, projected_network_bandwidth/min(projected_network_framerate, framerate)).
If set to the special value of 0, max_jpeg_size will be set to jpeg_buffer_size.
int
The maximum jpeg size used by the auto_jpeg_quality algorithm is min(max_jpeg_size, projected_network_bandwidth/min(projected_network_framerate, framerate)).
int
The maximum jpeg size used by the auto_jpeg_quality algorithm is min(max_jpeg_size, projected_network_bandwidth/min(projected_network_framerate, framerate)).
int
The minimum desired jpeg size for use with auto_jpeg_quality.
boolean
When in raw mode, the JPEG codec is turned off, and the raw imager data may be accessed using the image.raw (aka image_yuv command)
double
The sensitivity of each pixel in the motion circuitry. Values from 0 to 100 are valid, with 100 being the most sensitive, meaning that the pixel has to change by the least amount to be counted as a "changed pixel".
double
The percentage of the pixels in the motion detection area that must be "changed pixels" before a motion alarm is triggered.
int
The delay between frames being evaluated for motion detection. This value may be between 0 and 255, and is measured in frames. If this parameter is set too low, objects that are moving slowly may not get captured. If this parameter is set too high, fast objects that can move through the region of interest during the skipped frames may be missed.
double
The delay between frames being evaluated for motion detection. This value is measured in milliseconds and may be between 0 and 255 frames. If this parameter is set too low, objects that are moving slowly may not get captured. If this parameter is set too high, fast objects that can move through the region of interest during the skipped frames may be missed.
double, read-only
*
The percentage of pixels in the motion detection area that detected movement at the moment of the last alarm. This is a reading of how much motion was detected in the enabled areas of the motion map.
int, read-only
*
The x location of the centroid of motion in the detection window during the last alarm. Note that the centroid can be located in a non-enabled area. For example, if the only enabled rectangles are the four corners of the imager and each corner registers motion at the same time, the centroid of the motion would be near the center of the imager which would not be inside of any of the four corner's rectangular areas.
int, read-only
*
The y location of the centroid of motion in the detection window during the last alarm. For example, if the only enabled rectangles are the four corners of the imager and each corner registers motion at the same time, the centroid of the motion would be near the center of the imager which would not be inside of any of the four corner's rectangular areas.
double
The width of the motion_map. The motion map is a grid of rectangles overlayed on the imager. Each rectangle can be enabled or disabled. This parameter specifies the width of the grid (NOT the width of each rectangle in the grid).
The width of each rectangle in the grid is if motion_map_windowed=false is width/motion_map_width, sampled to a multiple of 4. If motion_map_windowed=true, the width in pixels is max_width/(subsampled+1)/motion_map_width, sampled to a multiple of 4.
If the pixel width does not round evenly to 4, the map will be sampled such that partially covered grids will be fully in the motion map rather than fully out of the motion map.
The maximum value for motion_map_width is the lessor of 256 max_width/(subsampled+1)/4.
double
See motion_map_width.
string
This parameter specifies which of the rectangles in the map are enabled and which rectangles are disabled. The motion map is a grid of motion_map_width by motion_map_height that is superimposed on top of the current viewing window (or the entire image sensor if motion_map_windowed is true). Each grid rectangle is either enabled or disabled. The map is specified as a string of hexadecimal digits, each bit corresponding to a single grid location. The most significant bit is the top left grid location and the least significant bit is bottom right grid location. For example, if the grid was 4x4, then all enabled would be FFFF, a checker board pattern with the top left enabled would be A5A5, the first column enabled would be 8888.
boolean
If true, motion_map covers the entire visible and non-visible areas of the image sensor. Only the visible areas are used for motion detection. For example, if only one quarter of the sensor was visible, one quarter of the motion_map is used. This is the recommended setting; however, for backwards compatibility issues, the default is off.
If false, motion_map applies to the current viewing window. If you change the viewing window, the motion detection grid also changes.
boolean
If enabled (show_motion_windows=1), the motion windows are shown as a light gray overlay on the image. Note that show_motion_windows and show_motion_detected may not be set simultaneously.
boolean
If enabled (show_motion_detected=1), the motion detected image is shown as a white overlay on the ghosted image. Note that any Frame Comparison Delay motion_gap that is set while this is enabled will affect system framerate and rtp_framerate. It will also affect the images sent by all methods. It is intended to be used only as a setup and calibration tool. Note that show_motion_windows and show_motion_detected may not be set simultaneously.
boolean
If true, auto_x, auto_y, auto_width and auto_height are used. If false, the entire visible region is used for autoexposure, autogain and whitebalance calculations.
int
The horizontal offset of the "auto window" from the left edge of the current viewing window. The auto window defines the area that is used by the auto_algorithm when calculating autoexposure, autogain and whitebalance. This window is relative to the current viewing window. Also see auto_y, auto_width, auto_height. This property may be disabled with auto_window_enable
int
The vertical offset of the "auto window" from the bottom edge of the current viewing window. The auto window defines the area that is used by the auto_algorithm when calculating autoexposure, autogain and whitebalance. This window is relative to the current viewing window. See auto_x, auto_width, auto_height. This property may be disabled with auto_window_enable
int
The width of the "auto window". The auto window defines the area that is used by the auto_algorithm when calculating autoexposure, autogain and whitebalance. This window is relative to the current viewing window. See auto_x, auto_y, auto_height. This property may be disabled with auto_window_enable
int
The height of the "auto window". The auto window defines the area that is used by the auto_algorithm when calculating autoexposure, autogain and whitebalance. This window is relative to the current viewing window. See auto_x, auto_y, auto_width. This property may be disabled with auto_window_enable
string
This property specifies the color correction matrix. This correction is applied after color gains and whitebalance. Available values are "unity", "default", "chip_default", "fluorescent", "daylight", "incandescent", "xenon_flash" and "halogen".
string
This property specifies the RGB->YCbCr color conversion matrix. This is applied after color gains and whitebalance. Available values are "yuv", "709", and "601".
double
The saturation parameter is a value between -100 and +100 that adjusts the amount of color in the image.
The value input here corresponds to the slope of the transform applied the color (Cb and Cr) components of the image. Saturation of 0 gives a slope of 1 meaning no change from the input, 100 gives 2 (saturated), -50 gives 1/2 (less saturated), and -100 gives 0 (no saturation - a grey scale image).
double
The slope of the transform applied the image's Y component. This is similar to contrast, except that the slope is centred at black rather than being centred at gray. In other words contrast makes dark pixels more black and white pixels more white whereas intensity brightens every pixel.
double
The contrast parameter is a value between -100 and +100 that adjusts the amount of contrast in the image.
The value input here corresponds to the slope of the transform applied the intensity (Y) component of the image. Contrast of 0 gives a slope of 1 meaning no change from the input, 50 gives 2 (more contrast), 100 gives infinity (maximum contrast), -50 gives 1/2 (less contrast), and -100 gives 0 (no contrast - no change in intensity across the image). Compare with intensity.
double
The brightness parameter is a value between -256 and 256 that adjusts the brightness level of the image. Technically, this is the offset of the transform applied the image's Y component. The valid range for brightness is -256 to +256. A brightness of 256 would give a completely white image, while a brightness of -256 would give a completely black image.
double
Gamma is similar to brightness, but doesn't change the maximums or minimums. Gamma causes the mid-tone brightness to increase or decrease. Technically, this is done by adding a power component to the image's intensity (Y) component - specifically y_new = ((y/255.0) ^ (1.0/gamma)) * 255.0. The range is limited to 0.01 to 100, but the useful range is much smaller, and is roughly centered around 1.4
double
The width of the privacy_map. The privacy map is a grid of rectangles overlayed on the imager. Each rectangle can be enabled or disabled. This parameter specifies the width of the grid (NOT the width of each rectangle in the grid).
The width of each rectangle in the grid is max_width/(subsampled+1)/privacy_map_width, sampled to a multiple of 4. If it does not round evenly to 4, the map will be sampled such that partially covered grids will be fully covered rather than fully exposed.
The maximum value for privacy_map_width is the lessor of 256 max_width/(subsampled+1)/4.
double
See privacy_map_width.
string
This parameter specifies which of the rectangles in the privacy map will be hidden. The privacy map is a grid of privacy_map_width by privacy_map_height that is superimposed on top of the entire sensor. Each grid rectangle is either enabled or disabled. The map is specified as a string of hexadecimal digits, each bit corresponding to a single grid location. The most significant bit is the top left grid location and the least significant bit is bottom right grid location. For example, if the grid was 4x4, then all enabled would be FFFF, a checker board pattern with the top left enabled would be A5A5, the first column enabled would be 8888. The setup crosshairs may be obscured by the privacy map.
boolean
Enable/disable privacy_map.
boolean
Enable/disable crosshair for camera setup. The privacy_map may have to be temporarily disabled to for the crosshair to be visible.
string
boolean
If set, the image is mirrored from left to right.
boolean
If set, the image is mirrored from top to bottom.
string
This parameter sets the hardware built-in edge enhancement property. The current valid values are "default", "alternate", "high" and "off".
string
This property contains a list of default image parameters that can be used via put_settings_from_property. This will set the camera image parameters back to the factory default state without affecting non-image parameters.
double
The frame rate of the camera. This may be affected by the image width, height, exposure or maximum_exposure. Network bandwidth may also affect perceived rtp_framerate independent of this parameter.
int, read-only
The amount of free RAM available to the operating system (in kilobytes).
int
The position of the infrared filter shuttle. True indicates "night" mode, with the IR filter removed.
boolean
Enable an on-screen timestamp in the image. Can be used with image_text to label the output.
string
Set the text that is used with timestamp_enable in the image overlay. This text is limited to 15 characters. Upper case alphabet, numbers and most punctuation are implemented, with the exception of tilde, vertical bar and curly braces.
int
Activate the stabilizer in the Canon Lens by set as 1. Once the stabilizer is activated, it can not be deactivated by software.
int
This parameter indicates if the camera is operating at normal light(day) mode or low light(night) mode. It is set by the camera everytime the camera switches from one mode to another. The user can explicitly set this parameter, which will cause the corresponding day or night settings to be applied.
int
Retrieve or set the current focus. This is a unitless number with absolute range of 0 to 32767, but may be more restricted by the startup position of the focus.
int
Retrieve the current focus minimum. This is a unitless number with absolute range of 0 to 32767, but may be more restricted by the startup position of the focus.
int
Retrieve the current focus maximum. This is a unitless number with absolute range of 0 to 32767, but may be more restricted by the startup position of the focus.
int, read-only
Retrieve the H/W detected minimum focus limit, if found. This is a unitless number with absolute range of 0 to 32767, but may be more restricted by the startup position of the focus.
int
Retrieve the H/W detected maximum focus limit, if found. This is a unitless number with absolute range of 0 to 32767, but may be more restricted by the startup position of the focus.
double, read-only
Retrieve the H/W detected focal length of the lens, if found. This is in mm, assuming a 35mm image plane.
string
The type of the iris that is installed on the camera. Valid values are "none", "dc", "calibrated". The calibrated iris value is set with the aperture parameter and the limits are set with the aperture_min and aperture_max parameters.
double
Retrieve or set the current aperture of a calibrated iris lens. For Canon lenses, it is read from the lens; if the lens is not attached or improperly connected, it returns -1. This must be a between aperture_min and aperture_max.
double
Retrieve or set the soft minimum aperture of the lens. This must be a positive number between aperture_hw_min and aperture_hw_max, likely between 4.0 and 22.0.
double
Retrieve or set the soft maximum aperture of the lens. This must be a positive number between aperture_hw_min and aperture_hw_max, likely between 4.0 and 22.0.
double
Retrieve or set the physical minimum aperture of the lens. For Canon lenses, it is read from the lens; if the lens is not attached or improperly connected, it returns -1. For other lenses, this must be a positive number, likely between 4.0 and 22.0 that should be input from the lens specifications.
double
Retrieve or set the physical maximum aperture of the lens. For Canon lenses, it is read from the lens; if the lens is not attached or improperly connected, it returns -1. For other lenses, this must be a positive number, likely between 4.0 and 22.0 that should be input from the lens specifications.
string
The expression to use to determine whether the low level light criteria hold. If the expression evaluates to 'true' or !=0 for more than low_light_stable_duration seconds (once per second) in a row, then the parameter settings low_light_settings will be put into effect.
The expression is phrased using the usual arithmetic symbols ('+', '-', '*', '/', '%') plus the comparison operators equals '=', less than '<', greater than '>', less than or equal to '<=', greater than or equal to '>=', not equal to '!=' and conjunction (and) '&' and disjunction (or) '|' boolean operators. The exposure, low_light_exposure_threshold, gain, low_light_gain_threshold, luminance and low_light_luminance_threshold values are available for comparison by name.
The expression elements must be separated by at least 1 space.
The expressions are sampled once per second.
double
The time in seconds that the test in low_light_criteria must continuously hold before low_light_settings will be put into effect.
string
This is a set of parameter and value pairs to be applied when the camera switches to low-light mode. The settings are provided as a semicolon seperated list. For example "saturation=0;gain=2;" might be a useful value for this parameter. The camera uses low_light_criteria and low_light_stable_duration to determine when to switch modes.
string
The expression to use to switch into normal light mode from low light mode. See low_light_criteria for details.
double
The time in seconds that the test in normal_light_criteria must continuously hold before normal_light_settings will be put into effect.
string
This is a set of parameter and value pairs to be applied when the camera switches out of low-light mode. The settings are provided as a semicolon seperated list. See low_light_settings.
double
This is a value that is passed into the normal_light_criteria and low_light_criteria expressions. It is provided largely to provide compatibility with previous camera software revisions which had a hardcoded low_light_criteria.
double
This is a value that is passed into the normal_light_criteria and low_light_criteria expressions. It is provided largely to provide compatibility with previous camera software revisions which had a hardcoded low_light_criteria.
double
This is a value that is passed into the normal_light_criteria and low_light_criteria expressions. It is provided largely to provide compatibility with previous camera software revisions which had a hardcoded low_light_criteria.
string, read-only
The camera's current IP address
string, read-only
The camera's current IP subnet mask
string, read-only
The camera's current broadcast address
string
This is the IP address the camera will have after the next reboot if DHCP is disabled (use_dhcp=0).
string
This is the subnet mask the camera will have after the next reboot if DHCP is disabled (use_dhcp=0).
string, read-only
The gateway currently being used.
string, read-only
The nameserver currently being used
string, read-only
The fully qualified domain name. If both name and dns_domain_name are set (and the camera has been rebooted so that these parameters have taken effect, then this is simply name.dns_domain_name. Otherwise, this is obtained by asking the nameserver.
string
This is the nameserver the camera will use after the next reboot if DHCP is disabled (use_dhcp=0).
string
The DNS domain name used by the camera. If this is the null string, then the fully qualified domain name (current_fqdn) is determined dynamically by looking up the camera name in the DNS server (nameserver). This property may be set by the DHCP server.
string
This is the gateway the camera will use after the next reboot if DHCP is disabled (use_dhcp=0).
boolean
Enable/disable DHCP. If use_dhcp=1, on the next boot, the camera will attempt to obtain it's network settings from a DHCP server.
string
This is the IP address the camera will have if DHCP is enable but no address information is received before the DHCP timeout. If this value is empty, and DHCP times out, then no IP address will be set.
int
The amount of time, in seconds, the camera should wait for network settings from a DHCP server.
string
Enable/disable the link local address. If set (use_link_local=1), then after the next reboot, the camera will be configured with a link local address.
string
The camera's Ethernet MAC address. This parameter is writeable if and only if the current MAC address is empty. This is used by the factory to set the MAC address. To users, this is a read-only string, identical to the MAC parameter.
string, read-only
The camera's Ethernet MAC address
boolean
1 enables and 0 disables the telnet daemon.
string
A list of ntp (network time protocol) servers as a whitespace seperated list. Set to a null string to disable ntp.
string
The camera's hostname. If the DHCP server passes a "hostname" parameter, this parameter is overridden.
string
The link local IP address that will be used if use_link_local is enabled.
boolean
If set, the watchdog will not get kicked. This should cause the camera to reboot after the watchdog timeout period.
boolean
Enable/disable the watchdog. The watchdog will periodically check various system parameters. If these parameters are functioning as expected, the the timer will get reset ("kicked"). If the timer does not get reset and the time expires, the camera will be rebooted.
boolean
If set, check the codec/imager status before kicking the watchdog. Enabling this property is not recommended under normal conditions because, if the imager fails, the camera will constantly reboot making communication with the camera very difficult. An imager failure is generally not something a reboot will fix.
boolean
If set, check that the webserver is functioning correctly before kicking the watchdog. If the webserver is not functioning correctly, the watchdog will not get kicked and the camera will reboot when the timer expires. If watchdog_http=0, the webserver test is not performed.
string
If set, this address will be pinged before kicking the watchdog. Set to a null string to disable. watchdog_ping_reset_en must also be set to enable this check to reset the camera. Using this property is not recommended under normal conditions, this is only useful if the camera is difficult to access and reseting the camera is likely to fix network connectivity problems. GPIO out can also be independently strobed in the case this test fails. To enable GPIO strobe, set output_select to "watchdog_ping".
boolean
If set, enable a watchdog trigger if watchdog_ping fails.
string
If set (user_password is NOT empty), a password is needed to view an image or video (access /cgi-usr/video and /cgi-usr/image). To remove a password, set it to the null (empty) string. If the password starts with "$1$", the string is assumed to be the MD5 hash of the password rather than the password itself. The username expected is "user".
user_password may not be set if admin_password is not set.
string
If set (admin_password is NOT empty), a password is needed to access any of the camera configuration commands (the /cgi-bin/ directory). To remove a password, set it to the null (empty) string. If the password starts with "$1$", the string is assumed to be the MD5 hash of the password rather than the password itself. The username expected is "admin".
The admin username and password may also be used to access the user sections of the camera.
string
A string describing the camera.
boolean
If true, access through the web interface is controlled by an LDAP server using the ldap_auth_* parameters
string
int
string
string
string
string
string
string
int
The speed of the first serial port of the camera. Currently supported speeds include: 300, 1200, 2400, 9600, 19200(default), 38400, 57600, 115200
boolean
Does the device on the camera serial port require local echo? 1 == Yes.
string
Use the serial port for console or for an accessory. The current valid values are "console", "accessory", "none". When set to "accessory", TCP port 8548 listens for connections and connects directly to the serial port. Changes do not take effect until the camera is reset. save_settings first!
string
Set the flow control method for the serial port. The current valid values are "none", "sw", "hw", and "both".
boolean
Enable or disable the rtp daemon. RTP streaming does not necessarily end when clients disconnect, so explicitly disabling RTP may be required to reclaim bandwidth. Once enables, RTSP clients may connect via rtsp://camera/ or http://camera/rtp.sdp.
int
The size of rtp packets. A size of 1450 ensures that ethernet fragmentation does not occur, a size of 65400 provides much faster transfers. RFC 2035 states that "Frames should be fragmented into packets in a manner avoiding fragmentation at a lower level." To follow this directive, a size of 1450 should be used. Many clients assume that this directive is followed, but since it is only a directive, not a requirement, this can be considered a bug. Unfortunately, such clients are common.
int
The rtp base port number. This number must always be even. Do not confuse this with the RTSP port number, which is always at the IANA standard location of 554.
string
Use the following pan-tilt-zoom protocols: pelco_d, pelco_p, vt.