AirLive - IP Camera Developer Pages

Version	Date	Comment
3.0.3	2013-Dec-25	Initial version.
3.0.4	2014-Mar-12	Modify limits to authority and CGI parameters.
3.0.5	2015-Dec-22	Update new parameters in device.conf

1 OVERVIEW

This document specifies the parameters and configuration files for IP camera and video servers using firmware version 1.6.03 and above.

1.1 Product and firmware versions

The support for the parameters specified in this document is highly product and release dependent. Please refer to the parameter list for the actual product.

1.2 Security levels

The security levels column in each parameter table shows the required security level to operate parameters. The numbers represent security levels on the form create/delete for groups and get/set for parameters. To be able to perform an action on a parameter the user needs to have a security level equal to or higher than the corresponding security level of the parameter.

Security level	Description
0	Unprotected, but it is not possible to access the camera from outside without at least view rights.
1	View access right needed to access the parameter.
4	Operator access right needed to access the parameter.
6	Administrator access right needed to access the parameter.
7	Internal parameters that can only be changed by firmware applications or by root, editing the configuration files directly.

1.3 Valid values

The following valid values are used in this document:

Valid values		Description
An integer		Any number between -2147483647 (-2^31-1) and 2147483647 (2^31-1).
An unsigned integer		Any number between 0 and 4294967295 (2^32-1).
<m>		Any number starting from number m.
<m> ... <n>		Any number between number m and number n.
A string		Any string (valid characters: ISO 8859-1).
A domain name		A string limited to contain a domain name.
A host name		A string limited to contain a host name.
An IP address		A string limited to contain an IP address of the format xxx.xxx.xxx.xxx, where xxx is a number between 0 to 255. Example: 192.168.1.100
A MAC Address		A string limited to contain a MAC address of the format xx:xx:xx:xx:xx:xx, where xx is a hexadecimal value. Example: 00:40:8C :00:01:3F
An e-mail address		A string limited to contain an e-mail address.
A URL/URI		A sting limited to contain a URL/URI.
A path		A string limited to contain a path.
A time		A string limited to contain a time of the format hh:mm:ss. Example: 12:03:41
A date		A string limited to contain a date of the format yyyy-mm-dd. Example: 2007-02-27
<value 1> <value 2> <value 3> ...		Enumeration, only the given values are valid. Example: yes no
<m><value> ... <n><value>	<value><m> ... <value><n>	Any number between m and n together with value. Example: 1Mbit ... 100Mbit
Read only		Only the default value is valid as value.
Auto generated		Automatically generated value, should not be changed manually.
Hardware dependent		The hardware decides the default value/the valid values.
Everything inside brackets		Description.

2 PARAMETER GROUPS

2.1 General

2.1.1 Brand

Description: Contains information about the brand, name and type of the product.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[GeneRal.Brand]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Brand	*	A string (Auto generated)	1/7	The brand of the product.
ProdFullName	*	A string (Auto generated)	1/7	The full name of the product.
ProdNbr	*	A string (Auto generated)	1/7	The product number.
ProdShortName	*	A string (Auto generated)	6/7	The short name of the product.
ProdType	*	Video Server, Network Camera, Network Video Recorder (Auto generated)	1/7	The product type.
WebURL	*	A string (Auto generated)	1/7	The URL to visit for support and information about the product.

* The default value for these parameters is product specific.

2.1.2 UserID

Description: Contains information about the brand, name and type of the product.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.UserID]

Parameter name	Default value	Valid values	Security level (get/set)	Description
ViewerAuthen	on	on, off	4/6	Enable anonymous viewer (value=off) or not (value=on).
PTZAuthen	on	on, off	4/6	Enable anonymous PTZ control (value=off) or not (value=on).
Admin	YWRtaW46YWRtaW4=	A base64 string	4/6	Default admin account.
MaxCnt	9	9	4/7	Maximum of UserID lists.
Prifix	U	U	4/7	The prefix of dynamic child groups.
U# *				Dynamic added child groups.
U#.User		A base64 string	4/4

* Note: the # is replaced with a group number starting from zero, e.g. General.UserID.U0

2.1.3 System

Description: Contains information about the brand, name and type of the product.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.System]

Parameter name

Default value

Valid values

Security level (get/set)

Description

BoaProtViewer

password

password,
anonymous

1/6

password = Password is required to access the view pages.

anonymous = Anybody on the network can access the product's view pages (but not the Admin tools) in a browser, and without having to log in.

HTTPPort

80,1124¡K65535

1/6

HTTP port number.

2.1.4 Network

Description: Network interface settings. The parameters in this group (as opposed to the subgroups of this group) are static network settings. If the Network.BootProto parameter is "dhcp" these parameters may not be in use so always use the read-only parameters in the subgroups to retrieve actual network settings in use by the operating system.

2.1.5 Network.DDNS

Description: Dynamic Updates in the Domain Name System (RFC 2136).

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Network.DDNS]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	no	yes,no	6/6	Enable/disable dynamic DNS service.
DDNSServer	none	*<domain name relative to root>*	6/6	DDNS server. Default support: dyndns(www.dyndns.org), dhs(www.dhs.org), tzo(www.tzo.com).
UserName	none	A string	6/6	User name to DDNS server.
Password	none	A string	6/6	Password to DDNS server.
HostName	none	A string	6/6	Host name to be registered.

2.1.6 Network.DDNS.ServerList

Description: Server list of DDNS.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Network.DDNS]

Parameter name	Default value	Valid values	Security level (get/set)	Description
NbrOfSupport	6	A number	6/7	The number of DDNS server which server list support.
Server0	http://www.dyndns.org,dyndns	*http://<absolute domain name> ,<domain name relative to root>*	6/7	Dyndns DDNS server.
Server1	http://www.dhs.org,dhs	*http://<absolute domain name> ,<domain name relative to root>*	6/7	Dhs DDNS server.
Server2	http://www.tzo.com,tzo	*http://<absolute domain name> ,<domain name relative to root>*	6/7	Tzo DDNS server.

2.1.7 Network.eth0

Description: Network settings of the first ethernet interface. Use these parameters to retrieve the network settings actually in use by the operating system.

Configure file: There is no configuration file for these parameters. They are retrieved directly from the interface.

Security level (create/delete): 7/7

[General.Network.eth0]

Parameter name	Default value	Valid values	Security level (get/set)	Description
DNSAuto	on	on, off	4/6	Specifies if the DNS server should be obtained from a DHCP server.
DNSServer1	0.0.0.0	An IP address	4/6	Primary domain name system server.
DNSServer2	0.0.0.0	An IP address	4/6	Secondary domain name system server.
BootProto	dhcp	dhcp, none	4/6	Enable/disable dynamic IP address assignment to the device.
IPAddress	192.168.1.100	An IP address	1/6	IP Address. The physical address of the device on the network.
MACAddress	00:40:8C:xx:xx:xx	A MAC address (Auto generated)	1/6	MAC address. The unique identity of the device. This parameter is read only.
SubnetMask	255.255.255.0	An IP address	4/6	Subnet mask. Divides the network.
DefaultRouter	192.168.1.1	An IP address	4/6	Routing table actually in use by the operating system
IPAddressRange	192.168.1.2- 192.168.1.254	A string	4/7

2.1.8 Network.UPnP

Description: Enable/disable Universal Plug and Play and set the name to be displayed in UPnP-clients.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Network.UPnP]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	yes	yes, no	1/6	Enables/disables Universal Plug and Play.

2.1.9 Network.UPnP.NATTraversal

Description: These parameters control NAT traversal functionality. NAT traversal is a technique that can be used to open up routers and firewalls to make devices on a LAN accessible from the Internet.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Network.UPnP.NATTraversal]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	no	yes, no	1/6	Enables/disables NAT traversal.
HTTPPort	80	1124 ... 65534	1/6	Number of HTTP port for NAT traversal.
HTTPSPort	443	1124 ... 65534	1/6	Number of SSL port for NAT traversal.
RTSPPort	554	1124 ... 65534	1/6	Number of RTSP port for NAT traversal.

2.1.10 Network.PPPoE

Description: Enable/disable PPP over Ethernet. The userid and password is provided by internet service provider.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Network.PPPoE]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	no	yes, no	1/6	Enables/disables PPPoE
IPAddress	0.0.0.0	An IP address	4/6	IP Address. The physical address of the device on the network.
UserID	none	A string	4/6	For login PPPoE service.
Password	none	A string	4/6	For login PPPoE service.
DNSAutod	on	on, off	4/6	Specifies if the DNS server should be obtained from a DHCP server.
DNSServer1	0.0.0.0	An IP address	4/6	Primary Domain Name System server.
DNSServer2	0.0.0.0	An IP address	4/6	Secondary Domain Name System server.

2.1.11 Network.RTSP

Description: Enable/disable Real Time Streaming Protocol.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Network.RTSP]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Port	554	1024¡K65534	1/6	The Port number for RTSP Server

2.1.12 Network.RTSP.R#

Description: Parameters for each RTSP stream.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Network.RTSP.R#]*

Parameter name

Default value

Valid values

Security level (get/set)

Description

ProtViewer

anonymous

anonymous,

password

1/6

Disable/enable RTSP Authentication mode

* Note: The # is replaced with a number, e.g. Network.RTSP.R0.

2.1.13 Network.RTP

Description: Parameters for Real-time Transport Protocol stream.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Network.RTP]

Parameter name	Default value	Valid values	Security level (get/set)	Description
StartPort	5000	1124 ... 65435	4/6	The RTP port range defines the range of ports we use in sending video/audio UDP stream. StartPort defines the lower bound of this range. Note: Each RTP session needs 4 ports, 2 ports for video and 2 ports for audio.
EndPort	7999	1223 ... 65534	4/6	Upper bound of port range in RTP Over UDP.

2.1.14 Network.RTP.R#

Description: Parameters for each Real-time Transport Protocol stream.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Network.RTP.R#]*

Parameter name	Default value	Valid values	Security level (get/set)	Description
Multicast	0	0,1	1/6	Enables(1) or disables(0) RTP multicast.
IPAddress	228.0.0.1	An IP address between 224.0.1.0 and 239.255.255.255	4/6	RTP multicast IP address.
VideoPort	0	0, 1024 ... 65535	4/6	The port number for RTP Multicast Video stream. 0 indicates the port number is automatically selected.
AudioPort	0	0, 1024 ... 65535	4/6	The port number for RTP Multicast Audio stream. 0 indicates the port number is automatically selected.
TTL	15	1 ... 55	4/6	The Time To Live for each UDP packet.

* Note: The # is replaced with a number, e.g. Network.RTP.R0.

2.1.15 Network.Bonjour

Description: Parameter for the Bonjour service discovery.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Network.Bonjour]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

yes

yes,

4/6

Enable/Disable Bonjour.

DeviceName

none

none or a string

4/6

The device name will be showed on the bonjour browser. If it uses the default value, this name will like the format below: [Brand]-[MacAddress].

2.1.16 Time

Description: Common time information which tell the time zone, how date and time is synchronized and the offset related to the chosen time zone and Coordinated Universal Time, UTC.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Time]

Parameter name	Default value	Valid values	Security level (get/set)	Description
ServerDate	2006-11-30	A date	4/6	The date (yyyy-mm-dd) when the device's time was set manually or synchronized with the computer.
ServerTime	14:52:23	A time	4/6	The time (hh:mm:ss) when the device's time was set manually or synchronized with the computer.
DateFormat	ymd	ymd, mdy, dmy	1/4
SyncSource	NTP	PC, NTP, None	4/6	The source to synchronize the time with; PC, NTP or None (manually).
TimeZone	GMT+08:00/Asia/Taipei	GMT-12, ... GMT-1, GMT, GMT+1, ... GMT+12	4/6	Time zone.
UTCOffset	00:00:00	A time	4/6	Time difference (hh:mm:ss) between the time zone and Coordinated Universal Time (UTC). -01:00:00 = -1 hour, i.e. 1 hour after UTC. 00:00:00 = 0 hour, 01:00:00 = 1 hour, i.e. before UTC.

2.1.16.1 Time. DayLightSaving

Description: Contain parameters required to manage Daylight Saving Time, DST.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Time. DayLightSaving]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

off

off,

4/6

Enable/disable DST (Daylight Saving Time)

2.1.16.1.1 Time.DayLightSaving.Start

Description: Start time of Daylight Saving Time, DST. If type is ¡¥date¡¦, ¡¥Month¡¦, ¡¥Date¡¦, ¡¥Hour¡¦, and ¡¥Min¡¦ need to be assigned. If type is ¡¥week¡¦, ¡¥Month¡¦, ¡¥Week¡¦, ¡¥Day¡¦, ¡¥Hour¡¦, and ¡¥Min¡¦ need to be assigned.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Time.DayLightSaving.Start]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Type	date	date, week	4/6	Type of day light saving start time.
Month	1	1, ¡K 12	4/6	January, February, ¡K, December.
Week	1	1, ¡K 5	4/6	N^th week of this month.
Day	1	1, ¡K7	4/6	Monday, Tuesday, ¡K Sunday.
Date	1	1, ¡K 31	4/6	Date.
Hour	0	0, ¡K 23	4/6	Hour.
Min	0	0, 15, 30, 45	4/6	Minute. In unit of a quarter-hour.

2.1.16.1.2 Time.DayLightSaving.Stop

Description: Stop time of Daylight Saving Time, DST. If type is ¡¥date¡¦, ¡¥Month¡¦, ¡¥Date¡¦, ¡¥Hour¡¦, and ¡¥Min¡¦ need to be assigned. If type is ¡¥week¡¦, ¡¥Month¡¦, ¡¥Week¡¦, ¡¥Day¡¦, ¡¥Hour¡¦, and ¡¥Min¡¦ need to be assigned.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Time.DayLightSaving.Stop]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Type	date	date, week	4/6	Type of day light saving start time.
Month	1	1, ¡K 12	4/6	January, February, ¡K, December.
Week	1	1, ¡K 5	4/6	N^th week of this month.
Day	1	1, ¡K7	4/6	Monday, Tuesday, ¡K Sunday.
Date	1	1, ¡K 31	4/6	Date.
Hour	0	0, ¡K 23	4/6	Hour.
Min	0	0, 15, 30, 45	4/6	Minute. In unit of a quarter-hour.

2.1.16.2 Time.NTP

Description:

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[General.Time.NTP]

