Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Automatically discovered devices can be created as IAP/MQ devices automatically, provided that the discovering engine can be certain that the discovered device belongs to that instance of the engine. In general, automatically discovered devices are reported with the device discovery event object, described below.

The edge server suggests a handle for the discovered device, which is unique within the segment and in the device’s protocol. This handle can be used when creating the device in this segment, but it is not required to be used. Creating and deleting devices is discussed in Device Do Action

...

The discoverDevices action supports the options described in Manual Device Discovery Options below.

The discoverDevices action supports an optional response. The response indicates the completion of the search and provides simple statistics. See Device Discovery Completion Object 2293062, below.

Manual Device Discovery Options

Field Name             

Type                 

Description

policy

String

(Optional)  Can be either fast or slow. The default is fast.

The slow policy can enable more time-consuming but more thorough algorithms, and is recommended when the edge network is expected to yield many discovered devices.

protocols

List of Strings

(Optional)  A list of protocol names where device discovery will be performed. When the protocols list is not provided, or empty, device discovery is attempted by all protocol engines that support this method.

provisioned

Boolean

(Optional)  Indicates whether the search looks for provisioned devices.  Can be either true or false.

The default is false.  

unprovisioned

Boolean

(Optional) Indicates whether the search includes unprovisioned devices.  

Can be either true or false.

The default is true.  

respond

String

(Optional)  Indicates where the device discovery completion object will be published at the end of the discovery process.  

See Device Discovery Completion Object2293062.

meta

Any valid JSON

(Optional)  A correlator.  When present, this correlator will be included with the device discovery completion object. 

See Device Discovery Completion Object2293062.

option

Object

(Optional)  An object with protocol-specific options.

Device Discovery Completion Object

When requested, a device discovery completion object is published to the topic specified with the respond argument, once the process is complete. The device discovery completion object is always published with MQTT options qos: 1, and retain: false.

...