Interface Options ▾

Translation:
Language:

Topology Information

IID: [1:{0227}]

This interface provides bulk topology information useful to 'bootstrap' a topology index. The provider of this information does not necessarily correspond to a source or a sink. In order to provide some size limitations, the amount of information that can be passed in a single response is limited. If a node has more information than can be provided in a single response, it should use multiple objects. It can use any method to determine which object identifiers it wants to use - the responding object is not important to the requester.

Associated Interfaces

> Type Definitions

PositionType ID: 3

The logical position of the device relative to the parent. The parent defines the context/meaning of the positions for its children. A parent may have multiple children with the same position, which may indicate a grouping or relationship between those children. The position is meta-data associated with the device itself, and not related directly to data or an event.

MAX: 
MIN: 
Unit: 
Type: uint16
TopologyArrayType ID: 6

An array of topology information from a source. If all the information cannot be put in a single array then multiple providers must be created.

Min Length: 1
Length: 1000
Type: array ( 5 - Topology ) TopologyType ID: 5

A structure containing topology information about a node.

Type: structure { 1 - id ,  2 - parent ,  4 - position }
Optional IDType ID: 2

An optional ID that is used in cases (for example, parent) where the ID may not exist. NULL indicates that there is no ID.

Type: nullable ( ID ) Optional PositionType ID: 4

An optional position is used in cases where the position may not exist. NULL indicates that there is no position.

Type: nullable ( Position ) IDType ID: 1

An identifier for an actor in the data exchange (device, source, sink, parent).

Type: oid

> Methods

Get Topology InfoItem ID: 1


Returns an array of topology info from a source. If a source has more topology info than will fit in the array then multiple providers are required.

Inputs:
 1 -  node - An ID to specify the desired result set. The broadcast OID indicates that all information should be returned. If a specific ID is used, then only information about that ID should be included. In this case no response would be generated by nodes that do not have relevant information.
Outputs:
 1 -  source - The ID of the source that manages the devices.
 6 -  topologyInfo - An array of topology information related to the source.