StarDot HTTP API

for NetCam SC/XL IP Cameras, Express 2/4/8 Video Servers

Version 1.14

Some commands may require a firmware upgrade.

Probing for StarDot Devices

Here is sample C++ probe code that will probe the LAN and quickly find all StarDot devices.

Device Information

http://<ip>/info.cgi - Information about the device

To read the resolution list for a device:

http://<ip>/info.cgi?resolutions

To read the maximum FPS per resolution list for a device (Version 1.1.67+):

http://<ip>/info.cgi?resolutions&api=2

Acquiring Video

Parse http://<ip>/info.cgi to check for device H.264 compatibility, available transport protocols and streaming port(s). Note: The ports are listed in descending priority order. Use the highest priority port to obtain the best video performance.

HTTP H.264 Video

HTTP (Version 1.1.67+, NetCam SC H264 Only)
Continuous HTTP stream of "Content-type: video/h264", NAL units are separated by ITU H.264 Annex B markers

http://<ip>/nph-h264.cgi

HTTP Multi-Part (Version 1.1.67+, NetCam SC H264 Only)
Multi-part HTTP stream with embedded timestamps

http://<ip>/nph-h264.cgi?multipart=1

There are three content types within the multi-part stream. The first is "Content-type: video/H.264I", which contains the SPS and PPS NAL units followed by an I-Frame NAL unit. Each NAL unit is preceded by an Annex B marker. The second is "Content-type: video/H.264P", which contains a single P-Frame NAL unit preceded by an Annex B marker. The third is "Content-type: video/SEI", which can contain motion detection data. Content blocks also contain a timestamp header: "X-StarDot-H264-Timestamp" with a value indicating the frame's timestamp relative to a 90Khz clock.

RTSP H.264 Video

Starting with firmware version 1.1.69, H.264 StarDot devices support RTSP, allowing H.264 video streams using RTP over unicast UDP as well as RTP over interleaved TCP.

RTSP and RTP (Version 1.1.69+, NetCam SC H264 Only)

rtsp://<ip>/nph-h264.cgi

The RTSP server supports URL parameters as well, similar to HTTP H.264 video streams. For example, to access video with SEI packets removed use:

rtsp://<ip>/nph-h264.cgi?sei=0

For more information, see:

info.cgi

You can query the device via "info.cgi" to check for H.264 video stream support. The following parameters apply to H.264 video streaming.

If a parameter is missing, it indicates that a particular H.264 feature is not supported.

Examples:

MJPEG Video

http://<ip>/nph-mjpeg.cgi

Add ?x after cgi to indicate camera or video input number. On NetCam SC and XL, this value is assumed since it's a single camera device. On the Express video servers, x indicates input number (0-7). You may also use the more descriptive camera=x

The following parameters can be added to the MJPEG URL (Version 1.1.61+, NetCam SC Only):

fps=x Limit frame rate to x frames per second

motion=x Stream video on motion only but send "keep alive" or confidence frame every x seconds

Example: http://<ip>/nph-mjpeg.cgi?motion=2

You can also obtain the MJPEG stream directly through streaming video port (default is 8001). However, the recommended method is the http nph-mjpeg URL.

MJPEG Thumbnail Video

(Version 1.1.71+, NetCam SC/XL Only)

http://<ip>/nph-mjpeg.cgi?thumb[&fps=x&motion=y]

http://<ip>/nph-mjpeg.cgi?mini[&fps=x&motion=y]

The NetCam SC and XL cameras support two independently sized MJPEG thumbnail streams. The standard thumbnail stream is approximately CIF-sized and the mini thumbnail stream is approximately QCIF-sized. Thumbnail resolution can vary depending on full-sized MJPEG resolution and aspect ration

Add ?x after cgi to indicate camera or video input number. On NetCam SC and XL, this value is assumed since it's a single camera device. On the Express video servers, x indicates input number (0-7). You may also use the more descriptive camera=x

The following parameters can be added to the MJPEG URL:

fps=x Limit frame rate to x frames per second

motion=x Stream video on motion only but send "keep alive" or confidence frame every x seconds

Example: http://<ip>/nph-mjpeg.cgi?thumb&motion=2&fps=10

To check for the existence of the thumb or mini stream, parse the info.cgi page

Individual JPEG frames

http://<ip>/image.jpg (or http://<ip>/netcam.jpg)

on multiple input devices (Express 2/4/8 Video Servers):

