7. LW3 Programmers’ Reference
MMX4x2 series – User's Manual
84
Applied firmware package: v1.6.0b19 | LDC software: v2.5.13b5
7.3.3.
Legend for the Control Commands
Command and Response – Example
ç
GET·/MEDIA/VIDEO/I2.SignalPresent
æ
pr·/MEDIA/VIDEO/I2.SignalPresent=
<signal_present>
Format
Description
<in>
Input port number
<out>
Output port number
<port>
Input or output port number
<loc>
Location number
<parameter>
Specific property defined and described in the command
<expression>
Batched parameters: the underline means that more expressions or parameters
can be placed by using a semicolon, e.g.
I2;I4;I5
or
F27:E1;F47:E2
ç
Sent command
æ
Received response
·
Space character
Further not listed
<parameters>
are defined at each commands.
7.3.4.
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
7.3.5. 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 successful 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
7.3.6.
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
