Brickcom FD-100A Series User Manual
  1. Manuals
  2. Brands
  3. Brickcom Manuals
  4. Security Camera
  5. FD-100A Series
  6. User manual

Brickcom FD-100A Series User Manual

Megapixel day & night fixed dome network camera
Hide thumbs Also See for FD-100A Series:
Table of Contents

Advertisement

Quick Links

Download this manual
Megapixel Day & Night
Fixed Dome Network Camera
FD-100A Series
User's Manual
Quality Service Group

Advertisement

Table of Contents
loading

Related Manuals for Brickcom FD-100A Series

Summary of Contents for Brickcom FD-100A Series

  • Page 1 Megapixel Day & Night Fixed Dome Network Camera FD-100A Series User’s Manual Quality Service Group...
  • Page 2 Product name: Network Camera (FD-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

    Device Information................. 44 Maintenance....................45 User Management ................. 45 IP Filter ....................46 Firmware Upgrade ................. 46 Configuration ..................47 Reset to default ..................47 Reboot ....................47 BRICKCOM IPCAM HTTP API ................48 Preface ......................48 Overview ....................... 48...
  • Page 4 HTTP API Transaction..................49 Streaming API ....................52 getChannels................... 56 getChannel ..................57 addChannel ................... 58 updateChannel................59 updateChannels ................60 getStream..................61 Camera API ....................62 setWhiteBalance................66 getWhiteBalance ................67 setBrightness.................. 67 getBrightness ................. 67 setColorSaturation ................67 getColorSaturation ................
  • Page 5 getEthernet ..................85 setWIFI ..................85 getWIFI..................86 4.10 4.11 setIPFilter ..................87 getIPFilter..................87 4.12 Storage API (TBD) .................... 88 System API..................... 89 getDeviceInfo ................. 92 setTimeSetting ................93 getTimeSetting ................93 setSyslogSetting................94 getSyslogSetting................94 getSyslogFile.................. 94 syslogClear ..................95 Admin API ......................
  • Page 6 I/O Control API....................120 setGPIOSetting ................120 10.1 getGPIOSetting ................120 10.2 10.3 getGPIOStatus ................121 MSN API ...................... 121 setMSNBot .................. 122 11.1 getMSNBot .................. 123 11.2 Technical specifications ..................124...

  • 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. FD-100A b. Power Adapter   c. Product CD d. Location Sticker  e. Warranty Card f. Screws bag  g. Quick Guide ...

  • Page 9: Fixed Dome Network Camera Overview

    FD-100A also provides many advanced features, including MPEG-4 / MJPEG / H.264 Codec Compression and 802.3af compliant PoE. In addition, the Brickcom IP camera can transmit the video to portable devices via other technology, for instance, WiMax, NAS, Digital Frame and power line. Additionally, with the 3-axis mechanical design and “Easy Installation Wizard”, it offers the end user a very...

  • Page 11: Device Appearance Description

    Device Appearance Description...

  • Page 12: Led Behavior

    LED Behavior Function LED Behavior Description Power LED Steady On Power on Power LED Unlighted Power off Link LED Steady On (Orange) Link Link LED Blinking (Orange) Trafficking Extension I/O Terminal Block The Network Camera provides an extension I/O terminal block which is used to connect external input/output devices.
  • Page 13 DI/DO Diagram Hardware Reset Reset Button...
  • Page 14 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. Reset: Please press and release the indented reset button within 1 second with paper clip or thin object.

  • Page 15: Installation

    Installation Hardware installation First, please check your product package contains all the accessories listed in the foregoing Package Contents. Depending on the user’s application and need, the Ethernet cable should meet the specs of UTP Category 5 and not exceed 100 meters in length.
  • Page 16 The users can use the screwdriver and two screws to mount the camera on the desired location through the two holes on each side of the device. Attach the location sticker onto it if the location is on the wall. 3.1 Through the two circles on the location sticker, and drill two holes into the wall.
  • Page 17 3.2 Hammer two plastic anchors into the holes. 3.3 Adjust two holes on each side of the device with the two plastic anchors, insert the screws into holes, and make sure to secure them.

  • Page 18: 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 19: Camera Connection

    Camera Connection Basic Connection (Without PoE) Connect the power adaptor to camera device. Connect the camera to the Ethernet hub via RJ45 Ethernet cable. Power over Ethernet (PoE) Connection Connect the camera to a PoE-enabled hub via single Ethernet cable. Connect the camera to a non-PoE hub via PoE Injector.
  • Page 20 Run the CD-ROM to install the Installation Wizard. For more information, please refer to “Software installation” for details. Access to the Network Camera from the Internet. For more information, please refer to “Access to the Network Camera” for details.

  • Page 21: Adjust The Lens Focus Range And Zoom Viewing

    Adjust the Lens focus range and zoom viewing Release the pan screw and then rotate the lens to left or right. After completion, tighten the pan screw. Release the tilt screw on both side of the device and then rotate the lens to up or down.

  • Page 22: How To Adjust The View Angle And Focus Range

    How to adjust the view angle and focus range Release the view angle controller and then moving the controller bar left or right to adjust the view angle. After completion, tighten the view angle controller. Release the focus controller and then moving the controller bar left or right to adjust the focus range.

  • Page 23: 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 24 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 26 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 27 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 29 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 30: Access To The Network Camera

    Access to the Network Camera 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: Configuration

    Configuration 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.
  • Page 35 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. IR LED: The user can select this option to turn on/off the IR. Auto: The Network Camera automatically removes the filter by judging the level of ambient light.

  • Page 36: 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 37 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 38 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 39: 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 40: Multicast

    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.

  • Page 41: 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 42: 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 43: Http/Https

    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.

  • Page 44: 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 45: Notification Setting

    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.
  • Page 46 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.
  • Page 47 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 48: 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 49: 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 50: 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 51: Device Information

    Device Information Video/Audio Setting - To view all the video/audio setting information about the network camera. Network Setting - To view all the network setting information about the network camera. System Information: To view all the system information about the network camera.

  • Page 52: 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 53: 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 54: 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 55: 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 56: 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 57 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.
  • Page 58 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 59: Streaming Api

    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.
  • Page 60 /* 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;...
  • Page 61 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; int index; // (Unique) 0: reserved. 1+: valid index char name[16];...
  • Page 62 /* SChannelSetSetting */ typedef struct _channelSetSetting { SChannelSetList channelList; } SChannelSetSetting;...

  • Page 63: 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 64: 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 65: 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 66: 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 67: 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 68: Getstream

    1.6 getStream ActionEvent: getStream Request rtsp://<IP>/channel<index> Response Comment <Index> is the index number of the SChannelSetting. Method...

  • Page 69: Camera Api

    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 Color Saturation setting of the Camera SMirrorFlipSetting MirrorFlip setting of the Camera SSharpnessSetting Sharpness setting of the Camera SContrastSetting...
  • Page 70 /* 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;...
  • Page 71 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, typedef struct _IRCutFilterSetting { int mode; // enum IRCutMode int thresholdLevel; // (reserved) 0-100 } SIRCutFilterSetting;...
  • Page 72 /* SVideoOverlaySetting */ enum TimeStampMOde{ TimeStamp_off=0, TimeStamp_on, enum UseImage{ NO_IMAGE = 0, 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;...

  • Page 73: Setwhitebalance

    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 setMirrorFlip Set MirrorFlip getMirrorFlip Get MirrorFlipof setSharpness Set Sharpness getSharpness Get Sharpness setContrast Set Contrast getContrast Get Contrast setFrequency...

  • Page 74: Getwhitebalance

    2.2 getWhiteBalance ActionEvent: getWhiteBalance Request http://<IP>/cgi-bin/camera.cgi?action=getWhiteBalance Response mode= level= Comment Method 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...

  • Page 75: Setmirrorflip

    2.7 setMirrorFlip ActionEvent: setMirrorFlip Request http://<IP>/cgi-bin/camera.cgi action= setMirrorFlip mirrorEnabled = flipEnabled= Response Comment Method POST 2.8 getMirrorFlip ActionEvent: getMirrorFlip Request http://<IP>/cgi-bin/camera.cgi?action= getMirrorFlip Response flipEnabled= mirrorEnabled = Comment Method 2.9 setSharpness ActionEvent: setSharpness Request http://<IP>/cgi-bin/camera.cgi action= setSharpness level= Response Comment Method POST 2.10 getSharpness ActionEvent: getSharpness...

  • Page 76: 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 77: Geteffect

    2.16 getEffect ActionEvent: getEffect Request http://<IP>/cgi-bin/camera.cgi?action=getEffect Response effectMode= Comment Method 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...

  • Page 78: Setirled

    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= displayString= useImage= useText= osdPalette1.y= osdPalette1.Cb= osdPalette1.Cr= osdPalette2.y= osdPalette2.Cb= osdPalette2.Cr= osdWindow1.x= osdWindow1.y=...

  • Page 79: 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 80: 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 81: 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 82: 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 83: Getaudiodevice

    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 POST 3.4 getAudioMuteState ActionEvent: getAudioMuteState Request http://<IP>/cgi-bin/audio.cgi?action=getAudioMuteState Response muted= Comment Method 3.5 setAudioVolume ActionEvent: setAudioVolume Request http://<IP>/cgi-bin/audio.cgi...

  • Page 84: 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 85 // 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;...
  • Page 86 /* SWIFISetting */ enum WIFIWPA_algorithmType { WL_TKIP=0, WL_AES, WL_TKIP_AES, enum WIFIWEP__authenticationType { WL_OPEN=0, WL_SHARED, 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 {...
  • Page 87 enum WIFIWPSMode { NONE=0, PIN, PBC, 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;...
  • Page 88 //authenticationMethod enum IEEE_802_1x_authenticationMethod { WL_MSCHAP=0, WL_MSCHAPV2, WL_PAP, WL_EAP_MD5, //innerEAPProtocolType enum IEEE_802_1x_innerEAPProtocolType { WL_INNER_EAP_TLS=0, WL_EAP_OTP, 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;...
  • Page 89 typedef struct _SSFilterAddressEntry { int enabled; char startIP[16]; char endIP[16]; }SFilterAddressEntry; typedef struct _SSFilterAddressList { int size; SFilterAddressEntry filterEntry[16]; }SFilterAddressList; typedef struct _SSIPFilterSetting { 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...

  • Page 90: Setbasicnetwork

    4.1 setBasicNetwork ActionEvent: setBasicNetwork Request http://<IP>/cgi-bin/basicNetwork.cgi action= set //STATIC addressType=0 ipv4Address= subnetMask= gatewayAddress= dnsAddress1= dnsAddress2= // DHCP, addressType=1 // PPPOE addresssType=2 pppoe.username= pppoe.password= Response Comment Method POST 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=...

  • Page 91: Getupnp

    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 Method POST 4.6 getDDNS ActionEvent: getDDNS Request http://<IP>/cgi-bin/ddns.cgi? action=get Response dyndnsEnabled=0 dyndns.wildcardEnabled=...

  • Page 92: Setethernet

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

  • Page 93: Getwifi

    Response Comment Method POST 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.

  • Page 94: 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 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=...

  • Page 95: 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 96: 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 97 TIME_ZONE_HAWAII, TIME_ZONE_ALASKA, TIME_ZONE_LOS_ANGELES, TIME_ZONE_PHOENIX, TIME_ZONE_MEXICO_CITY, TIME_ZONE_NEW_YORK, TIME_ZONE_SANTIAGO, 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;...
  • Page 98 } SNTPTimeSetting; typedef struct _TimeSetting int type; // enum TimeConfigType int enableDST; // Daylight saving. (0: disabled, 1: enabled) int timezoneID; // enum TimeZoneID SManualTimeSetting manual; SNTPTimeSetting ntp; } STimeSetting; /* SSyslogSetting */ // Note, these values are taken from manpage for syslog (3). enum LogPriority { SLOG_EMERG=0, // system is unusable...

  • Page 99: 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 100: Settimesetting

    5.2 setTimeSetting ActionEvent: setTimeSetting Request http://<IP>/cgi-bin/time.cgi action=set type=0 ================================================= type=1 enableDST= timezoneID= manual.year= manual.month= manual.day= manual.hour= manual.minute= manual.second= ================================================= type=2 enableDST= timezoneID= ntp.ntpServerLoc1= ntp.ntpServerLoc2= 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=...

  • Page 101: Setsyslogsetting

    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 ActionEvent: getSyslogSetting Request http://<IP>/cgi-bin/syslog.cgi ?action=get Response localLogLevel= useRemoteLog= addressingFormatType= remoteServerAddress= remoteServerPort= Comment Method 5.6 getSyslogFile ActionEvent: getSyslogFile Request http://<IP>/syslog.dump Response Content of syslog. Comment Method...

  • Page 102: 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 103: 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 104 char username[30]; // Unique key. char password[30]; int privilege; // Administration, Viewer } SUserSetting; /* SUserSetSetting */ typedef struct _userSetList { int size; SUserSetting users[10]; } SUserSetList; typedef struct _userSetSetting { SUserSetList userList; }SUserSetSetting; enum ProtocolMode{ PROTOCOL_HTTP=0, PROTOCOL_HTTPS, PROTOCOL_HTTP_HTTPS /* SHTTPSetting */ typedef struct _HTTPSetting { int enabled;...

  • Page 105: Adduser

    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> Response Comment Method POST 6.3 getUsers ActionEvent: getUsers Request http://<IP>/cgi-bin/users.cgi?action=getUsers Response Size= User1.index= User1.username= User1.password= User1.privilege= … User2.username= User2.password= User2.privilege=...

  • Page 106: 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 107: Gethttp

    6.7 getHTTP ActionEvent: getHTTP Request http://<IP>/cgi-bin/http.cgi?action= get Response enabled= port= Comment Method 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...

  • Page 108: Upgradefirmware

    6.11 upgradeFirmware ActionEvent: upgradeFirmware Request http://<IP>/cgi-bin/upgradeFirmware.cgi action= upgrade Followed by the IPCam firmware Response Comment Upgrade the system firmware upon this request Method POST 6.12 reboot ActionEvent: reboot Request http://<IP>/cgi-bin/reboot.cgi?action= reboot Response Comment Reboot the system Method GET/POST 6.13 importConfigFile ActionEvent: importConfigFile Request http://<IP>/cgi-bin/ConfigFile.cgi...

  • Page 109: Setpwdcomplexity

    6.15 setPWDComplexity ActionEvent: setPWDComplexity Request http://<IP>/cgi-bin/complexity.cgi action= set pwdRule1Enabled = pwdRule2Enabled = pwdRule3Enabled = Response Comment Method POST 6.16 getPWDComplexity ActionEvent: getPWDComplexity Request http://<IP>/cgi-bin/complexity.cgi?action= get Response pwdRule1Enabled = pwdRule2Enabled = pwdRule3Enabled = Comment Method Capability API (TBD) ActionEvents ActionEvent Description getCapability Get camera Capability.

  • Page 110: Getcapability

    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. resolutionWidth2=640 Streaming.name2. resolutionHeight2=400 Streaming.name2. resolutionWidth3=1280 Streaming.name2. resolutionHeight3=800 Audio.codec.size=3 Audio.codec1=PCMA Audio.codec2=PCMU Audio.codec3=G.726...

  • Page 111: 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 112: Setmotiondetection

    typedef struct _MDList { int size; SMDEntry MDEntry[5];//match stream }SMDList; 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...

  • Page 113: 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 114: 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 115: 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 116 /* 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 117 unsigned int addressType; unsigned char hostname[64]; unsigned char ipAddress[32]; unsigned char ipv6Address[48]; unsigned int portNo; 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;...
  • Page 118 unsigned char IpAddress[32]; unsigned char Ipv6Address[48]; unsigned char UserName[16]; unsigned char Password[16]; unsigned int AddressType; unsigned char Preserve[12]; 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,...

  • Page 119: Seteventsetting

    int size; SEventSubscriptionSetting subscription[10]; } SEventSubscriptionSettingList; ActionEvents 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...

  • Page 120: Addeventsetting

    9.2 addEventSetting ActionEvent: addEventSetting Request http://<IP>/cgi-bin/event.cgi action= addEventSetting index= enabled= name= eventID= sched.type= sched.time= actions= Response Comment Method POST 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...

  • Page 121: Geteventpolicy

    9.5 getEventPolicy ActionEvent: getEventPolicy Request http://<IP>/cgi-bin/event.cgi?action=getEventPolicy Response size= R1index= R1enabled= R1name= R1eventID= R1sched.type= R1sched.time= R1actions= R2index=… Comment Method 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...

  • Page 122: Setemailsetting

    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 Method POST...

  • Page 123: 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 124: 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 125: Setalarmmediainfo

    password2= passiveMode2= Comment Method 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...

  • Page 126: 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...

  • Page 127: I/O Control Api

    I/O Control API I/O Control API allows applications to 1) set/get the GPIO setting Data structures Data Structure Description SGPIO General I/O setting. /*GOPI */ enum{ GPIO_DIR_IN, GPIO_DIR_OUT, enum{ GPIO_STATUS_LOW, GPIO_STATUS_HIGH, ActionEvents ActionEvent Description setGPIOSetting Set GPIO setting getGPIOSetting Get GPIO setting getGPIOStatus Get GPIO status 10.1 setGPIOSetting...

  • Page 128: Getgpiostatus

    10.3 getGPIOStatus ActionEvent: getGPIOStatus Request http://<IP>/cgi-bin/event.cgi?action= getStatus Response Comment Method 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.

  • Page 129: Setmsnbot

    }SMsnbot; ActionEvents ActionEvent Description setMSNBot Set MSNBot setting getMSNBot Get MSNBot setting 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...

  • Page 130: 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...

  • Page 131: Technical Specifications

    Technical specifications General Specification Product Name Megapixel Day & Night Fixed Dome Network Camera Model Number FD-100A Hardware System CPU: 500 MHz Flash: 16M RAM: 64M DDR Image Sensor Sensor Type : 1/4” Mega-Pixel CMOS Sensor Sensor Resolution : 1280 x 800 pixel Minimum Illumination : 1 Lux (without IR LEDs) 0 Lux (IR LEDs ON)
  • Page 132 Reset Button LEDs Power/ Ethernet states Power DC 12V / 1A (Power Supply) PoE: 802.3af compliant Power consumption Max Power Consumption : 6 watts Environment Operating Temperature : 0° C ~ 50° C (32° F ~ 122° F) Operating Humidity : 10% ~ 80% Dimension 156(D) X 117 (H) mm Certification...

Table of Contents