http://<ip>/jpeg.cgi?x (where x = input number, 0 origin)


Individual JPEG Thumbnail Frames

(Version 1.1.71+, NetCam SC/XL Only)

http://<ip>/thumb.jpg

http://<ip>/mini.jpg


Motion Detection in JPEG Images

The motion detection information is stored in an APP10 marker in each JPEG.

For firmware 1.1.61 and later

2-byte APP10 marker (0xff, 0exa)
2-byte length (big endian)
4-byte type marker (0x53, 0x44, 0x4d, 0x30, or "SDM0")
32-byte motion grid (16x16); 0=no motion, 1=motion

For firmware 1.1.60 and earlier

2-byte APP10 marker (0xff, 0xea)
2-byte length (big endian, always 0x00, 0x22)
32-byte motion grid (16x16); 0=no motion, 1=motion

The motion grid is ordered consecutively from the top left to bottom right; there are 16 rows from top to bottom, each row is 16 columns from left to right. For example, if the first two bytes of motion data are "0x80 0x00", there is motion in the upper left grid cell.

Note that there may be other APP10 markers in the JPEG data, such as timestamp information, etc.

Motion Detection in the H.264 Stream

In the H.264 stream, the motion detection information is contained in "User Data Unregistered" SEI NAL units (see Annex D, Section D.1.6, in ITU-T Recommendation H.264).

The StarDot UUID identifying motion detection data is bed9b7e0-f060-32a1-bb7e-7d4c6d82d249, which specifies a user data payload of a 32-byte motion grid (16x16); 0=no motion, 1=motion

Note that there may be other SEI markers in the H.264 stream, including other User Data Unregistered UUID payload types.

Note: (Version 1.1.68+)

Reading/Writing Configuration Settings

To read a list of various configuration pages:

http://<ip>/admin.cgi?tablist

To read configuration parameters for a specific page:

http://<ip>/admin.cgi?image&_
http://<ip>/admin.cgi?overlay&_
http://<ip>/admin.cgi?ftp&_
http://<ip>/admin.cgi?applet&_
http://<ip>/admin.cgi?datetime&_
http://<ip>/admin.cgi?network&_
http://<ip>/admin.cgi?dialout&_
http://<ip>/admin.cgi?security&_
http://<ip>/admin.cgi?ptz&_
http://<ip>/admin.cgi?tzo&_
http://<ip>/admin.cgi?trigger&_
http://<ip>/admin.cgi?wx&_

Example of how to change parameters:

http://<ip>/admin.cgi?image&quality=50&sharpen=off

Note that you can only set configuration options from one "page" at a time, but you can specify multiple options.

The configuration files are automatically saved to flash memory, since this is essentially the same thing as hitting the the form's "Apply" button when using a web browser.

The above are all "HTTP GET" examples.

HTTP authentication will also need to be used in order to access the pages as "admin" if you are not accessing the pages through a web browser.

H264 Parameters

Only devices with h264=1 present in http://<ip>/info.cgi support H.264.

The URL format for changing image parameters is as follows:

http://<ip>/admin.cgi?image&param=value

You can combine multiple image parameters in one line:

http://<ip>/admin.cgi?image&param1=value&param2=value&param3=value

h264_bitrate
Specifies data rate when h264_cbr=1, in 1Kb/second.
h264_bitrate=[0-65535]
Recommended Range: 1024-10240

h264_cbr
Constant bitrate. 1 means use the fixed bitrate as specified in h264_bitrate (quality is dynamically adjusted). 0 means only h264_quality setting is honored.
h264_cbr=[0-1]

h264_keyframe
Number of P-Frames (delta) between I-Frames (reference).
h264_keyframe=[0-63]
Recommended Range: 10-63

h264_quality
Quality of video stream. Lower value means less compression artifacts but more bandwidth/storage consumed. Higher value means more compression artifacts but less bandwidth/storage consumed.
h264_quality=[0-51]
Recommended Range: 25-35

h264_framerate
H.264 video stream frame rate in frames per second. Only positive integers are valid and a value of 0 means maximum frame rate at the current resolution. The H.264 frame rate is not related to the MJPEG frame rate. The MJPEG frame rate is per session. The H.264 frame rate is global.
Note: to view the maximum frame rate for each resolution available per device, view the resolution info page at http://<ip>/info.cgi?resolutions&api=2
h264_framerate=[0-30]

