JVC VN-E4U API Guide - Page 72

(3) Iris Control, API Character String, Example, Example of Response, Interpretation, Allowed users

Page 72 highlights

8. API for Controlling External Devices Connected to VN-E4 _ 8.1. Control of Pelco-D Camera (3) Iris Control API Character String Example Example of Response Interpretation Allowed users /api/param?peripheral.serial(Number).device(Address).camera.iris=Data1 Below is an example that opens the iris of a camera with an address of 123 that is connected to serial port number 2. /api/param?peripheral.serial(2).device(123).camera.iris=+ peripheral.serial(2).device(123).camera.iris&200 OK Send the iris 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 iris as + or -. Use + to open and - to close the iris. Operation will be executed stepwise upon using the command once and there is no need to stop the operation. admin, operator, user (4) Focus Control API Character String /api/param?peripheral.serial(Number).device(Address).camera.focus=Data1 Example Below is an example that sets the focus to a distant point for the camera with an address of 123 that is connected to serial port number 2. /api/param?peripheral.serial(2).device(123).camera.focus=+ Example of Response peripheral.serial(2).device(123).camera.focus&200 OK Interpretation Send the focus 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 focus as +, -, manual or auto. Use + to focus to a distant point, - to a near point, manual to cancel auto focus, and auto to turn on auto focus. Operation will be executed stepwise upon using the command once and there is no need to stop the operation. Allowed users admin, operator, user (5) Zoom Control API Character String /api/param?peripheral.serial(Number).device(Address).camera.motion.zoom. mode=Data1&peripheral.serial(Number).device(Address).camera.motion.zoom.s tatus=Data2 Example Below is an example that sets the zoom to the tele end for the camera with an address of 123 that is connected to serial port number 2. /api/param?peripheral.serial(2).device(123).camera.motion.zoom.mode=in& peripheral.serial(2).device(123).camera.motion.zoom.status=start Example of Response peripheral.serial(2).device(123).camera.motion.zoom.mode&200 OK&peripheral.serial(2).device(123).camera.motion.zoom.status&200 OK Interpretation Send the zoom 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 in or out. Use in to set to the tele end and out to the wide end. 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.zoom.status=stop Allowed users admin, operator, user 72

  • 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

72
8. API for Controlling External Devices Connected to VN-E4 _
8.1. Control of Pelco-D Camera
(3) Iris Control
API Character String
/api/param?peripheral.serial(Number).device(Address).camera.iris=Data1
Example
Below is an example that opens the iris of a camera with an address of 123 that is connected to serial port
number 2.
/api/param?peripheral.serial(2).device(123).camera.iris=+
Example of Response
peripheral.serial(2).device(123).camera.iris&200 OK
Interpretation
Send the iris 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 iris as + or -. Use + to open and - to close the iris.
Operation will be executed stepwise upon using the command once and there is no need to stop the operation.
Allowed users
admin, operator, user
(4) Focus Control
API Character String
/api/param?peripheral.serial(Number).device(Address).camera.focus=Data1
Example
Below is an example that sets the focus to a distant point for the camera with an address of 123 that is
connected to serial port number 2.
/api/param?peripheral.serial(2).device(123).camera.focus=+
Example of Response
peripheral.serial(2).device(123).camera.focus&200 OK
Interpretation
Send the focus 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 focus as +, -, manual or auto. Use + to focus
to a distant point, - to a near point, manual to cancel auto focus, and auto to turn on auto focus. Operation will
be executed stepwise upon using the command once and there is no need to stop the operation.
Allowed users
admin, operator, user
(5) Zoom Control
API Character String
/api/param?peripheral.serial(Number).device(Address).camera.motion.zoom.
mode=Data1&peripheral.serial(Number).device(Address).camera.motion.zoom.s
tatus=Data2
Example
Below is an example that sets the zoom to the tele end for the camera with an address of 123 that is connected
to serial port number 2.
/api/param?peripheral.serial(2).device(123).camera.motion.zoom.mode=in&
peripheral.serial(2).device(123).camera.motion.zoom.status=start
Example of Response
peripheral.serial(2).device(123).camera.motion.zoom.mode&200
OK&peripheral.serial(2).device(123).camera.motion.zoom.status&200 OK
Interpretation
Send the zoom 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 in or out. Use in to set to the
tele end and out to the wide end. 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.zoom.status=stop
Allowed users
admin, operator, user