Escaping; Error Messages; Prefix Summary; The Tree Structure Of The Transmitter - Lightware HDMI-TPS-TX210 User Manual


  
7. LW3 Programmer's Reference
7.1.2. 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
7.1.3. 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
HDMI-TPS-TX200 series – User's Manual
7.1.4. 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.
7.2. The Tree Structure of the Transmitter
INFO: The tree structure is available in the
The /MEDIA node is used by the LDC to connect input
ports to output ports on different layers. Each subnode
of /MEDIA is representing a layer, e.g. video (/MEDIA/
VIDEO), audio (/MEDIA/AUDIO) or RS-232 (/MEDIA/
UART). Each layer has a crosspoint to define connections
between the ports associated with the layer, all of them
are represented by a specific node. E.g. the video layer
node is /MEDIA/VIDEO: under the video layer node, the
video crosspoint node (XP) and the video ports (I1, I2, ...)
are located.
Advanced View Window of LDC.
/ MEDIA
SYS
MANAGEMENT
EVENTS
PRESETS
REMOTE
EDID
51
VIDEO
AUDIO
UART
IR
GPIO
ETHERNET
MB