Parameter Specification

Revision: 3.0
Date: 2011-Aug-12


TABLE OF CONTENTS

DOCUMENT HISTORY.. 2

1 OVERVIEW... 2

1.1 Product and firmware versions. 2

1.2 Security levels. 2

1.3 Valid values. 2

2 PARAMETER GROUPS. 2

2.1 General 2

2.1.1 Brand. 2

2.1.2 UserID.. 2

2.1.3 System.. 2

2.1.4 Network. 2

2.1.5 Network.DDNS. 2

2.1.6 Network.DDNS.ServerList 2

2.1.7 Network.eth0. 2

2.1.8 Network.UPnP. 2

2.1.9 Network.UPnP.NATTraversal 2

2.1.11 Network.Wireless. 2

2.1.12 Network.Wireless.W#. 2

2.1.13 Network.RTSP. 2

2.1.14 Network.RTSP.R#. 2

2.1.15 Network.RTP. 2

2.1.16 Network.RTP.R#. 2

2.1.17 Network.Bonjour 2

2.1.18 Time. 2

2.1.18.1 Time. DayLightSaving. 2

2.1.18.1.1 Time.DayLightSaving.Start 2

2.1.18.1.2 Time.DayLightSaving.Stop. 2

2.1.18.2 Time.NTP. 2

2.2 Motion. 2

2.2.1 Motion.M#. 2

2.3 Image. 2

2.3.1 Image.I#. 2

2.3.2 Image.OSD.. 2

2.3.3 Image.Mask. 2

2.3.4 Image.VideoOut 2

2.4 ImageSource. 2

2.4.1 ImageSource.I0.Sensor 2

2.4.1.1 ImageSource.I0.Sensor.Default 2

2.4.2 ImageSource.I0.Config. 2

                    2.4.3 ImageSource.I0.IR

2.5 Audio. 2

2.5.1 AudioSource.A#. 2

2.5.1.1 AudioSource.A#.AudioDetection. 2

2.6 Input 2

2.6.1 Input.I#. 2

2.7 Output 2

2.7.1 Output.O#. 2

2.8 Schedule. 2

2.9 Properties. 2

2.9.1 Properties.Firmware. 2

2.9.2 Properties.Hardware. 2

2.9.3 Properties.DIDO.DI. 2

2.9.4 Properties.DIDO.DO.. 2

2.9.5 Properties.PTZ.. 2

2.9.6 Properties.Motion. 2

2.9.7 Properties.Audio. 2

2.9.8 Properties.System.. 2

2.9.9 Properties.Bonjour 2

2.9.10 Properties.NetworkStorage. 2

2.9.11 Properties.MemoryCard. 2

2.9.12 Properties.VideoOut 2

                    2.9.13 Properties.IR

2.10 Security. 2

2.10.1 Security.HttpsPolicy. 2

2.10.2 Security.IPFilter 2

2.10.2.1 Security.IPFilter.DenyList 2

2.10.2.2 Security.IPFilter.AllowList 2

2.11 PTZ

2.11.1 PTZ.PTZDrivers

2.11.2 PTZ.SerDrivers

2.11.3 PTZ.Speed

2.11.4 PTZ.CtrlParam

2.11.5 PTZ.PresetPos

2.11.5.1 PTZ.PresetPos.P#

2.11.6 PTZ.GuardTour

2.11.6.1 PTZ.GuardTour.G#

2.11.6.2 PTZ.GuardTour.G#.Tour.T#

2.12 EPTZ

2.12.1 EPTZ.PresetGroup

2.12.1.1 EPTZ.PresetGroup.S#

2.12.1.2 EPTZ.PresetGroup.S#.PresetPos.P#

2.12.2 EPTZ.GuardGroup

2.12.2.1 EPTZ.GuardGroup.S#

2.12.2.2 EPTZ.GuardGroup.S#.GuardTour

2.12.2.3 EPTZ.GuardGroup.S#.GuardTour.G#

2.12.2.4 EPTZ.GuardGroup.S#.GuardTour.G#.Tour.T#

3 OPTIONAL PARAMETER GROUP. 1

3.1 ImageSource. 1

3.1.1 Basic. 1

3.1.2 Advance. 1

 


DOCUMENT HISTORY

Version

Date

Comment

3.0

2011-Aug-12

Initial version.

 

 

 

 

 

 

 

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.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Brand]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Brand

*

A string (Auto generated)

0/7

The brand of the product.

ProdFullName

*

A string (Auto generated)

0/7

The full name of the product.

ProdNbr

*

A string (Auto generated)

0/7

The product number.

ProdShortName

*

A string (Auto generated)

0/7

The short name of the product.

ProdType

*

Video Server,
Network Camera,
Network Video Recorder
(Auto generated)

0/7

The product type.

WebURL

*

A string (Auto generated)

0/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.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[UserID]

Parameter name

Default value

Valid values

Security level (get/set)

Description

ViewerAuthen

on

on, off

6/6

Enable anonymous viewer (value=off) or not (value=on).

PTZAuthen

on

on, off

6/6

Enable anonymous PTZ control (value=off) or not (value=on).

Admin

 YWRtaW46YWRtaW4=

 A base64 string

6/6

Default admin account.

MaxCnt

9

