beautypg.com

On 1.7.5, Rename a user – Kramer Electronics VP-790 User Manual

Page 13

background image

VP-790 Protocol –

Communication

9

Direction

RS232 data

PC sends command

53 41 50 01 FF FF FF FF

00 00 00 20

00 00 00 00

54 50 01 00 00 00 00 00

00 00 00 10

00 00 00 00

50 46

01 3E

00 00 00 00

00 00 00 04

00 00 00 08

Board acknowledges to have received

a command

73 61 50 01 FF FF FF FF 00 00 00 00 00 00 00 00

Board sends answer (return values)

53 41 50 01 FF FF FF FF

00 00 00 1D

00 00 00 00

74 50 01 00 00 00 00 00

00 00 00 0D

00 00 00 00

70 46

01 3E

00 00 00 00

00 00 00 01

00

PC acknowledges to have received an

answer

73 61 50 01 FF FF FF FF 00 00 00 00 00 00 00 00

Direction

TCP/IP data

PC sends command

54 50 01 00 00 00 00 00

00 00 00 10

00 00 00 00

50 46

01 3E

00 00 00 00

00 00 00 04

00 00 00 08

Board acknowledges to have received

a command

None

Board sends answer (return values)

74 50 01 00 00 00 00 00

00 00 00 0D

00 00 00 00

70 46

01 3E

00 00 00 00 00 00 00 01

00

PC acknowledges to have received an

answer

None

1.7.5

131B

Rename a User

The API byOSDUserRenameSet is used to change the user name for a certain user
number.

The API Index is decimal 2953, i.e. hexadecimal

0x0B 89

. We want to give the

second user the new name “SURGEON 1”. The user number is of type UWORD32
with length 4 bytes. The range starts at 0, thus user 2 is

0x00 00 00 01.

The name

is of CHAR[] type, an array of UTF-8 codes (equals ASCII for the first 128
characters) preceded by its length sent as UWORD32. The UTF-8 codes of
“SURGEON 1” are

“0x53 55 52 47 45 4F 4E 20 31”

and the string is followed by

the null termination

“0x00”

. The length of the string is 10 bytes, i.e.

0x00 00 00 0A

.

The total number of data bytes are 18 = 0x12 bytes which is the data payload. The
payload of the data package is 18 + 12 bytes = 0x1E bytes. The payload of data
package and application header is 30 + 16 = 0x2E bytes.

The order in which the parameters are transmitted are given by the order in the
table describing the API, i.e. user number first, name second.

The return value(s) of this API function is the error code of BYTE type.

0x00

means

no error occurred.