Commit 7c81b27e authored by Peter Waher's avatar Peter Waher

getNodes

parent 193ed023
......@@ -311,6 +311,39 @@ Message types are defined by the `MessageType` enumeration, which can take the f
### getNodes
Gets information about a set of nodes in the concentrator. It is sent in an `iq get` to the concentrator, which responds with a `nodeInfos` element containing
a sequence of `nodeInfo` elements corresponding to a node in the request. The `nodeInfo` element in turn can have a sequence of parameter elements, named after
their corresponding data type, and messages, if the request asked for such information.
| Element | Attribute | Type | Use | Default | Description |
|:---------------|:------------------|:--------------|:---------|:---------|:--------------------------------------------------------------------------------------------------------------------|
| `getNodes` | `parameters` | `xs:string` | optional | `false` | If node parameters are included in the request. |
| | `messages` | `xs:string` | optional | `false` | If node messages are included in the request. |
| | `dt` | `xs:string` | optional | | Device token(s). |
| | `st` | `xs:string` | optional | | Service token(s). |
| | `ut` | `xs:string` | optional | | User token(s). |
| `nd` | `id` | `xs:string` | required | | Node identity. |
| | `src` | `xs:string` | optional | | Source identity. |
| | `pt` | `xs:string` | optional | | Partition. |
| `nodeInfos` | | | | | Contains a set of `nodeInfo` elements. |
| `nodeInfo` | `id` | `xs:string` | required | | Node identity. |
| | `src` | `xs:string` | optional | | Source identity. |
| | `pt` | `xs:string` | optional | | Partition. |
| | `localId` | `xs:string` | optional | | Optional local identity, unique among siblings. |
| | `logId` | `xs:string` | optional | | Optional log identity, related to node, if different from node identity. |
| | `displayName` | `xs:string` | optional | | Human readable, localized node name. |
| | `nodeType` | `xs:string` | optional | | Machine-readable node type, understood by the concentrator. |
| | `state` | `NodeState` | required | | Current state of node. |
| | `hasChildren` | `xs:boolean` | required | | If the node has child-nodes. |
| | `childrenOrdered` | `xs:boolean` | optional | `false` | If the order of the child nodes is important in the context. |
| | `isReadable` | `xs:boolean` | optional | `false` | If the node is readable, and can deliver sensor data to the client. |
| | `isControllable` | `xs:boolean` | optional | `false` | If the node is controllable, and publish control parameters to the client. |
| | `hasCommands` | `xs:boolean` | optional | `false` | If the node has commands the client can access. |
| | `sniffable` | `xs:boolean` | optional | `false` | If the node supports sniffing, i.e. can allow the client to attach a sniffer to it, to troubleshoot communication. |
| | `parentId` | `xs:string` | optional | | The identity of the parent node, if any. Root nodes do not have parent nodes. |
| | `parentPartition` | `xs:string` | optional | | The parent node partition, if available. |
| | `lastChanged` | `xs:dateTime` | optional | | When the node was last changed, for synchronization. |
### getAllNodes
### getNodeInheritance
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment