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