9

6/7

Maximum of UserID lists.

Prifix

U

U

6/7

The prefix of dynamic child groups.

U# *

 

 Dynamic added child groups.

U#.User

 

 A base64 string

6/6

 

* 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.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[System]

Parameter name

Default value

Valid values

Security level (get/set)

Description

BoaProtViewer

password

password,
anonymous

0/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

80,1124…65535

0/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).

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[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.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Network.DDNS]

Parameter name

Default value

Valid values

Security level (get/set)

Description

NbrOfSupport

3

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.

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

Security level (create/delete): 7/7

[Network.eth0]

Parameter name

Default value

Valid values

Security level (get/set)

Description

DNSAuto

on

on,

off

6/6

Specifies if the DNS server should be obtained from a DHCP server.

DNSServer1

0.0.0.0

An IP address

6/6

Primary domain name system server.

DNSServer2

0.0.0.0

An IP address

6/6

Secondary domain name system server.

BootProto

dhcp

dhcp,

none

6/6

Enable/disable dynamic IP address assignment to the device.

IPAddress

192.168.1.100

An IP address

0/6

IP Address. The physical address of the device on the network.

MACAddress

00:40:8C:xx:xx:xx

A MAC address (Auto generated)

6/6

MAC address. The unique identity of the device.

This parameter is read only.

SubnetMask

255.255.255.0

An IP address

6/6

Subnet mask. Divides the network.

DefaultRouter

192.168.1.1

An IP address

6/6

Routing table actually in use by the operating system

IPAddressRange

192.168.1.2-

192.168.1.254

A string

6/6

 

 

2.1.8 Network.UPnP

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

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Network.UPnP]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

yes

yes,
no

0/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.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Network.UPnP.NATTraversal]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

no

yes,
no

0/6

Enables/disables NAT traversal.

HTTPPort

80

1124 ... 65535

0/6

Number of HTTP port for NAT traversal.

HTTPSPort

443

1124 ... 65535

0/6

Number of SSL port for NAT traversal.

RTSPPort

554

1124 ... 65535

0/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.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Network.PPPoE]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

no

yes,

no

0/6

Enables/disables PPPoE

IPAddress

0.0.0.0

An IP address

6/6

IP Address. The physical address of the device on the network.

UserID

none

A string

6/6

For login PPPoE service.

Password

none

A string

6/6

For login PPPoE service.

DNSAutod

on

on,

off

6/6

Specifies if the DNS server should be obtained from a DHCP server.

DNSServer1

0.0.0.0

An IP address

6/6

Primary Domain Name System server.

DNSServer2

0.0.0.0

An IP address

6/6

Secondary Domain Name System server.

 

2.1.11 Network.Wireless

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

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Network.Wireless]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

no

yes,

no

6/6

Enables/disables Wireless

BootProto

dhcp

dhcp,

none

6/6

Enable/disable dynamic IP address assignment to the device.

IPAddress

192.168.2.100

An IP address

0/6

IP Address. The physical address of the device on the network.

SubnetMask

255.255.255.0

An IP address

6/6

Subnet mask. Divides the network.

DefaultRouter

192.168.2.1

An IP address

6/6

Routing table actually in use by the operating system

DNSAuto

on

on,

off

6/6

Specifies if the DNS server should be obtained from a DHCP server.

DNSServer1

0.0.0.0

An IP address

6/6

Primary Domain Name System server.

DNSServer2

0.0.0.0

An IP address

6/6

Secondary Domain Name System server.

ActiveSettingIndex

none

An unsigned integer

6/6

Specifies which wireless adapter(Network.Wireless.W#) is activated.

 

2.1.12 Network.Wireless.W#

Description: Network settings for each wireless adapter.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Network.Wireless.W#]*

Parameter name

Default value

Valid values

Security level (get/set)

Description

SSID

none

A string

6/6

Specifies the Service Set ID

NetType

Managed

Managed,
AdHoc

6/6

Enable\disable security

Authentication

Open

WPA-PSK,

WPA2-PSK,

WPA-None,
Open,
SharedKey

6/6

Specifies the security mode

WpaDataEncrypt

TKIP

TKIP,

AES

6/6

Encrypt mode for WPA

WpaGenMethod

Ascii

Ascii ,
Hex

6/6

Specifies the key type

WpaPhrase

none

A string

6/6

The pass phrase of wpa in Ascii mode

WpaKey

none

A string

6/6

The pass phrase of wpa in HEX mode

WepDataEncrypt

NoSecurity

NoSecurity,
SharedKey

6/6

Specifies the data encrypt mode

WepKeyLength

64bit

64bit,
128bit

6/6

Specifies the key length

WepGenMethod

Hex

Ascii ,
Hex

6/6

Specifies the key type

WepPassphrase

none

A string

6/6

Specifies the pass phrase

WepKey0

none

A string

6/6

Specifies the wep key

WepKey1

none

A string

6/6

Specifies the wep key

WepKey2

none

A string

6/6

Specifies the wep key

WepKey3

none

A string

6/6

Specifies the wep key

WepActiveKey

1

0,1,2,3

6/6

Specifies which WepKey is used

* Note: The # is replaced with a number, e.g. Network.Wireless.W0.

 

2.1.13 Network.RTSP

Description: Enable/disable Real Time Streaming Protocol.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Network.RTSP]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Port