Parameter name	Default value	Valid values	Security level (get/set)	Description
ManualServer	pool.ntp.org	An IP address or a host name	4/6	The NTP server to connect to when synchronizing the time in the device. Priority is first.
ManualServer1	1.pool.ntp.org	An IP address or a host name	4/6	The NTP server to connect to when synchronizing the time in the device. Priority is second.
ManualServer2	2.pool.ntp.org	An IP address or a host name	4/6	The NTP server to connect to when synchronizing the time in the device. Priority is third.
ManualServer3	3.pool.ntp.org	An IP address or a host name	4/6	The NTP server to connect to when synchronizing the time in the device. Priority is forth.

2.2 Motion

Description: Define the general properties of a Motion Detection window.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Motion]

Parameter name	Default value	Valid values	Security level (get/set)	Description
SensitivityFormat	0-100	0-100	4/7	Specify the minimal and maximal value of allowed sensitivity value.
ThresholdFormat	0-100	0-100	4/7	Specify the minimal and maximal value of allowed threshold value.
MaxCnt	3	3	4/7	Available motion detection windows.

2.2.1 Motion.M#

Description: Contain dynamic parameters, which define the properties of a Motion Detection window.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Motion.M#]*

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	no	yes, no	4/4	Enable/disable this detection window.
Sensitivity	50	(Depends on SensitivityFormat)	4/4	This tunes the "object difference from the background"-sensitivity, i.e. difference in terms of color and/or structure. A high value detects even very small changes and can e.g. trigger on image noise if set too high. A very low value requires on the other hand a very dramatic change with e.g. a dark object appearing in an almost white scene (or vice versa).
Threshold	50	(Depends on ThresholdFormat)	4/4	This adjusts the motion detection to be more or less sensitive for very fast motion. With a very low value the motion is detected only when a scene has changed but adapts to this changed scene as the new normal scene rapidly. A large value is more conservative and will detect the motion for a larger number of pictures before it consider this as being a normal object in the scene.
Left	0	Depends on resolution limit.	4/4	The coordinate for the left boundary of the rectangular motion detection window. The full value range is related to the full image width and 0 is counted from the left hand side of the image.
Top	0	Depends on resolution limit.	4/4	The coordinate for the upper boundary of the rectangular motion detection window. The full value range is related to the full image height and 0 is counted from the upper side of the image.
Right	0	Depends on resolution limit.	4/4	The coordinate for the right boundary of the rectangular motion detection window. The full value range is related to the full image width and 0 is counted from the left hand side of the image.
Bottom	0	Depends on resolution limit.	4/4	The coordinate for the bottom boundary of the rectangular motion detection window. The full value range is related to the full image height and 0 is counted from the upper side of the image.

* Note: The # is replaced with a group number starting from zero, e.g. Motion.M0.

2.3 Image

2.3.1 Image.OSD

Description: Image OSD parameters for each image configuration.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Image.OSD]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Date	off	on, off	4/4	Enable/disable Date/Time OSD.
Title	off	on, off	4/4	Enable/disable Alias on OSD
Position	top	top, bottom	4/4	Set OSD position.
BkColor	black	black, white	4/4	Set OSD back ground color.
Alias	None	String	4/4	Alias for Camera display on OSD.

2.3.2 Image.Mask

Description: Privacy mask parameters.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Image.Mask]

Parameter name	Default value	Valid values	Security level (get/set)	Description
MaxCnt	5	5	4/4	Available mask windows.
Prifix	M	M	4/4	The prefix of dynamic child groups.

Security level (create/delete): 4/4

Template: PrivacyMask

[Image.Mask.M#]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	off	on, off	1/4	Enable/disable privacy mask.
Name	None	String	1/4	Privacy Mask Name
XPos	0	An unsigned integer	1/4	The Horizontal position of upper left corner. The maximum allow range depends on ImageSource.I0.Config.MaxResolution (See section 2.4.1)
YPos	0	An unsigned integer	1/4	The vertical position of upper left corner. The maximum allow range depends on ImageSource.I0.Config.MaxResolution (See section 2.4.1)
Width	50	An unsigned integer	1/4	The width of the specified mask. The maximum allow range depends on ImageSource.I0.Config.MaxResolution (See section 2.4.1)
Height	50	An unsigned integer	1/4	The height of the specified mask. The maximum allow range depends on ImageSource.I0.Config.MaxResolution (See section 2.4.1)
Color	black	black	1/4	The color of mask. Only black color is available for this version.

2.3.3 Image.VideoOut

Description: Setting for analog video output. This option only applied for models with analog video output.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Image.VideoOut]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	off	on, off	1/6	Enable/disable analog video output.

2.4 ImageSource

Description: The parameter of image sources (video input or CCD/CMOS).

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[ImageSource]

Parameter name	Default value	Valid values	Security level (get/set)	Description
RecordIndex	0	An unsigned integer.	1/4	Specify the stream index for recording video clip.
SnapshotIndex	0	An unsigned integer.	1/4	Specify the stream index for recording snapshot clip.

2.4.1 ImageSource.I0.Sensor

Description: The name of the image source.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[ImageSource.I0.Sensor]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Brightness	50*	0¡K100	4/4	The image brightness.
Contrast	50*	0¡K100	4/4	The image contrast.
Saturation	50*	0¡K100	4/4	The image saturation.
Hue	50*	0¡K100	4/4	The image hue.
Sharpness	50*	0¡K100	4/4	The image sharpness.
Flip	off	on, off	4/4	Set image flip.
Mirror	off	on, off	4/4	Set image mirror.
PowerFrequency	auto	auto,hold,50,60	4/4	Specify current light source. The exposure time will be set to adequate value to avoid flicker.
WhiteBalance	auto	auto,hold,fluorescent, incandescent,sunny, cloudy,sun_shade,manual	4/4	White balance. If manual is chosen, ManualRgain set Red gain, ManualGgain set green gain, and ManualBgain set blue gain.
ExpTarget	20*	0¡K100	4/4	Set exposure target, the higher value, the higher image.
BackLightCompensate	off	on, off	4/4	Back light compensate.
ShutterSpeedMax	30	0¡K10000	4/4	Set max shutter speed, the value is denominator, 30 means 1/30 second
ShutterSpeedMin	120	0¡K10000	4/4	Set min shutter speed, the value is denominator, 120 means 1/120 second
GainMax	32	1,2,4,6,8,10,12,14,16,18,20,22, 24,26,28,30,32,36,40,44,48,52,56,60,64	4/4	Set max gain.
GainMin	1	1,2,4,6,8,10,12,14,16,18,20,22, 24,26,28,30,32,36,40,44,48,52,56,60,64	4/4	Set min gain.
ManualRgain	255	0...1023	4/4	Set red gain.
ManualGgain	255	0...1023	4/4	Set green gain.
ManualBgain	255	0...1023	4/4	Set blue gain.
LPRMode	disabled	disabled, 0-30, 30-60, 30-90	4/4	The mode of license plate recognition that you can change the speed range to fit your surroundings. 0-30 means car speed range in 0~30 km/hr.

(*) It depends on which model.

2.4.1.1 ImageSource.I0.Sensor.Rotate

Description: Contain parameters required to manage rotate open and angle.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[ImageSource.I0.Sensor.Rotate]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	off	off,on	4/6	Enable/disable rotat function.
Angle	0	0,90,180,270	4/6	Set rotate angle.
AngleDif	0	90,180,-90	4/6	Angle difference between the last angle.

2.4.2 ImageSource.I0.IR

