Brickcom WCB-100A, CB-100A User Manual

Megapixel Cube Network Camera

CB-100A series

User’s Manual

Quality Service Group

- -

Product name: Megapixel Cube Network Camera (WCB-100A/CB-100A)
Release Date: 2009/
Manual Revision: V1.00

Web site: www.brickcom.com
Email: [e-mail]

[e-mail]

Made in Taiwan. ©2009 Brickcom Corporation. All Rights Reserved

- -

Table of Contents

Before You Use This Product.......................................................................................... 0

Package Contents........................................................................................................... 0

Cube Network Camera Overview.................................................................................... 1

Device Appearance Description...................................................................................... 3

LED Behavior........................................................................................................... 4

Installation....................................................................................................................... 6

System Requirements.............................................................................................. 6

Camera Connection ................................................................................................. 7

Basic Connection............................................................................................... 7

Software Installation................................................................................................. 8

Access to the Network Camera..................................................................................... 15

Check Network Settings......................................................................................... 15

Add Password to prevent Unauthorized Access..................................................... 15

Authentication......................................................................................................... 16

Installing plug-in ..................................................................................................... 17

Live View....................................................................................................................... 18

Configuration................................................................................................................. 21

Camera/Video/Audio .............................................................................................. 21

Camera............................................................................................................ 21

Video................................................................................................................ 23

Audio................................................................................................................ 26

Multicast........................................................................................................... 27

Network.................................................................................................................. 28

IP Setting......................................................................................................... 28

UPnP ............................................................................................................... 29

DDNS (dynamic domain name service)........................................................... 29

Wireless.................................................................................................................. 31

Basic Settings.................................................................................................. 31

Advanced Settings........................................................................................... 36

Wi-Fi Protected Setup...................................................................................... 37

HTTP/HTTPS......................................................................................................... 38

Event...................................................................................................................... 39

Motion Detection.............................................................................................. 39

Notification setting ........................................................................................... 40

Scheduled Event.............................................................................................. 44

PIR................................................................................................................... 45

- -

System ................................................................................................................... 46

System Log...................................................................................................... 46

Date & Time Settings....................................................................................... 46

Device Information........................................................................................... 48

Maintenance........................................................................................................... 50

User Management ........................................................................................... 50

IP Filter ............................................................................................................ 51

Firmware Upgrade........................................................................................... 51

Configuration ................................................................................................... 52

Reset to default................................................................................................ 52

Reboot............................................................................................................. 52

FCC Caution................................................................................................................. 53

BRICKCOM IPCAM HTTP API ..................................................................................... 54

Preface................................................................................................................... 54

Overview ................................................................................................................ 54

HTTP API Transaction .................................................................................................. 55

API Categories.............................................................................................................. 57

Streaming API............................................................................................................... 58

1.1 getChannels.............................................................................................. 62

1.2 getChannel................................................................................................ 63

1.3 addChannel............................................................................................... 64

1.4 updateChannel.......................................................................................... 66

1.5 updateChannels........................................................................................ 67

1.6 getStream.................................................................................................. 68

Camera API................................................................................................................... 69

2.1 setWhiteBalance ....................................................................................... 74

2.2 getWhiteBalance....................................................................................... 75

2.3 setBrightness ............................................................................................ 75

2.4 getBrightness ............................................................................................ 75

2.5 setColorSaturation..................................................................................... 76

2.6 getColorSaturation .................................................................................... 76

2.7 setMirrorFlip .............................................................................................. 76

2.8 getMirrorFlip.............................................................................................. 77

2.9 setSharpness ............................................................................................ 77

2.10 getSharpness............................................................................................ 77

2.11 setContrast................................................................................................ 78

2.12 getContrast................................................................................................ 78

2.13 setFrequcny .............................................................................................. 78

- -

2.14 getFrequency ............................................................................................ 79

2.15 setEffect.................................................................................................... 79

2.16 getEffect.................................................................................................... 79

2.17 setEnvMode .............................................................................................. 80

2.18 getEnvMode.............................................................................................. 80

2.19 setIRCutFilter ............................................................................................ 80

2.20 getIRCutFilter............................................................................................ 81

2.21 setIRLED................................................................................................... 81

2.22 getIRLED................................................................................................... 81

2.23 setVideoOverlay........................................................................................ 82

2.24 getVideoOverlay........................................................................................ 82

2.25 setAutoIris................................................................................................. 83

2.26 getAutoIris................................................................................................. 83

2.27 setCameraSetting...................................................................................... 84

2.28 getCameraSetting ..................................................................................... 85

Audio API...................................................................................................................... 87

3.1 setAudioDevice ......................................................................................... 88

3.2 getAudioDevice......................................................................................... 88

3.3 setAudioMuteState.................................................................................... 88

3.4 getAudioMuteState.................................................................................... 89

3.5 setAudioVolume........................................................................................ 89

3.6 getAudioVolume........................................................................................ 89

Network API .................................................................................................................. 90

4.1 setBasicNetwork........................................................................................ 97

4.2 getBasicNetwork ....................................................................................... 98

4.3 setUPnP.................................................................................................... 98

4.4 getUPnP.................................................................................................... 98

4.5 setDDNS................................................................................................... 99

4.6 getDDNS................................................................................................. 100

4.7 setEthernet.............................................................................................. 100

4.8 getEthernet.............................................................................................. 101

4.9 setWIFI.................................................................................................... 101

4.10 getWIFI.................................................................................................... 102

4.11 setIPFilter................................................................................................ 103

4.12 getIPFilter................................................................................................ 104

Storage API (TBD) ...................................................................................................... 105

System API................................................................................................................. 106

5.1 getDeviceInfo ...........................................................................................110

- -

5.2 setTimeSetting .........................................................................................110

5.3 getTimeSetting.........................................................................................111

5.4 setSyslogSetting.......................................................................................112

5.5 getSyslogSetting ......................................................................................112

5.6 getSyslogFile............................................................................................113

5.7 syslogClear ..............................................................................................113

Admin API....................................................................................................................114

6.1 addUser....................................................................................................116

6.2 deleteUser................................................................................................117

6.3 getUsers...................................................................................................117

6.4 updateUser...............................................................................................118

6.5 setHTTP...................................................................................................118

6.6 setHTTP/HTTPS ......................................................................................119

6.7 getHTTP...................................................................................................119

6.8 setHTTPS.................................................................................................119

6.9 getHTTPS ............................................................................................... 120

6.10 resetToDefault......................................................................................... 120

6.11 upgradeFirmware.................................................................................... 120

6.12 reboot...................................................................................................... 120

6.13 importConfigFile...................................................................................... 121

6.14 exportConfigFile...................................................................................... 121

6.15 setPWDComplexity ................................................................................. 121

6.16 getPWDComplexity................................................................................. 122

Capability API (TBD)................................................................................................... 123

7.1 getCapability............................................................................................ 123

Motion detection API................................................................................................... 125

8.1 setMotionDetection.................................................................................. 127

8.2 getMotionDetection ................................................................................. 128

8.3 getMotionDetections................................................................................ 129

Event API.................................................................................................................... 130

9.1 setEventSetting....................................................................................... 136

9.2 addEventSetting...................................................................................... 137

9.3 updateEventSetting................................................................................. 137

9.4 removeEventSetting................................................................................ 138

9.5 getEventPolicy ........................................................................................ 138

9.6 getEventRule........................................................................................... 138

9.7 setEmailSetting ....................................................................................... 139

9.8 getEmailSetting....................................................................................... 140

- -

9.9 setFTPSetting ......................................................................................... 140

9.10 getFTPSetting ......................................................................................... 141

9.11 setAlarmMediaInfo .................................................................................. 142

9.12 getAlarmMediaInfo.................................................................................. 142

9.13 setSamba................................................................................................ 143

9.14 getSamba................................................................................................ 143

I/O Control API............................................................................................................ 144

10.1 setGPIOSetting ....................................................................................... 144

10.2 getGPIOSetting....................................................................................... 145

10.3 getGPIOStatus........................................................................................ 145

MSN API..................................................................................................................... 146

11.1 setMSNBot.............................................................................................. 147

11.2 getMSNBot.............................................................................................. 148

Before You Use This Product

The use of surveillance devices may be prohibited by law in your country. The Network
Camera is not only a high-performance web-ready camera but also can be part of a
flexible surveillance system. It is the user’s responsibility to ensure that the operation of
such devices is legal before installing this unit for its intended use.

It is important to first verify that all contents received are complete according to the list
in the "Package Contents" chapter. Take notice of the warnings in “Quick installation
guide” before the Network Camera is installed, then carefully read and follow the
instructions in the “Installation” chapter to avoid damages due to faulty assembly and
installation.

