Vivotek VS8102 User Manual

Vivotek VS8102 User Manual

H.264; poe; sd/sdhc card
Hide thumbs Also See for VS8102:
Table of Contents

Advertisement

Rev.: 1.3

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the VS8102 and is the answer not in the manual?

Questions and answers

Summary of Contents for Vivotek VS8102

  • Page 1 Rev.: 1.3...
  • Page 2: Table Of Contents

    Ready to Use ............................11 Accessing the Video Server 12 Using Web Browsers ..........................12 Using RTSP Players ..........................14 Using 3GPP-compatible Mobile Devices ....................15 Using VIVOTEK Recording Software ....................16 Main Page 17 Client Settings 21 Configuration 23 System ..............................24 Security ..............................26 HTTPS ..............................27...
  • Page 3: Overview3

    The VS8102 comes with VIVOTEK’s ST7501 32-CH central management software for high scalability and easy-to-use operation. With the VS8102, you can upgrade to a full-featured, high-end IP surveillance solution using existing infrastructure.
  • Page 4: Physical Description

    VIVOTEK Physical Description Front Panel SD/SDHC Card Slot BNC Video Input SD Card 3.5mm phonejack Audio Input Audio Audio Reset Video 3.5mm phonejack Audio Output Recessed Reset Button Back Panel Ethernet 1 2 3 4 5 6 7 8 Ethernet 10/100...
  • Page 5: Status Led

    VIVOTEK DI/DO Diagram Please refer to the following illustration for the connection method. PIN 1 Power+12V PIN 2 Digital output +12V PIN 3 Digital input PIN 4 Ground Status LED The LED indicates the status of the video server. Item...
  • Page 6 VIVOTEK Hardware Reset SD Card Audio Audio Reset Video Recessed Reset Button The reset button is used to reset the system or restore the factory default settings. Sometimes resetting the system can return the video server to normal operation. If the system problems remain after reset, restore the factory settings and install again.
  • Page 7: Network Deployment

    VIVOTEK Network Deployment Setting up the Video Server over the Internet This section explains how to configure the video server to an Internet connection. 1. Make video connection from the camera to the BNC video input. 2. Make audio connection from the Line-Out audio source to the 3.5mm phonejack audio input.
  • Page 8 VIVOTEK Internet connection via a router Before setting up the video server over the Internet, make sure you have a router and follow the steps below. 1. Connect your video server behind a router, the Internet environment is illustrated below.
  • Page 9 VIVOTEK Set up the Video Server through Power over Ethernet (PoE) When using a PoE-enabled switch The video server is PoE-compliant, allowing transmission of power and data via a single Ethernet cable. Follow the below illustration to connect the video server to a PoE-enabled switch via Ethernet cable.
  • Page 10: Software Installation

    After your network environment is analyzed, please click Next to continue the program. 3. The program will search for all VIVOTEK network devices on the same LAN. 4. After searching, the main installer window will pop up. Click on the MAC and model name which matches the product label on your device to connect to the video server via Internet Explorer.
  • Page 11: Ready To Use

    VIVOTEK Ready to Use 1. Access the video server on the LAN. 2. Retrieve live video through a web browser or recording software. User's Manual - 11...
  • Page 12: Accessing The Video Server 12

    3. The live video will be displayed in your web browser. 4. If it is the first time installing the VIVOTEK video server, an information bar will pop up as shown below. Follow the instructions to install the required plug-in on your computer.
  • Page 13 VIVOTEK ► By default, the video server is not password-protected. To prevent unauthorized access, it is highly recommended to set a password for the video server. For more information about how to enable password protection, please refer to Security on page 26.
  • Page 14: Using Rtsp Players

    VIVOTEK Using RTSP Players To view the MPEG-4 streaming media using RTSP players, you can use one of the following players that support RTSP streaming. Quick Time Player Real Player VLC media player 1. Launch the RTSP player. mpegable Player 2.
  • Page 15: Using 3Gpp-Compatible Mobile Devices

    VIVOTEK Using 3GPP-compatible Mobile Devices To view the streaming media through 3GPP-compatible mobile devices, make sure the video server can be accessed over the Internet. For more information on how to set up the video server over the Internet, please refer to Setup the video server over the Internet on page 7.
  • Page 16: Using Vivotek Recording Software

    VIVOTEK Using VIVOTEK Recording Software The product software CD also contains recording software, allowing simultaneous monitoring and video recording for multiple video servers. Please install the recording software; then launch the program to add the video server to the Channel list. For detailed information about how to use the recording software, please refer to the user’s manual of the software or download it from...
  • Page 17: Main Page 17

    VIVOTEK Main Page This chapter explains the layout of the main page. It is composed of the following sections: VIVOTEK INC. Logo, Host Name, Camera Control Area, Configuration Area, Menu, and Live Video Window. VIVOTEK INC. Logo Host Name Camera Control Area...
  • Page 18 VIVOTEK Live Video Window ■ The following window is displayed when the video mode is set to MPEG-4: MPEG-4 Protocol and Media Options Video Title Time Title and Time Video 17:08:56 2008/06/25 Video and Audio Control Buttons Video Title: The video title can be configured. For more information, please refer to Video Settings on page 53.
  • Page 19 VIVOTEK Volume: When the Mute function is not activated, move the slider bar to adjust the volume on the local computer. Mute: Turn off the volume on the local computer. The button becomes the Audio On button after clicking the Mute button.
  • Page 20 VIVOTEK Full Screen: Click this button to switch to full screen mode. Press the “Esc” key to switch back to normal mode. 20 - User's Manual...
  • Page 21: Client Settings 21

    VIVOTEK Client Settings This chapter explains how to select the stream transmission mode and saving options on the local computer. When completed with the settings on this page, click Save on the page bottom to enable the settings. H.264 / MPEG-4 Media Options Select to stream video or audio data or both.
  • Page 22 VIVOTEK MP4 Saving Options Users can record live video as they are watching it by clicking Start MP4 Recording on the main page. Here, you can specify the storage destination and file name. Folder: Specify a storage destination for the recorded video files.
  • Page 23: Configuration 23

    Click Configuration on the main page to enter the camera setting pages. Note that only Administrators can access the configuration page. VIVOTEK offers an easy-to-use user interface that helps you set up your video server with minimal effort. To simplify the setting procedure, two types of user interfaces are available: Advanced Mode for professional users and Basic Mode for entry-level users.
  • Page 24: System

    VIVOTEK Advanced Mode Configuration List Click to switch to Basic Mode Firmware Version Each function on the configuration list will be explained in the following sections. Those functions that are displayed only in Advanced Mode are marked with Advanced Mode . If you want to set up advanced...
  • Page 25 VIVOTEK System Time Keep current date and time: Select this option to preserve the current date and time of the Video server. The video server’s internal real-time clock maintains the date and time even when the power of the system is turned off.
  • Page 26: Security

    VIVOTEK Security This section explains how to enable password protection and create multiple accounts. Root Password The administrator account name is “root”, which is permanent and can not be deleted. If you want to add more accounts in the Manage User column, please apply the password for the “root” account first.
  • Page 27: Https

    VIVOTEK HTTPS (Hypertext Transfer Protocol over SSL) Advanced Mode This section explains how to enable authentication and encrypted communication over SSL (Secure Socket Layer). It helps protect streaming data transmission over the Internet on higher security level. Enable HTTPS Check this item to enable HTTPS communication, then select a connection option: "HTTP & HTTPS"...
  • Page 28 VIVOTEK 4. The Certificate Information will automatically de displayed in the third column as shown below. You can click Property to view detailed information about the certificate. 5. Click Home to return to the main page. Change the address from “http://” to “https://“ in the address bar and press Enter on your keyboard.
  • Page 29 VIVOTEK Create self-signed certificate manually 1. Select this option. 2. Click Create to open the Create Certificate page, then click Save to generate the certificate. 3. The Certificate Information will automatically be displayed in the third column as shown below. You can click Property to see detailed information about the certificate.
  • Page 30 VIVOTEK 3. If you see the following Information bar, click OK and click on the Information bar at the top of the page to allow pop-ups. 4. The pop-up window shows an example of a certificate request. 30 - User's Manual...
  • Page 31 VIVOTEK 5. Look for a trusted certificate authority that issues digital certificates. Enroll the video server. Wait for the certificate authority to issue a SSL certificate; click Browse... to search for the issued certificate, then click Upload in the second column.
  • Page 32: Snmp

    VIVOTEK SNMP (Simple Network Management Protocol) Advanced Mode This section explains how to use the SNMP on the video server. The Simple Network Management Protocol is an application layer protocol that facilitates the exchange of management information between network devices. It helps network administrators to remotely manage network devices and find, solve network problems with ease.
  • Page 33: Network

    Use fixed IP address: Select this option to manually assign a static IP address to the video server. 1. You can make use of VIVOTEK Installation Wizard 2 on the software CD to easily set up the Network Camera on LAN. Please refer to Software Installation on page 10 for details.
  • Page 34 VIVOTEK Primary DNS: The primary domain name server that translates hostnames into IP addresses. Secondary DNS: Secondary domain name server that backups the Primary DNS. Primary WINS server: The primary WINS server that maintains the database of computer name and IP address.
  • Page 35 VIVOTEK NOTE ► If the default ports are already used by other devices connected to the same router, the video server will select other ports for the video server. ► If UPnP is not supported by your router, you will see the following message: Error: Router does not support UPnP port forwarding.
  • Page 36 VIVOTEK 4. In the Networking Services dialog box, select Universal Plug and Play and click OK. 5. Click Next in the following window. 6. Click Finish. UPnP is enabled. ► How does UPnP work? UPnP networking technology provides automatic IP configuration and dynamic discovery of devices added to a network.
  • Page 37 VIVOTEK Enable IPv6 Select this option and click Save to enable IPv6 settings. Please note that this only works if your network environment and hardware equipment support IPv6. The ® browser should be Microsoft Internet Explorer 6.5, Mozilla Firefox 3.0 or above.
  • Page 38 VIVOTEK Please follow the steps below to link to an IPv6 address: 1. Open your web browser. 2. Enter the link-global or link-local IPv6 address in the address bar of your web browser. 3. The format should be: http://[2001:0c08:2500:0002:0202:d1ff:fe04:65f4]/ IPv6 address 4.
  • Page 39 Authentication server (usually a RADIUS server): Checks the client certificate and decides whether to accept the end user’s access request. ■ VIVOTEK video servers support two types of EAP methods to perform authentication: EAP-PEAP and EAP-TLS. Please follow the steps below to enable 802.1x settings: 1.
  • Page 40 VIVOTEK 3. When all settings are complete, move the video server to the protected LAN by connecting it to an 802.1x enabled switch. The devices will then start the authentication automatically. NOTE ► The authentication process for 802.1x: 1. The Certificate Authority (CA) provides the required signed certificates to the video server (the supplicant) and the RADIUS Server (the authentication server).
  • Page 41 VIVOTEK QoS (Quality of Service) Advanced Mode Quality of Service refers to a resource reservation control mechanism, which guarantees a certain quality to different services on the network. Quality of service guarantees are important if the network capacity is insufficient, especially for real-time streaming multimedia applications. Quality can be defined as, for instance, a maintained level of bit rate, low latency, no packet dropping, etc.
  • Page 42 VIVOTEK QoS/DSCP (the DiffServ model) DSCP-ECN defines QoS at Layer 3 (Network Layer). The Differentiated Services (DiffServ) model is based on packet marking and router queuing disciplines. The marking is done by adding a field to the IP header, called the DSCP (Differentiated Services Codepoint). This is a 6-bit field that provides 64 different class IDs.
  • Page 43 VIVOTEK HTTP Advanced Mode To utilize HTTP authentication, make sure that your have set a password for the video server first; please refer to Security on page 26 for details. Authentication: Depending on your network security requirements, the video server provides two types of security settings for an HTTP transaction: basic and digest.
  • Page 44 VIVOTEK URL command -- http://<ip address>:<http port>/<access name for stream 1 ~ 4> For example, when the Access name for stream 2 is set to video2.mjpg: 1. Launch Mozilla Firefox or Netscape. 2. Type the above URL command in the address bar. Press Enter.
  • Page 45 To stop talking, click again. The FTP server allows the user to save recorded video clips. You can utilize VIVOTEK's Installation Wizard 2 to upgrade the firmware via FTP server. By default, the FTP port is set to 21. It also can be assigned to another port number between 1025 and 65535.
  • Page 46 VIVOTEK RTSP Streaming To utilize RTSP streaming authentication, make sure that you have set a password for the video server first; please refer to Security on page 26 for details. Authentication: Depending on your network security requirements, the video server provides three types of security settings for streaming via RTSP protocol: disable, basic, and digest.
  • Page 47 VIVOTEK RTSP port /RTP port for video, audio/ RTCP port for video, audio ■ RTSP (Real-Time Streaming Protocol) controls the delivery of streaming media. By default, the port number is set to 554. ■ The RTP (Real-time Transport Protocol) is used to deliver video and audio data to the clients. By default, the RTP port for video is set to 5556 and the RTP port for audio is set to 5558.
  • Page 48: Ddns

    DDNS: Dynamic domain name service Enable DDNS: Select this option to enable the DDNS setting. Provider: Select a DDNS provider from the provider drop-down list. VIVOTEK offers Safe100.net, a free dynamic domain name service, to VIVOTEK customers. It is recommended that you register Safe100.net to access VIVOTEK’s video servers from the Internet.
  • Page 49 4. Select Enable DDNS and click Save to enable the setting. ■ CustomSafe100 VIVOTEK offers documents to establish a CustomSafe100 DDNS server for distributors and system integrators. You can use CustomSafe100 to register a dynamic domain name if your distributor or system integrators offer such services.
  • Page 50: Access List

    VIVOTEK Access List Advanced Mode This section explains how to control access permission by verifying the client PC’s IP address. General Settings Maximum number of concurrent streaming connection(s) limited to: Simultaneous live viewing for 1~10 clients (including stream 1 and stream 2). The default value is 10. If you modify the value and click Save, all current connections will be disconnected and automatically attempt to re-link (IE Explore or Quick Time Player).
  • Page 51 VIVOTEK ■ Refresh: Click this button to refresh all current connections. ■ Add to deny list: You can select entries from the Connection Status list and add them to the Deny List to deny access. Please note that those checked connections will only be disconnected temporarily and will automatically try to re-link again (IE Explore or Quick Time Player).
  • Page 52 VIVOTEK Network: This rule allows the user to assign a network address and corresponding subnet mask to the Allow/Deny List. For example: IP address 192.168.2.x will be bolcked. Range: This rule allows the user to assign a range of IP addresses to the Allow/Deny List.
  • Page 53: Audio And Video

    This function can work seamlessly with VIVOTEK’s ST7501 recording software. When an event occurs, the recording software can request time shift cache stream from the camera, which allows the user to get an earlier video data.
  • Page 54 VIVOTEK Note that when the frame size is set to 176 x 144 as shown in the picture below, only the time will be stamped on the video streams. 17:08:56 2008/06/25 Advanced Mode Image Settings Click Image Settings to open the Image Settings page. On this page, you can tune the White balance, Brightness, Saturation, Contrast, and Sharpness settings for the video.
  • Page 55 VIVOTEK You can click Preview to fine-tune the image, or click Restore to recall the original settings without incorporating the changes. When completed with the settings on this page, click Save to enable the setting and click Close to exit the page.
  • Page 56 VIVOTEK Advanced Mode Video quality settings for stream 1 ~ 4 Click the items to display the detailed video quality settings. fixed NOTE ► The frame size of stream 4 is fixed to QCIF. If you want to stream out the video to a mobile device, please select stream 4.
  • Page 57 VIVOTEK ■ Frame size You can set up different video resolution for different viewing devices. For example, set a smaller frame size and lower bit rate for remote viewing on mobile phones and a larger video size and a higher bit rate for live viewing on web browsers.
  • Page 58: Audio Settings

    VIVOTEK ■ Video quality The video quality can be adjusted to the following settings: Medium, Standard, Good, Detailed, and Excellent. You can also select Customize and manually enter a value. NOTE ► Video quality and fixed quality refers to the compression rate, so a lower value will produce higher quality.
  • Page 59: Motion Detection

    VIVOTEK Motion Detection This section explains how to configure the video server to enable motion detection. A total of three motion detection windows can be configured. Follow the steps below to enable motion detection: Follow the steps below to enable motion detection: 1.
  • Page 60 VIVOTEK A green bar indicates that even though motions have been detected, the event has not been triggered because the image variations still fall under the defined threshold. Percentage = 30% NOTE ► How does motion detection work? There are two motion detection parameters: Sensitivity and Percentage. In the illustration above, frame A and frame B are two sequential images.
  • Page 61: Camera Tampering Detection

    VIVOTEK Camera Tampering Detection This section explains how to set up camera temper detection. With tamper detection, the camera is capable of detecting incidents such as redirection, blocking or defocusing, or even spray paint. Please follow the steps below to set up the camera tamper detection function: 1.
  • Page 62: Camera Control

    Then you can configure the PTZ driver and RS485 port with the following settings. VIVOTEK offers five PTZ drivers: DynaDome/SmartDOME, Lilin PIH-7x00, Pelco D protocol, Pelco P protocol, and Samsung scc643 protocol. If none of the above PTZ drivers is supported by your PTZ scanner, please select Custom camera (scanner).
  • Page 63 VIVOTEK Preset Positions If you select DynaDome/SmartDOME, Lilin PIH-7x00, Pelco D, Pelco P, or Samsung scc643 protocol as the PTZ driver and click the Save button, the Preset Position button will be enabled. Click Preset Position to open the settings page. You can also select preset positions for the camera to patrol. A total of 20 preset positions can be configured.
  • Page 64 VIVOTEK ■ The Camera Control Panel and Preset Positions will be displayed on the home page: ■ Click Go to: Select one from the drop-down list, and the Network Camera will move to the selected preset position. 64 - User's Manual...
  • Page 65 VIVOTEK Patrol Settings You can select some preset positions for the Network Camera to patrol. Please follow the steps below to set up a patrol schedule: 1. Click a preset location on the list and click Select. 2. The selected preset location will be displayed on the Source list.
  • Page 66 VIVOTEK Custom Command If Custom Camera (scanner) is selected as the PTZ driver, the Preset Position and PTZ Control Panel on the main page will be disabled. You will need to configure command buttons to control the PTZ scanner. Click Custom Command to open the Custom Command page to set the commands in the Control Settings session.
  • Page 67: Homepage Layout

    Theme Options (the third column on this page). The settings will be displayed automatically in this Preview field. The following shows the homepage using the default settings: ■ Hide Powered by VIVOTEK: If you check this item, it will be removed from the homepage. Logo Here you can change the logo at the top of your homepage.
  • Page 68 VIVOTEK Theme Options Here you can change the color of your homepage layout. There are three types of preset patterns for you to choose from. The new layout will simultaneously appear in the Preview filed. Click Save to enable the settings.
  • Page 69 VIVOTEK ■ Follow the steps below to set up the customed homepage: 1. Click Custom on the left column. 2. Click the field where you want to change the color on the right column. Color Selector Custom Pattern 3. The palette window will pop up as shown below.
  • Page 70: Application

    Please note that there is a limited number of customized scripts you can upload; if the current amount of customized scripts has reached the limit, an alert message will pop up. If you need more information, please ask for VIVOTEK technical support. Click to upload a file...
  • Page 71 VIVOTEK Event Settings In the Event Settings column, click Add to open the Event Settings page. On this page, you can arrange three elements -- Trigger, Schedule, and Action to set an event. A total of 3 event settings can be configured.
  • Page 72 VIVOTEK An event is an action initiated by a user-defined trigger source; it is the causal arrangement of the following three elements: Trigger, Event Schedule, and Action. Trigger This is the cause or stimulus which defines when to trigger the video server. The trigger source can be configured to use the video server’s built-in motion detection mechanism or external digital input devices.
  • Page 73 VIVOTEK ■ Camera tampering detection This option allows the video server to trigger when the camera detects that is is being tampered with. To enable this function, you need to configure the Tampering Detection option first. Please refer to page 61 for detailed information.
  • Page 74 VIVOTEK To set an event with recorded video or snapshots, it is necessary to configure the server and media settings so that the video server will know what action to take (such as which server to send the media files to) when a trigger is activated.
  • Page 75 VIVOTEK When completed, click Save to enable the settings and click Close to exit Event Settings page. The new event settings / server settings / media settings will appear in the event drop-down list on the Application page. Here is an example of the Application page with an event setting: When the Event Status is ON, once an event is triggered by motion detection, the video server will automatically send snapshots via e-mail.
  • Page 76: Server Settings

    VIVOTEK Server Settings Click Add Server on Event Settings page to open the Server Setting page. On this page, you can specify where the notification messages are sent when a trigger is activated. A total of 5 server settings can be configured.
  • Page 77 VIVOTEK FTP: Select to send the media files to an FTP server when a trigger is activated. ■ Server address: Enter the domain name or IP address of the FTP server. ■ Server port By default, the FTP server port is set to 21. It can also be assigned to another port number between 1025 and 65535.
  • Page 78 VIVOTEK HTTP: Select to send the media files to an HTTP server when a trigger is activated. ■ URL: Enter the URL of the HTTP server. ■ User name: Enter the user name if necessary. ■ Password: Enter the password if necessary.
  • Page 79: Media Settings

    VIVOTEK Media Settings Click Add Media on the Event Settings page to open the Media Settings page. On this page, you can specify the type of media that will be sent when a trigger is activated. A total of 5 media settings can be configured.
  • Page 80 VIVOTEK Video clip: Select to send video clips when a trigger is activated. ■ Source: The video source. The stream source will be identical to the preset time shift caching stream. For more information about time shift caching stream, please refer to page 53.
  • Page 81 VIVOTEK You can continue to select a server and media type for the event. Please go back to page 66 for detailed information. ■ SD Test: Click to test your SD card. The system will display a message indicating success or failure. If you want to use your SD card for local storage, please format it before use.
  • Page 82 VIVOTEK Click 20081120 to open the directory: The format is: HH (24r) Click to open the file list for that hour Click to go back to the previous Click to delete level of the directory selected items Click to delete all...
  • Page 83: Recording

    VIVOTEK Recording Advanced Mode This section explains how to configure the recording settings for the video server. Recording Settings Insert your SD card and click here to test NOTE ► Before setting up this page, please set up the Network Storage on the Server Settings page first.
  • Page 84 VIVOTEK If successful, you will receive a test.txt file on the network storage server. 3. Enter a server name. 4. Click Save to complete the settings and click Close to exit the page. Recording Settings Click Add to open the recording setting page. In this page, you can define the recording source, recording schedule, and recording capacity.
  • Page 85 VIVOTEK Source: Select the recording source (stream 1 ~ 4). Trigger: Select a trigger source. ■ Schedule: The server will start to record files on the local storage or network storage (NAS). ■ Network fail: Since network fail, the server will start to record files on the local storage (SD card).
  • Page 86: Local Storage

    VIVOTEK Local Storage Advanced Mode This section explains how to manage the local storage on the video server. Here you can view SD card status, search for recorded files to playback, download, etc. no SD card SD Card Management SD card status: This column shows the status and reserved space of your SD card. Please remember to format the SD card when using for the first time.
  • Page 87 VIVOTEK SD card control ■ Enable cyclic storage: Check this item if you want to enable cyclic recording. When the maximum capacity is reached, the oldest file will be overwritten by the latest one. ■ Enable automatic disk cleanup: Check this item and enter the number of days you wish to retain a file.
  • Page 88 VIVOTEK Search Results The following is an example of search results. There are four columns: Trigger time, Media type, Trigger type, and Locked. Click to sort the search results in either direction. Enter a key word to filter the Numbers of entries displayed on one page...
  • Page 89 VIVOTEK Download: Click on a search result to highlight the selected item in purple as shown above. Then click the Download button and a file download window will pop up for you to save the file. JPEGs to AVI: This functions only applies to “JPEG“ format files such as snapshots. You can select several snapshots from the list, then click this button.
  • Page 90: System Log

    VIVOTEK System Log Advanced Mode This section explains how to configure the video server to send the system log to the remote server as backup. Remote Log You can configure the video server to send the system log file to a remote server as a log backup.
  • Page 91: View Parameters

    VIVOTEK View Parameters Advanced Mode The View Parameters page lists the entire system’s parameters in alphabetical order. If you need technical assistance, please provide the information listed on this page. User's Manual - 91...
  • Page 92: Maintenance

    VIVOTEK Maintenance This chapter explains how to restore the video server to factory default, upgrade firmware version, etc. Reboot This feature allows you to reboot the video server, which takes about one minute to complete. When completed, the live video page will be displayed in your browser. The following message will be displayed during the reboot process.
  • Page 93 VIVOTEK Export / Upload Files Advanced Mode This feature allows you to Export / Upload daylight saving time rules, custom language files, and setting backup files. Export daylight saving time configuration file: Click to set the start and end time of DST.
  • Page 94 Note: Do not power off the video server during the upgrade! Follow the steps below to upgrade the firmware: 1. Download the latest firmware file from the VIVOTEK website. The file is in .pkg file format. 2. Click Browse… and specify the firmware file.
  • Page 95 VIVOTEK The following message is displayed when the upgrade has succeeded. Reboot system now!! This connection will close. The following message is displayed when you have selected an incorrect firmware file. Starting firmware upgrade... Do not power down the server during the upgrade.
  • Page 96: Url Commands For The Network Camera/Video Server

    VIVOTEK Appendix URL Commands for the Network Camera/Video Server Overview For some customers who already have their own web site or web control application, the Network Camera/Video Server can be easily integrated through URL syntax. This section specifies the external HTTP-based application programming interface.
  • Page 97 VIVOTEK A Leading Provider of Multimedia Communication Solutions URL commands for VS8102 Version 1.0b 2014/10/20 www.vivotek.com User's Manual - 97...
  • Page 98 VIVOTEK may make changes to specifications and product descriptions at any time, without notice. The following are trademarks of VIVOTEK Inc., and may be used to identify VIVOTEK products only: VIVOTEK. Other product and company names contained herein may be trademarks of their respective owners.
  • Page 99 For some customers who already have their own web site or web control application, a Network Camera/Video server can be easily integrated through URLs. This document provides the supersets of URL commands V2 for VIVOTEK 8000 series products. This section specifies the external HTTP-based application programming interface. The HTTP-based camera interface provides the functionality to request a single image, to control camera functions (PTZ, output relay etc.), and to get and set internal parameter values.
  • Page 100: General Cgi Url Syntax And Parameters

    VIVOTEK General CGI URL Syntax and Parameters CGI parameters are written in lower-case and as one word without any underscores or other separators. When the CGI request includes internal camera parameters, these parameters must be written exactly as they are named in the camera or video server. The CGIs are organized in functionally-related directories under the cgi-bin directory.
  • Page 101 VIVOTEK [&<parameter>…] http://<servername>/cgi-bin/operator/getparam.cgi?[<parameter>] [&<parameter>…] http://<servername>/cgi-bin/admin/getparam.cgi?[<parameter>] [&<parameter>…] Where the <parameter> should be <group>[_<name>] or <group>[.<name>]. If you do not specify any parameters, all the parameters on the server will be returned. If you specify only <group>, the parameters of the related group will be returned.
  • Page 102: Set Server Parameter Values

    (Note: The return page can be a general HTML file (.htm, .html) or a VIVOTEK server script executable (.vspx) file. It cannot be a CGI command or have any extra parameters. This parameter must be placed at the end of the parameter list Return: HTTP/1.0 200 OK\r\n...
  • Page 103: Available Parameters On The Server

    VIVOTEK <parameter>=<value>\r\n [<parameter pair>] Only the parameters that you set and are readable will be returned. Example: Set the IP address of server to 192.168.0.123: Request: http://myserver/cgi-bin/admin/setparam.cgi?network_ipaddress=192.168.0.123 Response: HTTP/1.0 200 OK\r\n Content-Type: text/html\r\n Context-Length: 33\r\n \r\n network.ipaddress=192.168.0.123\r\n Available parameters on the server...
  • Page 104 VIVOTEK blank A blank string. everything inside <> A description integer primary key SQLite data type. A 32-bit signed integer. The value is assigned a unique integer by the server. text SQLite data type. The value is a text string, stored using the database encoding (UTF-8, UTF-16BE or UTF-16-LE).
  • Page 105 VIVOTEK <ip address>, *Do not use “skip to <blank> invoke default server” for default value. timezoneindex -489 ~ 529 <product Indicate timezone and dependent area. > -480: GMT-12:00 Eniwetok, Kwajalein -440: GMT-11:00 Midway Island, Samoa -400: GMT-10:00 Hawaii -360: GMT-09:00...
  • Page 106 VIVOTEK -140: GMT-03:30 Newfoundland -120: GMT-03:00 Brasilia, Buenos Aires, Georgetown, Greenland -80: GMT-02:00 Mid-Atlantic -40: GMT-01:00 Azores, Cape_Verde_IS. 0: GMT Casablanca, Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London 40: GMT 01:00 Amsterdam, Berlin, Rome, Stockholm, Vienna, Madrid, Paris 41: GMT 01:00...
  • Page 107 VIVOTEK Dhabi, Muscat, Baku, Tbilisi, Yerevan 180: GMT 04:30 Kabul 200: GMT 05:00 Ekaterinburg, Islamabad, Karachi, Tashkent 220: GMT 05:30 Calcutta, Chennai, Mumbai, New Delhi 230: GMT 05:45 Kathmandu 240: GMT 06:00 Almaty, Novosibirsk, Astana, Dhaka, Sri Jayawardenepura 260: GMT 06:30...
  • Page 108 VIVOTEK Is., New Caledonia 480: GMT 12:00 Aucklan, Wellington, Fiji, Kamchatka, Marshall Is. 520: GMT 13:00 Nuku'Alofa daylight_enable <boolean> Enable automatic daylight saving time in time zone. daylight_dstactualmode <boolean> Check if current time is under daylight saving time. (Used internally)
  • Page 109 VIVOTEK is non-negative. restoreexceptnet <Any value> Restore the system parameters to default values except (ipaddress, subnet, router, dns1, dns2, pppoe). This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the...
  • Page 110 VIVOTEK This command can cooperate with other “restoreexceptXYZ” commands. When cooperating with others, the system parameters will be restored to the default value except for a union of the combined results. Subgroup of system: info (The fields in this group are unchangeable.)
  • Page 111 VIVOTEK which have been uploaded to the server. customlanguage_i<0~(max string Custom language name. count-1)> Group: status NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) di_i<0~(ndi-1)> <boolean> 0 => Inactive, normal 1 => Active, triggered do_i<0~(ndo-1)> <boolean> 0 => Inactive, normal 1 => Active, triggered...
  • Page 112 VIVOTEK privilege_camctrl view, operator, view Indicate which privileges and admin above can control PTZ user_i0_name string[64] root User name of root user_i<1~20>_name string[64] <blank> User name user_i0_pass password[64] <blank> Root password user_i<1~20>_pass password[64] <blank> User password user_i0_privilege viewer, admin Root privilege...
  • Page 113 VIVOTEK eap-tls identity_peap String[64] <blank> PEAP identity identity_tls String[64] <blank> TLS identity password String[254] <blank> Password for TLS privatekeypassword String[254] <blank> Password for PEAP ca_exist <boolean> CA installed flag ca_time <integer> CA installed time. Represented in EPOCH ca_size <integer> CA file size (in bytes) certificate_exist <boolean>...
  • Page 114 VIVOTEK addonprefixlen 0~128 IPv6 prefix length. addonrouter <ip address> <blank> IPv6 router address. addondns <ip address> <blank> IPv6 DNS address. allowoptional <boolean> Allow manually setup of IP address setting. Subgroup of network: ftp NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) port 21, 1025~65535 Local ftp server port.
  • Page 115 VIVOTEK anonymousviewing <boolean> Enable anoymous streaming viewing. Subgroup of network: https NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) port 443, 1025 ~ HTTPS port. 65535 Subgroup of network: rtsp NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) port 554, 1025 ~ RTSP port.
  • Page 116 VIVOTEK stream2. -1 => audio mute s3_audiotrack <integer> The current audio track for stream2. -1 => audio mute Subgroup of network_rtsp_s<0~(n-1)>: multicast, n is stream count (capability.protocol.rtp.multicast=1) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) alwaysmulticast <boolean> Enable always multicast. ipaddress <ip address>...
  • Page 117 VIVOTEK pass password[64] <blank> PPPoE account password. Group: ipfilter NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) enable <boolean> Enable access list filtering. admin_enable <boolean> Enable administrator IP address. admin_ip String[44] <blank> Administrator IP address. maxconnection 1~10 Maximum number of concurrent streaming connection(s).
  • Page 118 VIVOTEK Group: videoin_c<0~(n-1)> for n channel products, and m is stream number NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) modulation ntsc, auto Set video input pal, modulation type. auto (videoin.type=0) (product dependent) color 0, 1 0 =>monochrome 1 => color flip <boolean>...
  • Page 119 VIVOTEK 176x120, 720x480 176x144, CIF, PAL => 352x240, 720x576 352x288, 4CIF, 704x480, 704x576 720x480 720x576 s<0~(m-1)>_h264_intraperiod 250, 500, 1000 Intra frame period in 1000, milliseconds. 2000, 3000, 4000 s<0~(m-1)>_h264_ratecontrolm cbr, vbr cbr, constant bitrate vbr, fix quality s<0~(m-1)>_h264_quant 99, 1~5...
  • Page 120 VIVOTEK 3000, 4000 s<0~(m-1)>_mpeg4_ratecontrol cbr, vbr cbr, constant bitrate mode vbr, fix quality s<0~(m-1)>_mpeg4_quant 0, 1~5 Quality of video when choosing vbr in “ratecontrolmode”. 0 is the customized manual input setting. 1 = worst quality, 5 = best quality. s<0~(m-1)>_mpeg4_quantlevel...
  • Page 121 VIVOTEK NTSC s<0~(m-1)>_mjpeg_qvalue 2~97 Manual video quality level input - choose customize input “mjpeg_quant = 0” (for MJPEG). s<0~(m-1)>_forcei Force I frame. enablewdr <boolean> Enable/disable WDR Group: audioin_c<0~(n-1)> for n channel products (capability.audioin>0) NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) source...
  • Page 122 VIVOTEK contrast -5 ~ 5 Adjust contrast of image according to mode settings. sharpness <product Adjust sharpness of image dependent> according to mode settings. Group: imagepreview_c<0~(n-1)> for n channel products NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) brightness <product Preview of brightness dependent>...
  • Page 123 VIVOTEK window 1~3. win_i<0~2>_name string[14] <blank> Name of motion window 1~3. win_i<0~2>_left 0 ~ 320 Left coordinate of window position. win_i<0~2>_top 0 ~ 240 Top coordinate of window position. win_i<0~2>_width 0 ~ 320 Width of motion detection window. win_i<0~2>_height 0 ~ 240...
  • Page 124 VIVOTEK DyndnsCustom, (dynamic) TZO, DyndnsCustom => dyndns.org DHS, (custom) DynInterfree, TZO => tzo.com PeanutHull, DHS => dhs.org CustomSafe100 DynInterfree =>dyn-interfree.it PeanutHull => PeanutHull CustomSafe100 => Custom server using safe100 method <provider>_hostna string[128] <blank> Your dynamic hostname. <provider>_userna string[64] <blank> Your user or email to login to the...
  • Page 125 VIVOTEK enableremotelog <boolean> Enable remote log. serverip <IP address> <blank> Log server IP address. serverport 514, Server port used for log. 1025~65535 level Levels used to distinguish the importance of the information: 0: LOG_EMERG 1: LOG_ALERT 2: LOG_CRIT 3: LOG_ERR...
  • Page 126 VIVOTEK secnamerw string[31] Private Read/write security name secnamero string[31] Public Read only security name authpwrw string[8~128] <blank> Read/write authentication password authpwro string[8~128] <blank> Read only authentication password authtyperw MD5,SHA Read/write authentication type authtypero MD5,SHA Read only authentication type encryptpwrw string[8~128] <blank>...
  • Page 127 VIVOTEK win_i<0~4>_height 0 ~ 240/288 Height of privacy mask window. Group: capability NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) api_httpversion 0200a <product The HTTP API version. dependent > bootuptime <positive <product Server bootup time. integer> dependent > <product Number of IR interfaces.
  • Page 128 VIVOTEK naudiosetting <positive <product Number of audio settings integer> dependent per channel. > nuart <product Number of UART interfaces. <positive dependent integer> > nvideoinprofile <positive <product Number of videoin profiles. integer> dependent > nmotionprofile <positive <product Number of motion profiles.
  • Page 129 VIVOTEK 0(bit 1 ~ 7 are valid), 1(bit 1 ~ 7 are invalid) Bit 9 => Reserved bit; Invalidate lens_pan, Lens_tilt, lens_zoon, lens_focus, len_iris. 0(fields are valid), 1(fields are invalid) npreset <positive <product Number of preset locations. integer> dependent >...
  • Page 130 VIVOTEK protocol_rtp_multicast_ <boolean> <product Indicate whether to support scalable dependent scalable multicast. > protocol_rtp_multicast_ <boolean> <product Indicate whether to support backchannel dependent backchannel multicast. > protocol_rtp_tcp <boolean> <product Indicate whether to support dependent RTP over TCP. > protocol_rtp_http <boolean> <product...
  • Page 131 VIVOTEK codec > types separated commas> videoout_codec <a list of the <product Available codec list. available dependent codec > types separated commas) audio_aec <boolean> <product Indicate whether to support dependent acoustic echo > cancellation. audio_extmic <boolean> <product Indicate whether to support...
  • Page 132 VIVOTEK commas) uart_httptunnel <boolean> <product Indicate whether to support dependent HTTP tunnel for UART > transfer. camctrl_privilege <boolean> <product Indicate whether to support dependent “Manage Privilege” of PTZ > control in the Security page. transmission_mode <product Indicate transmission mode dependent...
  • Page 133 VIVOTEK dependent the upgrade function for > the derivative brand. For example, if the value is true, the VVTK product can be upgraded to VVXX. (TCVV<->TCXX is excepted) evctrlchannel <boolean> <product Indicate whether to support dependent HTTP tunnel for >...
  • Page 134: Technical Specifications

    VIVOTEK date string[17] NULL Date of custom script. time string[17] NULL Time of custom script. Group: event_i<0~2> PARAMETER VALUE Default SECURITY DESCRIPTION (get/set) name string[40] NULL Identification of this entry. enable 0, 1 Enable or disable this event. priority 0, 1, 2 Indicate the priority of this event: “0”...
  • Page 135 VIVOTEK mdwin <integer> Indicate which motion detection windows detect. This field is required when trigger condition is “md”. One bit represents one window. The LSB indicates the 1 window. For example, to detect the 1 windows, set mdwin as 5.
  • Page 136 VIVOTEK action_server_i<0~4>_e 0, 1 Enable or disable this server action. nable The default value is 0. action_server_i<0~4>_ NULL, 0~4 NULL Index of the attached media. media action_server_i<0~4>_ <boolean> Enable this to create folders by datefolder date, time, and hour automatically.
  • Page 137 VIVOTEK email_passwd string[64] NULL Password of the user. email_senderemail string[128] NULL Email address of the sender. email_recipientemail string[128] NULL Email address of the recipient. ns_location string[128] NULL Location to upload or store the media. ns_username string[64] NULL Username to log in to the server.
  • Page 138 VIVOTEK videoclip_source <integer> Indicate the source of media stream. 0 means the first stream. 1 means the second stream and etc. 2 means the third stream and etc. 3 means the fourth stream and etc. videoclip_prefix string[16] <product Indicate the prefix of the filename.
  • Page 139 VIVOTEK notify 0: Disable recording notification 1: Enable recording notification notifyserver 0~31 Indicate which notification server is scheduled. One bit represents one application server (server_i0~i4). bit0 (LSB) = server_i0. bit1 = server_i1. bit2 = server_i2. bit3 = server_i3. bit4 = server_i4.
  • Page 140 VIVOTEK reserveamount The reserved amount in Mbytes when choosing cyclic recording mechanism. dest The destination to store the recorded data. “cf” means CF card. “0~4” means the index of the network storage. cffolder string[128] NULL Folder name. maxsize 100~2000 Unit: Mega bytes.
  • Page 141: Drive The Digital Output

    VIVOTEK stateorprovincename string[128] <product State or province name in the dependent> certificate information. localityname string[128] <product The locality name in the dependent> certificate information. organizationname string[64] <product Organization name in the dependent> certificate information. unit string[32] <product Organizational unit name in dependent>...
  • Page 142: Query Status Of The Digital Input

    VIVOTEK return <return page> Redirect to the page <return page> after the parameter is assigned. The <return page> can be a full URL path or relative path according to the current path. If you omit this parameter, it will redirect to an empty page.
  • Page 143: Query Status Of The Digital Output

    VIVOTEK Query Status of the Digital Output Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/dido/getdo.cgi?[do0][&do1][&do2][&do3] If no parameter is specified, all the digital output statuses will be returned. Return: HTTP/1.0 200 OK\r\n Content-Type: text/plain\r\n Content-Length: <length>\r\n \r\n [do0=<state>]\r\n [do1=<state>]\r\n...
  • Page 144: Account Management

    VIVOTEK http://<servername>/cgi-bin/viewer/video.jpg?[channel=<value>][&resolution=<value>] [&quality=<value>][&streamid=<value>] If the user requests a size larger than all stream settings on the server, this request will fail. PARAMETER VALUE DEFAULT DESCRIPTION channel 0~(n-1) The channel number of the video source. resolution <available The resolution of the image.
  • Page 145: System Logs

    VIVOTEK Delete Remove an account from the server. When using this method, the “username” field is necessary, and others are ignored. edit Modify the account password and privilege. When using this method, the “username” field is necessary, and other fields are optional.
  • Page 146: Upgrade Firmware

    VIVOTEK Upgrade Firmware Note: This request requires Administrator privileges. Method: POST Syntax: http://<servername>/cgi-bin/admin/upgrade.cgi Post data: fimage=<file name>[&return=<return page>]\r\n \r\n <multipart encoded form data> Server will accept the file named <file name> to upgrade the firmware and return with <return page> if indicated.
  • Page 147 VIVOTEK capability version) Model system.firmwareversion Model name of the server. Ex:IP3133-VVTK-0100a CapVersion MMmm, MM is major version from 00 ~ 99 Capability field version. mm is minor version from 00 ~ 99 ex: 0100 IP Filtering Note: This request requires Administrator access privileges.
  • Page 148 VIVOTEK <ip address> The ending IP address to add or to delete. index <value> The start position to add or to delete. return <return page> Redirect to the page <return page> after the parameter is assigned. The <return page> can be a full URL path or relative path according to the current path.
  • Page 149 VIVOTEK Senddata (capability.nuart>0) Note: This request requires Viewer privileges. Method: GET/POST Syntax: http://<servername>/cgi-bin/viewer/senddata.cgi? [com=<value>][&data=<value>][&flush=<value>] [&wait=<value>] [&read=<value>] PARAMETER VALUE DESCRIPTION 1 ~ <max. com port The target COM/RS485 port number. number> data <hex decimal The <hex decimal data> is a series of digits from 0 ~ 9, A ~ F.
  • Page 150 VIVOTEK http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=<cmd_type>[&<parameter>=<value>…] The commands usage and their input arguments are as follows. PARAMETER VALUE DESCRIPTION cmd_type <string> Required. Command to be executed, including search, insert, delete, update, and queryStatus. Command: search PARAMETER VALUE DESCRIPTION label <integer primary key> Optional. The integer primary key column will automatically be assigned a unique integer.
  • Page 151 VIVOTEK Format is “YYYY-MM-DD HH:MM:SS” Please embrace your input value with single quotes. Ex. triggerTime=’2008-01-01 00:00:00’ If you want to search for a time period, please apply “TO” operation. Ex. triggerTime=’2008-01-01 00:00:00’+TO+’2008-01-01 23:59:59’ is to search for records from the start of Jan 1 2008 to the end of Jan 1 2008.
  • Page 152 VIVOTEK Ex. Update records whose key numbers are 1 and 5 to be locked status. http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=1&label=1&label=5 Ex. Update records whose key numbers are 2 and 3 to be unlocked status. http://<servername>/cgi-bin/admin/lsctrl.cgi?cmd=update&isLocked=0&label=2&label=3 Command: queryStatus PARAMETER VALUE DESCRIPTION retType xml or javascript Optional.
  • Page 153 VIVOTEK GENETEC info Group: genetec NAME VALUE DEFAULT SECURITY DESCRIPTION (get/set) image_contrast <integer> <product 99/99 Only for genetec dependent> omnicast image_brightness <integer> <product 99/99 Only for genetec dependent> omnicast motion_i<0~2> <integer> <product 99/99 Only for genetec dependent> omnicast User's Manual - 153...
  • Page 154 Distributed by: 6F, No.192, Lien-Cheng Rd., Chung-Ho, Taipei County, Taiwan 154 - User's Manual Tel: +886-2-82455282 Fax: +886-2-82455532 E-mail: sales@vivotek.com VIVOTEK USA, INC. 470 Lakeside Drive Suite C, Sunnyvale, CA 94085 USA Tel: 408-773-8686 | Fax: 408-773-8298 | E-mail: salesusa@vivotek.com...
  • Page 155: Technology License Notice

    VIVOTEK Technology License Notice MPEG-4 AAC Technology THIS PRODUCT IS LICENSED UNDER THE MPEG-4 AAC AUDIO PATENT LICENSE. THIS PRODUCT MAY NOT BE DECOMPILED, REVERSE-ENGINEERED OR COPIED, EXCEPT WITH REGARD TO PC SOFTWARE, OF WHICH YOU MAY MAKE SINGLE COPIES FOR ARCHIVAL PURPOSES. FOR MORE INFORMATION, PLEASE REFER TO HTTP://WWW.VIALICENSING.COM.
  • Page 156: Electromagnetic Compatibility (Emc)

    があいます。この場合には使用者が適切な対策を講ずるよう要求されるこたがあります。 Liability VIVOTEK Inc. cannot be held responsible for any technical or typographical errors and reserves the right to make changes to the product and manuals without prior notice. VIVOTEK Inc. makes no warranty of any kind with regard to the material contained within this document, including, but not limited to, the implied warranties of merchantability and fitness for any particular purpose.

Table of Contents