Description: Configuration of the IR parameter

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[ImageSource.I0.IR]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Type	auto	on, off, auto	4/4	IR/LED Switch ON/OFF or auto switch.
ICRType	auto	on, off, auto	4/4	ICR Switch ON/OFF or auto switch. (¡§on¡¨ represent night mode; ¡§off¡¨ represent day mode)
Level	maximum value of level	1¡K3	4/4	The level value represent luminous intensity of IR
LevelFormat	1	1 1,2 1,2,3	4/7	Description what level be supported for IR device
LowTh	80	LowThMin ... LowThMax	4/4	The threshold value of IR/LED Auto switch on
HighTh	95	HighThMin ... HighThMax	4/4	The threshold value of IR/LED Auto switch off
LowThMin	0	0	4/7	Read only low threshold minimal value.
LowThMax	100	100	4/7	Read only low threshold maximal value.
HighThMin	0	0	4/7	Read only high threshold minimal value.
HighThMax	100	100	4/7	Read only high threshold maximal value.
LeastTime.DayToNight	10	1¡K10	4/4	Switch day to night mode if lasts more than seconds.

2.4.3 ImageSource.I0.Config

Description: Configuration of the sensor mode

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[ImageSource.I0.Config]

Parameter name	Default value	Valid values	Security level (get /set)	Description
CaptureMode	2048x1536@20*	(see description)	4/4	Switch capture mode, depends on CaptureModeFormatList
CaptureModeFormatList	2048x1536@20,1920x1080@30*	*	4/7	Capture mode List

(*) It depends on which model.

2.4.4 ImageSource.I0.SmartIR

Description:The adjustable IR will change its strength according to the object moving distance.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[ImageSource.I0]

Parameter name	Default value	Valid values	Security level (get /set)	Description
SmartIR	off	on,off	4/7	Enable/disable SmartIR.

2.4.5 ImageSource.I0.Iris

Description:

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[ImageSource.I0.Iris]

Parameter name	Default value	Valid values	Security level (get /set)	Description
Type	open	open,manual,auto	4/4	Iris type.
Value	17	0 ... 17*	4/4	Iris value.

(*) It depends on which model.

2.4.6 ImageSource.I0.LensControl

Description:

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[ImageSource.I0.LensControl]

Parameter name	Default value	Valid values	Security level (get /set)	Description
Smart.Method	fast	fast,full	4/4

2.5 StreamProfile

Description:

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[StreamProfile]

Parameter name	Default value	Valid values	Security level (get/set)	Description
MaxCnt	4	An Unsigned Integer*	1/7	Available stream profile numbers.
Prifix	I	I	1/7	The prefix of dynamic child groups.

(*) It depends on different model.

2.5.1 StreamProfile.I#

Description:

Security level (create/delete): 4/4

Template: StreamProfile

[StreamProfile.I#.Video]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	on	on, off	1/7	Enabled Video Streaming
Name	none	String	1/4	Profile Name.
Description	none	String	1/4	Profile Description
Codec	H264	MJPEG, H264	1/4	Codec Name
Profile	0	0,1,2	1/4	Compression method. 0:Baseline 1:Main 2:High Different Codec with different profile. H264:Baseline/Main/High(0/1/2) MJPEG:No profile could be used.
Resolution	1920x1080	*1920x1080, 1600x1200,* *1280x960, 1280x720,* *640x480, 640x360,* *320x240,**	1/4	Resolution
FPS	30*	Value in FPSFormat	1/4	Frame Rate

(*) It depends on which model.

[StreamProfile.I#.Video.Quality]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Mode	vbr	cbr,vbr,	1/4	Rate Control Mode
BitRate	6M	Value in BitrateFormat	1/4	Bit rate format for cbr mode.
MaxBitRate	8M	Value in BitrateFormat	1/4	Bit rate format for vbr mode.
Quant	31	Value in QFormat	1/4	Quality
QuantCustomize	no	yes,no	1/4	Set quality by user. (Only for quality format is vbr.)

[StreamProfile.I#.Video.Roi]

Parameter name	Default value	Valid values	Security level (get /set)	Description
Enabled	On	On, Off	1/4	Enabled Roi detection
NonRoiFps	1	Depends on fps limit	1/4	The FPS of non-ROI detection area.

[StreamProfile.I#.Audio]

Parameter name	Default value	Valid values	Security level (get /set)	Description
Enabled	On	On, Off	1/4	Enabled Audio Streaming

2.5.1.1 StreamProfile.I#.Video.Roi.I#

Description: Parameters for ROI.

Configure file: /etc/device.conf

Security level (create/delete): 4/4

[StreamProfile.I#.Video.Roi.I#] *

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	on	on, off	1/4	Enable ROI detection.
name	ROI	A string	1/4	ROI name.
RectX	0	Depends on resolution limit.	1/4	The Horizontal position of upper left corner. The value is from 0 to 640. Constraint: RectX+RectWidth <=640
RectY	0	Depends on resolution limit.	1/4	The vertical position of upper left corner. The value is from 0 to 360. Constraint: RectY+RectHeight <=360
RectWidth	200	Depends on resolution limit.	1/4	The width of the specified area. The value is from 0 to 640. Constraint: RectX+RectWidth <=640
RectHeight	200	Depends on resolution limit.	1/4	The height of the specified area. The value is from 0 to 360. Constraint: RectY+RectHeight <=360

* Note: the # is replaced with a group number starting from zero, e.g. StreamProfile.I0.Video.Roi.I0

* Note: the Maximum area of ROI is 640*360

2.6 Audio

2.6.1 AudioSource.A#

Description: Parameters for each audio source (audio input/chip).

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Audio.AudioSource.A#] *

Parameter name	Default value	Valid values	Security level (get/set)	Description
AudioEncoding	g.711 u-law	(see description)	1/4	The audio codec to use. Valid value depends on AudioCodecList.
AudioCodecList	g.711 u-law, g.711 a-law	g.711 u-law, g.711 a-law	4/7	The available audio codec that can be selected.

* Note: the # is replaced with a group number starting from zero, e.g. AudioSource.A0

2.6.1.1 AudioSource.A#.AudioDetection

Description: Parameters for audio detection.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Audio.AudioSource.A#. AudioDetection] *

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	off	on, off	4/4	Enable audio detection.
Sensitivity	5	(see description)	4/4	Higher sensitivity makes it easier to be triggered. Valid value depends on SensitivifyFormat.
SensitivifyFormat	1-100	1-100	4/7	Valid value for sensitivity.
Threshold	50	(see description)	4/4	Threshold that audio detection can be triggered. Valid value depends on ThresholdFormat.
ThresholdFormat	0-100	0-100	4/7	Valid value for threshold.

* Note: the # is replaced with a group number starting from zero, e.g. AudioSource.A0

2.7 Input

Description: Parameters for hardware input(s).

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Input]

Parameter name	Default value	Valid values	Security level (get/set)	Description
NbrOfInputs	1	An unsigned integer.	4/7	Number of inputs. The default value depends on different model.

2.7.1 Input.I#

Description: Parameters for hardware input(s).

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Input.I#] *

Parameter name	Default value	Valid values	Security level (get/set)	Description
Trig	open	open, closed	4/4	¡¥open¡¦ means enable trig. ¡¥closed¡¦ means disable trig.
DI	H	H, L	4/4	Specify trigger condition to high(H) or low(L).

* Note: The # is replaced with a group number starting from zero, e.g. Input.I0.

2.8 Output

Description: Parameters for hardware output(s).

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Output]

Parameter name	Default value	Valid values	Security level (get/set)	Description
NbrOfOutputs	1	An unsigned integer	4/7	Number of outputs.

2.8.1 Output.O#

Description: Parameters for hardware output(s).

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Output.O#] *

Parameter name	Default value	Valid values	Security level (get/set)	Description
Active	closed	open, closed	4/4	The active state of the output.
Mode	alarm	alarm, timer	4/4	alarm: Activated by trigger source. timer: Activated by schedule.
DO	H	H, L	4/4	Specify output level to be high(H) or low(L) when triggered.

* Note: The # is replaced with a group number starting from zero, e.g. Output.I0.

2.9 Schedule

Description: Arrange something to do at a particular time. There are maximum 10 scheule settings.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Schedule]

Parameter name	Default value	Valid values	Security level (get/set)	Description
MaxCnt	10	10	4/7	Maximum of schedule lists.
Prifix	S	S	4/7	The prefix of dynamic child groups .

Security level (create/delete): 4/4

Template: Schedule

[Schedule.S#]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Name	none	A string	4/4	The name on behalf of a schedule.
Sun	none,none,none,none,none	none, hh:mm-hh:mm	4/4	Set schedule in Sunday.
Mon	none,none,none,none,none	none, hh:mm-hh:mm	4/4	Set schedule in Monday.
Tue	none,none,none,none,none	none, hh:mm-hh:mm	4/4	Set schedule in Tuesday.
Wed	none,none,none,none,none	none, hh:mm-hh:mm	4/4	Set schedule in Wednesday.
Thu	none,none,none,none,none	none, hh:mm-hh:mm	4/4	Set schedule in Thursday.
Fri	none,none,none,none,none	none, hh:mm-hh:mm	4/4	Set schedule in Friday.
Sat	none,none,none,none,none	none, hh:mm-hh:mm	4/4	Set schedule in Saturday.

* Note: the # is replaced with a group number starting from zero, e.g. Schedule.S0

2.10 Properties

Description: Contains information about the firmware and system of the product. It also contains information about product dependent functionality and functionality that have no ordinary parameters. All user levels should be able to access the property parameters.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties]

Parameter name	Default value	Valid values	Security level (get/set)	Description
BoardID	TT01F001.00	A string	6/7	Board ID of product.

2.10.1 Properties.Firmware

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.Firmware]

Parameter name	Default value	Valid values	Security level (get/set)	Description
BuildDate	Thu Apr 17 20:14:13 CST 2008*	A string	4/7	Built date of firmware.
Version	MG.0.0.0.0*	A string	4/7	Firmware version.
SDKVersion	3.0*	A String	4/7	SDK Version

(*) It depends on which model or different time.

2.10.2 Properties.Hardware

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.Hardware]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Platform	HI3516*	A String	1/7	Platform string.