Package Contents

a. CB-100A/ WCB-100A

b. Product CD

c. Camera Stand

d. White Flat RJ-45 cable(1.5m)

e. Warranty Card

f. Power Adapter

g. Quick Guide

- 1 -

Cube Network Camera Overview

Compact designed Brickcom CB-100A/ WCB-100A offers high video quality surveillance
solution for residences and small businesses. Unlike general webcam, Brickcom CB-100A/
WCB-100A camera is a standalone complete system that does not need to be connected to a
computer. The built-in web server allows user to access over local area network (LAN) and
through the internet via a web browser for live viewing and intercom functions. Enhanced
facility for user, live viewing can also be supported via 3GPP phone and MSN.

Wireless capacity makes it easy to mount the device anywhere such as wall or desktop.

802.11b/g/n wireless with WPS and Ethernet connectivity can be integrated with an existing
network environment. “Easy Installation Wizard” also allows user to configure device easily,
even without IT background. Furthermore, the fashionable and streamline shape let the
CB-100A/ WCB-100A not only a network camera, but also a decoration device.

The CB-100A/ WCB-100A helps user monitor closely on family members, pets, offices,
properties or anything valuables.
Pet monitor - Office workers can monitor pet in the house anytime, and also deliver

voice by built-in speaker to let pet feel that the Owner is nearby

Residence monitor - Built-in PIR sensor can detect stranger intruding, which can trigger

illumination LED, and send alert with snapshot in email or MMS to user’s portable
device.

Labor monitor - Labor can be monitored when user is outside, and images also can be

recorded and stored in micro SD.

- 2 -

The elderly and baby care - The elderly and baby can be cared easily by live view and

intercom.

Small office surveillance - Employees working status can be monitored by portal device.

- 3 -

Device Appearance Description

< Front & Rear view >

<Side view>

Power Connector

Reset Button

Ethernet RJ45
10/100 Socket

Illumination LED

Speaker

PIR

Built-in

Microphone

Adjustable focal Lens

Micro SD slot

Privacy button

WPS button

(WCB-100A Only)

Power LED

WPS LED (WCB-100A )
Firmware upgrade LED

(CB-100A)

Status LED

Internet LED

Privacy LED

- 4 -

LED Behavior

Function LED Behavior Description Remark

Power Steady On

Normal Operation Top

(Blue)

Power Unlighted

Power off Top

(Blue)

Status

Steady On

1. Connect to switch by
Ethernet or WiFi.

2. Reset to default.

Second (Blue)

Status

Unlighted

1. Power off

2. No connection

Second (Blue)

Status

1.While F/W upgrading

2.While WiFi site survey

performing

Second (Blue)

Status

Blinking

1.While network
connection in progress

2. Restoring settings.

Second (Blue)

Internet

Steady On

Connect to Internet Third (Blue)

Internet

Unlighted

1. Power off

2. No connection

Third (Blue)

WPS

WPS in progress

WCB-100A
Fourth (Blue)

WPS

WPS Error

WCB-100A
Fourth (Blue)

- 5 -

WPS

Session overlap detected

WCB-100A
Fourth (Blue)

WPS

WPS Success

WCB-100A
Fourth (Blue)

Firmware
Upgrade

Steady On

Firmware Upgrade
Success

CB-100A
Fourth (Blue)

Privacy Steady On

Privacy mask active Bottom(Red)

Privacy Unlighted

Privacy mask inactive Bottom(Red)

Hardware Reset

The reset button is used to reset the system or restore the factory default settings. Sometimes
resetting the system can return the camera to normal operation. If the problems remain after
reset, please restore the factory settings and install it again.
Reboot - Please press and release the indented reset button within 1 second with paper clip
or thin object. Wait for the network camera to reboot.
Restore - Please press and hold the reset button until the status of LED turns off. It takes
about 10 seconds. Please note that all settings will be restored to factory default. Upon
successful restore, the status of LED will be blue again during normal operation.

Micro-SD Card Capacity

The network camera is compliant with Micro-SD (Maximum 32GB) cards.

Reset Button

- 6 -

Installation

System Requirements

Operating System
Microsoft Windows XP Home Edition SP2
Microsoft Windows XP Professional SP2
Computer
IBM PC/AT Compatible
CPU
Pentium 3GHz or faster
Memory
1024 MB or more
Monitor
1024 x 768 pixels or more, 24-bit True color or better
Network Interface
10/100Mbps Network interface card must be installed
Web Browser
Microsoft Internet Explorer 6.0 SP2
CD-ROM Drive
It is necessary to read the operating instructions in the provided CD-ROM.
Adobe Reader
It is necessary to read the operating instructions in the provided CD-ROM.

 Audio function will not be working if a sound card is uninstalled on PC. Audio may be

interrupted depending on the network environment.

- 7 -

Camera Connection

Basic Connection

1. Connect the supplied power cable from the camera to the power outlet.

2. Connect the camera to a switch via Ethernet cable.

Please check your product package contains all the accessories listed in the foregoing
Package Contents. Upon powering up, the power LED will become lighted first and then
the device will go through booting process. The status LED will be steady amber for getting
IP address. After getting IP Address, the link LED will blink orange while network
connection is processing.

- 8 -

Software Installation

In this manual, "User" refers to whoever has access to the Network Camera, and
"Administrator" refers to the person who can configure the Network Camera and grant user
access to the camera.
After hardware connection checking, the users can run the Installation Wizard program
included in the product CDROM to automatically search for the Network Camera in the
Intranet. There may be many Network Cameras in the local network. Users can differentiate
the Network Cameras with the serial number. The serial number is printed on the labels on the
carton and the bottom of the Network Camera body.

1. Insert the Installation CD into the CD-ROM driver. Click install and shows the welcome
screen. Follow the steps to install the Installation wizard on user’s computer.

- 9 -

2. Do not check the box if user would like to check the hardware installation settings,
Otherwise click “Skip the hardware installation” to skip the hardware connection checking,
the program will automatically search for the Network Camera in the Intranet.
Click “Start” to continue.

- 10 -

- 11 -

3. Select the Network Camera from the survey list and enter the user name and password.
The user name and password are assigned as “admin/admin”.

- 12 -

4. Setting the Network Camera IP address

User can either select simple mode or professional mode for network camera IP setting. If
simple mode is selected, the easy configuration program will set up the connection
automatically. If professional mode is selected, the user will need to configure the IP
manually, The DHCP setting is recommended. If user wants to set IP address manually,
please refer to the product user manual.

- 13 -

- 14 -

5. After finish setting, the connection successful or fail showed. If connection failed, user can
either try again or quit the installation. User can either select “Run PC-NVR” or "Start Web
GUI" to continue or click “X” on the top right of the screen to finish the installation.

Once installation is completed, the Administrator should proceed to the next section
"Access to the Network Camera" for necessary checks and configurations.

- 15 -

Access to the Network Camera

Check Network Settings

The Network Camera can be connected either before or immediately after software
installation onto the Local Area Network. The Administrator should complete the network
settings on the configuration page, including the correct subnet mask and IP address of
gateway and DNS. Ask your network administrator or Internet service provider for the detail
information.

Add Password to prevent Unauthorized Access

The Administrator should immediately implement a new password as a matter of
prudent security practice. The user name and password for the Administrator are assigned

as “admin/admin”. Once the Administrator’s password is saved, the Network Camera will ask
for the user’s name and password before each access. The Administrator can set up a
maximum of ten (10) user accounts. Each user can access the Network Camera except to
perform system configuration. Once the password is changed, the browser will display an
authentication window to ask for the new password. Once the password is set, there is no

provision to recover the Administrator’s password. The only option is to restore to
the original factory default settings.

- 16 -

Authentication

After opening the Web browser and typing in the URL of the Network Camera, a dialogue
window pops up to request a username and password. The user name and password for the
Administrator are assigned as “admin/admin”. Upon successful authentication, the following
figure is displayed.
The foreground is the login window and the background shows the message if authentication
fails. The user may check the option box to save the password for future convenience. This
option is not available to the Administrator for obvious reason.

- 17 -

Installing plug-in

For the initial access to the Network Camera in Windows, the web browser may prompt for
permission to install a new plug-in for the Network Camera on the Internet Explorer.
Permission request depends on the Internet security settings of the user’s PC or notebook. If
the highest security level is set, the computer may prohibit any installation and execution
attempt. This plug-in has been registered for certificate and is used to display the video in the

browser. Users may click on to proceed. If the web browser does not allow the
user to continue to install, check the Internet security option and lower the security levels or

contact your IT or networking supervisor for help.

- 18 -

Live View

Live View is the default page that opens when accessing the Network Camera. Live video is

displayed directly in the browser window.
 Stream1/Stream2 Channels
The network camera offers simultaneous dual stream for optimized quality and bandwidth. To
configure the codec compression and video resolution, please go to the
Configuration->Camera/video/audio->Video to make the changes, or refer to the Video
configuration on page 23.
 TCP/UDP protocol
TCP - This protocol guarantees the complete delivery of streaming data and thus provides
better video quality. Nevertheless, the downside with this protocol is that its real-time effect is
not as good as that of the UDP protocol.

- 19 -

UDP - This protocol allows for more real-time audio and video streams. However, network
packets may be lost due to network burst traffic and images may be broken. Activate UDP
connection when occasions require time-sensitive responses and the video quality is less
important.

/ Recording on/off: shows the status of recording video

/ MIC on /off: shows the status of MIC volume.

/ MD on/off: shows the status of Motion Detection

 Camera Control Panel - There are two slider bars and eight control buttons on the remote

controller. They are describe as below:

 Brightness and Mic volume adjustment - Drag the slider bar to adjust the image

brightness level and Mic volume. Click “Default” for default brightness setting and “Mute”
for no sound. For more Audio setting, please refer to the Audio configuration on page 26.

 Speaker –The build-in speaker plays the sound of an audio clip from computer MIC when

it is enabled.

Play or Stop - Click this button to play or stop the video.

Recording - Click this button to record video to your computer.

Snapshot - Click this button to capture and save still images.

Digital Zoom - Click this button to enable the zoom operation.

Mirror - horizontally reflect the display of the live video.

Flip - vertically reflect the display of the live video.

- 20 -

Real Size - click this button to view the object in real size. Press this button again

to switch back to normal mode.

Full Screen - Click this button to switch to full screen mode. Press “Esc” key to

switch back to normal mode.

Motion Detection Alert - Click this button to enable motion detection alert function.

NOTE - The <Video Control Panel> function has no effect on the recorded video. Whatever

changes made to the <Video Control Panel> will not be applied to the recorded video.

- 21 -

Configuration

Click Configuration on the main page to enter the camera setting pages. Note that only
Administrators can access the configuration page.

Camera/Video/Audio

Camera

Camera Setting
Brightness - Drag the slider bar to adjust the image brightness level, which ranges from -5 to

+5.

Contrast - Drag the slider bar to adjust the image contrast level, which ranges from -5 to +5.
Sharpness - Drag the slider bar to adjust the image sharpness level, which ranges from -5 to

+5.
Saturation - Drag the slider bar to adjust the image saturation level, which ranges from -5 to
+5.

- 22 -

Environment - User can look for a place that best suits your needs, either outdoor or indoor.
Flicker-Free - While flicker-free technology eliminates the problem of flicker,

it can cause slight judder on fast moving images or blurring problems; fast
scrolling text for example may blur.

NOTE - The "Environment" setting adjusts the sampling rate of the camera sensor to
achieve Flicker-free effect on the video.
The sampling rate, however, may not work best with the frame rate chosen in the "Video"
setting.
For best recording experience, configure your IP camera to one of the following frame rates
based on the Environment used:

Environment / Flicker-Free Frame Rate

------------------------------------ ----------------------------------

Outdoor 25, 10, 7, 5, 3, 2

Indoor (50/60 Hz ) 20, 10, 7, 5, 3, 2

Mirror and Flip

Mirror - Enable to horizontally reflect the display of the live video.
Flip - Enable to vertically reflect the display of the live video.

LED Control

Select from the drop-down list to adjust the brightness of the camera’s LED. It

offers LED for

illuminating the scene automatically at an event or when requested by the user.

Click Apply or Reset to take effect.

NOTE

1. The LED is not for continuous use and has an estimated life span of 30000 hours.

2. The LED can not be replaced.

- 23 -

Video

You can set up two separate streams for the Network Camera for different viewing devices.

Stream 1 & Stream 2

Video Codec - The Network Camera offers three choices of video codec standards for

real-time viewing: H.264, MPEG-4 and MJPEG.
Video Resolution - Select from the drop down list to choose the best resolution that fit
your need.
Frame Rate - Select from the drop down list of the frame rate, which ranges from 2 to 30
fps when H.264 or MJPEG is selected. Only 3 to 15 fps can be chosen when MPEG-4 is
selected. Set the frame rate higher for a smoother video quality.
Video quality and bit rate - User can either choose “quality” or “bitrate” to control the
video quality with video codec at H.264 or MPEG4. Only “quality” can be chosen when
video codec at MJPEG is selected. Set the bitrate higher for a better video quality.

- 24 -

However, high bitrate may cost high network bandwidth resources.
The video qualities are selectable at the following settings: SoSo, OK, Not Bad, Medium,
Standard, and Good.
HTTP Transport - Enable to use HTTP protocol for video/audio communication.
Click Apply or Reset to take effect.

Video Overlay

Video Overlay - Check to enable the timestamp function and select display position from the

drop-down list if user wants date and time to be shown on the screen of the live video. User may
also enable and enter the video description in text box; and select display position from the
drop-down list if user wants to make a note about the network camera.
Click Apply or Reset to take effect.

NOTE - The video overlay only takes effect in stream 1.

- 25 -

RTSP Server

To utilize RTSP authentication, make sure that you have set a password for the Network
Camera first.
RTSP (Real-Time Streaming Protocol) controls the delivery of streaming media. By default the
port number is set to 554.
Authentication - Depending on your network security requirements, the Network Camera
provides two types of security settings for streaming via RTSP protocol: NONE and DIGEST.
If DIGEST authentication is selected, user credentials are encrypted using MD5 algorithm, thus
providing better protection against unauthorized access.

Save file folder

Recording folder path - The destination for saving the recording video files. Click browse

to specify the saving path.
Snapshot folder path - The destination for saving the snapshot files. Click browse to
specify the saving path.

Click Apply or Reset to take effect.

- 26 -

Audio

You can set up two separate streams for the Network Camera for different viewing devices.
User can either enable or disable the audio function. If audio enable is selected, select the
Audio codec from the drop down list.

Advanced

Echo cancellation Enabled: Enable to avoid an echo.
Click Apply or Reset to take effect.

- 27 -

Multicast

Multicast addressing is a network technology for the delivery of information to a group of
destinations simultaneously using the most efficient strategy to deliver the messages over each
link of the network only once, creating copies only when the links to the multiple destinations
split. You can either enable or disable the stream1or stream2 for the Network Camera. The
default value for multicast address and port are 234.1.2.3 and 10000. Use different port number
for different stream. Use default value is recommended if you are not sure how to setting.
Click Apply or Reset to take effect.

- 28 -

Network

IP Setting

This section explains how to configure wired network connection for the Network Camera.

There are several ways to setup the Network Camera over the Internet. The first way is to

obtain an available dynamic IP address assigned by a DHCP server. The second way is to

utilize a static IP. The third way is to use PPPoE.

DHCP - Get IP address automatically. Select this option to obtain an available dynamic IP
address assigned by a DHCP server each time the camera is connected to the LAN.
Static IP - Select this option to manually assign a static IP address to the Network Camera.
Enter the static IP address, Subnet mask, Default Gateway, Primary and Secondary DNS
provided by your ISP.
PPPoE - (Point-to-point over Ethernet): Choose this connection type if you are connected
to the Internet via a DSL Line. Note that to utilize this feature, it requires an account
provided by your ISP. Enter the user name and password provided by your ISP.

Click Apply or Reset to take effect.

- 29 -

UPnP

Only UPnP discovery supported. Enable this function to allow the user to search for devices of
interest on the network. Enter the UPnP name as you wish to show on the intranet.

Click Apply or Reset to take effect.

DDNS (dynamic domain name service)

DynDNS - Enable the DDNS service allows your Network Camera, especially when assigned

with a dynamic IP address, to have a fixed host and domain name. Note that before utilizing this
function; please apply a dynamic domain account first. Enter the username, password and
hostname when enabled the DDNS.
Click Apply or Reset to take effect.

- 30 -

TZO

TZO - TZO is one kind of the DDNS providers. User can refer to the TZO.com: visit

http://www.tzo.com/ to apply a dynamic domain account when selecting this DDNS provider.

Enter the e-mail address, password and domain name when enabled the TZO.
Click Apply or Reset to take effect.

- 31 -

Wireless

Basic Settings

Network Name (SSID) - The SSID is the network name shared among all points in a wireless

network. The SSID must be identical for all devices in the wireless network. It is case-sensitive
and can be up to 32 characters in length. Make sure this setting is the same for all points in your
wireless network.
Wireless devices have a default wireless network name or Service Set Identifier (SSID) set by
the factory. Brickcom wireless products use Brickcom as the default wireless network name.
You should change the wireless network name to something unique to distinguish your wireless
network from other wireless networks that may exist around you, but do not use personal
information, because this information may be available for anyone to see when browsing for
wireless networks.

Security

Encryption protects data transmitted over a wireless network. Wi-Fi Protected Access
(WPA-Personal/WPA2-personal) and Wired Equivalent Privacy (WEP) offer different levels of
security for wireless communication. A network encrypted with WPA-Personal/WPA2-personal
is more secure than a network encrypted with WEP, because WPA-Personal/WPA2-personal

- 32 -

uses dynamic key encryption. To protect the information as it passes over the airwaves, you
should enable the highest level of encryption supported by your network equipment.

Select the security method for your wireless network. If you do not want to use wireless security,
keep the default, Disabled.

- 33 -

WEP

WEP is a basic encryption method that is not as secure as WPA.

Tx Key - Select a key from the drop-down menu.
WEP Encryption - Select a level of WEP encryption, 64 bits 10 hex digits or 128 bits 26 hex

digits. The default is 64 bits 10 hex digits.

Key 1-4 - Enter the WEP key(s) manually
Authentication Type - The default is set to open system, which allows either Shared Key or

Auto authentication to be used. With Open System authentication, the sender and the recipient
do NOT use a WEP key for authentication. With Shared Key authentication, the sender and
recipient use a WEP key for authentication.
Network Type - Select Infrastructure if your network consists of both wired and wireless

devices that communicate through a central device, such as an access point. Select Ad-hoc if
your network consists of only wireless devices that communicate with each other directly.

Click Apply or Reset to take effect.

- 34 -

Site Survey

SSID Broadcast, when wireless clients survey the local area for wireless networks to associate
with, they will detect the SSID broadcast of the camera.

WPA-Personal

WPA supports two encryption methods, TKIP and AES, with dynamic encryption keys. Select
the type of algorithm, TKIP or AES. The default is TKIP.
Shared Key - Enter the key shared between the Router and the server keys. Enter a
passphrase of 8-63 characters.
Network Type - Select Infrastructure if your network consists of both wired and wireless
devices that communicate through a central device, such as an access point. Select Ad-hoc if
your network consists of only wireless devices that communicate with each other directly.
Click Apply or Reset to take effect.

- 35 -

WPA2-Personal

WPA2 supports AES encryption methods with dynamic encryption keys.
Shared Key - Enter the key shared between the Router and the server keys. Enter a
passphrase of 8-63 characters.

NOTE: If you are using WPA or WPA2, each device in your wireless network MUST use the
same WPA or WPA2 method and shared key, or else the network will not function properly.

- 36 -

Advanced Settings

Network Mode - From this drop-down menu, you can select the wireless standards running on

your network. If you have both Wireless-B, Wireless-G and Wireless-N (2.4GHz) devices in your
network, keep the default setting, Mixed. If you have both Wireless-B, Wireless-G devices in
your network, select BG-Mixed. If you have only Wireless-B devices, select Wireless-B Only. If
you have only Wireless-G devices, select Wireless-G Only. If you have only Wireless-N
(2.4GHz) devices, select Wireless-N Only.
Radio Band - The settings are available for the Auto-20/40MHz channel and Standard-20 MHz
channel. The Auto-20/40MHz channel set up a network using the 20/40MHz band, and the
Standard-20 MHz channel set up a network using the 20 MHz band.
Enable WMM (802.1e QoS) - WMM is a wireless Quality of Service feature that improves
quality for audio, video, and voice applications by prioritizing wireless traffic. To use this feature,
your wireless client devices in your network must support Wireless WMM. If you would like to
disable this feature, select Disabled. Otherwise, keep the default, Enabled.

- 37 -

Wi-Fi Protected Setup

Use this method if your client device has a Wi-Fi Protected Setup PIN number.

1. Enter the PIN number and SSID from the device in the field on the screen.
Click Apply or Reset to take effect.

- 38 -

HTTP/HTTPS

HTTP - This protocol allows the same quality as TCP protocol without needing to open specific

ports for streaming under some network environments. Users inside a firewall can utilize this
protocol to allow streaming data through.
HTTPS - (Hypertext Transfer Protocol over SSL): This section explains how to enable
authentication and encrypted communication over SSL (Secure Socket Layer). It helps protect
streaming data transmission over the Internet on higher security level.
Click to enable and click Apply or Reset to take effect.

- 39 -

Event

Motion Detection

Motion can be detected by measuring change in speed or vector of an object or objects in the
field of view. This section explains how to configure the Network Camera to enable motion
detection. There are three motion detection windows can be configured.

Detection Setting - Select and enable the motion detection windows function. Easier to
trigger event by higher the sensitivity value and lower the Threshold value.

- 40 -

Notification - To react in response to particular events. A typical application is that when a

motion is detected, the Network Camera sends buffered images to a FTP server, Samba,
SMTP or HTTP as notifications. In this page, you can specify which notification messages will
be sent when a trigger is activated. You can configure the Network Camera to send video
streaming URL or video clips to your email address or FTP site.
Click Apply or Reset to take effect.

Notification setting

When an event is triggered, you can specify what kind of action will be performed. You can
attach video clip to your email address, FTP site, samba or HTTP.

FTP - File Transfer Protocol (FTP) is often used as an application component to
automatically transfer files for program internal functions. Select to send the media files to a
FTP server when a trigger is activated. Enter the FTP IP address or hostname; by default,
the FTP port server is set to 21, enter account name and password to configure the setting.

- 41 -

Click Apply or Reset to take effect.

SMTP - Select to send the media files via Email when a trigger is activated.

From - Enter the email address of the sender.
To - Enter the email address of the recipient. Many recipients are separated by commas.
My name - The title shown in the email.
Subject - Enter the subject of the email.
Attached - There are two choices of media types available: video streaming URL and video
clip.
SMTP Server and port number - Enter the server host name and port number of the email
server.
Authentication - Select the authentication type from the drop-down list.
Email Account - Enter the user name of the email account if necessary.
Email Password - Enter the password of the email account if necessary.

- 42 -

Click Apply or Reset to take effect.

Samba - Select to send the network file system media files via network neighborhood when

a trigger is activated.
IP Address - Enter the IP address of the samba server.
User Name - Enter the user name of the samba server.
Password - Enter the password of the samba server.
Workgroup - Enter the workgroup of the samba server.
Share DIR - Enter the share DIR of the samba server.

Click Apply or Reset to take effect.

- 43 -

HTTP - Select to send the HTTP notification when a trigger is activated

URL – Specify the URL to send HTTP requests, the URL is normally written as follows:

http://ip_address/ notification.cgi?parameter

ip_address – type the IP address or host name of the host to which you want to connect.
Parameter – type the notification parameter if necessary.

Example
URL - http://192.168.1.1/xxxx.cgi
Message - name1=value1&name2=vlaue2
Result - http://192.168.1.1/xxxx.cgi? name1=value1&name2=vlaue2
Ex:
https://192.168.1.1/notification.cgi?event=MD&camera=FB-100A
Message - Enter the message notification that informs you when a trigger is activated.

- 44 -

Scheduled Event

Click New to open the recording setting page. In this page, you can define the recording
schedule and recording capacity.

Name - Enter a descriptive name for the recording setting.
Event - Select from the drop-down menu for the recording or rebooting event.
Time - Specify the recording duration.

■ Select the time for recording in 24-hr time format. End time must be more than start time.

■ Select the days on weekly basis.

When completed, Click Add to have recording name appears in the recording list on the
recording page. Select Enabled; the system begins recording and send recorded file to the
Network Storage. To edit a recording setting; click Edit to modify. Upon the completion, click
update to finish the modification. To remove a recording setting from the list, select a recording
name from the list and then click Delete. Click New to add more events.

- 45 -

PIR

Enable PIR sensor to detect a moving infrared object such as a person in the dark.
Sensitivity - is used to adjust the sensitivity of the PIR Sensor from 10 - 100%. The default
sensitivity is 50%.
By increasing the sensitivity, the range of the PIR Sensor is also increased. The PIR Sensor can
be configured to detect movement in the dark up a maximum range of 6 meters. Select from the
drop-down list to adjust the PIR Sensor’s sensitivity.

Notification

Light - to illuminate the scene. The brightness of light source can be manually selected from the
drop-down list.

Click Apply or Reset to take effect.

- 46 -

System

System Log
Log - To send a system log to the network camera when a trigger is activated.