Controlling the Relay

To turn off or on the device's relay (Version 1.1.65+):

http://<ip>/io.cgi?relay=[0/1]

A value of 0 turns the relay off. A value of 1 turns the relay on.

Reading the Trigger Input Status

To read the status of an input trigger (Version 1.1.65+):

http://<ip>/io.cgi

Output is in plain text, and looks like:

io=1
trigger1=1
trigger2=0
trigger3=0
trigger4=0
trigger5=0
trigger6=0

Note that only some devices support the full list of inputs (triggers). The NetCam SC, for example has only one input trigger, even though all six possible inputs triggers are listed.

The normal status of trigger 1 on the SC cameras is 1. When voltage is applied is applied to the input, the value becomes 0.

Image Parameters

The URL format for changing image parameters is as follows:

http://<ip>/admin.cgi?image&param=value

You can combine multiple image parameters in one line:

http://<ip>/admin.cgi?image&param1=value&param2=value&param3=value

brightness (SC ,XL, Express)
This is the target value for the auto exposure code. The higher the value, the brighter the image becomes. Only applies if auto_exposure is enabled.
brightness=[0-255]
Recommended Range: 70-200

auto_exposure (SC, XL only)
Enable to have the camera determine the proper image exposure based on the average brightness of the pixels. Can be adjusted with brightness value.
auto_exposure=[0-1]
Recommended Value: 1

exposure (SC, XL only)
Set the camera’s exposure. Only applies if auto_exposure is disabled.
exposure=[0-32767]

exposure_limit (SC, XL only)
Set maximum exposure. Only applies if auto_exposure is enabled.
exposure_limit=[0-32767]

extended (SC, XL only)
Allow extended exposures. Enable to allow camera to enter extended exposure mode. In low light, the frame rate will slow down to allow longer exposures.
extended=[0/1]

auto_iris (SC, XL only)
Only enable if there is a DC Auto Iris lens installed and plugged into the camera.
auto_iris=[0/1]

sync (SC, XL only)
Fluorescent light synchronization. If camera scene is primarily illuminated by fluorescent lighting, set sync to 60Hz or 50Hz, depending on the country’s electrical frequency.
sync=[0-2] (0=off, 1=60Hz, 2=50Hz)

backlight (SC, XL only)
Enable for backlight compensation (BLC).
backlight=[0/1]

mirror (SC, Express only)
Flip image/video left to right.
mirror=[0/1]

invert (SC, Express only)
Flip image/video upside down.
mirror=[0/1]

agc (SC, XL only)
Enable for automatic gain control (digital gain). AGC dynamically adjusts the intensity value in low light.
agc=[0/1]

agc_limit (SC, XL only)
Automatic gain compensation limit, which is a limit on the digital gain amount used by AGC. A higher value produces a noisier but brighter image in low light. Only applies if agc is enabled.
agc_limit=[0-255]
recommended range: 32-128

intensity (SC, XL only)
This is the digital gain setting. Only applies if agc is disabled.
intensity=[0-255]
Recommended Range: 16-128

lowlight (SC, XL only)
Low light mode automatically turns on analog gain if the camera control logic determines it is required. Image noise will be increased slightly.
lowlight=[0/1]

lowlight_preset (SC only)
Sets a variety of lowlight settings.
lowlight_preset=[0-3]

0 = Manual (allows access to individual controls on web config page)
1 = High Speed, Low Gain
2 = High Speed, High Gain
3 = Low Speed, Low Gain
4 = Low Speed, High Gain

lowlight_dnr (SC only)
Determines the amount of digital noise reduction (DNR). A value of 0 means no DNR.
lowlight_dnr=[0-3]

lowlight_pixelrep (SC only)
The amount of pixel replication or binning allowed in low light situations. The higher the pixelrep value, the brighter the image at the expense of clarity.
lowlight_pixelrep=[0-3]

0 = None
1 = Minimal
2 = Average
3 = Full

lowlight_saturation (SC only)
Determines how the saturation value adjusts in low light and IR conditions. This value is bit-oriented.
lowlight_saturation=[0-15]

Bit 8 = Go into black & white mode if camera goes into IR mode
Bits 0-7 = Determine amount to desaturate in low light (the higher the number, the higher the saturation level)

lowlight_imagespeed (SC only)
Determines what has more priority in low light conditions, long exposure or low light gain methods. A setting of 0 means to give long exposure priority. Only applies if extended=1.
lowlight_imagespeed=[0-3]