* The default value for these parameters is product specific.

2.10.3 Properties.DIDO.DI

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.DIDO.DI]

Parameter name

Default value

Valid values

Security level (get/set)

Description

yes, no

6/7

The product support alarm input.

Type

physical

virtual, physical

6/7

The alarm input type.

virtual: alarm input is from out side(ex. speed dome)

physical: On board alarm input.

2.10.4 Properties.DIDO.DO

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.DIDO.DO]

Parameter name

Default value

Valid values

Security level (get/set)

Description

yes, no

6/7

The product support alarm output.

Type

physical

virtual, physical

6/7

The alarm output type.

virtual: alarm output is from out side(ex. speed dome)

physical: On board alarm output.

2.10.5 Properties.PTZ

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.PTZ]

Parameter name	Default value	Valid values	Security level (get/set)	Description
PTZ¹	yes	yes, no	6/7	The product has Pan Tilt Zoom support.

¹ Product dependent. If the parameter does not exist, the functionality is not supported.

2.10.6 Properties.Motion

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.Motion]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Motion¹	yes	yes, no	6/7	The product has Motion Detection support.

¹ Product dependent. If the parameter does not exist, the functionality is not supported.

2.10.7 Properties.Audio

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.Audio]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Audio¹	yes	yes, no	4/7	The product has audio support.
AudioDetection¹	yes	yes, no	4/7	The product support audio detection function.

¹ Product dependent. If the parameter does not exist, the functionality is not supported.

2.10.8 Properties.System

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.System]

Parameter name	Default value	Valid values	Security level (get/set)	Description
IDE	no	yes, no	7/7
PCI	no	yes, no	7/7
USB	no	yes, no	7/7
SDC	no	yes, no	7/7
LCD	no	yes, no	7/7
UART1	yes	yes, no	7/7
UART2	yes	yes, no	7/7
UART3	no	yes, no	7/7
UART4	no	yes, no	7/7

2.10.9 Properties.NetworkStorage

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.NetworkStorage]

Parameter name	Default value	Valid values	Security level (get/set)	Description
NetworkStorage	yes	yes, no	6/7	The product has Network Storage support.

2.10.10 Properties.MemoryCard

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.MemoryCard]

Parameter name	Default value	Valid values	Security level (get/set)	Description
MemoryCard¹	no	yes, no	6/7	The product support SD card.

¹ Product dependent. If the parameter does not exist, the functionality is not supported.

2.10.11 Properties.VideoOut

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.VideoOut]

Parameter name	Default value	Valid values	Security level (get/set)	Description
VideoOut¹	No	yes, no	6/7	The product support analog video output.

¹ Product dependent. If the parameter does not exist, the functionality is not supported.

2.10.12 Properties.IR

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.IR]

Parameter name	Default value	Valid values	Security level (get/set)	Description
IR	yes	yes, no	6/7	The product support IR.
ICR	yes	yes, no	6/7	The product support ICR.
SmartIR	yes	yes, no	6/7	The product support SmartIR.

2.10.13 Properties.Image

Description:

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.Image]

Parameter name	Default value	Valid values	Security level (get/set)	Description
BitRateFormat	32k,64k,128k,256k,512k,768k, 1M,1.5M,2M,3M,4M,6M,8M,10M*	Default value	1/7	The supported BitRate value for CBR
CodecFormat	H264,MJPEG*	Default value	1/7	The supported Codec options.
MaxBitRateFormat	512k,1M,2M,4M,6M,8M,10M*	Default value	1/7	The supported MaxBitRate value for VBR

* The default value for these parameters is product specific.

2.10.13.1 Properties.Image.ResolutionFormat

Description:

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.Image.ResolutionFormat]

Parameter name	Default value	Valid values	Security level (get/set)	Description
List	1920x1080,1280x720, 640x480,640x360,320x240*	Default value	1/7	The product support resolution.
Profile.P#	1920x1080,1280x720, 640x480,640x360,320x240*	Default value	1/7	The resolutions that profile # supports. # could be integer..

* The default value for these parameters is product specific.

2.10.13.2 Properties.Image.FixQualityFormat

Description:

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.Image.FixQualityFormat]

Parameter name	Default value	Valid values	Security level (get/set)	Description
H264	0,68,55,50,46,41*	Default value	1/7	If quant quality is not customize, the product support H264 quality value.
MJPEG	0,90,70,50,35,25*	Default value	1/7	If quant quality is not customize, the product support MJPEG quality value.

* The default value for these parameters is product specific.

2.10.13.3 Properties.Image.FPSFormat

Description:

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.Image.FPSFormat]