554

102465535

0/6

The Port number for RTSP Server

 

2.1.14 Network.RTSP.R#

Description: Parameters for each RTSP stream.

Configuration 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

0/6

Disable/enable RTSP Authentication mode

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

 

2.1.15 Network.RTP

Description: Parameters for Real-time Transport Protocol stream.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Network.RTP]

Parameter name

Default value

Valid values

Security level (get/set)

Description

StartPort

5000

1024 ... 65532

6/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

1025 ... 5535

6/6

Upper bound of port range in RTP Over UDP.

 

2.1.16 Network.RTP.R#

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

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Network.RTP.R#]*

Parameter name

Default value

Valid values

Security level (get/set)

Description

Multicast

0

0,1

0/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

6/6

RTP multicast IP address.

VideoPort

0

0,
1024 ... 65535

6/6

The port number for RTP Multicast Video stream. 0 indicates the port number is automatically selected.

AudioPort

0

0,
1024 ... 65535

6/6

The port number for RTP Multicast Audio stream. 0 indicates the port number is automatically selected.

TTL

15

1 ... 55

6/6

The Time To Live for each UDP packet.

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

 

2.1.17 Network.Bonjour

Description: Parameter for the Bonjour service discovery.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Network.Bonjour]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

yes

yes,

no

6/6

Enable/Disable Bonjour.

DeviceName

none

none or a string

6/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.18 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.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Time]

Parameter name

Default value

Valid values

Security level (get/set)

Description

ObtainFromDHCP

no

yes,

no

6/6

DHCP servers may provide names/IP addresses for local/remote NTP servers. Enable this feature by setting this parameter to yes.

ServerDate

2006-11-30

A date

6/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

6/6

The time (hh:mm:ss) when the device's time was set manually or synchronized with the computer.

DateFormat

ymd

ymd,

mdy,

dmy

6/6

 

SyncSource

NTP

PC,
NTP,
None

6/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

6/6

Time zone.

UTCOffset

00:00:00

A time

6/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.18.1 Time. DayLightSaving

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

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Time. DayLightSaving]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

off

off,

on

6/6

Enable/disable DST (Daylight Saving Time)

 

2.1.18.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.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Time.DayLightSaving.Start]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Type

date

date,

week

6/6

Type of day light saving start time.

Month

1

1, 12

6/6

January, February, , December.

Week

1

1, 5

6/6

Nth week of this month.

Day

1

1, 7

6/6

Monday, Tuesday,  Sunday.

Date

1

1, 31

6/6

Date.

Hour

0

1, 23

6/6

Hour.

Min

0

0,

15,

30,

45

6/6

Minute. In unit of a quarter-hour.

 

2.1.18.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.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Time.DayLightSaving.Stop]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Type

date

date,

week

6/6

Type of day light saving start time.

Month

1

1, 12

6/6

January, February, , December.

Week

1

1, 5

6/6

Nth week of this month.

Day

1

1, 7

6/6

Monday, Tuesday,  Sunday.

Date

1

1, 31

6/6

Date.

Hour

0

1, 23

6/6

Hour.

Min

0

0,

15,

30,

45

6/6

Minute. In unit of a quarter-hour.

 

2.1.18.2 Time.NTP

Description:

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Time.NTP]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Server

Pol.ntp.org

An IP address or a host name

6/6

The NTP server to connect to when synchronizing the time in the device.

Update

01:00:00

A time

6/6

Time interval (hh:mm:ss) to update from the NTP server.

VolatileServer

0.0.0.0

An IP address or a host name

6/6

The name/IP address of the NTP server, received from the DHCP server. Only one NTP server is currently supported. The NTP server name/IP address will be valid only until the next DHCP renewal or reboot.

 

2.2 Motion

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

Configuration 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

6/7

Specify the minimal and maximal value of allowed sensitivity value.

ThresholdFormat

0-100

0-100

6/7

Specify the minimal and maximal value of allowed threshold value.

SetupStreamIndex

0

0, 1, 2

6/7

The stream index(see section 2.6.1) for motion estimation.

NbrOfWindows

3

3

6/7

Available motion detection windows.

 

2.2.1 Motion.M#

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

Configuration 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

6/6

Enable/disable this detection window.

Sensitivity

50

(Depends on SensitivityFormat)

6/6

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)

6/6

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

0-9999

6/6

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

0-9999

6/6

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

0-9999

6/6

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

0-9999

6/6

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 FtpClient

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

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[FtpClient]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

off

on,

off

6/6

Enable/disable FTP client.

ServerName

none

An IP address or a host name

6/6

IP address or host name of the server

UserName

none

A string

6/6

FTP user name

Password

none

A string

6/6

FTP password.

Passive

off

on,

off

6/6

Use passive FTP.

ImageType

jpeg

jpeg, mpeg4

6/6

Specify the file format to be snapshot(jpeg) or video clip(mpeg4). If mpeg4 is set, the video clip is captured from steam specified by Image.SetupStreamIndex(see section 2.6)

 

2.3.1 FtpClient.Alarm

Description: Parameters for FTP alarm.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[FtpClient.Alarm]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

off

on,

off

