JVC VN-E4U API Guide - Page 71

Control of Pelco-D Camera, (1) Pan Control, (2) Tilt Control

Page 71 highlights

8. API for Controlling External Devices Connected to VN-E4 _ 8.1. Control of Pelco-D Camera This section describes APIs for controlling external devices that are connected to the serial port of VN-E4. Make use of the APIs explained in this section in the way as mentioned in Section 4. 8.1. Control of Pelco-D Camera This is an API for controlling cameras that support Pelco-D protocols. (1) Pan Control API Character String Example Example of Response Interpretation Allowed users /api/param?peripheral.serial(Number).device(Address).camera.motion.pan. mode=Data1&peripheral.serial(Number).device(Address).camera.motion.pan.sp eed=Data2&peripheral.serial(Number).device(Address).camera.motion.pan.sta tus=Data3 The format above specifies the pan direction (mode), pan speed (speed) and start/stop (status) at one time. It is also possible to set them separately over 3 times. Below is an example that indicates panning towards the left at speed 50 of a camera with an address of 123 that is connected to serial port number 2. /api/param?peripheral.serial(2).device(123).camera.motion.pan.mode=left& peripheral.serial(2).device(123).camera.motion.pan.speed=50&peripheral.se rial(2).device(123).camera.motion.pan.status=start peripheral.serial(2).device(123).camera.motion.pan.mode&200 OK&peripheral.serial(2).device(123).camera.motion.pan.speed&200 OK&peripheral.serial(2).device(123).camera.motion.pan.status&200 OK Send the pan command to the specified serial port and camera address. Specify the serial port as 1 or 2. Specify the camera address between the range of 0 to 255. Specify the mode as left or right. Specify the speed between the range of 0 to 100. Specify status as start or stop. To specify stop only, make use of the API as shown in the following example. /api/param?peripheral.serial(2).device(123).camera.motion.pan.status=stop admin, operator, user (2) Tilt Control API Character String Example Example of Response Interpretation Allowed users /api/param?peripheral.serial(Number).device(Address).camera.motion.tilt. mode=Data1&peripheral.serial(Number).device(Address).camera.motion.tilt.s peed=Data2&peripheral.serial(Number).device(Address).camera.motion.tilt.s tatus=Data3 The format above specifies the tilt direction (mode), tilt speed (speed) and start/stop (status) at one time. It is also possible to set them separately over 3 times. Below is an example that indicates upward tilting at speed 50 of a camera with an address of 123 that is connected to serial port number 2. /api/param?peripheral.serial(2).device(123).camera.motion.tilt.mode=up& peripheral.serial(2).device(123).camera.motion.tilt.speed=50&peripheral.s erial(2).device(123).camera.motion.tilt.status=start peripheral.serial(2).device(123).camera.motion.tilt.mode&200 OK&peripheral.serial(2).device(123).camera.motion.tilt.speed&200 OK&peripheral.serial(2).device(123).camera.motion.tilt.status&200 OK Send the tilt command to the specified serial port and camera address. Specify the serial port as 1 or 2. Specify the camera address between the range of 0 to 255. Specify the mode as up or down. Specify the speed between the range of 0 to 100. Specify status as start or stop. To specify stop only, make use of the API as shown in the following example. /api/param?peripheral.serial(2).device(123).camera.motion.tilt.status=stop admin, operator, user 71

  • 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

71
8. API for Controlling External Devices Connected to VN-E4 _
8.1. Control of Pelco-D Camera
This section describes APIs for controlling external devices that are connected to the serial port of VN-E4. Make use of the APIs explained in
this section in the way as mentioned in Section 4.
This is an API for controlling cameras that support Pelco-D protocols.
(1) Pan Control
API Character String
/api/param?peripheral.serial(Number).device(Address).camera.motion.pan.
mode=Data1&peripheral.serial(Number).device(Address).camera.motion.pan.sp
eed=Data2&peripheral.serial(Number).device(Address).camera.motion.pan.sta
tus=Data3
The format above specifies the pan direction (mode), pan speed (speed) and start/stop (status) at one time. It is
also possible to set them separately over 3 times.
Example
Below is an example that indicates panning towards the left at speed 50 of a camera with an address of 123 that
is connected to serial port number 2.
/api/param?peripheral.serial(2).device(123).camera.motion.pan.mode=left&
peripheral.serial(2).device(123).camera.motion.pan.speed=50&peripheral.se
rial(2).device(123).camera.motion.pan.status=start
Example of Response
peripheral.serial(2).device(123).camera.motion.pan.mode&200
OK&peripheral.serial(2).device(123).camera.motion.pan.speed&200
OK&peripheral.serial(2).device(123).camera.motion.pan.status&200 OK
Interpretation
Send the pan command to the specified serial port and camera address. Specify the serial port as 1 or 2. Specify
the camera address between the range of 0 to 255. Specify the mode as left or right. Specify the speed between
the range of 0 to 100. Specify status as start or stop. To specify stop only, make use of the API as shown in the
following example.
/api/param?peripheral.serial(2).device(123).camera.motion.pan.status=stop
Allowed users
admin, operator, user
(2) Tilt Control
API Character String
/api/param?peripheral.serial(Number).device(Address).camera.motion.tilt.
mode=Data1&peripheral.serial(Number).device(Address).camera.motion.tilt.s
peed=Data2&peripheral.serial(Number).device(Address).camera.motion.tilt.s
tatus=Data3
The format above specifies the tilt direction (mode), tilt speed (speed) and start/stop (status) at one time. It is
also possible to set them separately over 3 times.
Example
Below is an example that indicates upward tilting at speed 50 of a camera with an address of 123 that is
connected to serial port number 2.
/api/param?peripheral.serial(2).device(123).camera.motion.tilt.mode=up&
peripheral.serial(2).device(123).camera.motion.tilt.speed=50&peripheral.s
erial(2).device(123).camera.motion.tilt.status=start
Example of Response
peripheral.serial(2).device(123).camera.motion.tilt.mode&200
OK&peripheral.serial(2).device(123).camera.motion.tilt.speed&200
OK&peripheral.serial(2).device(123).camera.motion.tilt.status&200 OK
Interpretation
Send the tilt command to the specified serial port and camera address. Specify the serial port as 1 or 2. Specify
the camera address between the range of 0 to 255. Specify the mode as up or down. Specify the speed between
the range of 0 to 100. Specify status as start or stop. To specify stop only, make use of the API as shown in the
following example.
/api/param?peripheral.serial(2).device(123).camera.motion.tilt.status=stop
Allowed users
admin, operator, user
8.1. Control of Pelco-D Camera