0 = Slow
1 = Medium
2 = Fast
3 = Fastest

lowlight_yuv (SC only)
An alternate method of color processing that yields brighter images in low light at the expense image clarity.
lowlight_yuv=[0/1]

resolution (SC, XL, Express)
Set the image/video resolution. The resolution lists vary for each model.

resolution=[value]
or
resolution=[widthxheight] (Version 1.1.61+)

To read the resolution list, http://<ip>/info.cgi?resolutions (Version 1.1.61+)
To read the resolution / frame rate list, http://<ip>/info.cgi?resolutions&api=2 (Version 1.1.67+)

saturation (SC, XL, Express)
Amount of color saturation in video/image.
saturation=[0-255] for SC, XL
saturation=[0-127] for Express
Recommended SC/XL Range: 90-160
Recommended Express Value: 64
Note: A value of 0 renders a black & white (monochrome) image.

hue (Express only)
Video/image hue value.
hue=[-128 to 127]
Recommended Value: 0

haze (SC, XL only)
Represents haze subtraction or contrast. The higher value, the higher the contrast. If auto_haze is enabled, haze acts as a skew (Version 1.1.63+)
haze=[0-255]
Recommended Range: 10-40

contrast (Express only)
Amount of contrast in video/image. The higher value, the higher the contrast.
haze=[0-255]
Recommended Value: 64

auto_haze (SC, XL only)
When enabled, camera automatically adjusts the haze (contrast).
auto_haze=[0/1]
Recommended Value: 1

quality (SC, XL, Express)
This represents the JPEG quality. A high value creates a bigger image file size (higher bandwidth consumption) and less visible compression artifacts. A low value creates a smaller image file size (lower bandwidth consumption) and more visible compression artifacts.
quality=[20-100]
Recommended Range: 50-90

jpeg_size (SC, XL, Express)
Limit JPEG size to X KB.The best way to limit the bandwidth consumption. JPEG quality is adjusted on the fly so JPEG file size does not exceed the specified size (in Kilobytes).
jpeg_size=[0-1024]
0 = Disable

sharpen (SC, XL only)
Camera software sharpens the image.
sharpen=[0/1]
Recommended Value:1

filter (SC, XL, Express)
Level of sharpening.
filter=[0-3]
Recommended Value: 0 or 1

filter_lpf (SC, XL, Express)
Do not sharpen darker areas.
filter_lpf=[0-1]
Recommended Value: 1

skip (SC, XL, Express)
Represents frame skip. A frame skip value of 0 means skip no frames, a frame skip value of 1 means skip every 1 frame, etc. Can be used to reduce bandwidth consumption.
skip=[0-32767]
Default Value: 0

led (SC, XL, Express)
Sets the status of the camera’s front LED.
led=[0-7]
Recommended Values: 1, 3, 5 or 7

0 = LED is always off
1 = LED is always green
2 = LED is off, but flashes yellow if imaging
3 = LED is green, but flashes yellow if imaging
4 = LED is off, but flashes red if motion
5 = LED is green, but flashes red if motion
6 = LED if off, but flashes yellow if imaging, flashes red if motion
7 = LED Is green, but flashes yellow if imaging, flashes red if motion

Note: “imaging” occurs when the camera creates an image for an http request or FTP upload.

manual color balance values (SC, XL only)
Set manual color balance values. Only applies if balance is disabled.
red=[0-1023]
green=[0-1023]
blue=[0-1023]
Recommended Range: 256-1023

balance (SC, XL only)
Automatic color balance. Enable to have the camera automatically correct red, green & blue values to achieve a proper color balance.
balance=[0-1]
Recommended Value: 1

balance_type (SC, XL only)
This is color balance method.
balance_type=[0-3]
Recommended Value: 0

0 = Average
1 = Bright
2 = Spot
3 = Automatic

color skew values (SC, XL only)
Set auto color balance skew values. Only applies if balance is enabled. Can be used to skew the auto color balance to achieve a custom auto color balance. Only applies if balance=1.
red_scale=[0-1023]
green_scale=[0-1023]
blue_scale=[0-1023]
Recommended Range: 256-1023

balance_show (SC, XL only)
If enabled, areas used for color balance are shown as green pixels.
balance_show=[0-1]
Recommended value: 0

