Method Types
GET method
In this case, POST and PUT are equivalent, they are for modifying read-write properties and invoking methods.
Supported Commands
The requested value is in the body of the response.
Protocol Command
REST API
ɯ header: GET·<ip><NODEPATH><PropertyName>·
Example
ɯ header:
LW3 ç <NODEPATH>.<PropertyName>
Example ç
Setting property value (SET)
The desired property value should be given as a plain text in the body of the request. The new value is in the
body of the response.
Protocol Command
REST API
ɯ header: POST·<ip><NODEPATH><PropertyName>·
ɯ body: <new_value>
Example
ɯ header:
ɯ body: false
LW3 ç <NODEPATH>.<PropertyName>=<new_value>
Example ç
Invoking method (CALL)
The argument should be given in the body of the request.
Protocol Command
REST API
ɯ header: POST·<ip><NODEPATH><methodName>·
ɯ body: <new_value>
Example
ɯ header:
ɯ body:
LW3 ç <NODEPATH>:<methodName>(<value>)
Example ç
Not Supported Commands
Protocol Command Note
REST API Not supported
LW3 ç <NODEPATH>
Example ç
Subscribing to a node (OPEN)
Protocol Command Note
REST API Not interpreted Not supported
LW3 ç <NODEPATH>
Example ç
Unsubscribing from a Node (CLOSE)
Protocol Command Note
REST API Not interpreted Not supported
LW3 ç <NODEPATH>
Example ç
command like:
Error code Description
200 OK Standard response for successful HTTP request.
Unauthorized
Method Not Allowed
A request method is not supported for the requested resource. This is
the error code when trying to modify a read-only property.
Not Found Invalid nodepath or property name.
Not Acceptable
quals the
pE: an error for the property
mE: an error for a method
Internal Server Error
Polling
Subscription and unsubscription features are not supported, they can be substituted with polling. It means
that a custom user script sends a request for a detected property from time to time.
To Next Page
Loading...
Need help?
General
