Controls And Prefixes - Lightware VINX-120-HDMI-ENC User Manual


  
5. Programmers' Reference

5.3. Controls and Prefixes

5.3.1. Escaping
Property values and method parameters can contain characters that are used as control characters in the
protocol. They must be escaped. The escape character is the backslash ('\') and escaping means injecting
a backslash before the character that should be escaped (like in C language).
Control characters are the followings: \ { } # % ( ) \r \n \t
Example:
The original text: John●(Doe).●#3:●5%2=1●node1\node11
The escaped text: John●\(Doe\).●\#3:●5\%2=1●node1\\node11
5.3.2. Error Messages
There are several error messages defined in the LW3 protocol, all of them have a unique error number.
Format: XE●[primitive]●%EYYY:●[Error message]
Legend:
'X' can be:
'-': syntax error. Cannot parse the command at all.
'n': node error.
'p': property error.
'm': method error.
YYY: error code, which can be one of the followings:
YYY: error code
000 Lw3ErrorCodes_None
001 Lw3ErrorCodes_Syntax
002 Lw3ErrorCodes_NotFound
003 Lw3ErrorCodes_AlreadyExists
004 Lw3ErrorCodes_InvalidValue
005 Lw3ErrorCodes_IllegalParamCount
006 Lw3ErrorCodes_IllegalOperation
007 Lw3ErrorCodes_AccessDenied
008 Lw3ErrorCodes_Timeout
009 Lw3ErrorCodes_CommandTooLong
010 Lw3ErrorCodes_InternalError
011 Lw3ErrorCodes NotImplemented
Name Default text
Syntax error
Not found
Already exists
Invalid value
Illegal parameter count
Illegal operation
Access denied
Timeout
Command too long
Internal error
Not implemented
VINX-1x0-HDMI Extenders – User's Manual
5.3.3. Prefix Summary
The following prefixes are defined in the LW3 protocol:
'n-': a node,
'nE': an error for a node,
'nm': a manual for a node,
'pr': a read-only property,
'pw': read-write property,
'pE': an error for the property,
'pm': a manual for the property,
'm-': a method,
'mO': a response after a success method execution,
'mF': a response after a failed method execution,
'mE': an error for a method,
'mm': a manual for a method.
5.4. Tree Structure Examples
/ MANAGEMENT
SYS
EDID
MEDIA
DISCOVERY
The LW3 Protocol Tree of the Encoder (left) and the Decoder (right)
MULTICAST / MANAGEMENT
NETWORK
MB SYS
F MEDIA
E
U
EDID
D
VIDEO DISCOVERY
UART
24
MULTICAST
NETWORK
MB
VIDEO
KM
UART
D