JVC VN-V686UAPI manuel d'utilisation

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

Aller à la page of

Un bon manuel d’utilisation

Les règles imposent au revendeur l'obligation de fournir à l'acheteur, avec des marchandises, le manuel d’utilisation JVC VN-V686UAPI. Le manque du manuel d’utilisation ou les informations incorrectes fournies au consommateur sont à la base d'une plainte pour non-conformité du dispositif avec le contrat. Conformément à la loi, l’inclusion du manuel d’utilisation sous une forme autre que le papier est autorisée, ce qui est souvent utilisé récemment, en incluant la forme graphique ou électronique du manuel JVC VN-V686UAPI ou les vidéos d'instruction pour les utilisateurs. La condition est son caractère lisible et compréhensible.

Qu'est ce que le manuel d’utilisation?

Le mot vient du latin "Instructio", à savoir organiser. Ainsi, le manuel d’utilisation JVC VN-V686UAPI décrit les étapes de la procédure. Le but du manuel d’utilisation est d’instruire, de faciliter le démarrage, l'utilisation de l'équipement ou l'exécution des actions spécifiques. Le manuel d’utilisation est une collection d'informations sur l'objet/service, une indice.

Malheureusement, peu d'utilisateurs prennent le temps de lire le manuel d’utilisation, et un bon manuel permet non seulement d’apprendre à connaître un certain nombre de fonctionnalités supplémentaires du dispositif acheté, mais aussi éviter la majorité des défaillances.

Donc, ce qui devrait contenir le manuel parfait?

Tout d'abord, le manuel d’utilisation JVC VN-V686UAPI devrait contenir:
- informations sur les caractéristiques techniques du dispositif JVC VN-V686UAPI
- nom du fabricant et année de fabrication JVC VN-V686UAPI
- instructions d'utilisation, de réglage et d’entretien de l'équipement JVC VN-V686UAPI
- signes de sécurité et attestations confirmant la conformité avec les normes pertinentes

Pourquoi nous ne lisons pas les manuels d’utilisation?

Habituellement, cela est dû au manque de temps et de certitude quant à la fonctionnalité spécifique de l'équipement acheté. Malheureusement, la connexion et le démarrage JVC VN-V686UAPI ne suffisent pas. Le manuel d’utilisation contient un certain nombre de lignes directrices concernant les fonctionnalités spécifiques, la sécurité, les méthodes d'entretien (même les moyens qui doivent être utilisés), les défauts possibles JVC VN-V686UAPI et les moyens de résoudre des problèmes communs lors de l'utilisation. Enfin, le manuel contient les coordonnées du service JVC en l'absence de l'efficacité des solutions proposées. Actuellement, les manuels d’utilisation sous la forme d'animations intéressantes et de vidéos pédagogiques qui sont meilleurs que la brochure, sont très populaires. Ce type de manuel permet à l'utilisateur de voir toute la vidéo d'instruction sans sauter les spécifications et les descriptions techniques compliquées JVC VN-V686UAPI, comme c’est le cas pour la version papier.

Pourquoi lire le manuel d’utilisation?

Tout d'abord, il contient la réponse sur la structure, les possibilités du dispositif JVC VN-V686UAPI, l'utilisation de divers accessoires et une gamme d'informations pour profiter pleinement de toutes les fonctionnalités et commodités.

Après un achat réussi de l’équipement/dispositif, prenez un moment pour vous familiariser avec toutes les parties du manuel d'utilisation JVC VN-V686UAPI. À l'heure actuelle, ils sont soigneusement préparés et traduits pour qu'ils soient non seulement compréhensibles pour les utilisateurs, mais pour qu’ils remplissent leur fonction de base de l'information et d’aide.

