42
5. API for Acquiring/Changing Parameters of VN-E4 _
5.7. Serial Port
Acquiring Serial Port Comment from VN-E4
Format
/api/param?peripheral.serial(Number).comment
Example
When acquiring comment of Serial Port 1
/api/param?peripheral.serial(1).comment
Example of response
peripheral.serial(1).comment=serial1&200 OK
Interpretation
Acquire comment of the serial port. Specify a value between 1 to 2 since VN-E4 comes with 2 serial ports. The
value returned will be a character string of 40 bytes or less. This comment setting is optional and does not
affect the functions of the serial port.
Allowed users
admin, operator, user
Setting Serial Port Comment for VN-E4
Format
/api/param?peripheral.serial(Number).comment=data
Example
When setting comment of Serial Port 1
/api/param?peripheral.serial(1).comment=Memo1
Example of response
peripheral.serial(1).comment&200 OK
Interpretation
Change the serial port comment. Specify a value between 1 to 2 since VN-E4 comes with 2 serial ports.
Specify comment using a character string of 40 bytes or less. Specify as follows when the comment setting is
to be left blank.
Example when
comment is left blank
/api/param?peripheral.serial(1).comment=%00
This comment setting is optional and does not affect the functions of the serial port.
Allowed users
admin, operator