This page displays the system’s log in chronological order. The system log is stored in the
Network Camera’s buffer area and will be overwritten when reaching a certain amount.
Click Retrieve to retrieve the log, or click Save to file to save the file in the specify location.

Date & Time Settings
Manual - The user enters the date and time manually.

Clone from PC - Sync with computer time; click clone to synchronize the date and time of

the Network Camera with the local computer. The read-only date and time of the PC is
displayed as updated.

- 47 -

NTP - Select to update the time with the NTP server on hourly, daily, weekly, or monthly

basis.

Time Zone - According to your local time zone, select one from the drop-down list.
NTP Server 1 and Server 2 - Enter the address of the NTP server.
Daylight Saving - Enable this option to retain the Daylight Saving Time changes
automatically.

Click Apply or Reset to take effect.

- 48 -

Device Information
Video/Audio Setting - To view the entire video/audio setting information about the network

camera.

Network Setting - To view the entire network setting information about the network camera.

System Information - To view the entire system information about the network camera.

- 49 -

Storage Management - To view the entire recorded files in SD card.

Click Remove to safely remove the storage device.
Click Reload to view the list.

- 50 -

Maintenance

User Management
This section explains how to enable password protection and create multiple accounts.

Privilege Setting - Enter the new user’s name and password. Select the privilege for

new user account. Click Add to take effect. The administrator account name is “admin”,
which is permanent and can not be deleted.
Access rights are sorted as following (Viewer, Administrator and Remote Viewer). Only
administrators can access the Configuration page. Viewers can access the main page for
live viewing only. The privilege of Remote Viewer is same as viewer except TCP protocol
can only be selected for live viewing page. Administrators can add up to 10 user accounts.
Administrator also can change user’s access rights or delete user accounts. Select an
existing account to modify and make necessary changes; then click Update or Delete to
take effect.

- 51 -

IP Filter
IP Filter - Enable the IP filter and set of allow or deny IP address range to server. Click Add to
list to add the IP range to the IP filter list.

Click Apply or Reset to take effect.

Firmware Upgrade

This feature allows you to upgrade the firmware on your Network Camera. It takes about few
minutes to complete the process. Note that do not power off the Network Camera during the
upgrade.

Upgrade - Click Browse… and specify the firmware file. Click Upgrade. The Network
Camera starts to upgrade and will reboot automatically when the upgrade completes.

- 52 -

Configuration

This feature allows you to export/import the configuration files of the network camera.

Import/Export - Click export to pop up a dialog to indicate the location and file to export.
Click browse to indicate the location and file of the camera configuration and click import
to import the configuration file back into the network camera.

Reset to default
Click Reset to restore the network camera to factory default setting.

Reboot

This feature allows you to reboot the Network Camera, which takes about one minute to
complete. When completed, the live video page will be displayed in your browser. The following
message will show during the rebooting process.

- 53 -

FCC Caution

This device complies with Part 15 of FCC rules.
Operation is subject to the following two conditions;
(1) This device may not cause harmful interference, and
(2) This device must accept any interference received, including interference that may cause

undesired operations.

- 54 -

BRICKCOM IPCAM HTTP API

Preface

This document specifies the Brickcom IPCAM HTTP API which enables applications to
access and/or configure the IP Cameras manufactured by Brickcom over a TCP/IP capable
network. Developers who wish to write their own utility should follow the API specification
herein.

Overview

Brickcom IPCAM HTTP API is the proprietary network control protocol designed by Brickcom
Technology to enable applications to access IP Cameras manufactured by Brickcom. The API
allows for configuration of the settings and inquiry of current status on these IP Cameras. The
API is structured and transmitted over HTTP protocols and hence is given the name HTTP
API.

The complete API is further divided into several categories for ease of management. We
dedicate one chapter for each API category to better expound on that API subset.

Figure 1, Illustration of API generic transactions

- 55 -

HTTP API Transaction

An HTTP API transaction is always started with a request from a client application, which is
received by the Web server on the IP Camera device and processed by the IP Camera and
finally ends with a response sent back to the requesting client.

The client HTTP request takes in either one of the two forms:

 HTTP GET: Normally used to retrieve the settings or status of the IP Camera
 HTTP POST: Normally used to configure the settings of the IP Camera

If the request is successfully received by the IP Camera, the response will contain a HTTP
header with a 200 OK response code and the HTTP body with the actual response data or
other value if error occurs. An example is provided for each request type below:

Illustration 1, Get the network setting from the IP Camera

Client request
GET http://<IP Camera address>/network.cgi HTTP/1.0

…

Server response

HTTP/1.0 200 OK
Content-Type: text/plain

IPAddress=192.168.1.1
SubnetMask=255.255.255.0

…

Illustration 2, Set the network setting from the IP Camera

Client request
POST http://<IP Camera address>/network.cgi HTTP/1.0

IPAddress=192.168.1.1
SubnetMask=255.255.255.0

- 56 -

Server response

HTTP/1.0 200 OK
…

Error Response

If the IP Camera is unable to handle the client HTTP API request due to certain conditions
such as system busy, incorrect parameters, or any other reason, an appropriate HTTP status
code 400 Bad Request is returned accompanied with an error code and error string that
explains the failure.

Client request

GET/POST …

Server response

HTTP/1.0 400 Bad Request
…
ErrorCode=XXX
ErrorString=Invalid IP Address

- 57 -

API Categories

The API categories are listed in the table below.

Table 1, API Categories
API Category Description

Streaming Enable users to set/get the setting about multimedia

streaming.
Camera Enable users to set/get the camera/lens setting.
Audio Enable user to set/get the audio devices’ setting.
Network Enable users to set/get the network setting.
Event Enable users to register to listen for notification coming from

IPCAM.
Storage Enable users to configure storage device for storing media

content.
System Enable users to set/get miscellaneous system settings.
Admin Enables users to perform administrative tasks over the IP

Camera.
Capability Provide users with the list of available features supported by

the IP Camera.
Motion
detection

Enable user to set/get the motion detection setting and

add/delete/update detection region.
Event Enable user to set/get the event setting and set/get the

notification setting.
I/O control Enable user to control I/O status

Ps: Fields marked in gray are reserved.

- 58 -

Streaming API

Streaming API allows applications to

1) set/get the IP Camera streaming setting

2) help users to view video streaming

Data structures
Data Structure Description

SVideoFormatSetting The selected video codec format, encode rate, etc.
SAudioFormatSetting The selected audio codec format, encode rate, etc.
STransportSetting The selected network transport.
SVideoSessionSetting The selected setting of video session used for

streaming

SAudioSessionSetting The selected setting of audio session used for

streaming

SChannelSetting The selected setting of media session (audio+video)

used for aggregate streaming.

SChannelSetSetting The set of available channels on this IPCam

enum _ConstantBitrate{
VBR = 0,
CBR,
};

enum _bitrateKbps{
kbps_64 = 64,
kbps_128 = 128,
kbps_256 = 256,
kbps_384 = 384,
kbps_512= 512,
kbps_768 = 768,
kbps_1500 = 1500,
kbps_2000 = 2000,
kbps_4000 = 4000,
kbps_6000 = 6000,

- 59 -

kbps_8000 = 8000,
kbps_10000 = 10000,
kbps_12000 = 12000,
kbps_15000 = 15000,
};

/* SVideoFormatSetting */
typedef struct _videoFormatSetting {
int sourceDevice; // reserved
char codecType [16]; //
char codecSubType [16];
int constantBitrate; // 0:enabled 1:disabled
int bitrateInKbps; // Kbps
int resolutionWidth;
int resolutionHeight;
int quality; // JPEG Specific
int frameRate; // FPS
int gop; // (reserved)

} SVideoFormatSetting;

typedef struct _audioFormatSetting {
int sourceDevice; // reserved
char codecType[16]; // G711
char codecSubType[16]; // AUTO
int numberOfChannel; // (reserved) Mono, Stereo =>0
int sampleRate; // (reserved) 8KHZ
int frameIntervalMS; //(reserved) 10MS
int sampleSizeBit; //(reserved)16 Bit

} SAudioFormatSetting;

/* SMetaFormatSetting */
typedef struct _metaFormatSetting {
int mdAlarmEnabled;
} SMetaFormatSetting;

- 60 -

/* STransportSetting */
typedef struct _transportSetting {
int multicastEnabled;
char multicastAddress[16];
int multicastPort;
int ttl; // 0-255
} STransportSetting;

/* SVideoSessionSetting */
typedef struct _videoSessionSetting {
int enabled;
SVideoFormatSetting format;
STransportSetting transport;
} SVideoSessionSetting;

/* SAudioSessionSetting */
typedef struct _audioSessionSetting {
int enabled;
SAudioFormatSetting format;
STransportSetting transport;
} SAudioSessionSetting;

/* SMetaSessionSetting */
typedef struct _metaSessionSetting {
int enabled;
SMetaFormatSetting format;
STransportSetting transport;
} SMetaSessionSetting;

/* SChannelSetting */
typedef struct _channelSetting {
int enabled;

- 61 -

int index; // (Unique) 0: reserved. 1+: valid index

char name[16];
int transportType;
SVideoSessionSetting video;
SAudioSessionSetting audio;

SMetaSessionSetting meta;

} SChannelSetting;

/* SChannelSetting */
enum _TransportType {
TRANSPORT_TYPE_RTSP_RTP=0,
TRANSPORT_TYPE_RTP_ONLY=1,
TRANSPORT_TYPE_HTTP=2,
TRANSPORT_TYPE_MSN=3,
};

typedef struct _channelSetting {
int enabled;
int index; // (Unique) 0: reserved. 1+: valid index
char name[16];
int transportType; // enum _TransportType
SVideoSessionSetting video;
SAudioSessionSetting audio;
SMetaSessionSetting meta;
} SChannelSetting;

typedef struct _SChannelSetList {
int size;
SChannelSetting channels[5];
}SChannelSetList;

/* SChannelSetSetting */
typedef struct _channelSetSetting {
SChannelSetList channelList;
} SChannelSetSetting;

- 62 -

ActionEvents

ActionEvent Description

getChannels Get all available channels
getChannel Get a channel info
addChannel Add a new channel
updateChannel Update an existing channel
updateChannels Update all existing channels
deleteChannel Delete a channel
getStream Request to receive a RTSP streaming session

1.1 getChannels

ActionEvent: getChannels
Request

http://<IP>/cgi-bin/channels.cgi&action=get

Response

size =
CH1.index=1
CH1.enabled=
CH1.name=
CH1.transportType=
CH1.video.enabled=
CH1.video.format.sourceDevice=
CH1.video.format.codecType=
CH1.video.format.codecSubType=
CH1.video.format.constantBitrate=
CH1.video.format.bitrateInKbps=
CH1.video.format.resolutionWidth=
CH1.video.format.resolutionHeight=
CH1.video.format.frameRate=
CH1.video.format.gop=
CH1.video.format.quality=
CH1.video.transport.multicastEnabled=
CH1.video.transport.multicastAddress=
CH1.video.transport.multicastPort=
CH1.video.transport.ttl=
CH1.audio.enabled=

- 63 -

CH1.audio.format.codecType=
CH1.audio.format.codecSubType=
CH1.audio.transport.multicastEnabled=
CH1.audio.transport.multicastAddress=
CH1.audio.transport.multicastPort=
CH1.audio.transport.ttl=
CH1.meta.enabled=
CH1.meta.format.mdAlarmEnabled=
CH1.meta.transport.multicastEnabled=
CH1.meta.transport.multicastAddress=
CH1.meta.transport.multicastPort=
CH1.meta.transport.ttl=

Ch2.index=2
….

Comment
Method

GET

1.2 getChannel

ActionEvent: getChannel
Request

http://<IP>/cgi-bin/channels.cgi?action=getChannel&index=<index>

Response

enabled=
name=
transportType=
video.enabled=
video.format.codecType=
video.format.codecSubType=
video.format.constantBitrate=
video.format.bitrateInKbps=
video.format.resolutionWidth=
video.format.resolutionHeight=
video.format.frameRate=

- 64 -

video.format.gop=
video.format.quality=
video.transport.multicastEnabled=
video.transport.multicastAddress=
video.transport.multicastPort=
video.transport.ttl=
audio.enabled=
audio.format.codecType=
audio.format.codecSubType=
audio.transport.multicastEnabled=
audio.transport.multicastAddress=
audio.transport.multicastPort=
audio.transport.ttl=
meta.enabled=
meta.format.mdAlarmEnabled=
meta.transport.multicastEnabled=
meta.transport.multicastAddress=
meta.transport.multicastPort=
meta.transport.ttl=

Comment
Method

GET

1.3 addChannel

ActionEvent: addChannel
Request

http://<IP>/cgi-bin/channels.cgi
action=add
index=<index>
enabled=
name=
transportType=
video.enabled=
video.format.codecType=
video.format.codecSubType=
video.format.constantBitrate=
video.format.bitrateInKbps=
video.format.resolutionWidth=

- 65 -

video.format.resolutionHeight=
video.format.frameRate=
video.format.gop=
video.format.quality=
video.transport.multicastEnabled=
video.transport.multicastAddress=
video.transport.multicastPort=
video.transport.ttl=
audio.enabled=
audio.format.codecType=
audio.format.codecSubType=
audio.transport.multicastEnabled=
audio.transport.multicastAddress=
audio.transport.multicastPort=
audio.transport.ttl=
meta.enabled=
meta.format.mdAlarmEnabled=
meta.transport.multicastEnabled=
meta.transport.multicastAddress=
meta.transport.multicastPort=
meta.transport.ttl=

Response
Comment
Method

POST

- 66 -

1.4 updateChannel

ActionEvent: updateChannel
Request

http://<IP>/cgi-bin/channels.cgi
action=update
index=<index>
enabled=
name=
transportType=
video.enabled=
video.format.codecType=
video.format.codecSubType=
video.format.constantBitrate=
video.format.bitrateInKbps=
video.format.resolutionWidth=
video.format.resolutionHeight=
video.format.frameRate=
video.format.gop=
video.format.quality=
video.transport.multicastEnabled=
video.transport.multicastAddress=
video.transport.multicastPort=
video.transport.ttl=
audio.enabled=
audio.format.codecType=
audio.format.codecSubType=
audio.transport.multicastEnabled=
audio.transport.multicastAddress=
audio.transport.multicastPort=
audio.transport.ttl=
meta.enabled=
meta.format.mdAlarmEnabled=
meta.transport.multicastEnabled=
meta.transport.multicastAddress=
meta.transport.multicastPort=
meta.transport.ttl=

- 67 -

Response
Comment
Method

POST

1.5 updateChannels

ActionEvent: updateChannels
Request

http://<IP>/cgi-bin/channels.cgi
action=updateAll
c1Enable=&
c1Name=&
c1TransportType=&
c1VideoEnabled=&
c1VideoFormatCodecType=&
c1VideoFormatCodecSubType=&
c1VideoFormatConstantBitrate=&
c1VideoFormatBitrateInKbps =&
c1VideoFormatResolutionWidth=&
c1VideoFormatResolutionHeight=&
c1VideoFormatFrameRate=&
c1VideoFormatGop=&
c1VideoFormatQuality =&
c1VideoTransportMulticastEnabled=&
c1VideoTransportMulticastAddress=&
c1VideoTransportMulticastPort=&
c1VideoTransportTtl=&
c1AudioEnabled=&
c1AudioFormatCodecType=&
c1AudioFormatCodecSubType =&
c1AudioTransportMulticastEnabled=&
c1AudioTransportMulticastAddress=&
c1AudioTransportMulticastPort=&
c1AudioTransportTtl=&
c1MetaEnabled=&
c1MetaFormatMdAlarmEnabled =&
c1MetaTransportMulticastEnabled=&

- 68 -

c1MetaTransportMulticastAddress=&
c1MetaTransportMulticastPort=&
c1MetaTransportTtl=&
c2Enable=&…….

Response
Comment
Method

POST

ActionEvent: deleteChannel
Request

http://<IP>/cgi-bin/channels.cgi
action=delete&index=<index>

Response
Comment
Method

POST

1.6 getStream

ActionEvent: getStream
Request

rtsp://<IP>/channel<index>

Response
Comment

<Index> is the index number of the SChannelSetting.

Method

- 69 -

Camera API

Camera API allows applications to set/get the Camera/lens setting.

Data structures

Data Structure Description

SWhiteBalanceSetting White balance setting of the Camera
SBrightnessSetting Brightness setting of the Camera
SColorSaturationSetti
ng

Color Saturation setting of the Camera

SMirrorFlipSetting MirrorFlip setting of the Camera
SSharpnessSetting Sharpness setting of the Camera
SContrastSetting Contrast setting of the Camera
SFrequencySetting 50Hz / 60Hz switching
SEffectSetting Special Effect switching
SEnvModeSetting Indoors / Outdoor switching
SIRCutFilterSetting IR cut-off filter setting
SIRLEDSetting IR LED setting
SVideoOverlaySetting Video overlay setting

/* SWhiteBalanceSetting */
enum WhiteBalanceMode {
WB_MODE_OFF=0,
WB_MODE_SIMPLE,
WB_MODE_ADVANCED,

};
/* SAutoExposureSetting */
enum AutoExposureMode {
AE_MODE_OFF=0,
AE_MODE_AEC,
AE_MODE_AGC,
};

- 70 -

/* SExposureSetting */
typedef struct _ExposureSetting {
int mode; // enum AutoExposureMode
} SExposureSetting;

/* SWhiteBalanceSetting */
typedef struct _whiteBalanceSetting {
int mode; // enum WhiteBalanceMode
int level; //
} SWhiteBalanceSetting;

/* SBrightnessSetting */
typedef struct _brightnessSetting {
int level; //
} SBrightnessSetting;

/* SColorSaturationSetting */
typedef struct _colorSaturationSetting {
int level; //
} SColorSaturationSetting;

/* MirrorFlipSetting */
typedef struct _MirrorFlipSetting {
int mirror_enabled;
int flip_enabled;
} SMirrorFlipSetting;

/* SSharpnessSetting */
typedef struct _sharpnessSetting {
int level; //
} SSharpnessSetting;

/* SContrastSetting */
typedef struct _contrastSetting {
int level; //
} SContrastSetting;

enum Frequency {

- 71 -

FREQ_60HZ=0,
FREQ_50HZ,
};

/* SFrequencySetting */
typedef struct _frequencySetting {
int freq; // 60Hz : 0 , 50Hz : 1
} SFrequencySetting;

enum SpecialEffectMode {
EFFECT_MODE_DISABLED=0,
EFFECT_MODE_NEGATIVE,
EFFECT_MODE_BLACKWHITE,
};

enum IndoorOutdoorMode {
MODE_OUTDOOR=0,
MODE_INDOOR,
};

typedef struct _effectSetting {
int effectMode; // enum SpecialEffectMode
} SEffectSetting;

typedef struct _EnvModeSetting {
int envMode; // enum IndoorOutdoorMode
} SEnvModeSetting;

/* SIRCutFilterSetting */
enum IRCutMode {
IRCUT_MODE_OFF=0,
IRCUT_MODE_ON,
IRCUT_MODE_AUTO,
};

- 72 -

typedef struct _IRCutFilterSetting {
int mode; // enum IRCutMode
int thresholdLevel; // (reserved) 0-100
} SIRCutFilterSetting;

/* SIRLEDSetting */
enum IRLEDMode {
IRLED_OFF=0,
IRLED_ON,
IRLED_MODE_AUTO,

};

typedef struct _IRLEDSetting {
int mode; // enum IRCutMode
int thresholdLevel; // (reserved) 0-100
} SIRLEDSetting;

/*SAutoIris*/
enum AutoIrisMode {
AUTOIRIS_DISABLED=0,
AUTOIRIS_ENABLED,
};
typedef struct _autoIris {
int enabled; //enum AutoIrisMode
}SAutoIris;

/* SVideoOverlaySetting */
enum TimeStampMOde{
TimeStamp_off=0,
TimeStamp_on,
};
enum UseImage{
NO_IMAGE = 0,

- 73 -

UPLOAD_IMAGE,
};

typedef struct _OsdPalette {
int y; //Range:0~255
int Cb; //Range:0~255
int Cr; //Range:0~255
} SOsdPalette;
typedef struct _OsdWindow {
int x; //Range:depends on resolution
int y; //Range:depends on resolution
int transparent;//Range:0~3
} SOsdWindow;

/* SVideoOverlaySetting */
typedef struct _VideoOverlaySetting {
int useTimestamp; // 0: no timestamp, 1: use timestamp
char displayString[50];
int useImage; // 0: no image, 1: use uploaded image.
int enabled;
SOsdPalette osdPalette1;
SOsdPalette osdPalette2;
SOsdWindow osdWindow1;
SOsdWindow osdWindow2;

} SVideoOverlaySetting;

ActionEvents

ActionEvent Description

setWhiteBalance Set white balance
getWhiteBalance Get white balance
setBrightness Set brightness
getBrightness Get brightness
setColorSaturation Set Color Saturation
getColorSaturation Get Color Saturation

- 74 -

setMirrorFlip Set MirrorFlip
getMirrorFlip Get MirrorFlipof
setSharpness Set Sharpness
getSharpness Get Sharpness
setContrast Set Contrast
getContrast Get Contrast
setFrequency Set Frequency
getFrequency Get Frequency
setEffect Set Effect
getEffect Get Effect
setEnvMode Set EnvMode
getEnvMode Get EnvMode
setIRCutFilter Set IR cut Filter
getIRCutFilter Get IR cut filter
setIRLED Set IR LED
getIRLED Get IR LED
setVideoOverlay Set video overlay
getVideoOverlay Get video overlay
setCameraSetting Set all camera setting.
getCameraSetting Get all camera setting.

2.1 setWhiteBalance

ActionEvent: setWhiteBalance
Request

http://<IP>/cgi-bin/camera.cgi
action=setWhiteBalance
mode=
level=

Response
Comment
Method

POST

- 75 -

2.2 getWhiteBalance

ActionEvent: getWhiteBalance
Request http://<IP>/cgi-bin/camera.cgi?action=getWhiteBalance
Response

mode=
level=

Comment
Method

GET

2.3 setBrightness

ActionEvent: setBrightness
Request

http://<IP>/cgi-bin/camera.cgi
action= setBrightness
level=

Response
Comment
Method

POST

2.4 getBrightness

ActionEvent: getBrightness
Request http://<IP>/cgi-bin/camera.cgi?action=getBrightness
Response

level=

Comment
Method

GET

- 76 -

2.5 setColorSaturation

ActionEvent: setColorSaturation
Request

http://<IP>/cgi-bin/camera.cgi
action= setColorSaturation
level=

Response
Comment
Method

POST

2.6 getColorSaturation

ActionEvent: getColorSaturation
Request http://<IP>/cgi-bin/camera.cgi?action=getColorSaturation
Response

level=

Comment
Method

GET

2.7 setMirrorFlip

ActionEvent: setMirrorFlip
Request

http://<IP>/cgi-bin/camera.cgi
action= setMirrorFlip
mirrorEnabled =
flipEnabled=

Response
Comment
Method

POST

- 77 -

2.8 getMirrorFlip

ActionEvent: getMirrorFlip
Request http://<IP>/cgi-bin/camera.cgi?action= getMirrorFlip
Response

flipEnabled=
mirrorEnabled =

Comment
Method

GET

2.9 setSharpness

ActionEvent: setSharpness
Request

http://<IP>/cgi-bin/camera.cgi
action= setSharpness
level=

Response
Comment
Method

POST

2.10 getSharpness

ActionEvent: getSharpness
Request http://<IP>/cgi-bin/camera.cgi?action=getSharpness
Response

level=

Comment
Method

GET

- 78 -

2.11 setContrast

ActionEvent: setContrast
Request

http://<IP>/cgi-bin/camera.cgi
action=setContrast
level=

Response
Comment
Method

POST

2.12 getContrast

ActionEvent: getContrast
Request http://<IP>/cgi-bin/camera.cgi?action=getContrast
Response

level=

Comment
Method

GET

2.13 setFrequcny

ActionEvent: setFrequcny
Request

http://<IP>/cgi-bin/camera.cgi
action=setFrequency
freq =

Response
Comment
Method

POST

- 79 -

2.14 getFrequency

ActionEvent: getFrequency
Request http://<IP>/cgi-bin/camera.cgi?action=getFrequency
Response

freq=

Comment
Method

GET

2.15 setEffect

ActionEvent: setEffect
Request

http://<IP>/cgi-bin/camera.cgi
action=setEffect
effectMode =

Response
Comment
Method

POST

2.16 getEffect

ActionEvent: getEffect
Request http://<IP>/cgi-bin/camera.cgi?action=getEffect
Response

effectMode=

Comment
Method

GET

- 80 -

2.17 setEnvMode

ActionEvent: setEnvMode
Request

http://<IP>/cgi-bin/camera.cgi
action=setEnvMode
envMode =

Response
Comment
Method

POST

2.18 getEnvMode

ActionEvent: getEnvMode
Request http://<IP>/cgi-bin/camera.cgi?action=getEnvMode
Response

envMode=

Comment
Method

GET

2.19 setIRCutFilter

ActionEvent: setIRCutFilter
Request

http://<IP>/cgi-bin/camera.cgi
action=setIRCutFilter
mode=

thresholdLevel=

Response
Comment
Method

POST

- 81 -

2.20 getIRCutFilter