6/6

Enable alarm trigger function of ftp client.

RemotePath

none

none or a string

6/6

Directory of ftp server to put files.

ImageName

none

none or a string

6/6

Prefix of file name.

Suffix

date

date,

seq

6/6

Date: add date time information as suffix.

Seq: add sequence number as suffix.

Motion

off

on,

off

6/6

Enable triggered from motion detection.

Audio

off

on,

off

6/6

Enable triggered from audio detection.

SensorIn

off

on,

off

6/6

Enable triggered from digital input.

BufferEnabled

off

on,

off

6/6

Enable triggered if network link down.

Period

always

always,

schedule

6/6

Always: trigger always take effect.

Schedule: Trigger take effect only within schedule.(see section 2.11.1)

 

2.3.2 FtpClient.Periodical

Description: Parameters for sending files periodically.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[FtpClient.Periodical]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

off

on,

off

6/6

Enable periodical sending files to FTP server.

RemotePath

none

none or a string

6/6

Directory of ftp server to put files.

ImageName

none

none or a string

6/6

Prefix of file name.

Suffix

date

date,

seq

6/6

Date: add date time information as suffix.

Seq: add sequence number as suffix.

Period

always

always,

schedule

6/6

Always: trigger always take effect.

Schedule: Trigger take effect only within schedule.(see section 2.11.2)

Interval

003000

(hhmmss)

6/6

Time interval(hhmmss) to send files.

 

2.4 SMTP

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

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[SMTP]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

 off

on,

off

6/6

Enable SMTP notify.

ServerName

 none

An URL

6/6

Mail server name.

ServerPort

25

1-65535

6/6

Mail server port.

ServerSSL

off

off,

on

6/6

Specify if SSL protocol needed for the mail server.

RcptToAddr1

none

An e-mail address

6/6

Mail address of receiver.

AdminAddr

none

An e-mail address

6/6

Mail address of sender.

Subject

none

A string

6/6

Subject of mail.

Message

none

A string

6/6

Message of mail.

 

2.4.1 SMTP.Authentication

Description: Parameters for SMTP authentication.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[SMTP.Authentication]

Parameter name

Default value

Valid values

Security level (get/set)

Description

AuthenMode

none

none,

smtp,

smtp-pop

6/6

none: No authentication needed.

smtp: Authentication needed for SMTP.

smtp-pop: Need to login pop before SMTP.

AthPopServerName

none

An URL/URI

6/6

The IP address or host name of the POP server.

AthUserNam

none

A string

6/6

The user name for the mail server or the POP server.

AthPassword

none

A string

6/6

The password for the mail server or the POP server.

 

2.4.2 SMTP.Alarm

Description:

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[SMTP.Alarm]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

off

on,

off

6/6

Enable/disable SMTP alarm.

FileAttach

off

none,

on,

off

6/6

Enable/disable file attached in mail.

ImageName

none

none or a string

6/6

Prefix of file name.

Suffix

date

date,

seq

6/6

Date: add date time information as suffix.

Seq: add sequence number as suffix.

Motion

off

on,

off

6/6

Enable triggered from motion detection.

Audio

off

on,

off

6/6

Enable triggered from audio detection.

SensorIn

off

on,

off

6/6

Enable triggered from digital input.

BufferEnabled

off

on,

off

6/6

Enable triggered if network link down.

Period

always

always,

schedule

6/6

Always: trigger always take effect.

Schedule: Trigger take effect only within schedule.(see section 2.11.3)

 

2.4.3 SMTP.Periodical

Description:

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[SMTP. Periodical]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

off

on,

off

6/6

Enable periodical sending of SMTP.

ImageName

none

none or a string

6/6

Prefix of file name.

Suffix

date

date,

seq

6/6

Date: add date time information as suffix.

Seq: add sequence number as suffix.

Period

always

always,

schedule

6/6

Always: trigger always take effect.

Schedule: Trigger take effect only within schedule.(see section 2.11.4)

Interval

003000

(hhmmss)

6/6

Time interval(hhmmss) to send mail.

 

2.5 IPNotify

2.5.1 IPNotify.SMTPNotify

Description: Sending notification through e-mail when IP is changed.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[IPNotify.SMTPNotify]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

off

on,
off

6/6

Enables the SMPT notify.

Dhcp

off

on,
off

6/6

Specify if notify for DHCP.

Static

off

on,
off

6/6

Specify if notify for static IP.

Pppoe

yes

yes,

no

6/6

Specify if notify for PPPoE.

RcptAddr

none

An e-mail address

6/6

Mail address of receiver.

Subject

IP address notification 

A string

6/6

Subject of message to be sent.

Messgae

IP:PORT:MAC:Model:Serial:

A string

6/6

Message to be sent.

 

2.3 Image

Description: Common image parameters used for all image configurations.

Configuration files: /etc/device.conf

Security level (create/delete): 7/7

[Image]

Parameter name

Default value

Valid values

Security level (get
/set)

Description

MaxViewers

10

1 ... 10

0/7

Max number of simultaneous viewers (does not affect multicast delivery).

NbrOfConfigs

1 in one-input products
5 in four-input products (4 inputs + Quad)

An unsigned integer (Read only)

6/7

Number of image configurations.

NbrOfStreams

