Related Manuals for Brickcom WFB-100A
Summary of Contents for Brickcom WFB-100A
- Page 1 Megapixel Day & Night Fixed Box Network Camera FB-100A Series User’s Manual Quality Service Group...
- Page 2 Product name: Network Camera (WFB-100A/FB-100A) Release Date: 2009/ Manual Revision: V2.0 Web site: www.brickcom.com Email: technical@brickcom.com info@brickcom.com Made in Taiwan. ©2009 Brickcom Corporation. All Rights Reserved...
-
Page 3: Table Of Contents
Table of Contents Before You Use This Product ..................... 0 Package Contents......................0 Fixed Box Network Camera Overview ................1 Device Appearance Description ..................3 LED Behavior........................5 Installation.......................... 9 Hardware Installation ...................... 9 Camera Connection...................... 12 Basic Connection (Without PoE)................. 12 Power over Ethernet (PoE) Connection .............. - Page 4 Reboot ........................ 56 BRICKCOM IPCAM HTTP API ..................57 Preface ......................... 57 Overview........................57 HTTP API Transaction ..................... 58 API Categories......................... 60 Streaming API ........................61 getChannels ...................... 64 getChannel ......................65 addChannel ....................... 66 updateChannel ....................67 updateChannels ....................68 getStream ......................
- Page 5 setBasicNetwork ....................91 getBasicNetwork....................92 setUPnP ......................93 getUPnP ......................93 setDDNS......................93 getDDNS ......................94 setEthernet ......................94 getEthernet ......................94 setWIFI ......................95 4.10 getWIFI ......................96 4.11 setIPFilter ......................97 4.12 getIPFilter ......................98 Storage API (TBD) ......................99 System API ........................
- Page 6 getEventRule ....................123 setEmailSetting....................123 getEmailSetting ....................124 setFTPSetting....................125 9.10 getFTPSetting....................125 9.11 setAlarmMediaInfo................... 126 9.12 getAlarmMediaInfo................... 126 9.13 setSamba ......................126 9.14 getSamba ......................127 I/O Control API ....................... 127 10.1 setGPIOSetting....................127 10.2 getGPIOSetting ....................128 10.3 getGPIOStatus....................
-
Page 7: Before You Use This Product
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. -
Page 8: Package Contents
Package Contents a. FB-100A b. CS mount Lens (Optional) c. Product CD d. Camera Stand e. Warranty Card f. Power Adapter g. Detachable Antenna (WFB-100A) h. Quick Guide... -
Page 9: Fixed Box Network Camera Overview
For easy setup, “Easy Installation Wizard” makes the configuration simple even for users without IT background. The Brickcom IP camera simplifies the hardware and software installation by flexible design and multiple applications. In other words, the WFB-100A is not only for normal home security but also suitable for professional surveillance demand such... -
Page 11: Device Appearance Description
Device Appearance Description <Front Panel> Light Sensor Status LED WPS LED (WFB-100A Only) Built-in Microphone <Rear Panel> Ethernet RJ45 10/100 Socket Power Connector (AC24V in) (Link/Power LED embedded) Power Connector (DC12V in) Detachable Antenna (WFB-100A Only) Auto Iris Connector WPS Button... - Page 12 <CS Mount Lens> <Optional Lens> <Vari-focal Lens with Manual Iris> Iris Controller Focus Controller Zoom Controller <Optional Lens> <Vari-focal Lens with Auto Iris (DC Drive)> Zoom Controller Focus Controller...
-
Page 13: Led Behavior
LED Behavior Function LED Behavior Description Remark WFB-100A WPS in Front Right progress (Blue) WFB-100A WPS Error Front Right (Blue) Session WFB-100A overlap Front Right detected (Blue) WFB-100A WPS Success Front Right (Blue) Hardware Front Left Status failure (Green) 1. Restoring... - Page 14 Extension I/O Terminal Block The Network Camera provides an extension I/O terminal block which is used to connect external input/output devices. The pin definitions are listed as below. Function Power +4.5V Digital Output Digital Input Ground RS-485 - RS-485 +...
- Page 15 DI/DO Diagram...
- Page 16 Hardware Reset Reset Button 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.
-
Page 17: Installation
Installation Hardware Installation Mounting the CS-Mount Lens to the Camera <Vari-focal Lens with Manual Iris> --- Optional Lens Mount the CS-mount lens by turning it clockwise onto the camera mount until it stops. If it’s necessary, please turn the lens counterclockwise slowly until it gets the best position. - Page 18 <Vari-focal Lens with Auto Iris> --- Optional Lens Mount the CS-mount lens by turning it clockwise onto the camera mount until it stops. If it’s necessary, please turn the lens counterclockwise slowly until it gets the best position. Connect the lens cable plug (DC Iris control cable) to the camera side connector. Unscrew the zoom controller to adjust the zoom factor.
-
Page 19: System Requirements
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:... -
Page 20: Camera Connection
Camera Connection Basic Connection (Without PoE) If you have external devices such as sensors and alarms, please make connections with extension I/O terminal block. Connect the camera to a switch via Ethernet cable. Connect the supplied power cable from the camera to the power outlet. Please check your product package contains all the accessories listed in the foregoing Package Contents. -
Page 21: Power Over Ethernet (Poe) Connection
Power over Ethernet (PoE) Connection When connecting to PoE-enabled switch The camera is PoE compliant and please connects the camera to a PoE-enabled switch via single Ethernet cable. When connecting to a non-PoE switch Please connect the camera to a non-PoE switch via PoE Injector (optional). -
Page 22: Software Installation
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. - Page 23 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”...
- Page 25 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”.
- Page 26 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.
- Page 28 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.
-
Page 29: Access To The Network Camera
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. -
Page 30: Authentication
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. -
Page 31: Installing Plug-In
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. -
Page 32: Live View
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 30. - Page 33 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.
- Page 34 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.
-
Page 35: Configuration
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. - Page 36 Night Vision IR CUT - the Network Camera switches off the IR cut filter at all times for the sensor to accept the infrared light, thus helps improve low light sensitivity. Auto - The Network Camera automatically removes the filter by judging the level of ambient light.
- Page 37 IRIS Auto Iris lens - Select when the auto Iris lens is installed. Manual Iris lens is the default lens. Exposure Mode Auto - The camera sets the exposure by auto exposure time. Auto exposure setting including the long exposure mode is performed according to the lighting conditions. Manual - The camera fixes the exposure time and performs auto exposure settings.
-
Page 38: Video
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. - Page 39 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;...
- Page 40 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.
-
Page 41: Audio
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. -
Page 42: Multicast
Multicast Multicast sends a stream to the multicast group address and allows multiple clients to acquire the stream at the same time by requesting a copy from the multicast group address. Therefore, multicast can effectively save Internet bandwidth. The RTSP (Real-Time Streaming Protocol) controls the delivery of streaming media. -
Page 43: Network
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 The third way is to use PPPoE. -
Page 44: Upnp
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. -
Page 45: Wireless
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... - Page 46 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.
- Page 47 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.
- Page 48 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.
-
Page 49: Advanced Settings
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. -
Page 50: Http/Https
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). -
Page 51: Event
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. -
Page 53: Notification Setting
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. - Page 54 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.
- Page 55 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.
-
Page 56: Scheduled Event
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. -
Page 57: Di/Do
DI/DO Digital input - Select High or Low to define normal status of the digital input. The Network Camera will report the current status. Digital output - Select Grounded or Open and enter the duration to define normal status of the digital output. -
Page 58: System
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. -
Page 59: Date & Time Settings
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. -
Page 60: Device Information
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. - Page 61 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.
-
Page 62: Maintenance
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. -
Page 63: Ip Filter
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. -
Page 64: Configuration
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. -
Page 65: Brickcom Ipcam Http Api
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. -
Page 66: Http Api Transaction
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... - Page 67 Client request GET/POST … Server response HTTP/1.0 400 Bad Request … ErrorCode=XXX ErrorString=Invalid IP Address...
-
Page 68: Api Categories
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. -
Page 69: Streaming Api
Streaming API Streaming API allows applications to set/get the IP Camera streaming setting 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. - Page 70 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;...
- Page 71 int enabled; SMetaFormatSetting format; STransportSetting transport; } SMetaSessionSetting; /* SChannelSetting */ typedef struct _channelSetting { int enabled; 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,...
-
Page 72: Getchannels
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... -
Page 73: Getchannel
Ch2.index=2 …. Comment Method 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= 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... -
Page 74: Addchannel
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= 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... -
Page 75: Updatechannel
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= Response Comment Method POST... -
Page 76: Updatechannels
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=& c1MetaTransportMulticastAddress=& c1MetaTransportMulticastPort=& c1MetaTransportTtl=&... -
Page 77: Getstream
1.6 getStream ActionEvent: getStream Request rtsp://<IP>/channel<index> Response Comment <Index> is the index number of the SChannelSetting. Method... -
Page 78: Camera Api
Camera API The 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 Color Saturation setting of the Camera SMirrorFlipSetting MirrorFlip setting of the Camera SSharpnessSetting Sharpness setting of the Camera SContrastSetting... - Page 79 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;...
- Page 80 typedef struct _EnvModeSetting int envMode; // enum IndoorOutdoorMode } SEnvModeSetting; /* SIRCutFilterSetting */ enum IRCutMode { IRCUT_MODE_OFF=0, IRCUT_MODE_ON, IRCUT_MODE_AUTO, typedef struct _IRCutFilterSetting { int mode; // enum IRCutMode int thresholdLevel; // (reserved) 0-100 } SIRCutFilterSetting; /* SIRLEDSetting */ enum IRLEDMode { IRLED_OFF=0, IRLED_ON, IRLED_MODE_AUTO,...
- Page 81 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;...
-
Page 82: Setwhitebalance
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 2.2 getWhiteBalance ActionEvent: getWhiteBalance Request http://<IP>/cgi-bin/camera.cgi?action=getWhiteBalance Response mode=... -
Page 83: Setbrightness
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 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... -
Page 84: Setsharpness
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... -
Page 85: Setcontrast
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 2.13 setFrequcny ActionEvent: setFrequcny Request http://<IP>/cgi-bin/camera.cgi action=setFrequency freq = Response Comment Method POST 2.14 getFrequency ActionEvent: getFrequency Request http://<IP>/cgi-bin/camera.cgi?action=getFrequency Response freq=... -
Page 86: Setenvmode
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 2.19 setIRCutFilter ActionEvent: setIRCutFilter Request http://<IP>/cgi-bin/camera.cgi action=setIRCutFilter mode= thresholdLevel= Response Comment Method POST... -
Page 87: Getircutfilter
2.20 getIRCutFilter ActionEvent: getIRCutFilter Request http://<IP>/cgi-bin/camera.cgi?action=getIRCutFilter Response mode= thresholdLevel= Comment Method 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 2.23 setVideoOverlay ActionEvent: setVideoOverlay Request http://<IP>/cgi-bin/camera.cgi action=setVideoOverlay useTimestamp=... -
Page 88: Getvideooverlay
2.24 getVideoOverlay ActionEvent: getVideoOverlay Request http://<IP>/cgi-bin/camera.cgi?action=getVideoOverlay Response 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= Comment Method 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... -
Page 89: Setcamerasetting
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 Response Comment Method POST... -
Page 90: Getcamerasetting
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 videoOverlay.osdWindow2.x=0 videoOverlay.osdWindow2.y=0 videoOverlay.osdWindow2.transparent=0 Comment Method... -
Page 91: Audio Api
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;... -
Page 92: Setaudiodevice
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 3.3 setAudioMuteState ActionEvent: setAudioMuteState Request http://<IP>/cgi-bin/audio.cgi action=setAudioMuteState muted= Response Comment Method... -
Page 93: Setaudiovolume
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... -
Page 94: Network Api
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... - Page 95 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; } SDDNSSetting; /* SEthernetSetting */ enum EthernetMediaType { ETHER_MEDIA_TYPE_AUTO=0,...
- Page 96 WL_WEPAUTO, enum WIFISecurityMode { WL_NONE=0, WL_WEP, WL_WPAPSK, WL_WPA2PSK, //WL_WPA_ENTERPRISE, //WL_WPA2_ENTERPRISE, enum WIFIAccessMode { WIFI_ACCESS_MODE_INFRASTRUCTURE=0, WIFI_ACCESS_MODE_ADHOC, enum WIFIOperationMode { WIFI_OP_MODE_AUTO=0, WIFI_OP_MODE_11G_ONLY, WIFI_OP_MODE_11B_ONLY, WIFI_OP_MODE_11N_ONLY, WIFI_OP_MODE_11BG_MIXED, WIFI_OP_MODE_11GN_MIXED, WIFI_OP_MODE_11BGN_MIXED, enum WIFIPreambleType { WIFI_PREAMBLE_TYPE_LONG=0, WIFI_PREAMBLE_TYPE_SHORT, enum WIFIAuthenticationType { WIFI_AUTHENTICATION_TYPE_OPEN=0, WIFI_AUTHENTICATION_TYPE_SHARED_KEY, enum WIFIchannelBandWidth { FORTY_MHZ=0, TWENTY_MHZ, enum WIFIWPSMode { NONE=0, PIN,...
- Page 97 typedef struct _SSWPS { int WPSMode; // enum WIFIWPSMode char PINCode[64]; }SWPS; typedef struct _SSWPA { int algorithmType; // enum WIFIWPA_algorithmType char sharedKey[64]; }SWPA; typedef struct _SSKeyentry { char encryptionKey[64]; }SKeyentry; typedef struct _SSEncryptionKeyList { int size; SKeyentry keyEntry[4]; }SEncryptionKeyList; typedef struct _SSWEP { int authenticationType;...
- Page 98 typedef struct _IEEE_802_1xSetting { int enabled; int authenticationProtocolType; //enum authenticationProtocolType int innerTTLSAuthenticationMethod; //enum authenticationMethod int innerEAPProtocolType;//enum innerEAPProtocolType int validateServerEnabled; char userName[65]; char password[65]; char anonymousID[65]; int autoPACProvisioningEnabled; int caline; int clientline; int PACline; } SIEEE_802_1xSetting; typedef struct _WIFISetting { int enabled; int mode;...
-
Page 99: Setbasicnetwork
int enabled; int permissionType; SFilterAddressList allowList; SFilterAddressList denyList; }SIPFilterSetting; ActionEvents ActionEvent Description setBasicNetwork Set the basic network setting getBasicNetwork Get the basic network setting setUPnP Set UPnP setting getUPnP Get UPnP setting setDDNS Set DDNS setting getDDNS Get DDNS setting setEthernet Set Ethernet setting getEthernet... -
Page 100: Getbasicnetwork
4.2 getBasicNetwork ActionEvent: getBasicNetwork Request http://<IP>/cgi-bin/basicNetwork.cgi?action=get Response addressType= (0=Static,1=DHCP, 2=PPPoE) ipv4Address= subnetMask= gatewayAddress= dnsAddress1= dnsAddress2= pppoe.username= pppoe.password= Comment Method... -
Page 101: Setupnp
4.3 setUPnP ActionEvent: setUPnP Request http://<IP>/cgi-bin/upnp.cgi action=set enabled= name= Response Comment Method POST 4.4 getUPnP ActionEvent: getUPnP Request http://<IP>/cgi-bin/upnp.cgi?action=get Response enabled= name= Comment Method 4.5 setDDNS ActionEvent: setDDNS Request http://<IP>/cgi-bin/ddns.cgi action=set dyndnsEnabled= dyndns.wildcardEnabled= dyndns.username= dyndns.password= dyndns.hostname= tzodnsEnabled= tzodns.wildcardEnabled= tzodns.username= tzodns.password= tzodns.hostname= Response Comment... -
Page 102: Getddns
4.6 getDDNS ActionEvent: getDDNS Request http://<IP>/cgi-bin/ddns.cgi? action=get Response dyndnsEnabled=0 dyndns.wildcardEnabled= dyndns.username= dyndns.password= dyndns.hostname= tzodnsEnabled= tzodns.wildcardEnabled= tzodns.username= tzodns.password= tzodns.hostname= Comment Method 4.7 setEthernet ActionEvent: setEthernet Request http://<IP>/cgi-bin/ethernet.cgi action=set mediaType= Response Comment Method POST 4.8 getEthernet ActionEvent: getEthernet Request http://<IP>/cgi-bin/ethernet.cgi?action=get Response mediaType= Comment Method... -
Page 103: Setwifi
4.9 setWIFI ActionEvent: setWIFI Request http://<IP>/cgi-bin/wifi.cgi action=set enabled= mode= operationMode= channel= SSID= preamble= rtsThreshold= fragmentationThreshold= authentication= channelBandWidth= securityMode= WEP. authenticationType= WEP. defaultTransmitKeyIndex = WEP. wepKeyLength = WEP. encryptionKeyList. Keyentry1.encryptionKey= WEP. encryptionKeyList. Keyentry2.encryptionKey= WEP. encryptionKeyList. Keyentry3.encryptionKey= WEP. encryptionKeyList. Keyentry4.encryptionKey= WPA. algorithmType= WPA.sharedKey= WPS.WPSMode= WPS.PINCode=... -
Page 104: Getwifi
4.10 getWIFI ActionEvent: getWIFI Request http://<IP>/cgi-bin/wifi.cgi? action=get Response enabled= mode= operationMode= channel= SSID= preamble= rtsThreshold= fragmentationThreshold= authentication= channelBandWidth= securityMode= (a.) securityMode=0 return Nothing!! (b.) securityMode=1 WEP. authenticationType= WEP. defaultTransmitKeyIndex = WEP. wepKeyLength= WEP. encryptionKeyList.Keyentry1.encryptionKey= WEP. encryptionKeyList.Keyentry2.encryptionKey= WEP. encryptionKeyList.Keyentry3.encryptionKey= WEP. encryptionKeyList.Keyentry4.encryptionKey= (c.) securityMode=2 WPA. -
Page 105: Setipfilter
4.11 setIPFilter ActionEvent: setIPFilter Request http://<IP>/cgi-bin/IPFilter.cgi action=set permissionType= enabled= allow.enabled1= allow.startIP1= allow.endIP1= allow.enabled2= allow.startIP2= allow.endIP2= ……. deny.enabled1= deny.startIP1= deny.endIP1= deny.enabled2= deny.startIP2= deny.endIP2= Response Comment Method POST... -
Page 106: Getipfilter
4.12 getIPFilter ActionEvent: getIPFilter Request http://<IP>/cgi-bin/ IPFilter.cgi? action=get Response enabled= permissionType= allow.size= allow.enabled1= allow.startIP1= allow.endIP1= allow.enabled2= allow.startIP2= allow.endIP2= ……. deny.size= deny.enabled1= deny.startIP1= deny.endIP1= deny.enabled2= deny.startIP2= deny.endIP2= Comment Method... -
Page 107: Storage Api (Tbd)
Storage API (TBD) Storage API allows applications to configure the storage devices reachable by the IPCAM unit. Data structures Data Structure Description ActionEvents ActionEvent Description ActionEvent: Request http://<IP>/cgi-bin/stream. l?action= Response Comment Method... -
Page 108: System Api
System API System API allows applications to configure miscellaneous system settings not covered by any other category. These settings include Time, Syslog, and etc. // NOTE: In the future, we may switch to rsyslog instead of syslogd. Data structures Data Structure Description SDeviceInfo IP Camera device info... - Page 109 TIME_ZONE_SAO_PAULO, TIME_ZONE_NORONHA_ISLAND, TIME_ZONE_PRAIA, TIME_ZONE_LONDON, TIME_ZONE_PARIS, TIME_ZONE_CAIRO, TIME_ZONE_MOSCOW, TIME_ZONE_DUBAI, TIME_ZONE_KARACHI, TIME_ZONE_DHAKA, TIME_ZONE_JAKARTA, TIME_ZONE_HONG_KONG, TIME_ZONE_TOKYO, TIME_ZONE_SYDNEY, TIME_ZONE_NOUMEA, TIME_ZONE_NewZealand, TIME_ZONE_MAX // Reserved for internal use... typedef struct _TimeZone { int id; // Time zone id. Char TZSyntax[128]; } STimeZone; typedef struct _TimeZoneList { int size;...
- Page 110 SManualTimeSetting manual; SNTPTimeSetting ntp; } STimeSetting; /* SSyslogSetting */ // Note, these values are taken from manpage for syslog (3). enum LogPriority { SLOG_EMERG=0, // system is unusable SLOG_ALERT, // action must be taken immediately SLOG_CRIT, // critical conditions SLOG_ERR, // error conditions SLOG_WARNING, // warning conditions...
-
Page 111: Getdeviceinfo
ActionEvents ActionEvent Description getDeviceInfo Get device info setTimeSetting Set time setting getTimeSetting Get time setting setSyslogSetting Set syslog setting getSyslogSetting Get syslog setting getSyslogFile Get syslog file. SyslogClear Clear syslog. getSystemStatus Get system status 5.1 getDeviceInfo ActionEvent: getDeviceInfo Request http://<IP>/cgi-bin/system.cgi?action=get Response chipVersion= sensorID=... -
Page 112: Gettimesetting
Response Comment Method POST 5.3 getTimeSetting ActionEvent: getTimeSetting Request http://<IP>/cgi-bin/time.cgi?action=get Response type= enableDST= timezoneID= manual.year= manual.month= manual.day= manual.hour= manual.minute= manual.second= enableDST= timezoneID= ntp.ntpServerLoc1= ntp.ntpServerLoc2= Comment Method 5.4 setSyslogSetting ActionEvent: setSyslogSetting Request http://<IP>/cgi-bin/syslog.cgi action=set localLogLevel= useRemoteLog= addressingFormatType= remoteServerAddress= remoteServerPort= Response Comment Method POST 5.5 getSyslogSetting... -
Page 113: Syslogclear
5.7 syslogClear ActionEvent: syslogClear Request http://<IP>/cgi-bin/syslog.cgi?action=clear Response Comment Clear syslog. Method ActionEvent: getSystemStatus Request http://<IP>/cgi-bin/systemStatus.cgi?action=get Response Comment Method... -
Page 114: Admin Api
Admin API Admin API enables applications to perform administrative tasks on the IPCAM unit. The tasks include add/delete users, upgrade firmware, etc. Data structures Data Structure Description SUserSetting Setting for a user account SUserSetSetting All user accounts SHTTPSetting HTTP setting SHTTPSSetting HTTPS setting ActionEvents... - Page 115 enum UserPrivilegeType { USER_PRIVILEGE_VIEW=0, USER_PRIVILEGE_ADMIN, USER_PRIVILEGE_REMOTE_VIEW, /* SUserSetting */ typedef struct _userSetting { int index; char username[30]; // Unique key. char password[30]; int privilege; // Administration, Viewer } SUserSetting; /* SUserSetSetting */ typedef struct _userSetList { int size; SUserSetting users[10]; } SUserSetList;...
-
Page 116: Adduser
char filename[64]; } SConfigFile; /* SComplexityPWDSetting */ typedef struct _SSComplexityPWDSetting { int pwdRule1Enabled; int pwdRule2Enabled; int pwdRule3Enabled; }SComplexityPWDSetting; 6.1 addUser ActionEvent: addUser Request http://<IP>/cgi-bin/users.cgi action=add index= username=<username> password=<password> privilege=<privilege> Response Comment Method POST 6.2 deleteUser ActionEvent: deleteUser Request http://<IP>/cgi-bin/users.cgi action=delete username=<username>... -
Page 117: Updateuser
6.4 updateUser ActionEvent: updateUser Request http://<IP>/cgi-bin/users.cgi action= update index= username=<xxxx> password= privilege= Response Comment Method POST 6.5 setHTTP ActionEvent: setHTTP Request http://<IP>/cgi-bin/http.cgi action= set enabled= port= Response Comment Method POST 6.6 setHTTP/HTTPS ActionEvent: setHTTP/HTTPS Request http://<IP>/cgi-bin/http.cgi action= setAll enabled= port= httpsEnabled= httpsPort= Response... -
Page 118: Sethttps
6.8 setHTTPS ActionEvent: setHTTPS Request http://<IP>/cgi-bin/https.cgi action= set enabled= port= Response Comment Method POST 6.9 getHTTPS ActionEvent: getHTTPS Request http://<IP>/cgi-bin/https.cgi?action= get Response enabled= port= Comment Method 6.10 resetToDefault ActionEvent: resetToDefault Request http://<IP>/cgi-bin/reset.cgi?action= reset Response Comment Reset all settings to factory default Method 6.11 upgradeFirmware ActionEvent: upgradeFirmware... -
Page 119: Importconfigfile
6.13 importConfigFile ActionEvent: importConfigFile Request http://<IP>/cgi-bin/ConfigFile.cgi action= set filename = Response Comment Method POST 6.14 exportConfigFile ActionEvent: exportConfigFile Request http://<IP>/cgi-bin/ConfigFile.cgi?action= get Response Comment Method 6.15 setPWDComplexity ActionEvent: setPWDComplexity Request http://<IP>/cgi-bin/complexity.cgi action= set pwdRule1Enabled = pwdRule2Enabled = pwdRule3Enabled = Response Comment Method POST 6.16 getPWDComplexity... -
Page 120: Capability Api (Tbd)
Capability API (TBD) ActionEvents ActionEvent Description getCapability Get camera Capability. 7.1 getCapability ActionEvent: getCapability Request http://<IP>/cgi-bin/Capability.cgi?action= get Response Streaming.VideoCodec.size=2 Streaming.VideoCodec1=h264 Streaming.VideoCodec2=mjpeg Streaming.name1=h264 Streaming.name1.resolution.size=3 Streaming.name1. resolutionWidth1=320 Streaming.name1. resolutionHeight1=192 Streaming.name1. resolutionWidth2=640 Streaming.name1. resolutionHeight2=400 Streaming.name1. resolutionWidth3=1280 Streaming.name1. resolutionHeight3=800 Streaming.name2=mjpeg Streaming.name2.resolution.size=3 Streaming.name2. resolutionWidth1=320 Streaming.name2. resolutionHeight1=192 Streaming.name2. -
Page 121: Motion Detection Api
Motion detection API Motion detection API allows applications to 1) set/get the motion detection setting Data structures Data Structure Description SMotionDetectionSetti Basic motion detection setting. SMDList List of detection channels. SChannelMotionDetec Keep the information of detection channels. tion SMDRegionList List of detection regions. SMDRegion Keep the information of detection regions. -
Page 122: Setmotiondetection
typedef struct _MotionDetectionSetting { SMDList MDList; }SMotionDetectionSetting; ActionEvents ActionEvent Description setMotionDetection Set motion detection setting getMotionDetection Get motion detection setting getMotionDetections Get all motion detections setting 8.1 setMotionDetection ActionEvent: setMotionDetection Request http://<IP>/cgi-bin/motiondetection.cgi action=set enabled=1 channelIndex detectionInterval= region1.enabled= region1.sensitivity= region1.threshold= region1.x= region1.y= region1.x1= region1.y1=... -
Page 123: Getmotiondetection
8.2 getMotionDetection ActionEvent: getMotionDetection Request http://<IP>/cgi-bin/ motiondetection.cgi?action=getMD&index=<index> Response enabled=1 detectionInterval= region.size region1.enabled= region1.sensitivity= region1.threshold= region1.x= region1.y= region1.x1= region1.y1= region2.enabled= region2.sensitivity= region2.threshold= region2.x= region2.y= region2.x1= region2.y1= region3.enabled= region3.sensitivity= region3.threshold= …… Comment Method... -
Page 124: Getmotiondetections
8.3 getMotionDetections ActionEvent: getMotionDetections Request http://<IP>/cgi-bin/ motiondetection.cgi?action=get Response size= MD1.enabled=1 MD1.channelIndex MD1.detectionInterval= MD1.region.size MD1.region1.enabled= MD1.region1.sensitivity= MD1.region1.threshold= MD1.region1.x= MD1.region1.y= MD1.region1.x1= MD1.region1.y1= MD1.region2.enabled= MD1.region2.sensitivity= MD1.region2.threshold= MD1.region2.x= MD1.region2.y= MD1.region2.x1= MD1.region2.y1= MD1.region3.enabled= MD1.region3.sensitivity= MD1.region3.threshold= MD1.region3.x= MD1.region3.y= MD1.region3.x1= MD1.region3.y1= …………. Comment Method... -
Page 125: Event Api
Event API Event API allows applications to 1) set/get the event setting 2) set/get the notification setting Data structures Data Structure Description SEventPolicySetting General setting for events. SEventRuleSettingList List of event rules. SEventRuleSetting Details the setting of each event. SEventScheduleSettin Set up the schedule for triggering events SEmailSetting Details the setting of email. - Page 126 /* SEmailSetting */ typedef struct _emailSetting { unsigned char senderAddress[64]; //=> XXX@gmail.com unsigned char receiverAddress1[64]; //=> XXX@brickcom.com.tw // if NULL, disable unsigned char receiverAddress2[64]; //=> YYY@brickcom.com.tw // if NULL, disable unsigned char senderName[64]; //=> IPCAM unsigned char subject[64]; //=> "IPCAM Alert"...
- Page 127 unsigned char accountName[64]; unsigned char password[64]; unsigned int passiveModeEnabled; } SFTPServer; /* SFTPSetting */ typedef struct _ftpSetting { unsigned int uploadSnapShotEnabled; unsigned int uploadVideoClipEnabled; SFTPServer primary; SFTPServer secondary; } SFTPSetting; /* SAlarmMediaInfo */ typedef struct _mediaInfo { unsigned int snapShotEnabled; unsigned int videoClipEnabled;...
- Page 128 unsigned char workGroup[32]; unsigned char shareDIR[32]; } SambaServer; ////////////////////// // Event notification ////////////////////// /* Event subscription */ enum _eventTransportMode { EVENT_TRANSPORT_MODE_PUSH=0, EVENT_TRANSPORT_MODE_PULL=1, /* Event transport type */ enum _eventTransportProtocol { EVENT_TRANSPORT_PROTOCOL_RESERVED=0, EVENT_TRANSPORT_PROTOCOL_UDP=1, EVENT_TRANSPORT_PROTOCOL_TCP=2, EVENT_TRANSPORT_PROTOCOL_HTTP=3, enum _eventTransportDataFormat { EVENT_TRANSPORT_DATA_FORMAT_BINARY=0, EVENT_TRANSPORT_DATA_FORMAT_TEXT=1, EVENT_TRANSPORT_DATA_FORMAT_XML=2, typedef struct _eventTransportSetting { int mode;...
-
Page 129: Seteventsetting
ActionEvent Description setEventSetting Set event setting getEventPolicy Get event policy getEventRule Get event rule addEventSetting Add event setting updateEventSetting Update event setting removeEventSetting Remove event setting setEmailSetting Set Email setting getEmailSetting Get Email setting setFTPSetting Set FTP setting getFTPSetting Get FTP setting setAlarmMediaInfo Set alarm media info getAlarmMediaInfo... -
Page 130: Updateeventsetting
9.3 updateEventSetting ActionEvent: updateEventSetting Request http://<IP>/cgi-bin/event.cgi action= updateEventSetting index= enabled= name= eventID= sched.type= sched.time= actions= Response Comment Method POST 9.4 removeEventSetting ActionEvent: removeEventSetting Request http://<IP>/cgi-bin/event.cgi action= removeEventSetting index= Response Comment Method POST 9.5 getEventPolicy ActionEvent: getEventPolicy Request http://<IP>/cgi-bin/event.cgi?action=getEventPolicy Response size= R1index= R1enabled= R1name=... -
Page 131: Geteventrule
9.6 getEventRule ActionEvent: getEventRule Request http://<IP>/cgi-bin/event.cgi?action=getEventRule Response index=0 enabled=0 name= eventID=0 sched.type=0 sched.time= actions= Comment Method 9.7 setEmailSetting ActionEvent: setEmailSetting Request http://<IP>/cgi-bin/event.cgi action=setEmailSetting senderAddress= receiverAddress1= receiverAddress2= senderName= subject= attachedVideoURLEnabled= attachedSnapShotEnabled= attachedVideoClipEnabled= authenticationMode1= port1= smtpServerHostName1 accountName1= password1= authenticationMode2= port2= smtpServerHostName2= accountName2= password2= Response Comment... -
Page 132: Getemailsetting
9.8 getEmailSetting ActionEvent: getEmailSetting Request http://<IP>/cgi-bin/event.cgi?action=getEmailSetting Response senderAddress= receiverAddress1= receiverAddress2= senderName= subject= attachedVideoURLEnabled= attachedSnapShotEnabled= attachedVideoClipEnabled= authenticationMode1= port1= smtpServerHostName1 accountName1= password1= authenticationMode2= port2= smtpServerHostName2= accountName2= password2= Comment Method... -
Page 133: Setftpsetting
9.9 setFTPSetting ActionEvent: setFTPSetting Request http://<IP>/cgi-bin/event.cgi action= setFTPSetting uploadSnapShotEnabled= uploadVideoClipEnabled= addressType1= hostName1= ipAddress1= ipv6Address1= port1= accountName1= password1= passiveMode1= addressType2= hostName2= ipAddress2= ipv6Address2= port2= accountName2= password2= passiveMode2= Response Comment Method POST 9.10 getFTPSetting ActionEvent: getFTPSetting Request http://<IP>/cgi-bin/event.cgi?action= getFTPSetting Response uploadSnapShotEnabled= uploadVideoClipEnabled= addressType1= hostName1= ipAddress1=... -
Page 134: Setalarmmediainfo
9.11 setAlarmMediaInfo ActionEvent: setAlarmMediaInfo Request http://<IP>/cgi-bin/event.cgi action= setAlarmMediaInfo snapShotEnabled = videoClipEnabled = timeBeforeEvent= timeAfterEvent= Response Comment Method POST 9.12 getAlarmMediaInfo ActionEvent: getAlarmMediaInfo Request http://<IP>/cgi-bin/event.cgi?action= getAlarmMediaInfo Response snapShotEnabled = videoClipEnabled = timeBeforeEvent= timeAfterEvent= Comment Method 9.13 setSamba ActionEvent: setSamba Request http://<IP>/cgi-bin/event.cgi action= setSamba hostDns= IpAddress=... -
Page 135: Getsamba
9.14 getSamba ActionEvent: getSamba Request http://<IP>/cgi-bin/event.cgi?action= getSamba Response addressType= hostDns= ipAddress= ipv6Address= userName= password= preserve= shareDIR= workGroup= Comment Method I/O Control API I/O Control API allows applications to set/get the GPIO setting Data structures Data Structure Description SGPIO General I/O setting. /*GOPI */ enum{ GPIO_DIR_IN,... - Page 136 10.2 getGPIOSetting ActionEvent: getGPIOSetting Request http://<IP>/cgi-bin/event.cgi?action= get Response Comment Method 10.3 getGPIOStatus ActionEvent: getGPIOStatus Request http://<IP>/cgi-bin/event.cgi?action= getStatus Response Comment Method...
-
Page 137: Msn Api
MSN API MSN API allows applications to 1) set/get the IP Camera MSNBot setting Data structures Data Structure Description SMsnbot Details the setting of MSNBot. SMsnBuddyList List of msn buddy. MsnBuddy Details the buddy information. /*MSNbot */ typedef struct _MsnBuddy{ int enabled;... -
Page 138: Setmsnbot
11.1 setMSNBot ActionEvent: setMSNBot Request http://<IP>/cgi-bin/msn.cgi action=set account= passwd= msnOpPasswd= friendlyName= buddy0.enabled= buddy0.account= buddy0.isNotifiedAcnt= buddy1.enabled= buddy1.account= buddy1.isNotifiedAcnt= buddy2.enabled= buddy2.account= buddy2.isNotifiedAcnt= buddy3.enabled= buddy3.account= buddy3.isNotifiedAcnt= buddy4.enabled= buddy4.account= buddy4.isNotifiedAcnt= webcamEnabled= alarmNotifyEnabled= Response Comment Method POST... -
Page 139: Getmsnbot
11.2 getMSNBot ActionEvent: getMSNBot Request http://<IP>/cgi-bin/msn.cgi?action= get Response account= passwd= msnOpPasswd= friendlyName= buddy0.enabled= buddy0.account= buddy0.isNotifiedAcnt= buddy1.enabled= buddy1.account= buddy1.isNotifiedAcnt= buddy2.enabled= buddy2.account= buddy2.isNotifiedAcnt= buddy3.enabled= buddy3.account= buddy3.isNotifiedAcnt= buddy4.enabled= buddy4.account= buddy4.isNotifiedAcnt= webcamEnabled= alarmNotifyEnabled= Comment Method...