Parameter name	Default value	Valid values	Security level (get/set)	Description
H264	30,30,30,30*	Default value	1/7	The Maximum FPS supported in each profile 30,30,30,30 means max FPS for every Profiles is 30
MJPEG	30,30,30,30*	Default value	1/7	The Maximum FPS supported in each profile 30,30,30,30 means max FPS for every Profiles is 30

* The default value for these parameters is product specific.

2.10.14 Properties.GlassDemister

Description:

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.GlassDemister]

Parameter name	Default value	Valid values	Security level (get/set)	Description
GlassDemister	yes	yes, no	4/7	Hardware defog.

2.10.15 Properties.Lens

Description:

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.Lens]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Type	motorized*	motorized,fisheye,normal*	4/7	The product lens type. motorized means it is a zoom in/out lens. fisheye means it is a fisheye lens. normal means it is a fixed lens.

* The default value for these parameters is product specific.

2.10.16 Properties.LPRMode

Description:

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.LPRMode]

Parameter name	Default value	Valid values	Security level (get/set)	Description
LPRMode	yes	yes,no	1/7	To check if the camera support LPR mode.

2.11 Security

Description: Contains parameters related to SSL(Secure socket layer).

2.11.1 Security.HttpsPolicy

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Security.HttpsPolicy]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Admin	http	http, https, http_n_https	4/6	Set allowed connect mode for group admin (http, https, or both).
Operator	http	http, https, http_n_https	4/6	Set allowed connect mode for group operator (http, https, or both).
Viewer	http	http, https, http_n_https	4/6	Set allowed connect mode for group viewer (http, https, or both).

2.11.2 Security.IPFilter

Description: IP filter can set to allow or deny a range of IP address to get connected.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Security.IPFilter]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	off	on, off	4/4	Specify if IP filter is enabled.
Type	Deny	Deny, Allow	4/4	Set IP address range that will be blocked or allowed by product.
MaxCnt	5	5	4/7	Maximum of denied IP lists.
Prifix	F	F	4/7	The prefix of dynamic child groups .