4

4

0/7

Number of available streams.

SetupStreamIndex

0

0,1,2,3

6/7

Define the video stream used in OSD and Motion Detection setting.

 

2.3.1 Image.I#

Description: View Area configuration.

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

Parameter name

Default value

Valid values

Security level (get/set)

Description

Name

View Area

String

6/6

View Area Name.

Resolution

1920x1080

16-Aligned Resolution

6/6

View Area Resolution.

Offset

0x0

16-Aligned Coordinates

6/6

View Area Start Coordinates.

 

2.3.2 Image.OSD

Description: Image OSD parameters for each image configuration.

Configuration file: /etc/device.conf

Security level (create/delete): 6/6

[Image.OSD]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Date

off

on, off

6/6

Enable/disable Date/Time OSD.

Title

off

on, off

6/6

Enable/disable Alias on OSD

Alias

None

String

6/6

Alias for Camera display on OSD.

 

2.3.3 Image.Mask

Description: Privacy mask parameters.

Configuration file: /etc/device.conf

Security level (create/delete): 6/6

[Image.Mask]

Parameter name

Default value

Valid values

Security level (get/set)

Description

MaxCnt

5

5

6/7

Enable/disable privacy mask.

Prifix

M

M

6/7

The prefix of dynamic child groups.

 [Image.Mask.M#]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

off

on, off

6/6

Enable/disable privacy mask.

Name

None

String

6/6

Privacy Mask Name

XPos

0

An unsigned integer

6/6

The Horizontal position of upper left corner. The maximum allow range depends on ImageSource.I0.Config.MaxResolution (See section 2.7.1)

YPos

0

An unsigned integer

6/6

The vertical position of upper left corner. The maximum allow range depends on ImageSource.I0.Config.MaxResolution (See section 2.7.1)

Width

0

An unsigned integer

6/6

The width of the specified mask. The maximum allow range depends on ImageSource.I0.Config.MaxResolution (See section 2.7.1)

Height

0

An unsigned integer

6/6

The height of the specified mask. The maximum allow range depends on ImageSource.I0.Config.MaxResolution (See section 2.7.1)

Color

black

black

6/6

The color of mask. Only black color is available for this version.

 

2.3.4 Image.VideoOut

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

Configuration file: /etc/device.conf

Security level (create/delete): 6/6

[Image.VideoOut]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

off

on, off

6/6

Enable/disable analog video output.

 

2.4 ImageSource

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

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[ImageSource]

Parameter name

Default value

Valid values

Security level (get/set)

Description

NbrOfSources

1

An unsigned integer

6/7

Number of image sources/inputs.

RecordIndex

0

An unsigned integer.

6/6

Specify the stream index for recording video clip.

 

2.4.1 ImageSource.I0.Sensor

Description: The name of the image source.

Configuration 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…100

4/4

The image brightness.

Contrast

50

0…100

4/4

The image contrast.

Saturation

50

0…100

4/4

The image saturation.

Hue

50

0…100

4/4

The image hue.

Sharpness

20

0…100

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

4/4

White balance.

ExpTarget

25

0…100

4/4

Set exposure target, the higher value, the higher image.

BackLightCompensate

off

on, off

4/4

Back light compensate.

ShutterSpeedMax

30

0…10000

4/4

Set max shutter speed, the value is denominator, 30 means 1/30 second

ShutterSpeedMin

120

0…10000

4/4

Set min shutter speed, the value is denominator, 120 means 1/120 second

GainMax

32

1,2,4,8,16,32,64

4/4

Set max gain.

GainMin

1

1,2,4,8,16,32,d

4/4

Set min gain.

Color

color

color,mono

4/4

Set image color.

   

2.4.2 ImageSource.I0.IR

Description: Configuration of the IR parameter

Configuration 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

6/6

IR/LED Switch ON/OFF or auto switch.

ICRType

auto

on, off, auto

6/6

ICR Switch ON/OFF or auto switch. (“on” represent night mode; “off” represent day mode)

Level

maximum value of level

13

6/6

The level value represent luminous intensity of IR

LevelFormat

1

1

1,2

1,2,3

6/7

Description what level be supported for IR device

LowTh

80

LowThMin ... LowThMax

6/6

The threshold value of IR/LED Auto switch on

HighTh

95

HighThMin ... HighThMax

6/6

The threshold value of IR/LED Auto switch off

LowThMin

0

 

6/7

Read only low threshold minimal value.

LowThMax

100

 

6/7

Read only low threshold maximal value.

HighThMin

0

 

6/7

Read only high threshold minimal value.

HighThMax

100

 

6/7

Read only high threshold maximal value.

 

[ImageSource.I0.IR.LeastTime]

Parameter name

Default value

Valid values

Security level (get
/set)

Description

DayToNight

10

110

6/6

Switch day to night mode if lasts more than seconds.

 

2.5 Audio

2.5.1 AudioSource.A#

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

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[AudioSource.A#] *

Parameter name

Default value

Valid values

Security level (get/set)

Description

AudioEncoding

g.711 u-law

(see description)

0/6

The audio codec to use. Valid value depends on AudioCodecList.

AudioCodecList

g.711 u-law, g.711 a-law, AMR Audio, Off

g.711 u-law, g.711 a-law, AMR Audio, Off

6/7

The available audio codec that can be selected.

AudioCodecBitRate

4.75k

4.75k, 5.15k, 5.9k, 6.7k, 7.4k 7.95k, 10.2k 12.2k

6/6

The bit rate for AMR audio. This parameter is valid when AudioCodecList is set to AMR Audio.

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

2.5.1.1 AudioSource.A#.AudioDetection

Description: Parameters for audio detection.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[AudioSource.A#. AudioDetection] *

Parameter name

Default value

Valid values

Security level (get/set)

Description

Enabled

no

yes, no

6/6

Enable audio detection.

Sensitivity

5

(see description)

6/6

Higher sensitivity makes it easier to be triggered. Valid value depends on SensitivifyFormat.

SensitivifyFormat

1-10

1-10

6/7

Valid value for sensitivity.

Threshold

50

(see description)

6/6

Threshold that audio detection can be triggered. Valid value depends on ThresholdFormat.

ThresholdFormat

0-100

0-100

6/7

Valid value for threshold.

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

 

2.6 Input

Description: Parameters for hardware input(s).

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Input]

Parameter name

Default value

Valid values

Security level (get/set)

Description

NbrOfInputs

4

An unsigned integer.

6/7

Number of inputs. The default value depends on different model.

 

2.6.1 Input.I#

Description: Parameters for hardware input(s).

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Input.I#] *

Parameter name

Default value

Valid values

Security level (get/set)

Description

Name

AlarmIn#+1

A string

6/6

The name of the input.

Trig

closed

open,
closed

6/6

open means enable trig. closed means disable trig.

DI

H

H, L

6/6

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.7 Output

Description: Parameters for hardware output(s).

Configuration 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

6/7

Number of outputs.

 

2.7.1 Output.O#

Description: Parameters for hardware output(s).

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Output.O#] *

Parameter name 

Default value

Valid values

Security level (get/set)

Description

Name

Output #+1

A string

6/6

The name of the output.

Active

closed

open, 
closed

6/6

The active state of the output.

Mode

alarm

alarm, timer

6/6

alarm: Activated by trigger source.

timer: Activated by schedule.

Motion

off

on, off

6/6

Trigger from motion detection.

Audio

off

on, off

 

Trigger from audio detection.

SensorIn

off

on, off

6/6

Trigger from alarm input.

BufferEnabled

off

on, off

6/6

Trigged if network link down.

Period

always

always, schedule

6/6

Always: trigger always take effect.

Schedule: Trigger take effect only within schedule.

Duration

10

1 60

6/6

Output duration when triggered.

DO

H

H, L

 

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.8 Schedule

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

Configuration 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

6/7

Maximum of schedule lists.

Prifix

S

S

6/7

The prefix of dynamic child groups .

[Schedule.S#]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Name

none

A string

6/6

The name on behalf of a schedule.

Sun

none,none,none,none,none

none,

hh:mm-hh:mm

6/6

 

Mon

none,none,none,none,none

none,

hh:mm-hh:mm

6/6

 

Tue

none,none,none,none,none

none,

hh:mm-hh:mm

6/6

 

Wed

none,none,none,none,none

none,

hh:mm-hh:mm

6/6

 

Thu

none,none,none,none,none

none,

hh:mm-hh:mm

6/6

 

Fri

none,none,none,none,none

none,

hh:mm-hh:mm

6/6

 

Sat

none,none,none,none,none

none,

hh:mm-hh:mm

6/6

 

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

2.9 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.

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Properties]

Parameter name

Default value

Valid values

Security level (get/set)

Description

BoardID

T01F001.00

A string

6/7

Board ID of product.

 

2.9.1 Properties.Firmware

Configuration 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

6/7

Built date of firmware.

Version

MG.0.0.0.0

A string

6/7

Firmware version.

 

2.9.2 Properties.Hardware

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Properties.Hardware]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Platform

GM8180

GM8180

6/7

Platform string.

 

2.9.3 Properties.DIDO.DI

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Properties.DIDO.DI]