Table des matières du manuel d’utilisation

  • Page 1

    IP Camera VN-V686U    API GUIDE This document provides a description of protocols and API of VN-V686. Refer Readme file in the CD-ROM for updated informa tion. 2008.6.19. JVC LST0652-001A 1[...]

  • Page 2

    Updates Version Date Updates 1.00 2007/12/13 First release. 1.01 2008/4/25 Limitation of Registering Preset Position is added. Fixed auto patrol number for auto return. Fixed api text for getting status of a privacy ma sking area. 1.02 2008/6/19 - Boundary option is added to JPEG request API. - Status of Intelligent tracking is added to JP EG forma[...]

  • Page 3

    Custom Application Software Devel opment Guide VN-V686 can be used from a custom application software by ut ilizing the API and protocols for VN-V686. The following operations are possible. ● Getting JPEG from VN-V686. ● Getting MPEG-4 from VN-V686. ● Getting Alarm from VN-V686. ● Getting or changing VN-V686 settings. ● Pan/Tilt/Zoom/Focu[...]

  • Page 4

    Content 1. Getting JPEG from VN-V686 via HTTP 2. Getting MPEG-4 from VN-V686 via HTTP 3. API to Search VN-V686 4. Getting Alarm from VN-V686 via TCP 5. Using API that Requires Basic Authentication 6. API for Getting/Changing Parameters of VN-V686 7. List of Protocols and Port Numbers Used with VN-V686 8. Customizing VN-V686's Built-in Viewer 9[...]

  • Page 5

    1. Getting JPEG from VN-V686 via H TTP 1.1. Basic Procedures 1) The client establishes a TCP connection to port number 80. 2) The client sends out API. Example GET /api/video?encode=jpeg&framerate=30&boundary=on&ptz_info=off HTTP/1.1<CRLF> Host: 192.168.0.2<CRLF><CRLF> Note <CRLF> denotes the line feed code ( 0x0[...]

  • Page 6

    When ptz_info=on is specified, boundary, pan/tilt/zoom information and JPEG file will be sent out continuously a fter HTTP Response as follows. Example of Booundary and pan/tilt/zoom information: --foo<CRLF> Content-Type: image/jpeg<CRLF> Content-Length: 31200<CRLF> X-Puls-Pan: 0<CRLF> X-Puls-Tilt: 0<CRLF> X-Posi-Zoom:[...]

  • Page 7

    1.2. API Format Structure Unlike APIs for getting/setting parameters, Accept line is not required. Basic authentic ation is also not necessary. Example GET /api/video?encode=jpeg&framerate=30&boundary=on&ptz_info=off HTTP/1.1<CRLF> Host: 192.168.0.2<CRLF><CRLF> Parameter value is indicated using =. Do not insert space [...]

  • Page 8

    HTTP/1.1 200 OK<CRLF> Content-Type: multipart/x-mixed-replace;boundary=--foo<CRLF> Date: Tue, 02 Oct 2007 07:33:12 GMT<CRLF> Server: JVC VN-V686 Network Camera<CRLF> x-vnv686_response: encode=jpeg&framerate=30&framesize=vga&boundary=on&ptz_info=off<CRLF><CRLF> When API is successfully received wi [...]

  • Page 9

    FFD8 Start Code FFE0 Application Segment FFFE Comment Segment 1 FFFE Comment Segment 2 (reserved) FFC4 DHT Huffman Table FFDB DQT Quantization Table FFDD DRI Restart Interval FFC0 SOF Frame Information FFDA Data Start Segment FFD9 End Code The following information is stored in the comment segment 1. Each item has a fixed le ngth. Item Size Example[...]

  • Page 10

    Target position of Intelligent tracking 30 track_area = 90,420-150,460 Indicates position of Intelligent tracking target . The numbers are top left position and bottom right position. Item names and values, excluding the version information that does not include =, are stored in the following forma t. Example: When width=640, the 13-byte area will [...]

  • Page 11

    HTTP Response and MPEG-4 stream sent out by VN-V686 are as follows. When ptz_info=on is specified, boundary, pan/tilt/zoom information and MPEG-4 VOP will be se nt out continuously after HTTP Response are as follows. Example of Booundary and pan/tilt/zoom information: --foo<CRLF> Content-Type: image/jpeg<CRLF> Content-Length: 5914<CR[...]

  • Page 12

    Details of MPEG-4 stream is explained later. 5) When the client wants to stop current MPEG-4 transmission, the client disconnects TCP80. VN-V686 does not accept further API via current TCP that is used for JPEG transmission. To change para meter, disconnect current TCP to stop the MPEG-4 transmission, connect new TCP, and send API with new parame t[...]

  • Page 13

    Server: JVC VN-V686 Network Camera<CRLF> x-vnv686_response: encode=mpeg4&framerate=30&framesize=vga&ptz_info=off<CRLF><CRLF> MPEG-4 framerate can be changed by Web page or API. When MPEG-4 framerate is changed, the framerate of current stream is changed also. 2.4. Restrictions Access restriction VN-V686 has access rest[...]

  • Page 14

    There are VOL, Userdata1, GOV and Userdata2 before each I-VOP.   Data Structure before I-VOP Item Note VOL VOL of MPEG-4 Video Userdata1 Reserved GOV GOV of MPEG-4 Video Userdata2 Userdata    Data Structure of Userdata2 Item Example Note Start Code 0x000001B2 Start code of userdata in M PEG-4 Video Product Name type = VN-V686U Product Name Ti[...]

  • Page 15

    Response Example system.id=VN-V686U(192.1 68.0.2/24)&200 OK<CRLF> 4. Getting Alarm from VN-V686 4.1. Procedure 1) The client establishes a TCP connection to port number 32040. 2) When motion is detected from the video image of VN-V686, or when there are changes to the ala rm input (make or break), VN-V686 will send out alarm information i[...]

  • Page 16

    The following is an example of API for Getting subnet mask of VN-V686. Example GET /api/param?network.interface.subnetmask HTTP/1.1<CRLF> Accept: text/plain<CRLF> Host: 192.168.0.2<CRLF> Authorization: Basic YWRtaW46dm4tdjY4Ng==<CRLF><CRLF> Specify the response format by Accept line. Plain text response is returned whe[...]

  • Page 17

    Date: Fri, 13 MAY 2005 07:33:12 GMT<CRLF> Server: JVC VN-V686 API Server<CRLF> network.interface.subnetmask=255.0.0.0&200 OK<CRLF> 4) The client disconnects TCP80 to end the use of API. Note: APIs for getting/setting parameters are not restricted by the access restriction func tion. 6. API for Getting/Changin g Parameters of V[...]

  • Page 18

    An error code will be returned when setting is not properly performed. Example: ParamA.ParamB.ParamC&401 Unauthorized 6.2. Camera These APIs are related to camera settings. Same functions are shown on the Camera page of the WEB setting page and PTZ Controller of built-in viewer. Refer to the instruction manual for details on the Ca mera page an[...]

  • Page 19

    To set as blank, specify as %00(0x25, 0x30, 0x30). To use space, specify as %20(0x25, 0x32, 0x30). If you want to set "Comment In JPEG" for example, specify as follows. /api/param?camera.id=Comment%20In%20JPEG The Camera ID is used as sender's display name of alarm mail. If you want to set sende r's mail address, s ee " Set[...]

  • Page 20

    Example of setting a value /api/param?camera.image.pedestal=50 Example of 1 step change /api/param?camera.image.pedestal=+ Example of response camera.image.pedestal &202 Accepted(camera.status=save) Interpretation Change pedestal setting. Specify 0 to 100, "+" or "-". The value is ma pped to 3 internal levels. It becomes bri[...]

  • Page 21

    Example of response camera.image.gamma.activelevel &202 Accepted(camera.status=save) Interpretation Change active gamma level setting. S pecify from 0 to 100 . The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot. Thie set ting is valid when gamma setting is "active". Allowe[...]

  • Page 22

    becomes sharper 1 step by specifying "+", softer 1 step by specifying "-". The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator Getting Color Level from VN-V686 Format /api/param?camera.image.color Example of response camera.image.color=5[...]

  • Page 23

    reboot. Allowed users admin, operator Getting Stabilizer Level from VN-V686 Format /api/param?camera.image.stabilizer.level Example of response camera.image.stabilizer.level=100&200 OK Interpretation Acquire stabilizer level. Value from 0 to 100 is returned. The le vel is 3 steps internally. Allowed users admin, operator, user Setting Stabilize[...]

  • Page 24

    Getting AGC from VN-V686 Format /api/param?camera.image.brightness Example of response camera.image.brightnesss=autoL&200 OK Interpretation Acquire AGC setting. "manual", "autoL", " autoM" or "autoH" is returned. Allowed users admin, operator, user Setting AGC for VN-V686 Format /api/param?camera.image.br[...]

  • Page 25

    "quality" is returned. In case of "motion", AGC is used before using sense up. In case of "quality", sense up is used before using AGC. Allowed users admin, operator, user Setting ALC priority for VN-V686 Format /api/param?camera.auto_exposure.priority=data Example /api/param?camera.auto_exposure.priority=quality Examp[...]

  • Page 26

    Interpretation Acquire B&W mode. "color", "bw", "autoL", "autoM" or "autoH" is returne d. Allowed users admin, operator, user Setting B&W Mode for VN-V686 Format /api/param?camera.image.true_daynight=data Example /api/param?camera.image.true_daynight=autoM Example of response camera.image.tr[...]

  • Page 27

    Allowed users admin, operator, user Setting Light for focus in B&W mod e for VN-V686 Format /api/param?camera.image.true_daynight.light=data Example /api/param?camera.image.true_daynight.af=infrared Example of response camera.image.true_daynight.light &202 Accepted(camera.status=save) Interpretation Change light setting for focus in B&W[...]

  • Page 28

    Setting Iris for VN-V686 Format /api/param?camera.iris=data Example to set fixed value /api/param?camera.iris=50 Example to set auto /api/param?camera.iris=autoM Example to change from auto to maual /api/param?camera.iris=manual Example of response camera.iris &202 Accepted(camera(num).status=save or camera.motion.auto_pan.image=save) Interpret[...]

  • Page 29

    Interpretation Acquire white balance setting. "autoW" , "autoN" or "manual" is returned. Allowed users admin, operator, user Setting White Balance for VN-V686 Format /api/param?camera.image.white_balance=data Example /api/param?camera.image.white_balance=autoW Example of response camera.image.white_balance &202 Acc[...]

  • Page 30

    Interpretation Acquire B-gain of white balance setting. s0 to s255 is returne d. The s before number means "step". Allowed users admin, operator, user Setting B-Gain of White Balance for VN -V686 Format /api/param?camera.image.white_balance.b=data Example of response camera.image.white_balance.b &202 Accepted(camera.status=save) Inter[...]

  • Page 31

    Example of response camera.image.blc=off&200 OK Interpretation Acquire Back Light Compensation setting. "off", "a", "b", "c" or "d" is returned. Refer the instruction manual for detailed information of "a", "b", "c" and "d". Allowed users admin, operator, [...]

  • Page 32

    Example /api/param?encode(1).framesize=qvga Example of response encode(1).framesize& 202 Accepted(encode(1).status=save) Interpretation Change JPEG frame size. Specify "vga" or "qvga". File size setting is changed automatically when frame size is changed. If frame size is changed from vga to qvga, file size is changed to thi[...]

  • Page 33

    Example of response encode(1).quality& 202 Accepted(encode(1).status=save) Interpretation Change the file size setting of JPEG. The unit of set va lues is in KB. VN-V686 will perform rate control with this file size as the target. When frame size is VGA, setting between the range of 10k to 100k is possible. When frame size is QVGA, se tting bet[...]

  • Page 34

    Getting MPEG-4 bitrate Setting from VN-V686 Format /api/param?encode(2).bitrate Example of response encode(2).bitrate=8000000&200 OK Interpretation Acquire the bitrate setting of MPEG-4. If the response is 8000000 for exa mple, the setting is 8Mbps. Allowed users admin, operator, user Setting MPEG-4 bitrate Setting for VN-V686 Format /api/param[...]

  • Page 35

    Interpretation Acquire frame rate of MPEG-4 encoding. Allowed users admin, operator, user Setting MPEG-4 Frame Rate Setting for VN-V686 Format /api/param?encode(2).framerate=data Example /api/param?encode(2).framerate=30 Example of response encode(2).framerate& 202 Accepted(encode(2).status=save) Interpretation Change frame rate of MPEG-4. Spec[...]

  • Page 36

    Setting MPEG-4 Priority Setting for VN -V686 Format /api/param?encode(2).priority=data Example /api/param?encode(2).priority=motion Example of response encode(2).priority& 202 Accepted(encode(2).status=save) Interpretation Change priority of MPEG-4. Specify "motion" or "quality". To keep fra me rate, select "motion"[...]

  • Page 37

    Allowed users admin, operator Getting Alarm Action from VN-V686 Format /api/param?application.event(Number).action Example When Getting action of alarm action No. 1 /api/param?application.event(1).action Example of Response application.event(1).action=mailto/somebody@somecompany.com/none/Message&200 OK Interpretation Acquire the alarm action of[...]

  • Page 38

    application.event(1).action=udpto/10.0.0.100/20000/Message&200 OK When alarm output is specified, pinout, distinction between make/break (m1 or b1) and output time (millise cond) will be returned. Segments are indicated by /. Example of Response application.event(1).action=pinout/m1/1500&200 OK When preset position is specified, position nu[...]

  • Page 39

    Specify mailto, mail address, JPEG attach and the character string to be sent when sending via mail. Segments are indicated by /. The maximum number of characters for the mail address is 95. To attach JPEG, specify obje ct01. If none is specified instead of object01, JPEG is not attached to the mail. Number of the character string is from 1 to 127 [...]

  • Page 40

    Specify pinout, distinction between make/break (m1 or b1) and the time (millisec ond) when alarm output is specified. Segments are indicated by /. The time is 0 or from 100 to 5000. When the time is 0, alarm output doe s not come back to previous state. Setting Example /api/param?application.event(1).action=pinout/m1/1500 Specify preset position nu[...]

  • Page 41

    Example of Response application.event(1).filter(sunday).status&202 Accepted(application.event(1).status=restart) Interpretation Set filter setting of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be se t between the r[...]

  • Page 42

    time can be from 000001 to 240000. Start time must be earlier than end time. The changes to filter of alarm action is saved by /api/param?application.eve nt(Number).status=restart. Allowed users admin, operator Getting Alarm Filter Type from VN-V686 Format /api/param?application.event(Number).filter(WeekOfDay).type Example When Getting Type of Sund[...]

  • Page 43

    Example When Getting Trigger of Alarm No. 1 /api/param?application.event(1).trigger Example of Response application.event(1).trigger=m1&200 OK Interpretation Acquire Trigger of the alarm action for the specified a larm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(numbe[...]

  • Page 44

    specify m1 in the case of Make for alarm input 1. specify b1 in the case of Break for alarm input 1. specify m2 in the case of Make for alarm input 2. specify b2 in the case of Break for alarm input 2. specify v1 for motion detection of video. specify ncbws for IR Filter OFF. specify ncbwe for IR Filter ON. specify efans for fan stop. specify camer[...]

  • Page 45

    Interpretation Change the address setting of the SMTP server. Specify the IP address or FQDN. The maximum FQDN size is 63 bytes. Specify as 0.0.0.0 when the SMTP server is not set. It is also possible to leave the setting fie ld blank as follows. /api/param?application.smtp.host=%00 Allowed users admin, operator Getting SMTP Server Port Number Sett[...]

  • Page 46

    Allowed users admin, operator Getting "POP before SMTP" Setting from VN-V686 Format /api/param?application.smtp.type Example of Response application.smtp.type=pbs&200 OK Interpretation Acquire the "POP before SMTP" setting. "simple" is returned when this is set to off. "pbs" is returned when this is set t[...]

  • Page 47

    Interpretation Acquire the port number setting of the POP server. Allowed users admin, operator, user Setting POP Server Port Number for VN -V686 Format /api/param?application.pop.port=data Example /api/param?application.pop.port=110 Example of Response application.pop.port&200 OK Interpretation Change the port number setting of the POP server.[...]

  • Page 48

    Setting POP Server Password for VN-V686 Format /api/param?application.pop.password=data Example /api/param?application.pop.password=someword Example of Response application.pop.password&200 OK Interpretation Change the password setting of the POP server. The ma ximum password size is 32 bytes. Set as follows when this is to be left blank. /api/[...]

  • Page 49

    Interpretation Change the FTP server directory setting used for FTP transmission. It is possible to set FTP transmission to a directory under the FTP server home directory by specifying that directory na me. Use %2F to segment the directory. ("2F" is ASCII code of "/".) The maximum directory name size is 63 byte s. Example /api/[...]

  • Page 50

    Example of Response application.ftp.naming=default&200 OK Interpretation Acquire file naming of periodic FTP. "default" , "type1" or "type2" is returned. When default is set, the file name is as YYYYMMDDHHMMSS-NNN-2.jpg. Example 20060207201315-001-2.jpg When type1 is set, the file name is as ***YYYMMDDHHMMSSNNN.jpg[...]

  • Page 51

    File Name Example Camera.jpg Allowed users admin, operator Setting User Define Name of File Nami ng for VN-V686 Format /api/param?application.ftp.naming_option=data Example of Response application.ftp.naming_option&200 OK Interpretation Change user define name for file naming of periodic FTP. The maximum size is 16 bytes. When /api/param?applic[...]

  • Page 52

    For Post Duration /api/param?application.object.postrec&200 OK Interpretation Change parameters for PrePost + ftp. These parameters a re used when recftp is set as an alarm action. Specify 30, 15, 10, 7.5, 6, 5, 3, 2, or 1 for frame rate. Maximum Pre/Post duration is 60 seconds. Setting zero to Pre and Post duration is invalid. Allowed users ad[...]

  • Page 53

    Allowed users admin, operator 6.6. PTZ The APIs below are related to pan/tilt/zoom control. These are equivalent to the features on the PTZ page of the WEB setting page and PTZ Controller of built-in viewer. Refer to the instruction manual for details on the PTZ page and PTZ Controller. (1) Settings for PTZ Control Getting Auto Return Mode from VN-[...]

  • Page 54

    Accepted(camera.status=save) Interpretation Change timeout of Auto Return in seconds. Specify 60, 120, 180, 300, 600, 1200, 1800 or 3600. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator Getting Auto Return Status from VN-V6 86 Format /api/param?camera.m[...]

  • Page 55

    Allowed users admin, operator Specify target for Intelligent Track ing for VN-V686 Format /api/param?camera.motion.auto_tracking(2).target=sx-sy /api/param?camera.motion.auto_tracking(2).target=sx-sy-R-G-B Example to specify position (10, 20) /api/param?camera.motion.auto_tracking(2).target=s10-s20 Example to specify position (10, 20) and color (2 [...]

  • Page 56

    /api/param?camera.motion.auto_tracking(2).restarttime Example of response camera.motion.auto_tracking(1).restarttime=10&200 OK Interpretation Acquire restart time of Auto Tracking or Intelligent tracking in se conds. In case of Auto tracking, if there is no motion, the camera goes to home position after the restart time, and restarts Auto Tra c[...]

  • Page 57

    Getting Tracking Zoom setting of Intelligent Tracking from VN-V686 Format /api/param?camera.motion.auto_tracking(2).zoom Example of response camera.motion.auto_tracking(2).zoom=on&200 OK Interpretation Acquire tracking zoom setting of Intelligent Tra cking. When it is on, Intelligent tracking changes zoom position automatically. When it is off,[...]

  • Page 58

    Interpretation Acquire maximum zoom of Intelligent Tracking. Zoom limit c an not be bigger than maximum zoom. Value from 1.00 to 21.37 is returned. Allowed users admin, operator, user Setting Maximum Zoom of Intelligent Tracking for VN-V686 Format /api/param?camera.motion.auto_tracking(2).max_zoom=data Example of Response camera.motion.auto_trackin[...]

  • Page 59

    current resolution is QVGA. Allowed users admin, operator, user Setting Dead Zone of Intelligent Tracking for VN-V686 Format /api/param?camera.motion.auto_tracking(2).dead_zone=data Example of Response camera.motion.auto_tracking(2).dead_zone&202 Accepted(camera.status=save) Interpretation Change dead zone of Intelligent Tracking. Motion smalle[...]

  • Page 60

    Accepted(camera.status=save) Interpretation Change On/Off of Pan Limit. Specify "on" or "off" . The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot. Allowed users admin, operator Getting Left Side of Pan Limit from VN-V6 86 Format /api/param?camera.motion.pan.limit.le[...]

  • Page 61

    Getting Tilt Limit from VN-V686 Format /api/param?camera.motion.tilt.limit.upper Example of response camera.motion.tilt.limit.upper=5&200 OK Interpretation Acquire Tilt Limit in degrees. Allowed users admin, operator, user Setting Tilt Limit for VN-V686 Format /api/param?camera.motion.tilt.limit.upper=data Example to set horizontal /api/param?c[...]

  • Page 62

    off : Auto Flip function does not activate. full_digital : This is Digital Flip on Web page. The top/bottom and left/right of the image flips when the object has passed the bottom of the camera, at the position of 135 degrees. half : Thi is Mode1 on Web page. When the camera faces bottom, it rotates 180 degrees horizontally a nd stops. In this case[...]

  • Page 63

    Moving to Specified Pan Posi tion for VN-V686 Format /api/param?camera.motion.pan=data Example to move to absolute 90 degrees /api/param?camera.motion.pan=90.00 Example to move to relative 45 degrees /api/param?camera.motion.pan=+45.00 Example of Response camera.motion.pan&200 OK Interpretation Move to specified pan position. To move to absolut[...]

  • Page 64

    Format /api/param?camera.motion.variable_pantiltspeed.status Example of Response camera.motion.variable_pantiltspeed.status=on&200 OK Interpretation Acquire current setting of variable pan/tilt speed. "on" or "off" is returned. Allowed users admin, operator, user Setting Status of Variable Pan/Tilt Speed for VN-V686 Format /[...]

  • Page 65

    Setting Direction of Tilt Operati on for VN-V686 Format /api/param?camera.motion.tilt.mode=data Example to set to up /api/param?camera.motion.tilt.mode=up Example of Response camera.motion.tilt.mode&200 OK Interpretation Set direction of tilt operation. Specify up or down. Allowed users admin, operator Setting Speed of Tilt Operati on for VN-V6[...]

  • Page 66

    means Wide edge and 99.99 means Tele edge. Allowed users admin, operator Zoom Operation for VN-V686 Format /api/param?camera.motion.zoom.status=data Example to start zoom /api/param?camera.motion.zoom.status=start Example of Response camera.motion.zoom.status&200 OK Interpretation Start or stop zoom operation. Specify start or stop. Allowed use[...]

  • Page 67

    zoom is Tele edge, focus can be from 0.00 to about 78. When focus is set to auto, easy_auto is returned. Allowed users admin, operator, user Moving to Specified Focus Pos ition for VN-V686 Format /api/param?camera.focus=data Example to move to absolute 50.00 /api/param?camera.focus=50.00 Example to move to relative 5 Near /api/param?camera.focus=+5[...]

  • Page 68

    Interpretation Set speed of focus operation. Specify 0 to 100. The spee d is 4 steps internally. Allowed users admin, operator (3) Preset Position Getting Current Preset Position from VN-V686 Format /api/param?camera.status Example of response camera.status=3&200 OK Interpretation Acquire current preset position after moving to preset position.[...]

  • Page 69

    Moving to Preset Position for VN-V6 86 Format /api/param?camera.position(number).status=goto Example of Response camera.position(3).status&200 OK Interpretation Move to specified preset position. Specify from 0 to 99 as position number. Allowed users admin, operator Getting Title of Preset Position from VN-V686 Format /api/param?camera.position[...]

  • Page 70

    Example of Response camera.motion.auto_pan.status&200 OK Interpretation Start/stop auto pan. Specify start, stop, goto_start or goto_end. Allowed users admin, operator Getting Direction of Auto Pan from VN-V6 86 Format /api/param?camera.motion.auto_pan.mode Example of response camera.motion.auto_pan.mode=left&200 OK Interpretation Acquire d[...]

  • Page 71

    Interpretation Set current position as start position of auto pan. Pan/tilt/z oom/focus positions are saved. Caution: Though Moving to tilt position over 90 degrees is possible when auto flip mode is digital flip, select tilt position under 90 degrees as start position of auto pan. Allowed users admin, operator Setting Current Position as En d Posi[...]

  • Page 72

    seconds, and limited number of commands can be recorded. When the duration or command number is over, error response is returned to pan/tilt/zoom/focus command as below. 206 Partial Content, auto_trace(timeout) 206 Partial Content, auto_trace(memoryfull) If stop is specified after those limitations, "206 Partial Content" is returned. Afte[...]

  • Page 73

    Allowed users admin, operator, user Getting Preset Postion Number of Auto Patrol from VN-V686 Format /api/param?camera.motion.auto_patrol(number1).position(number2) Example to get preset position number of pa trol nuber 3 in mode 1 /api/param?camera.motion.auto_patrol(0).position(3) Example of response camera.motion.auto_patrol(0).position(3)=5&[...]

  • Page 74

    is saved by the API, camera.motion.auto_patrol.status=save. If the change is not saved, the se tting is restored by reboot. Allowed users admin, operator Saving Preset Position Number/Duarion of Auto Patrol for VN-V686 Format /api/param?camera.motion.auto_patrol(number).status=save Example of Response camera.motion.auto_patrol(0).status&202 Acc[...]

  • Page 75

    number. Allowed users admin, operator, user Setting Status of a Privacy Masking Area for VN-V686 Format /api/param?camera.private_mask.area(number).status=data Example of Response camera.private_mask.area(number).status&202 Accepted(camera.status=save) Interpretation Change each status of privacy masking area. Specify from 0 to 7 a s area numbe[...]

  • Page 76

    "clear" or "exit". When editing is started, zoom is changed to Wide edge, and pan/tilt positions a re restored if the privacy masking area has settings. Pan/tilt position of the privacy masking area can be cha nged by pan/tilt APIs. Allowed users admin, operator Setting Width of Privacy Masking A rea for VN-V686 Format /api/para[...]

  • Page 77

    Caution: Motion detect does not work during auto tracking. Allowed users admin, operator Getting Motion Detect Sensitivity fro m VN-V686 Format /api/param?camera.detection.level Example of response camera.detection.level=20&200 OK Interpretation Acquire the motion detect sensitivity. A value between 0 to 100 will be returned. The larger the val[...]

  • Page 78

    Example /api/param?camera.detection.area=000102030405060708090001 Example of response camera .detection.area&202 Accepted(camera.status=save) Interpretation Change the motion detect mask. Specify using a 24 ASCII character string. Refer to the item on "Getting Motion Detect Mask from VN-V686" on the interpretation of this character st[...]

  • Page 79

    Getting IP Address from VN-V686 Format /api/param?network.interface.ip Example of Response network.interface.ip=192.168.0.2&200 OK Interpretation Acquire the current IP address. Allowed users admin, operator, user Setting IP Address for VN-V686 Format /api/param?network.interface.ip=data Example /api/param?network.interface.ip=192.168.0.2 Examp[...]

  • Page 80

    Interpretation Acquire the current default gateway. Allowed users admin, operator, user Setting Default Gateway for VN-V686 Format /api/param?network.gateway=data Example /api/param?network.gateway=192.168.0.254 Example of Response network.gateway&200 OK Interpretation Change the default gateway. To set static default ga teway, disable DHCP. De[...]

  • Page 81

    Example /api/param?network.dns.status=on Example of Response network.dns.status&200 OK Interpretation Change status of DNS server setting, or validate changes to DNS server se ttings. Specify "on", "off" or "restart". Changes of DNS server settings become valid by "restart". Allowed users admin, operator [...]

  • Page 82

    Allowed users admin, operator, user Setting TOS Value of JPEG for VN-V68 6 Format /api/param?network.interface.dscp.video.jpeg=data Example /api/param?network.interface.dscp.video.jpeg=56 Example of Response network.interface.dscp.video.jpeg&202 Accepted(network.interface.status=restart) Interpretation Change TOS that includes DHCP field for JP[...]

  • Page 83

    Example /api/param?network.interface.ttl.unicast=56 Example of Response network.interface.ttl.unicast&202 Accepted(network.interface.status=restart) Interpretation Change TTL of unicast. The range of set value is betwe en 1 to 255. To validate the change, use "network.interface.status=restart" API. Allowed user admin Getting Multicast[...]

  • Page 84

    Allowed user admin Getting Network Negotiation Setti ng from VN-V686 Format /api/param?network.interface.negotiation Example of Response network.interface.negotiation=auto&200 OK Interpretation Acquire the network Negotiation setting. Eithe r auto, 100full, 100half, 10full or 10half will be returned. Allowed users admin, operator, user Setting [...]

  • Page 85

    Allowed users admin, operator 6.13. Multicast Streaming The APIs below are related to manual streaming. These are equivalent to the features on the S treaming page of the WEB setting page. Refer to the instruction manual for details on the Streaming pa ge. Getting Status of JPEG Multicast Str eaming from VN-V686 Format /api/param?network.destinatio[...]

  • Page 86

    "network.destination(1).host=start" API. Allowed user admin Getting JPEG Multicast Port Numb er from VN-V686 Format /api/param?network.destination(1).port Example of Response network.destination(1).port=49152&200 OK Interpretation Acquire JPEG multicast port number. Allowed users admin, operator Setting JPEG Multicast Port Number for [...]

  • Page 87

    Format /api/param?network.destination(2).status Example of Response network.destination(2).status=off&200 OK Interpretation Acquire status of MPEG-4 multicast streaming. Either on or off will be returned. Allowed users admin, operator Setting Status of MPEG-4 Multicast Streaming, or Save Changes for VN- V686 Format /api/param?network.destinatio[...]

  • Page 88

    Allowed users admin, operator Setting MPEG-4 Multicast Port Number for VN-V686 Format /api/param?network.destination(1).port=data Example /api/param?network.destination(1).port=59152 Example of Response network.destination(1).port&202 Accepted(network.destination(1).host=save) Interpretation Change MPEG-4 multicast port number. Specify from 2 t[...]

  • Page 89

    Interpretation Acquire the IP address setting of the restricted client. Setting is possible up to 10 items. Specify a value between 1 to 10 for the number. The following will be returned if subnet mask was specified. Example of Response 2 network.access_control(stream_out).host(1)=10.0.0.0/24&200 OK The above example indicates that the range is[...]

  • Page 90

    Example /api/param?network.ntp.status=on Example of Response network.ntp.status&200 OK Interpretation Change the on/off status of SNTP client, or validate c hanges to settings. Specify "on", "off" or "restart". as on or off. IP address of NTP server and access interval are validated by "restart". Allowed [...]

  • Page 91

    Getting Access Interval Unit of NT P from VN-V686 Format /api/param?network.ntp.unit Example of Response network.ntp.unit=hour&200 OK Interpretation Acquire the unit of interval for accessing the NTP server. "min", "hour" or "day" is returned. Allowed users admin, operator, user Setting Access Interval Unit of SNTP[...]

  • Page 92

    Timezone Character String Description GMT-12 Timezone that is 12 hours earlier than the Greenwich Mean Time . GMT-11 Timezone that is 11 hours earlier than the Greenwich Mean Time . GMT-10 Timezone that is 10 hours earlier than the Greenwich Mean Time . Hawaii Same timezone as GMT-10 GMT-9:30 Timezone that is 9 hours and 30 minutes earlier than the[...]

  • Page 93

    GMT+8:45 Timezone that is 8 hours and 45 minutes later than the Greenwich Mean Time. GMT+9 Timezone that is 9 hours later than the Greenwich Mean Time . GMT+9:30 Timezone that is 9 hours and 30 minutes later than the Greenwich Mean Time. Japan Same timezone as GMT+9. GMT+10 Timezone that is 10 hours later than the Greenwich Mean Time . GMT+10:30 Ti[...]

  • Page 94

    6.17. Maintenance The APIs below are related to maintenance. These are equivalent to the fea tures on the Maintenance page of the WEB setting page. Refer to the instruction manual for details on the Maintenance page. Initialization Format /api/param?system.status=initialize Example of Response system.status&200 OK Interpretation Restore all VN-[...]

  • Page 95

    Allowed users admin, operator, user Setting Time of Auto Cleaning for VN-V686 Format /api/param?camera.motion.pan.auto_cleaning.time=data Example of Response camera.motion.pan.auto_cleaning.time &202 Accepted(camera.status=save) Interpretation Change time of auto cleaning. Specify time in forma t of hhmmss. To save the change, use "camera.[...]

  • Page 96

    system.session.sending(01).from.framesize=vga&200 OK In case of MPEG-4, system.session.sending(01).from.encode=mpeg4 is returned. In case of multicast, system.session.sending(01).to.ip becomes multicast IP address. Interpretation Acquire the sending status of VN-V686. Starting and stopping stre am can be occurred in random order, so it can happ[...]

  • Page 97

    Example of Response system.software.revision(net)=V1-00&200 OK Interpretation Acquire firmware revisions of streaming manager. Allowed users admin, operator, user Getting Firmware Revisions of PTZ C ontroller Format /api/param?system.software.revision(sys) Example of Response system.software.revision(sys)=V1-00&200 OK Interpretation Acquire[...]

  • Page 98

    returned. Allowed users admin, operator, user Getting Mode of FTP Server from VN-V686 Format /api/param?application.ftp.mode Example of Response application.ftp.mode=active&200 OK Interpretation Acquire the mode of FTP server that is used by ala rm action. Either active or passive is returned. active mode: Standard mode of FTP server. Also call[...]

  • Page 99

    number for data plus one is the port number for control. Allowed user admin, operator 7. List of Protocols and Po rt Numbers Used with VN-V686 VN-V686 uses the following protocols and port numbers. Protocol / Port Number Use TCP 80 WEB setting page, API for Getting status and changing settings, acquisition of JPEG from VN-V686 by client UDP 80 Sear[...]

  • Page 100

    - TimeFormat Set from 0 to 6 to select time format 0: YYYY/MM/DD HH:MM:SS.mm 1: YYYY/MM/DD HH:MM:SS 2: DD/MM/YYYY HH:MM:SS 3: MM/DD/YYYY HH:MM:SS 4: MM/DD HH:MM:SS 5: HH:MM:SS 6: HH:MM - DispMotion Set 1 to display motion detect (MPEG-4 viewer does not have this property.) - FolderName Folder name to save JPEG. The folder is created under MyDocumen[...]

  • Page 101

    <PARAM NAME="DispHeig ht" VALUE="240"> <PARAM NAME="Fra meRate" VALUE="15"> <PARAM NAME="Ve rsion2" VALUE="1"> </OBJECT> (2) Getting Multicast Execute Play method after setting properties below. <OBJECT ID="JPEGVi ewer" WIDTH = 640 HEIGHT= 480 CLASSID=&[...]

  • Page 102

    if(obj.value== " Play "){ obj.value="Pause"; JPEGViewer.Se tStill(0); }else{ obj.value=" Pla y "; JPEGViewer.Se tStill(1); } } </SCRIPT> <BODY STYLE="font-f amily:sans-serif;" onBeforeUnload="stop_clic k()" onload="p lay_click()"> <font size="6"> SAMPLE TEXT <[...]

  • Page 103

    VNviewcnt1.Play 8.4. HTML Example for MPEG-4 viewer (1) Getting MPEG-4 at display size QVGA Execute Play method after setting properties below. <OBJECT ID="MPEG4Vi ewer" WIDTH = 320 HEIGHT= 240 CLASSID="CLSID:062 774CF-C5DB-4683-909F-9B1AB 013CF35" CODEBASE="./v686m.ca b#version=2,0,0,8"> <PARAM NAME="IP [...]

  • Page 104

    <!DOCTYPE HTML PU BLIC "-//W3C//DTD HTM L4.0 Transitional//EN"> <HTML><HEAD> <META http-equiv="Co ntent-Type" content="text/ht ml;charset=ISO-8859-1"> <TITLE></TITLE> </HEAD> <SCRIPT LANGUAGE=J AVASCRIPT> function stop_clic k() { MPEG4Viewer.Sto p(); } function play_click[...]

  • Page 105

    <form name="myForm"> <table><tr><td> <INPUT TYPE="BUTTON" NAME="still_btn" VALUE="Pause" onclick=" still_click(t his)"></td><td> </tr></table> </form></BODY></HTML> 8.5. Notes - Enable the JPEG/MPEG-4 frame size that you want in[...]