[Security.IPFilter.F#]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Rule	User select	single, network, range	4/4	IPFilter rules.
SingleAddress	0.0.0.0	<ip address>	4/4	IP address of the single or network rule.
StartAddress	0.0.0.0	<ip address>	4/4	Start IP address of the range rule.
EndAddress	0.0.0.0	<ip address>	4/4	End IP address of the range rule.
Submask	0	0~32	4/4	CIDR notation

* Note: the # is replaced with a group number starting from zero, e.g. Security.IPFilter.F0

2.12 PTZ

2.12.1 PTZ.PTZDrivers

Description: List of installed PTZ drivers.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[PTZ.PTZDrivers]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Driver0	pelcop	A string	4/7	The name of the driver currently installed on index0.
Driver1	pelcod	A string	4/7	The name of the driver currently installed on index1.
Driver2	dynacolor	A string	4/7	The name of the driver currently installed on index2.
Driver3	vtrec	A string	4/7	The name of the driver currently installed on index3.

2.12.2 PTZ.SerDrivers

Description: List of PTZ drivers associated with serial ports.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[PTZ.SerDrivers]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Ser0Driver	None	A string	6/6	The name of the driver currently associated with serial port 0.
Ser1Driver	pelcop	A string	1/1	The name of the driver currently associated with serial port 1.

2.12.3 PTZ.Speed

Description: List of speed setting for PTZ.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[PTZ.Speed]

Parameter name	Default value	Valid values	Security level (get/set)	Description
PanSpeed	3	1 ~5	1/1	Pan speed.
TiltSpeed	3	1 ~4	1/1	Tilt speed.
ZoomSpeed	50	0 ¡K 100	1/1	Zoom speed.
FocusSpeed	50	0 ¡K 100	1/1	Focus speed.
AutoPanSpeed	3	1 ~4	1/1	Auto pan speed.

2.12.4 PTZ.CtrlParam

Description: Transmitter and receiver ID/address.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[PTZ.CtrlParam]

Parameter name	Default value	Valid values	Security level (get/set)	Description
keyid	0	0	6/7	Transmitter ID/address
address	0	0 ¡K 128	1/1	Receiver ID/address

2.12.5 PTZ.PresetPos

Description: Defines dynamic parameter about preset position.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

2.12.5.1 PTZ.PresetPos.P#

Description: A dynamic parameter group PTZ.PresetPos.P# is created for each new preset position. # merely denotes the number of the dynamic parameter group and has no connection to any preset position numbers mentioned below.

Configure file: /etc/device.conf

Security level (create/delete): 1/1

Template: PresetPos

[PTZ.PresetPos.P#]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Pos

none

<Name>: A valid preset position name according to the PTZ control section in HTTP API.

~ : ¹ delimited string with the
following content:
<Type>: server
<No>: An integer
<PresetNo>: An integer
<DriverNo>: 1, ...
<CamNo>:1, ...
<Pan>: -1, An integer
<Tilt>: -1, An integer
<Zoom>: 10000, An integer
<Focus>: 10000, An integer
<Iris>: 10000,An integer

1/1

Holds all necessary information about the preset position.

<Name>: The name of the preset position.
<Type>: The type of preset position, "server" for server preset positions.
<No>: The number of the server preset position.
<PresetNo>: The number of the device preset position.
<DriverNo>: The number (index) of the concerned driver.
<CamNo>: The number of the concerned camera.
<Pan>: The pan position if known, else -1.
<Tilt>: The tilt position if known, else -1.
<Zoom>: The zoom position if known, else 10000.
<Focus>: The focus position if known, else 10000.
<Iris>: The iris position if known, else 10000.

Example of a server preset position (number 3) emulated by a device preset position (number 12):
Entrance~server:3:12:1:
2:45:10:10000:10000:
10000

¹ Except for Name, delimited by ~.

2.12.6 PTZ.GuardTour

Description: Defines parameter about patrol position.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[PTZ.GuardTour]

Parameter name	Default value	Valid values	Security level (get/set)	Description
ActiveTour	none	G0 ¡K G3	1/1	Default guardtour.

2.12.6.1 PTZ.GuardTour.G#

Description: A dynamic parameter group PTZ.GuardTour.G# is created for each patrol group.

Configure file: /etc/device.conf

Security level (create/delete): 1/1

Template: GuardTour

[PTZ.GuardTour.G#]*

Parameter name	Default value	Valid values	Security level (get/set)	Description
Running	no	yes, no	1/1	This guard tour setting is been running.
Name	GourdTour#+1	A string	1/1	Name of guard tour setting
IntervalSecond	300	0~59940	1/1	The interval second between one GuardTour run.

* Note: The # is replaced with a number, e.g. GuardTour.G0.

2.12.6.2 PTZ.GuardTour.G#.Tour.T#

Description: A dynamic parameter group PTZ.GuardTour.G#.Tour.T# is created for each new patrol position. # merely denotes the number of the dynamic parameter group and has no connection to any patrol position numbers mentioned below.

Configure file: /etc/device.conf

Security level (create/delete): 1/1

Template: Tour

[PTZ.GuardTour.G#.Tour.T#]*

Parameter name	Default value	Valid values	Security level (get/set)	Description
PresetNbr	none	0 ¡K 31	1/1	Index of preset position (see section 2.12.5).
Position	1	1 ¡K 8	1/1	The order in the tour list.
WaitTime	2	1 ¡K 99	1/1	Wait time from this position to next position.

* Note: The # is replaced with a number, e.g. GuardTour.G0.Tour.T0.

2.12.7 PTZ.RS485

Description: Defines parameter about RS485 setting.

Configure file: /etc/device.conf

Security level (create/delete): 1/1

[PTZ.RS485]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	off	off,on	1/1	Enabled/disabled RS485.

2.13 Serial

Description: Controls the functionality/purpose of the serial ports and some configuration that is shared by various applications. Note that some applications have their own settings for baudrate, parity etc.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Serial]

Parameter name

Default value

Valid values

Security level (get/set)

Description

NbrOfPorts

An unsigned integer

6/7

Number of serial ports.

PurposePort#

0: OFF

1: PTZ

OFF,
PTZ

6/7

The current usage of the serial port.

OFF = Unused.

PTZ = Pan Tilt Zoom. Supports PTZ control and serial port control according to HTTP API. Requires an installed PTZ driver.

2.13.1 Serial.Ser#

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Serial.Ser#] *

Parameter name	Default value	Valid values	Security level (get/set)	Description
PortMode	RS232	RS232, RS485¹	6/6	Serial port protocol. May be read-only depending on hardware.
BaudRate	38400	300, 600, 1200, 2400, 2400, 4800, 9600, 19200, 38400, 57600, 115200, (for RS485 also 230400 and 460800)	6/6	The baudrate used in the serial communication.
DataBits	8	7, 8	6/6	The number of data bits.
StopBits	1	1, 2	6/6	The number of stop bits.
Parity	None	None, Even, Odd	6/6	The parity.

* Note: The # is replaced with a number, e.g. Serial.Ser1.¹Product-dependent. Check the product specification.

2.14 Event

Description: Configure the event trigger type and server action, local action, media type.

2.14.1 Event.Server

Description: A dynamic parameter group Event.Server.S# is created for configure FTP, SMTP, HTTP, HTTPS, Network Storage setting.

Configure file: /etc/device.conf

Security level (create/delete): 7/7

[Event.Server]

Parameter name	Default value	Valid values	Security level (get/set)	Description
MaxCnt	3	3	4/7	Maximum of event server number.
Prifix	E	E	4/7	The prefix of dynamic child groups.

Security level (create/delete): 4/4

Template: FTP/SMTP/HTTP/HTTPS/NetworkStorage

[Event.Server.S#]

Template: FTP

Description: Parameters for the File Transfer Protocol, for sending files. Can be used by an event to upload files to.

Parameter name	Default value	Valid values	Security level (get/set)	Description
Name	none	A string	4/4	The name of event server.
Type	ftp	ftp	4/7	The server type.
ServerName	none	An IP address or a host name	4/4	IP address or host name of the server.
ServerPort	21	1~65535	4/4	FTP server port.
UploadPath	none	A folder name	4/4	Upload to specific folder.
Username	none	A string	4/4	FTP server user name.
Password	none	A string	4/4	FTP server password.
Passive	none	on,off	4/4	Use passive FTP.

Template: SMTP

Description: Parameters for the Simple Mail Transfer Protocol, for sending e-mail messages between mail servers.

Parameter name	Default value	Valid values	Security level (get/set)	Description
Name	none	A string	4/4	The name of event server.
Type	smtp	smtp	4/7	The server type.
ServerName	none	An IP address or a host name	4/4	IP address or host name of the server.
ServerPort	25	1~65535	4/4	Mail server port.
ServerSSL	off	off,on	4/4	Specify if SSL protocol needed for the mail server.
Authentication.Mode	none	none,smtp,smtp-pop	4/4	none: No authentication needed. smtp: Authentication needed for SMTP. smtp-pop: Need to login pop before SMTP.
Authentication.PopServerName	none	An IP address or a host name	4/4	The IP address or host name of the POP server.
Authentication.Username	none	A string	4/4	The user name for the mail server or the POP server.
Authentication.Password	none	A string	4/4	The password for the mail server or the POP server.
AdminAddr	none	An e-mail address	4/4	Mail address of sender.

Template: HTTP

Description: If an event handling server is available, user can configure the CGI parameters and/or messages sent to the event server when event occurred.

Parameter name	Default value	Valid values	Security level (get/set)	Description
Name	None	A string	4/4	The name of event server.
Type	http	http	4/7	The server type.
URL	none	An URL	4/4	HTTP URL.
CGIPath	None	A string	4/4	CGI path and CGI name.
Port	80	1~65535	4/4	HTTP server port.
Username	none	A string	4/4	User name.
Password	none	A string	4/4	User password.
ProxyAddr	none	A string	4/4	Proxy address.(optional)
ProxyPort	none	1~65535	4/4	Proxy port.(optional)
ProxyUsername	none	A string	4/4	User name of proxy server. (optional)
ProxyPassword	none	A string	4/4	Password of proxy server. (optional)

Template: NetworkStorage

Description: User could record video or save alarm file to network storage through samba (Windows network file) or nfs (Unix network file).

Parameter name	Default value	Valid values	Security level (get/set)	Description
Name	none	A string	4/4	The name of event server.
Type	ns	ns	4/7	The server type.
Protocol	cifs	cifs, nfs	4/4	Types of network file system.
Location	none	A string	4/4	Network File path, e.g. //<IP>/<folder> for cifs, <IP>:/<folder> for nfs.
Path	none	A folder name	4/4	Upload to folder.
Workgroup	none	A string	4/4	Workgroup of server network
Username	none	A string	4/4	Username for cifs.
Password	none	A string	4/4	Password for cifs.

2.14.2 Event.Media

Description: A dynamic parameter group Event.Media.M# is created for configure media setting.

Configure file: /etc/device.conf

Security level (create/delete): 4/4

Template: Media

[Event.Media]

Parameter name	Default value	Valid values	Security level (get/set)	Description
MaxCnt	5	5	4/7	Maximum of event media number.
Prifix	M	M	4/7	The prefix of dynamic child groups.

[Event.Media.Alarm]

Parameter name	Default value	Valid values	Security level (get/set)	Description
BufferSize	¹ 30720	¹ 30720	4/7	Size of record pre-buffer.
MaxFileSize	¹ 10240	¹ 10240	4/7	Maximum size of record file.
MaxBufferTime	¹ 8	¹ 8	4/7	Maximum record time of record file.
MaxBitRate	¹ 4M	¹ 4M	4/7	The maximum bitrates when recording.

¹ These parameters are for P6210, and there will be changed depend on different model.

[Event.Media.Snapshot]

Parameter name	Default value	Valid values	Security level (get/set)	Description
PreAlarm.Format	¡§0~7¡¨	¡§0~7¡¨	4/4	Specify the minimal and maximal value of allowed pre-alarm image.
PostAlarm.Format	¡§0~7¡¨	¡§0~7¡¨	4/4	Specify the minimal and maximal value of allowed post-alarm image.

[Event.Media.Video]

Parameter name	Default value	Valid values	Security level (get/set)	Description
PreAlarm.Format	¡§0~7¡¨	¡§0~7¡¨	4/4	Specify the minimal and maximal value of allowed pre-alarm record time.
PostAlarm.Format	¡§1~7¡¨	¡§1~7¡¨	4/4	Specify the minimal and maximal value of allowed post-alarm record time.

[Event.Media.M#]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Name	none	A string	4/4	Name of event media.
Type	snapshot	snapshot,video,syslog	4/4	Types of media.
ImageName	none	A string	4/4	Name of record file.
Suffix	date	none,date,seq	4/4	Suffix of record file.
PreAlarm	5	0~7	4/4	Record time or snapshot number of pre-alarm.
PostAlarm	5	0~7 for snapshot 1~7 for video	4/4	Record time or snapshot number of post-alarm.

2.14.3 Event.List

Description: A dynamic parameter group Event.List.E# is created for configure event setting.

Configure file: /etc/device.conf

Security level (create/delete): 4/4

Template: Event

?[Event.List]

Parameter name	Default value	Valid values	Security level (get/set)	Description
MaxCnt	3	3	4/7	Maximum of event list number.
Prifix	E	E	4/7	The prefix of dynamic child groups.

[Event.List.E#]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Name	none	5	4/4	Name of event.
Enabled	off	on/off	4/4	Set this event enable or disable.
Priority	2	1~5	4/4	Configure priority of event. ¡¥1¡¦ is highest priority.
Interval	10	1~999	4/4	Time interval between triggers.
Period	always	always, schedule	4/4	Enable alarm trigger all the time or by schedule.
Schedule	none	0~4 (index of schedule)	4/4	Specify what schedule use.

[Event.List.E#.Trigger]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Type	Motion	Motion, Audio, Tampering, Periodical, Boot, RecNotify, Linkdown, IPNotify, Dinput, ICR, PIR	4/4	Configure the trigger type.
Param	0	Motion detection window number, period of periodical, digital input number	4/4	Specify motion detection window number, period of periodical, digital input number.
Condition	none	/(means active),\(means inactive),x(means change)	4/4	Specify trigger condition is active, inactive or both.

[Event.List.E#.Action.Local]

Description: Configure local action of event. Local action including PTZ, Digital Output, IR Cut filter.

[Event.List.E#.Action.Local.L0]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Name	PTZ	PTZ	4/7	Name of local action.
Enabled	off	off,on	4/4	Enable PTZ local action.
Type	preset	preset, patrol	4/4	Specify what kind type of PTZ action.
PresetNbr	none	index of preset position	4/4	Index of preset position.
PatrolNbr	none	index of patrol group	4/4	Index of patrol group.
Return	off	off,on	4/4	Enable or disable go back to original position.
Duration	10	1~999	4/4	After alarm trigger, PTZ go specified preset position, it will stay specified seconds then go back to original position.

[Event.List.E#.Action.Local.L1]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Name	DO1	DO1	4/7	Name of local action.
Enabled	off	off,on	4/4	Enable digital output 1 local action.
Type	triggering	triggering, duration	4/4	triggering: Activated by trigger active. duration: Activated by duration.
Duration	10	1~999	4/4	Output duration when triggered.

[Event.List.E#.Action.Local.L2]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Name	DO2	DO2	4/7	Name of local action.
Enabled	off	off,on	4/4	Enable digital output 2 local action.
Type	triggering	triggering, duration	4/4	triggering: Activated by trigger active. duration: Activated by duration.
Duration	10	1~999	4/4	Output duration when triggered.

[Event.List.E#.Action.Local.L3]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Name	ICR	ICR	4/7	Name of local action.
Enabled	off	off,on	4/4	Enable ICR local action.
Type	triggering	triggering, duration	4/4	triggering: Activated by trigger active. duration: Activated by duration.
Duration	10	1~999	4/4	IR cut filter duration when triggered.

[Event.List.E#.Action.Server]

Description: A dynamic parameter group Event.List.E#.Action.Server.S# is created for configure server action setting.

Template: Server

Parameter name	Default value	Valid values	Security level (get/set)	Description
MaxCnt	5	5	6/7	Maximum of server action.
Prifix	S	S	6/7	The prefix of dynamic child groups.

[Event.List.E#.Action.Server.MemoryCard]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Name	SD	SD	4/7	Name of server.
Enabled	off	off, on	4/4	Enable memory card action.

[Event.List.E#.Action.Server.S#]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	on	on, off	4/4	Enable this server action.
Server	none	server index: 0~4	4/4	Index of server.
Media	none	media index: 0~4	4/4	Index of media.
RemotePath	none	A string	4/4	Upload to specify path.
Parameter	none	A string	4/4	Setting for HTTP server, message to be sent when event triggered.
RcptToAddr	none	An e-mail address	4/4	Mail address of receiver.

2.14.4 Event.MemoryCard

Description: Memory card could be used to save video clip/snapshot triggered by alarm or schedule. When ftp client or network storage fails to send file, memory card could be a storage media for backup.

Configure file: /etc/device.conf

Security level (create/delete): 6/6

[Event.MemoryCard]

Parameter name	Default value	Valid values	Security level (get/set)	Description
Enabled	off	on, off	6/6	Enable/disable memory card function.
Notify	off	on, off	6/6	Send notification by SMTP if card status change. Card status include card remove, fail, full, ¡K,etc.
Overwrite	off	on, off	6/6	Over write old files if card full.
CapacityWarn	0	0 ¡K 50	6/6	Send notification by SMTP if remaining size of card reaches specified percentage value (%). Set value 0 to disable this function.
Path	none	A string	6/6	SD Card File path, e.g. <folder>/IPCamera<MACaddress>/¡K
Media.Type	snapshot	snapshot, video, syslog	6/6	Snapshot: take a pic. Video: record a video file. Syslog: syslog that a event be triggered
Media.ImageName	none	A string	6/6	Prefix of file name
Media.Suffix	date	date	6/7	Add date time information as suffix.
Media.PreAlarm	0	0 ¡K7 (type=snapshot/video) 0(type=syslog)	6/6	Record time in unit of second before trigger a event.
Media.PostAlarm	0(type=snapshot) 1(type=video) 0(type=syslog)	0…7(type=snapshot) 1…7(type=video) 0(type=syslog)	6/6	Record time in unit of second after trigger a event.

2.14.5 Event.Scheduled

Description: Record periodical files to Network Storage or SD Card.

Configure file: /etc/device.conf

Security level (create/delete): 6/6

[Event.Scheduled]

Parameter name	Default value	Valid values	Security level (get/set)	Description
MaxCnt	2	2	6/7	Maximum of periodical recording schedules.
Prifix	S	S	6/7	The prefix of dynamic child groups .
S# *				Dynamic added child groups.
S#.Name	none	A string	6/6	A name id of that recording schedule.
S#.Enabled	on	on, off	6/6	Enable/disable recording.
S#.Suffix	date	date	6/7	File suffix
S#.FileSize	10	1¡K50	6/6	One Recording file size (in MB)
S#.CyclicSize	1024	100¡K1024000	6/6	While overall disk usage is larger than this size, the previous files will be replaced.
S#.ServerType	none	NS, SD	6/6	The recording schedule records files to Network Storage or SD Card.
S#.Period	always	always, schedule	6/6	Determine the recording schedule records always or at a particular date.
S#.Schedule	0	0¡K9	6/6	Record at this particular date Schedule. (refer to ch 2.11)

* Note: the # is replaced with a group number starting from zero, e.g. Event.Scheduled.S0

2.16 Syslog

Description: Parameters for system log.

Configure file: /etc/device.conf

Security level (create/delete): 6/6

[Syslog]

Parameter name	Default value	Valid values	Security level (get/set)	Description
EnableRemoteLog	off	on, off	6/6	Enable/Disable Remote system log.
ServerIp	None	A string	6/6	Syslog server IP address.
ServerPort	514	1 ... 65535	6/6	Syslog server port number.