ir_enable (NetCam SC IR Models Only)
Determines behavior of mechanical IR filter.
ir_enable=[0-2]
Default value: 0

0 = Off (non-IR mode)
1 = On (IR mode)
2 = Auto

exposure_grid (SC, XL only)
The exposure grid is divided into an 8 x 8 grid. Each of the 64 sections can be enabled or disabled. The enabled areas are used to help determine the proper exposure. Only applies when auto_exposure is enabled.
exposure_grid_[0-7][0-7]=[off|no|0/on|yes|1]

All motion detection related parameters are now in the motion section (Version 1.1.61+)

Overlay Parameters

The URL format for changing overlay parameters is as follows:

http://<ip>/admin.cgi?overlay&param=value

You can combine multiple overlay parameters in one line:

http://<ip>/admin.cgi?overlay&param1=value&param2=value&param3=value

overlay
Displays date/time information, optional weather and sensor information and customizable text on top of live image.
overlay=[off/on]

overlay_utc
Display overlay date/time information in UTC.
overlay_utc=[0-1]

overlay_text
overlay_text=[text]
Up to four lines of text is allowed. There is a maximum of 255 characters pre line. Lines are truncated with \r\n.

overlay_scale
overlay_scale=[0-3]
Determines scale or size of font

0=1x
1=2x
2=3x
3=4x

overlay_position
Position of overlay text, 0=top, 1=bottom.
overlay_position=[0-1]

overlay_x
X-axis offset.
overlay_x=[0-4095]

overlay_y
Y-axis offset.
overlay_y=[0-4095]

FTP Parameters

The URL format for changing FTP parameters is as follows:

http://<ip>/admin.cgi?ftp&param=value

You can combine multiple FTP parameters in one line:

http://<ip>/admin.cgi?ftp&param1=value&param2=value&param3=value

sched_ftp_upload
Turn on to enable FTP upload.
sched_ftp_upload=[off/on]

ftp_timeout
If upload is too slow or error prone, increase the FTP timeout value, which represents the number of seconds to wait before retrying FTP transmission.
ftp_timeout=[0-1024]
Recommended value: 120

