MODEX-OPTS, MODEX-OPTM
User’s Manual
Section 7.
Programmer’s reference
Page 69 / 113
7.2. Commands
Getter
The
‘GET’ command can be used to get sub nodes, properties and methods of a specific
node. It also can be used to get the value of a property.
Response format
The first two characters of a response are unambiguously identifies the type of the element
that the response line concerns. First character is the type of the element
(node/property/method), second is for miscellaneous information (e.g. read/write rights).
Defined prefixes are:
‘n-’: node
‘pr’: property – only readable
‘pw’: property – writable, readable
‘m-’: method executable
After prefix the response contains the full path of the node, property or method after a space
character.
7.2.1. Get all children of a node
Get all of the child nodes of a parent node, with one GET command.
Command format:
GET
●[nodePath]
Response format:
n-
●[nodePath]
Example:
> GET●/MEDIA/IR
< n-●/MEDIA/IR/XP1
< n-●/MEDIA/IR/P1
< n-●/MEDIA/IR/P2
7.2.2. Get all properties and methods of a node
Get all properties and methods of a specific node, with one GET command, using an
asterisk wildchar.
Command format:
GET
●[nodePath].*
Response format:
(for properties)
pX
●[nodePath].[propertyName]=[parameter]
Legend:
X can be:
‘r’:
read-only
‘w’:
read-write
Response format:
(for methods)
m-
●[nodePath]:[methodName]
Example:
> GET●/PRESETS/1.*
< pr●/PRESETS/1.Index=1
< pw●/PRESETS/1.RemoveLock=false
< pw●/PRESETS/1.Text=Preset 1