ActionEvent: getIRCutFilter
Request http://<IP>/cgi-bin/camera.cgi?action=getIRCutFilter
Response

mode=

thresholdLevel=

Comment
Method

GET

2.21 setIRLED

ActionEvent: setIRLED
Request

http://<IP>/cgi-bin/camera.cgi
action=setIRLED
mode=
thresholdLevel=

Response
Comment
Method

POST

2.22 getIRLED

ActionEvent: getIRLED
Request http://<IP>/cgi-bin/camera.cgi?action=getIRLED
Response

mode=
thresholdLevel=

Comment
Method

GET

- 82 -

2.23 setVideoOverlay

ActionEvent: setVideoOverlay
Request

http://<IP>/cgi-bin/camera.cgi
action=setVideoOverlay
useTimestamp=
displayString=
useImage=
useText=
osdPalette1.y=
osdPalette1.Cb=
osdPalette1.Cr=
osdPalette2.y=
osdPalette2.Cb=
osdPalette2.Cr=
osdWindow1.x=
osdWindow1.y=
osdWindow1.transparent=
osdWindow2.x=
osdWindow2.y=
osdWindow2.transparent=

Response
Comment
Method

POST

2.24 getVideoOverlay

ActionEvent: getVideoOverlay
Request http://<IP>/cgi-bin/camera.cgi?action=getVideoOverlay
Response

useTimestamp=
displayString=
useImage=
useText=
osdPalette1.y=

- 83 -

osdPalette1.Cb=
osdPalette1.Cr=
osdPalette2.y=
osdPalette2.Cb=
osdPalette2.Cr=
osdWindow1.x=
osdWindow1.y=
osdWindow1.transparent=
osdWindow2.x=
osdWindow2.y=
osdWindow2.transparent=

Comment
Method

GET

2.25 setAutoIris

ActionEvent: setAutoIris
Request

http://<IP>/cgi-bin/camera.cgi
action= setAutoIris
enabled

Response
Comment
Method

POST

2.26 getAutoIris

ActionEvent: getAutoIris
Request http://<IP>/cgi-bin/camera.cgi?action= getAutoIris
Response

enabled=

Comment
Method

GET

- 84 -

2.27 setCameraSetting

ActionEvent: setCameraSetting
Request

http://<IP>/cgi-bin/camera.cgi
action=setCameraSetting
whiteBalance.mode=0
whiteBalance.level=0
brightness.level=1
colorSaturation.level=-1
flipEnabled=0
mirrorEnabled=0
sharpness.level=2
contrast.level=0
freq=0
effectMode=0
envMode=1
IRCutFilter.mode=2
IRCutFilter.thresholdLevel=0
IRLED.mode=2
IRLED.thresholdLevel=0
autoIris.enabled=1
videoOverlay.useTimestamp=1
videoOverlay.displayString=HELLO
videoOverlay.useImage=0
videoOverlay.useText=
videoOverlay.osdPalette1.y=255
videoOverlay.osdPalette1.Cb=128
videoOverlay.osdPalette1.Cr=128
videoOverlay.osdPalette2.y=16
videoOverlay.osdPalette2.Cb=128
videoOverlay.osdPalette2.Cr=128
videoOverlay.osdWindow1.x=0
videoOverlay.osdWindow1.y=13
videoOverlay.osdWindow1.transparent=0
videoOverlay.osdWindow2.x=0
videoOverlay.osdWindow2.y=0
videoOverlay.osdWindow2.transparent=0

- 85 -

Response
Comment
Method

POST

2.28 getCameraSetting

ActionEvent: getCameraSetting
Request http://<IP>/cgi-bin/camera.cgi?action=getCameraSetting
Response

whiteBalance.mode=0
whiteBalance.level=0
brightness.level=1
colorSaturation.level=-1
flipEnabled=0
mirrorEnabled=0
sharpness.level=2
contrast.level=0
freq=0
effectMode=0
envMode=1
IRCutFilter.mode=2
IRCutFilter.thresholdLevel=0
IRLED.mode=2
IRLED.thresholdLevel=0
autoIris.enabled=1
videoOverlay.useTimestamp=1
videoOverlay.displayString=HELLO
videoOverlay.useImage=0
videoOverlay.useText=
videoOverlay.osdPalette1.y=255
videoOverlay.osdPalette1.Cb=128
videoOverlay.osdPalette1.Cr=128
videoOverlay.osdPalette2.y=16
videoOverlay.osdPalette2.Cb=128
videoOverlay.osdPalette2.Cr=128
videoOverlay.osdWindow1.x=0
videoOverlay.osdWindow1.y=13
videoOverlay.osdWindow1.transparent=0

- 86 -

videoOverlay.osdWindow2.x=0
videoOverlay.osdWindow2.y=0
videoOverlay.osdWindow2.transparent=0

Comment
Method

GET

- 87 -

Audio API

Audio API allows applications to

1) set/get the audio device setting

2) set/get the audio volume of the device

Data structures

Data Structure Description

SAudioDeviceSetting Basic audio device setting

/* SAudioDeviceSetting */
typedef struct _audioDeviceSetting {
int muted; // True (muted), False (un-muted)
int level; // volume level 1-100
int mediaType; // (reserved) Full=0, Half duplex=1
int voiceSource; // voice MIC/Line in =>0/1 =>0
} SAudioDeviceSetting;

ActionEvents

ActionEvent Description

setAudioDevice Set audio device setting
getAudioDevice Get audio device setting
setAudioMuteState Mute or un-mute audio
getAudioMuteState Get the mute state of audio
setAudioVolume Set audio volume setting
getAudioVolume Get audio volume setting

- 88 -

3.1 setAudioDevice

ActionEvent: setAudioDevice
Request

http://<IP>/cgi-bin/audio.cgi
action=setAudioDevice
muted=
level =
voiceSource =

Response
Comment
Method

POST

3.2 getAudioDevice

ActionEvent: getAudioDevice
Request http://<IP>/cgi-bin/ audio.cgi?action=getAudioDevice
Response

muted =
level =
voiceSource =

Comment
Method

GET

3.3 setAudioMuteState

ActionEvent: setAudioMuteState
Request

http://<IP>/cgi-bin/audio.cgi
action=setAudioMuteState
muted=

Response
Comment
Method

POST

- 89 -

3.4 getAudioMuteState

ActionEvent: getAudioMuteState
Request http://<IP>/cgi-bin/audio.cgi?action=getAudioMuteState
Response

muted=

Comment
Method

GET

3.5 setAudioVolume

ActionEvent: setAudioVolume
Request

http://<IP>/cgi-bin/audio.cgi
action=setAudioVolume
level=

Response
Comment
Method

POST

3.6 getAudioVolume

ActionEvent: getAudioVolume
Request http://<IP>/cgi-bin/audio.cgi?action=getAudioVolume
Response

level=

Comment
Method

GET

- 90 -

Network API

Network API allows applications to set/get the network-related settings including IP address,
WIFI network, etc.

Data structures

Data Structure Description

SBasicNetworkSetting Basic network setting such as IP address, netmask,

etc.
SUPnPSetting UPnP setting for SSDP advertisement
SDDNSSetting DDNS setting
SEthernetSetting Ethernet (802.3?) setting
SWIFISetting 802.11 WLAN setting
SIPFilterSetting IPFilter setting

/* SBasicNetworkSetting */

enum NetAddressType {
NET_ADDRESS_TYPE_STATIC=0,
NET_ADDRESS_TYPE_DHCP,
NET_ADDRESS_TYPE_PPPOE,
};

typedef struct _DHCPSetting {
// Currently reserved
} SDHCPSetting;

typedef struct _PPPoESetting {
char username[128];
char password[128];
} SPPPoESetting;

- 91 -

typedef struct _BasicNetworkSetting {
int addressType; // enum NetAddressType
char ipv4Address[16];
char subnetMask[16];
char gatewayAddress[16];
char dnsAddress1[16];
char dnsAddress2[16];
SDHCPSetting dhcp;
SPPPoESetting pppoe;

// TBD: IPv6, ….
} SBasicNetworkSetting;

/* SUPnPSetting */

typedef struct _UPnPSetting {
int enabled;

char upnpName[128];

} SUPnPSetting;

/* SDDNSSetting */

enum ddnsServerType{
DYNDNS = 0,
TZO,
};

typedef struct _SDDNSEntry{
int wildcardEnabled;//0:disable 1:enable
char username[128];
char password[128];
char hostname[128];
}SDDNSEntry;

typedef struct _DDNSSetting {
int dyndnsEnabled;
int tzodnsEnabled;
SDDNSEntry dyndns;
SDDNSEntry tzodns;