6.1.3.3 Method NetworkScan

NetworkScan allows an OPC UA Client to update the BACnet device list by using the BACnet Who-Is and I-Am services.

Signature

	NetworkScan (
		[in]	0:UInt32					WaitTimeInSeconds
		[in]	0:Boolean					ApplyRange
		[in]	0:UInt32					DeviceRangeLow
		[in]	0:UInt32					DeviceRangeHigh
		[out]	BaseDataType []				DeviceAddressBindings
		[out]	0:UInt32 []					MaxAPDULengthAccepted
		[out]	BACnetSegmentation []			SegmentationSupported
		[out]	0:UInt16 []					VendorIdentifier
		);
Argument Description
WaitTimeInSecondsWait time between sending Who-Is and returning the received I-Am results.
ApplyRangeFlag indicating if the DeviceRangeLow and DeviceRangeHigh parameters are applied.
DeviceRangeLowThis parameter is an unsigned integer in the range 0 - 4194303. In conjunction with the 'Device Instance Range High Limit' parameter, it defines the devices that are qualified to respond with an I-Am service request. If the 'Device Instance Range Low Limit' parameter is present, then the 'Device Instance Range High Limit' parameter shall also be present, and only those devices whose Device Object_Identifier instance number falls within the range 'Device Instance Range Low Limit' ≤ Device Object_Identifier Instance Number ≤ 'Device Instance Range High Limit' shall be qualified to respond. The value of the 'Device Instance Range Low Limit' shall be less than or equal to the value of the 'Device Instance Range High Limit'. If the 'Device Instance Range Low Limit' and 'Device Instance Range High Limit' parameters are omitted, then all devices that receive this message are qualified to respond with an I-Am service request.
DeviceRangeHighThis parameter is an unsigned integer in the range 0 - 4194303. In conjunction with the 'Device Instance Range Low Limit' parameter, it defines the devices that are qualified to respond with an I-Am service request. If the 'Device Instance Range High Limit' parameter is present, then the 'Device Instance Range Low Limit' parameter shall also be present, and only those devices whose Device Object_Identifier instance number falls within the range 'Device Instance Range Low Limit' ≤ Device Object_Identifier Instance Number ≤ 'Device Instance Range High Limit' shall be qualified to respond. The value of the 'Device Instance Range High Limit' shall be greater than or equal to the value of the 'Device Instance Range Low Limit'. If the 'Device Instance Range Low Limit' and 'Device Instance Range High Limit' parameters are omitted, then all devices that receive this message are qualified to respond with an I-Am service request.
DeviceAddressBindingsThe format is server-specific. In each value of the array should be the device identifier and the BACnet MAC address provided by the I-Am service.
MaxAPDULengthAccepted

This element, of type Unsigned, is the maximum number of octets that may be contained in a single, indivisible application

layer protocol data unit. The value of this property shall be greater than or equal to 50. The value of this property is also

constrained by the underlying data link technology. See Clauses 6 through 11.

If the value of this property is not encodable in the 'Max APDU Length Accepted' parameter of a ConfirmedRequest-PDU,

then the value encoded shall be the highest encodable value less than the value of this property. In such cases, a responding device may ignore the encoded value in favor of the value of this property, if it is known.

SegmentationSupported

This element, of type BACnetSegmentation, indicates whether the BACnet Device supports segmentation of messages and,

if so, whether it supports segmented transmission, reception, or both:

{SEGMENTED_BOTH, SEGMENTED_TRANSMIT, SEGMENTED_RECEIVE, NO_SEGMENTATION}

VendorIdentifierThis element, of type Unsigned16, is a unique vendor identification code, assigned by ASHRAE, which is used to distinguish proprietary extensions to the protocol.

Method Result Codes

ResultCode Description
Common StatusCodes defined in OPC 10000-4