Parameter name

Default value

Valid values

Security level (get/set)

Description

DI

 no

yes, no

6/7

The product support alarm input.

Type

virtual

virtual, physical

6/7

The alarm input type.

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

physical: On board alarm input.

 

2.9.4 Properties.DIDO.DO

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Properties.DIDO.DO]

Parameter name

Default value

Valid values

Security level (get/set)

Description

DI

 no

yes, no

6/7

The product support alarm output.

Type

virtual

virtual, physical

6/7

The alarm output type.

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

physical: On board alarm output.

  

2.9.5 Properties.PTZ

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[Properties.PTZ]

Parameter name

Default value

Valid values

Security level (get/set)

Description

PTZ1

 yes

yes, 
no

6/7

The product has Pan Tilt Zoom support.

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

 

2.9.6 Properties.Motion

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Properties.Motion]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Motion1

 yes

yes, 
no

6/7

The product has Motion Detection support.

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

 

2.9.7 Properties.Audio

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Properties.Audio]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Audio1

 yes

yes,
no

6/7

The product has audio support.

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

 

2.9.8 Properties.System

Configuration 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

6/7

 

PCI

 no

yes,
no

6/7

 

USB

 no

yes,
no

6/7

 

RTC

no

yes,
no

6/7

 

SDC

no

