40
5. API for Acquiring/Changing Parameters of VN-E4 _
5.7. Serial Port
The APIs below are related to the serial port. These are equivalent to the features on the Serial Port page of the WEB setting page. However,
specification of control device and camera address are not supported by API. Refer to the instruction manual for details on the Serial Port
page.
Acquiring Serial Port Baud Rate Setting from VN-E4
Format
/api/param?peripheral.serial(Number).baud
Example
When acquiring baud rate of Serial Port 1
/api/param?peripheral.serial(1).baud
Example of response
peripheral.serial(1).baud=9600&200 OK
Interpretation
Acquire the serial port's baud rate. Specify a value between 1 to 2 since VN-E4 comes with 2 serial ports.
Value returned will be 1200, 1800, 2400, 4800, 9600, 19200 or 38400.
Allowed users
admin, operator, user
Setting Serial Port Baud Rate for VN-E4
Format
/api/param?peripheral.serial(Number).baud=data
Example
When setting the baud rate of Serial Port 1
/api/param?peripheral.serial(1).baud=19200
Example of response
peripheral.serial(1).baud&200 OK
Interpretation
Change the serial port's baud rate. Specify a value between 1 to 2 since VN-E4 comes with 2 serial ports.
Specify baud rate as 1200, 1800, 2400, 4800, 9600, 19200 or 38400.
Allowed users
admin, operator
Acquiring Serial Port Data Length Setting from VN-E4
Format
/api/param?peripheral.serial(Number).bit
Example
When acquiring data length of Serial Port 1
/api/param?peripheral.serial(1).bit
Example of response
peripheral.serial(1).bit=8&200 OK
Interpretation
Acquire the serial port's data length. Specify a value between 1 to 2 since VN-E4 comes with 2 serial ports.
Value returned will be 7 or 8.
Allowed users
admin, operator, user
Setting Serial Port Data Length for VN-E4
Format
/api/param?peripheral.serial(Number).bit=data
Example
When setting the data length of Serial Port 1
/api/param?peripheral.serial(1).bit=8
Example of response
peripheral.serial(1).bit&200 OK
Interpretation
Change the serial port's data length. Specify a value between 1 to 2 since VN-E4 comes with 2 serial ports.
Specify data length as 7 or 8.
Allowed users
admin, operator
5.7. Serial Port