Invocation; Subscription - Lightware MODEX-OPTS-TX User Manual

Examples:

8.2.5. Invocation

A method can be invoked with the help of 'CALL' command.
Command format: CALL●[nodePath]:[methodName]([parameter])
Response format:
The response for a method execution is a state and a value. The state is mandatory and
always defined, if the method could be executed. It can be either a success or a failure.
The value is optional and it can contain additional information – such as the reason why
the state is a failure or a specific value when the state is success – which the client can
process. It is also possible to get an error message, when the method could not be
executed – e.g. the parameter was illegal – and hence not even the state of the execution
could be specified.
mX●[nodePath]:[methodName]=Y
Legend:
Example:
Error response format:
If there were errors during the execution, an error message is received, which follows the
method name. Find the error numbers in section
mE●[nodePath]:[methodName]●%EXXX:Error message
Example:

8.2.6. Subscription

User can subscribe to any node. Subscribe to a node means that user will get a notification
if any of the properties of the node is changed. These notifications are asynchronous
messages – such as the ones described above – and hence they are useful to keep client
application up-to-date, without receiving any unwanted information. When user does not
want to be informed about the changes anymore, he can simply unsubscribe from the node.
Page 64 / 90
> SET●/SYS/CORE/B/VIDEODVOOO.HdcpEnable=false
< nE●%E002:Node not found
> SET●/SYS/CORE.PartNumber=12345678
< pE●%E004:Writing read-only property
> SET●/SYS/CORE/B/VIDEODVI.HdcpEnable=falssss
< pE●%E005:Invalid value
> SET●/SYS/CORE/B/VIDEODVI.HdcpEnab=false
< pE●%E006:Property not exists
X can be:
'O':
if the execution is successful.
'F':
if the execution is failed, but the method could be executed.
'E':
if the method could not be executed: e.g. illegal parameter count.
Y can be:

the return value of the method if any.

it is valid that a method does not have any return value. In this case the
equal sign ('=') can be omitted.
> CALL●/MANAGEMENT/LOCK:LockAll()
< mO●/MANAGEMENT/LOCK:LockAll
> CALL●/EDID:DeleteEdid(U100)
< mE●%E005:Invalid●value
8.1.3 on page 61.
Section 8. Programmer's reference