yes,
no

6/7

 

LCD

no

yes,
no

6/7

 

UART1

yes

yes,
no

6/7

 

UART2

yes

yes,
no

6/7

 

UART3

no

yes,
no

6/7

 

UART4

no

yes,
no

6/7

 

 

2.9.9 Properties.Bonjour

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Properties.Bonjour]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Bonjour1

 yes

yes, 
no

6/7

The product has Bonjour service discovery support.

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

 

2.9.10 Properties.NetworkStorage

Configuration 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.9.11 Properties.MemoryCard

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Properties.MemoryCard]

Parameter name

Default value

Valid values

Security level (get/set)

Description

MemoryCard1

 no

yes, no

6/7

The product support SD card.

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

 

2.9.12 Properties.VideoOut

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Properties.VideoOut]

Parameter name

Default value

Valid values

Security level (get/set)

Description

VideoOut1

 No

yes, no

6/7

The product support analog video output.

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

 

2.9.13 Properties.IR

Configuration 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.

ICRSwitchMode

withIR

withIR, withICR

6/7

withIR: ICR switch synchronize with IR.

withICR: ICR can control independent.

 

2.10 Security

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

2.10.1 Security.HttpsPolicy

Configuration 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

6/6

Set allowed connect mode for group admin (http, https, or both).

Operator

http

http,

https,

http_n_https

6/6

Set allowed connect mode for group operator (http, https, or both).

Viewer

http

http,

https,

http_n_https

6/6

Set allowed connect mode for group viewer (http, https, or both).

 

2.10.2 Security.IPFilter

Description: IP filter can set to allow or deny a range of IP address to get connected. The priority of deny list is higher than allow list.

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Security.IPFilter]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Switch

off

on, off

6/6

Specify if IP filter is enabled.

 

2.10.2.1 Security.IPFilter.DenyList

Description: Set IP address range that will be blocked by product. Up to 5 settings available.

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Security.IPFilter.DenyList]

Parameter name

Default value

Valid values

Security level (get/set)

Description

MaxCnt

5

5

6/7

Maximum of denied IP lists.

Prifix

F

F

6/7

The prefix of dynamic child groups .

