9. Programmer's Reference
UBEX series – Matrix Application Mode – User's Manual
104
9. Programmer's Reference
UBEX series – Matrix Application Mode – User's Manual
104
MA
TRIX APPLIC
A
TION MODE
Applied F-series endpoint firmware package: v1.4.1 | Applied R-series endpoint firmware package: v1.4.1 | Applied MMU firmware package: v1.2.1 | LDC software: v1.34.0b2
9.2.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 /SYS
æ
n- /SYS/EB
æ
n- /SYS/CECU
æ
n- /SYS/ENDPOINTS
æ
m- /SYS:factoryDefaults
æ
m- /SYS:softReset
æ
m- /SYS:reset
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/STREAMS/VIDEO/S301.SourceName=My4K60Video
æ
pw /MEDIA/STREAMS/VIDEO/S301.SourceName=My4K60Video
CALL command
A method can be invoked by the
CALL
command. Use the colon character (:) when addressing the method:
ç
CALL /MEDIA/XP/VIDEO:switch(S101:D102)
æ
mO /MEDIA/XP/VIDEO: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/STREAMS/VIDEO/D201/PORT.Output5vMode
æ
pm /MEDIA/STREAMS/VIDEO/D201/PORT.Output5vMode ["Auto" | "AlwaysOn" | "AlwaysOff"]
9.2.4. Prefix Summary
DEFINITION:
The prefix is a 2-character long code that describes the type of the response.
The following prefixes are defined in the LW3 protocol:
Prefix
Description
Prefix
Description
n-
a node
pm
a manual for the property
nE
an error for a node
m-
a method
nm
a manual for a node
mO
a response after a success method execution
pr
a read-only property
mF
a response after a failed method execution
pw
read-write property
mE
an error for a method
pE
an error for the property
mm
a manual for a method
9.2.5. Error Messages
There are several error messages defined in the LW3 protocol, all of them have a unique error number.
ç
CALL /MEDIA/XP/VIDEO:switch(SA:D1)
æ
mE /MEDIA/XP/VIDEO:switch %E004:Invalid value
9.2.6. Escaping
DEFINITION:
An escape sequence is a sequence of characters that does not represent itself when used
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:
CALL /MEDIA/CONTROL/UART/P101/PORT:sendMessage(Set(01))
The
escaped
message:
CALL /MEDIA/CONTROL/UART/P101/PORT:sendMessage(Set\(01\))
