Command Types; Prefix Summary; Error Messages; Escaping - Lightware MMX8x4-HT420M User Manual

   
8. LW3 Programmers' Reference
8.3.3. Command Types
GET command
The GET command can be used to get the child nodes, properties and methods of a specific node. It can also
be used to get the value of a property. Use the dot character (.) when addressing a property:
ç GET /.SerialNumber
æ pr /.SerialNumber=87654321
GETALL command
The GETALL command can be used to get all child nodes, properties and methods of a node with one
command.
ç GETALL /MEDIA/UART
æ ns /MEDIA/UART/P1
æ ns /MEDIA/UART/P2
æ pr /MEDIA/UART.PortCount=2
æ pr /MEDIA/UART.PortUi=P1:12209;P2:12224
æ pr /MEDIA/UART.P1=Local RS-232
æ pr /MEDIA/UART.P2=TPS out RS-232
SET command
The SET command can be used to modify the value of a property. Use the dot character (.) when addressing
the property:
ç SET /MEDIA/VIDEO/I1.ColorSpaceMode=0
æ pw /MEDIA/VIDEO/I1.ColorSpaceMode=0
CALL command
A method can be invoked by the CALL command. Use the colon character (:) when addressing the method:
ç CALL /MEDIA/VIDEO/XP:switch(I1:O1)
æ mO /MEDIA/VIDEO/XP:switch
MAN command
The manual is a human readable text that describes the syntax and provides a hint for how to use the
primitives. For every node, property and method in the tree there is a manual, type the MAN command to get
the manual:
ç MAN /MEDIA/VIDEO/O1.Pwr5vMode
æ pm /MEDIA/VIDEO/O1.Pwr5vMode ["0" | "1" | "2"] 0 - Auto, 1 - Always On, 2 - Always Off
MMX8x4-HT series – User's Manual
8.3.4. Prefix Summary
DEFINITION:

The following prefixes are defined in the LW3 protocol:
Prefix
n-
nE
nm
pr
pw
pE
8.3.5. Error Messages
There are several error messages defined in the LW3 protocol, all of them have a unique error number.
ç CALL /MEDIA/VIDEO/XP:switch(IA:O1)
æ mE /MEDIA/VIDEO/XP:switch %E004:Invalid value
8.3.6. Escaping
DEFINITION:

inside a character or string literal, but is translated into another character or a sequence of characters.
Property values and method parameters can contain characters which 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 following: \ { } #% ( ) \r \n \t
The original message:
The escaped message:
Applied firmware package: v1.3.0 | LDC software: v2.4.2
The prefix is a 2-character long code that describes the type of the response.
Description Prefix
a node pm
an error for a node m-
a manual for a node mO
a read-only property mF
read-write property mE
an error for the property mm
An escape sequence is a sequence of characters that does not represent itself when used
CALL /MEDIA/UART/P1:sendMessage(Set(01))
CALL /MEDIA/UART/P1:sendMessage(Set\(01\))
106
Description
a manual for the property
a method
a response after a success method execution
a response after a failed method execution
an error for a method
a manual for a method