[Security.IPFilter.DenyList.F#]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Rule

User
select

single,
network,
range

6/6

IPFilter rules.

SingleAddress

0.0.0.0

<ip address>

6/6

IP address of the single or network rule.

StartAddress

0.0.0.0

<ip address>

6/6

Start IP address of the range rule.

EndAddress

0.0.0.0

<ip address>

6/6

End IP address of the range rule.

Submask

0

0…36

6/6

CIDR notation

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

  

2.10.2.2 Security.IPFilter.AllowList

Description: Set IP address range that will be allowed by product. Up to 5 settings available.

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[Security.IPFilter.AllowList]

Parameter name

Default value

Valid values

Security level (get/set)

Description

MaxCnt

5

5

6/7

Maximum of allowd IP lists.

Prifix

F

F

6/7

The prefix of dynamic child groups .

[Security.IPFilter.AllowList.F#]

Parameter name

Default value

Valid values

Security level (get/set)

Description

Rule

User
select

single,
network,
range

6/6

IPFilter rules.

SingleAddress

0.0.0.0

<ip address>

6/6

IP address of the single or network rule.

StartAddress

0.0.0.0

<ip address>

6/6

Start IP address of the range rule.

EndAddress

0.0.0.0

<ip address>

6/6

End IP address of the range rule.

Submask

0

0…36

6/6

CIDR notation

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

 

2.11 PTZ

2.11.1 PTZ.PTZDrivers

Description: List of installed PTZ drivers.

Configuration 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.11.2 PTZ.SerDrivers

Description: List of PTZ drivers associated with serial ports.

Configuration 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/7

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.11.3 PTZ.Speed

Description: List of speed setting for PTZ.

Configuration file: /etc/device.conf

Security level (create/delete): 7/7

[PTZ.Speed]

Parameter name

Default value

Valid values

Security level (get/set)

Description

PanSpeed

50

0 … 100

1/1

Pan speed.

TiltSpeed

50

0 … 100

1/1

Tilt speed.

ZoomSpeed

50

0 … 100

1/1

Zoom speed.

FocusSpeed

50

0 … 100

1/1

Focus speed.

AutoPanSpeed

50

0 … 100

1/1

Auto pan speed.

 

2.11.4 PTZ.CtrlParam

Description: Transmitter and receiver ID/address.

Configuration 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 128

1/1

Receiver ID/address

 

2.11.5 PTZ.PresetPos

Description: Defines dynamic parameter about preset position.

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

2.11.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.

Configuration 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.

~ : 1 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

1 Except for Name, delimited by ~.

 

2.11.6 PTZ.GuardTour

Description: Defines parameter about patrol position.

Configuration 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 G3

1/1

Default guardtour.

 

2.11.6.1 PTZ.GuardTour.G#

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

Configuration 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.11.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.

Configuration 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 31

1/1

Index of preset position (see section 2.8.5).

Position

1

1 8

1/1

The order in the tour list.

WaitTime

2

1 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.11.7 PTZ.RS485

Description: Defines parameter about RS485 setting.

Configuration 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.12 EPTZ

2.12.1 EPTZ.PresetGroup

2.12.1.1 EPTZ.PresetGroup.S#

Description: Defines parameter group for each view area about preset position.

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[EPTZ.PresetGroup.S#]*

Parameter name

Default value

Valid values

Security level (get/set)

Description

HomePos

none

An preset index, 0~31.

1/1

Define preset index of home position.

* Note: The # is replaced with a number, e.g. EPTZ.PresetGroup.S0.

2.12.1.2 EPTZ.PresetGroup.S#.PresetPos.P#

Description: Defines parameter group about information of preset position.

Configuration file:  /etc/device.conf

Security level (create/delete): 1/1

Template: PresetPos

[EPTZ.PresetGroup.S#.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.

~ : 1 delimited string with the
following content:
<x offset>:
An integer, save by system.
<y offset>:
An integer, save by system.
<width>:
An integer, save by system.
<height>:
An integer, save by system.

1/1

Holds all necessary information about the preset position.

<Name>: The name of the preset position.
<x offset>: The x position.
<y offset>:
The y position.
<width>:
The resolution of width.
<height>:
The resolution of height.

Example of a EPTZ preset position: 
Preset~0:0:640:480

* Note: The # is replaced with a number, e.g. EPTZ.PresetGroup.S0.PresetPos.P0.

1 Except for Name, delimited by ~.

 

2.12.2 EPTZ.GuardGroup

2.12.2.1 EPTZ.GuardGroup.S#

Description: Defines parameter group for each view area about patrol group.

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[EPTZ.GuardGroup.S#]*

* Note: The # is replaced with a number, e.g. EPTZ.GuardGroup.S0

2.12.2.2 EPTZ.GuardGroup.S#.GuardTour

Description: Defines parameter group for patrol group.

Configuration file:  /etc/device.conf

Security level (create/delete): 7/7

[EPTZ.GuardGroup.S#.GuardTour]

Parameter name

Default value

Valid values

Security level (get/set)

Description

ActiveTour

none

G0 G1

1/1

Default guardtour.

 

2.12.2.3 EPTZ.GuardGroup.S#.GuardTour.G#

Description: A dynamic parameter group for patrol position.

Configuration file:  /etc/device.conf

Security level (create/delete): 1/1

Template: GuardTour

[EPTZ.GuardGroup.S#.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. EPTZ.GuardGroup.S0.GuardTour.G0

 

2.12.2.4 EPTZ.GuardGroup.S#.GuardTour.G#.Tour.T#

Description: A dynamic parameter group EPTZ.GuardGroup.S#.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.

Configuration file: /etc/device.conf

Security level (create/delete): 1/1

Template: Tour

[EPTZ.GuardGroup.S#.GuardTour.G#.Tour.T#]*

Parameter name

Default value

Valid values

Security level (get/set)

Description

PresetNbr

none

0 31

1/1

Index of preset position (see section 2.9.1).

Position

1

1 8

1/1

The order in the tour list.

WaitTime

2

1 99

1/1

Wait time from this position to next position.

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

 

3 OPTIONAL PARAMETER GROUP

The parameter of optional parameter group is output from device driver directly. The client can read available options or related parameters from this group. For example, some product with sensor type A may has the attribute of contrast. The other product with sensor type B may not has contrast but saturation. All of these parameters are read only, user setting is saved by parameter groups in chapter 2.

3.1 ImageSource

Description: This group defines parameter about sensor.

3.1.1 Basic

Description: Specify available image setup parameters.

CGI format: cgi-bin/admin/param_option/ImageSource=Basic

[ImageSource.I0.Sensor]

Parameter name

Format

Description

Option

(option1),(option2),

Available options. If some option is listed, the available setting of this option can be get from Format.(option). See lists below.

Format.Brightness

<m>-<n>

Range of brightness

Format.Contrast

<m>-<n>

Range of contrast

Format.Saturation

<m>-<n>

Range of saturation

Format.Hue

<m>-<n>

Range of hue

Format.Sharpness

<m>-<n>

Range of sharpness

 

3.1.2 Advance

Description: Specify available advanced features of sensor.

CGI format: cgi-bin/admin/param_option/ImageSource=Advance

[ImageSource.I0.Sensor]

Parameter name

Format

Description

Option

(option1),(option2),

Available options. If some option is listed, the available setting of this option can be get from Format.(option). See lists below.

Format.Flip

off/on

Image flip.

Format.Mirror

off/on

Image mirror.

Format.Lighting

Auto/50Hz/60Hz

Option of lighting condition.

Format.WhiteBalance

(option1),(option2),

Option of white balance.

Format.Exposure

(option1),(option2),

Option of exposure time, in unit of second.

Format. BackLightCompensate

off/on

Back light compensate.

Format.SlowShutter

off/on

Slow shutter(long time exposure).

Format.ShutterSpeed

(option1),(option2),

Option of shutter speed.

Format.Gain

(option1),(option2),

Option of sensor gain.

Format.IR

off/on/auto

Option of infrared(IR) LED.

Format.WideDynamic

off/on/auto

Option of wide dynamic range feature of sensor.

Format.Stabilizer

off/on

Image stabilizer.