ftp_hostname
The FTP hostname, in the format domain.extension or machine.domain.extension or an IP address ( Do not include ftp:// or http://).
ftp_hostname=[hostname or IP address]
Example: example.com

ftp_user
FTP host username.
ftp_user=[username]

ftp_password
FTP host password.
ftp_password=[password]

ftp_passive
FTP "passive" mode.
ftp_passive=[off/on]

ftp_archive
When enabled, a renaming scheme maintains a rotating archive of the last ten images.
ftp_archive=[off/on]

ftp_delete_file
This is an option for FTP hosts that have restrictions on renaming a file with a filename that already exists. Instead renaming the uploaded image from camera0.jpg.tmp to camera0.jpg, it will first delete camera0.jpg and then rename camera0.jpg.tmp to camera0.jpg.
ftp_delete_file=[off/on]

ftp_iis_bug
A workaround for restrictions that some Microsoft IIS servers.
ftp_iis_bug=[off/on]

ftp_filename
The primary path/filename of the image to be FTP uploaded.
ftp_filename=[path/filename.jpg]

ftp_filename2
The secondary path/filename of the image to be FTP uploaded.
ftp_filename2=[path/filename.jpg]

ftp_filename3
Only used for the ip.html upload. The filename can be renamed but the html contents are always the same. It contains the date/time when the upload occurred and the camera's IP address.
ftp_filename3=[path/filename.html]

sched_ftp_delay
Amount of time in seconds to delay between FTP uploads.
sched_ftp_delay=[0-86399]

sched_ftp_time_start
Time of day to start FTP upload.
sched_ftp_time_start=[00:00-23:59]

sched_ftp_time_stop
Time of day to end FTP upload.
sched_ftp_time_stop=[00:00-23:59]

sched_ftp_day
Days of week to run FTP upload.
sched_ftp_day_[sun-sat]=[on/off]

ftp_image
Represents the internal image filename. Normally this would not be changed.
ftp_image=[path/filename]
Recommended value: /dev/video/jpeg0

sched_ftp_command
Internal name for the FTP scripting program. Normally this would not be changed.
sched_ftp_command=[filename]
Recommended value: ftpscript0

Date/Time Settings

The URL format for changing date/time parameters is as follows:

http://<ip>/admin.cgi?datetime&param=value

You can combine multiple date/time parameters in one line:

http://<ip>/admin.cgi?datetime&param1=value&param2=value&param3=value

mode
Date/time mode can be either manual or automatic. Automatic implies external timeserver synchronization.
mode=[automatic/manual]

time_server
External time server to synchronize with. Only applies if mode=automatic.
time_server=[timeserver]
Example: time.nist.gov

time_zone
Time zone camera is in.
time_zone=[timezone]
Example: PST8PDT

date
Set current date.
date=yyyy-mm-dd

time
Set current time.
time=hh:mm:ss

Network Settings

The URL format for changing network parameters is as follows:

http://<ip>/admin.cgi?network&param=value

You can combine multiple network parameters in one line:

http://<ip>/admin.cgi?network&param1=value&param2=value&param3=value

NETWORKING
Turns on/off networking.
NETWORKING=[no/yes]

eth0_BOOTPROTO
The Ethernet bootproto can be either DHCP or none.
eth0_BOOTPROTO=[dhcp/none]

eth0_IPADDR
Ethernet IP address.
eth0_IPADDR=[n.n.n.n]

eth0_NETMASK
Ethernet subnet mask.
eth0_NETMASK=[n.n.n.n]

GATEWAY
Network gateway IP address.
GATEWAY=[n.n.n.n]

NAMESERVER
DNS entries 1-3.
NAMESERVER[1-3]=[n.n.n.n]

eth0_BROADCAST
Ethernet broadcast address.
eth0_BROADCAST=[n.n.n.n]

http_port
Set the camera's default http port.
http_port=[0-65535]
Default value: 80

mjpeg_base_port
The motion JPEG starting port (on single camera devices, this is the only motion JPEG port).
mjpeg_base_port=8001
Default value: 8001
Note: Obsolete. See Video Streaming section to see recommended way of reading MJPEG stream.

HOSTNAME
Hostname for the camera or device.
HOSTNAME=[hostname]
Example: netcamsc

eth0_DEVICE
Ethernet 0 device. Always set as eth0.
eth0_DEVICE=eth0

eth0_MACADDR
Ethernet 0 MAC Address [read only]
eth0_MACADDR=00:30:f4:d2:11:04

Dial-Out Settings

The URL format for changing dial-out parameters is as follows:

http://<ip>/admin.cgi?dialout&param=value

You can combine multiple dial-out parameters in one line:

http://<ip>/admin.cgi?dialout&param1=value&param2=value&param3=value

DIALOUT_ENABLED
When set to yes, dial-out is enabled.
DIALOUT_ENABLED=[no/yes]
Default value: no

ppp0_DEVICE
PPP0 device. This is normally left as ppp0.
ppp0_DEVICE=ppp0

ppp0_ONBOOT
Enabled or disable PPP on boot.
ppp0_ONBOOT=[no/yes]
Default value: no

DIALOUT_DEVICE
The serial port the dial-out device is connected to, either S0 or S1.
DIALOUT_DEVICE=/dev/ttyS[0-1]

DIALOUT_DEVICE_SPEED
Baud rate of dial-out device.
DIALOUT_DEVICE_SPEED=[baudrate]
Default value: 38400

DIALOUT_MODEM_INIT
Dial-out modem initialization string.
DIALOUT_MODEM_INIT=[init-string]

DIALOUT_PHONE_NUMBER
Dial-out phone number.
DIALOUT_PHONE_NUMBER=[nnn-nnn-nnnn]

DIALOUT_CONNECT_TIMEOUT
Dial-out connect timeout value (in seconds).
DIALOUT_CONNECT_TIMEOUT=[0-32767]
Default value: 180

DIALOUT_USERNAME
Dial-out username (usually ISP login name).
DIALOUT_USERNAME=[username]

DIALOUT_PASSWORD
Dial-out password (usually ISP login password).
DIALOUT_PASSWORD=[password]

DIALOUT_ALWAYS_UP
When enabled, dial-out connection remains open. When disabled, dial-out connection is driven by client side activity (FTP upload, ping, etc.).
DIALOUT_ALWAYS_UP=[no/yes]
Default value: no

DIALOUT_DEFAULT_ROUTE
When enabled, a dial-out connection will be the default route.
DIALOUT_DEFAULT_ROUTE=[no/yes]

DIALOUT_SHELL_LOGIN
Advanced option. Set only when ISP requires a shell login.
DIALOUT_SHELL_LOGIN=[no/yes]
Default value: no

DIALOUT_SEND_CR
Advanced option. Set only when ISP requires a CR to be sent.
DIALOUT_SEND_CR=[no/yes]
Default value: no

ppp0_DEVICE
PPP0 device. This is normally left as ppp0.
ppp0_DEVICE=ppp0

PTZ General Settings

PTZ control currently only supports one addressable PTZ camera per StarDot device. The URL format for changing PTZ parameters is as follows:

http://<ip>/admin.cgi?ptz&param=value

You can combine multiple PTZ parameters in one line:

http://<ip>/admin.cgi?ptz&param1=value&param2=value&param3=value

ENABLED
Set to yes to enable PTZ control (requires compatible pan/tilt/zoom unit connected via serial port).
ENABLED=[no/yes]

CAMERA
On video servers, select camera input number.
CAMERA=[0-12]

TYPE
Pan/tilt type.
TYPE=[ad/pelco/sony/stardot]

ADDRESS (Version 1.1.68+)
Pan/tilt RS485 address.
ADDRESS=[0-255]

DEV
Serial port pan/tilt is connected to.
DEV=/dev/ttyS[0-1]

DEV_SPEED (Version 1.1.68+)
Serial port baud rate.
DEV_SPEED=[1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200]

PTZ Protocol Settings

PTZ protocol settings are stored as follows:

American Dynamics: http://<ip>/edit.cgi?ptz-ad.conf

Pelco-D: http://<ip>/edit.cgi?ptz-pelco.conf

Sony: http://<ip>/edit.cgi?ptz-sony.conf

PTZ Control

The URL format for issuing PTZ commands is as follows:

http://<ip>/ptz.cgi?command[&value]

PAN/TILT
The following commands are available for pan/tilt (value is the travel time in milliseconds):
http://<ip>/ptz.cgi?up&value
http://<ip>/ptz.cgi?down&value
http://<ip>/ptz.cgi?left&value
http://<ip>/ptz.cgi?right&value

ZOOM
The following commands are available for zoom (value is the travel time in milliseconds):
http://<ip>/ptz.cgi?in&value
http://<ip>/ptz.cgi?out&value

FOCUS
The following commands are available for focus (value is the travel time in milliseconds):
http://<ip>/ptz.cgi?near&value
http://<ip>/ptz.cgi?far&value

IRIS
The following commands are available for iris (value is the travel time in milliseconds):
Example: http://<ip>/ptz.cgi?open
Example: http://<ip>/ptz.cgi?close

STOP
Stops all PTZ activity:
Example: http://<ip>/ptz.cgi?stop

SET PRESET
Example: http://<ip>/ptz.cgi?set&n

GO TO PRESET
Example: http://<ip>/ptz.cgi?go&n

Note: presets are zero based.

TZO Dynamic DNS Settings

The URL format for changing TZO parameters is as follows:

http://<ip>/admin.cgi?tzo&param=value

You can combine multiple TZO parameters in one line:

http://<ip>/admin.cgi?tzo&param1=value&param2=value&param3=value

TZO_ENABLED
Set to yes to enabled TZO dynamic DNS service.
TZO_ENABLED=[no/yes]

TZO_NAME
TZO hostname.
TZO_NAME=[name.tzo.com]
(or name.remotecam.com, name.stardotcams.com)

TZO_EMAIL
Email address associated with TZO hostname.
TZO_EMAIL=[user@example.com]

TZO_KEY
Key or password associated TZO hostname (generated by TZO.com).
TZO_KEY=[XXXXXXXX]

TZO_GATEWAY
Set to yes to enable TZO gateway
TZO_GATEWAY=[no/yes]
Default value: yes

TZO_CTYPE
TZO type. Advanced setting, leave value as 3.
TZO_CTYPE=3

Trigger Settings

The URL format for changing trigger parameters is as follows:

http://<ip>/admin.cgi?trigger&param=value

You can combine multiple trigger parameters in one line:

http://<ip>/admin.cgi?trigger&param1=value&param2=value&param3=value

TRIGGER
Set to on to enable triggering.
TRIGGER=[off/on]

EXEC
Script that is run once a triggered event occurs.
EXEC=[trigger-ftp/trigger-smtp]

CAMERA
Select which camera(s) will buffer images. Network cameras are always Camera0. Video servers have multiple camera inputs, up to 12.
CAMERA[0-12]=[off/on]

MODE
Select type of mode.
MODE=[trigger/continuous]

TYPE
Type of trigger.
TYPE=[edge/level]
Default value: edge

io_port
The I/O port on the back of NetCam.
io_port=[1-4]

io_level
The trigger level, high or low.
io_level=[0/1]

SCHEDULE
For 24/7 operation, set to off. To limit the days and hours, set to on.
SCHEDULE=[off/on]

START
Trigger schedule start time. Only applies if schedule=on.
START=[00:00-23:59]

STOP
Trigger schedule stop time. Only applies if schedule=on.
STOP=[00:00-23:59]

Day of Week
Set days of week for triggering. Only applies if schedule=on.
[SUN-SAT]=[off/on]

PRE_BUFFER
To pre-buffer triggered image, set to on.
PRE_BUFFER=[off/on]

PRE_BUFFER_DELAY
Delay in milliseconds between pre-buffered trigger images.
PRE_BUFFER_DELAY=[0-32767]
Default value: 250

PRE_BUFFER_COUNT
Number of triggered images to pre-buffer. Storage capacity is dependent on available resources and size of JPEG images. It may not always be possible to store 50 pre-buffer images.
PRE_BUFFER_COUNT=[1-50]
Default value: 8

POST_BUFFER
To post-buffer triggered image, set to on.
POST_BUFFER=[off/on]

POST_BUFFER_DELAY
Delay in milliseconds between post-buffered trigger images.
POST_BUFFER_DELAY=[0-32767]
Default value: 250

POST_BUFFER_COUNT
Number of triggered images to post-buffer. Storage capacity is dependent on available resources and size of JPEG images. It may not always be possible to store 50 post-buffer images.
POST_BUFFER_COUNT=[1-50]
Default value: 8

smtp_MAILTO
Email address to send images to after trigger occurs.
smtp_MAILTO=user@example.com

smtp_MAILFROM
Email address in "From" field in triggered image email.
smtp_MAILFROM=user@example.com

ftp_timeout
The amount of time to delay before re-attempting an FTP delay.
ftp_timeout=120
Default value: 120

ftp_hostname
The FTP server hostname the triggered images will upload to.
ftp_hostname=[example.com]

ftp_user
The username for the FTP server the triggered images will upload to.
ftp_user=[username]

ftp_password
The password for the FTP server the triggered images will upload to.
ftp_password=[password]

ftp_passive
Enable/disable passive mode for the FTP server the triggered images will upload to.
ftp_passive=[off/on]

ftp_path
FTP path where the triggered images will upload to.
ftp_path=[path]

Motion Detection

motion_noise
Motion detection noise filter. A low value means ignore less noise, a higher value means ignore more noise.
motion_noise=[0-15]
Default value: 8

motion_noheaders
If enabled, motion detection flag will not be included in the JPEG header.
motion_noheaders=[0-1]

motion_gradual
If enabled, the motion detection logic will ignore gradual lighting changed (like a sunset).
motion_gradual=[0-1]

motion_time
Represents the amount of time (in 0.5 second increments) to keep signaling motion after motion was detected.
motion_time=[0-15]
Default value: 4

motion_show
If enabled, the motion detected areas will display as green squares on the image.
motion_show=[0-1]

motion_sensitivity
Sensitivity of the motion detection logic. A low value means less sensitive, a higher value means more sensitive.
motion_sensitivity=[0-15]
Default value: 8

Weather Station Settings

The URL format for changing weather station parameters is as follows:

http://<ip>/admin.cgi?wx&param=value

You can combine multiple weather station parameters in one line:

http://<ip>/admin.cgi?wx&param1=value&param2=value&param3=value

WX_ENABLED
Set to yes to enable weather station polling.
WX_ENABLED=[no/yes]

WX_MODEL
Weather station model number.
WX_MODEL=[wx1/wx2]

WX_DEVICE
Serial port the weather station is connected to.
WX_DEVICE=/dev/ttyS[0-1]

WX_ALTITUDE
Altitude at weather station / camera location, measured in feet.
WX_ALTITUDE=[0-32767]

WX_TEMPERATURE
Temperature offset, in celsius, positive or negative, decimal values permitted.
WX_TEMPERATURE=x

WX_HUMIDITY
Humidity offset, positive or negative, only integers permitted.
WC_HUMIDITY=x