Click or drag to resize

BACnetBACnetDiscovery Class

BACnet Discovery class.

This class will trigger BACnetDiscoveryEvent event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProBACnetBACnetDiscovery

Namespace: Crestron.SimplSharpPro
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public class BACnetDiscovery : IParentInformation

The BACnetBACnetDiscovery type exposes the following members.

Properties
 NameDescription
Public propertyDeviceIdForObjectDiscovery Property to return the device ID for which the object discovery is in progress. Returns MaxValue if the discovery is not in progress.
Public propertyDevices Collection of BACnetBACnetDiscoveryDeviceInfo objects. This is the discovered remote devices collection.
Public propertyDiscoveryTimeout Property to set the timeout for Device and Object Discovery process in minutes. Maximum value is 10 and the minimum value is 1. If value passed is greater than 10 then DiscoveryTimeout is set to 10, if value is 0 it will be ignored. Default value is for this property is 1.
Public propertyNumberOfDiscoveredDevices Returns the number of devices discovered.
Public propertyNumberOfDuplicateDevices This property tells that the number of duplicate device ids found in the BACnet Discovery. The device ids shall be unique in the network and the duplicate ids shall be resolved. In all of the devices with duplicate device ids the first device found only will be added to the devices list and other devices will not be added to the devices list.
Public propertyParent Parent for BACnetBACnetDiscovery class.
Public propertyStartDeviceDiscovery Starts Remote Device Discovery with the user specified discovery timeout in minutes by setting property DiscoveryTimeout. The default value of property DiscoveryTimeout is 1. The Discovery status will be changed to DeviceDiscoveryInProgress and BACnetDiscoveryEvent event will be fired with DeviceDiscoveryInProgressEventId if the device discovery process is started successfully.
Public propertyStartDiscoveryOfAllObjects Starts the Discovery of all Objects for all the discovered devices with the specified timeout by setting the DiscoveryTimeout property, if no discovery process is already active. Nothing is done if the number of devices discovered are 0. Sends the Start Object Discovery packet to the BACnet stack for the first device in the Devices collection and the discovery status will be changed to AllObjectDiscoveryInProgress and BACnetDiscoveryEvent event will be fired with AllObjectsDiscoveryInProgressEventId.
Public propertyStartObjectDiscovery Starts the Object Discovery for the specified device with the specified timeout if no discovery process is already active in minutes, by setting property DiscoveryTimeout. The default value of property DiscoveryTimeout is 1. The Discovery status will be changed to ObjectDiscoveryInProgress and BACnetDiscoveryEvent event will be fired with ObjectDiscoveryInProgressEventId if the object discovery process is started successfully.
Public propertyStatus Returns the status of the current BACnet Discovery.
Public propertyStopDeviceDiscovery Property to stop the Device Discovery if already in progress that is started using StartDeviceDiscovery. Response timeout is set to 1 minute, for the response to be received from the BACnet stack. The Discovery status will be changed to DeviceDiscoveryStoppingInProgress and BACnetDiscoveryEvent event will be fired with DeviceDiscoveryStoppingInProgressEventId if the device discovery process is started successfully.
Public propertyStopObjectDiscovery Stops the Object Discovery if Object Discovery is already in progress that is started using StartObjectDiscovery and StartDiscoveryOfAllObjects. Response timeout is set to 1 minute for the response to be received from the BACnet stack.
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
Top
Methods
 NameDescription
Public methodAddAll Populate all the devices discovered and all their objects into the corresponding collections with current response timeout. Default Device priority will be used.
Public methodAddAll(eBACnetPriorityType) Populate all the devices discovered and all their objects into the corresponding collections with current response timeout. The devices will be added to the "RemoteBACnetDevices.RemoteDevices" collection and the object will be added to their corresponding object collections.
Public methodAddAllDevices Populate all the devices discovered to the "RemoteBACnetDevices.RemoteDevices" collection with default priority and with current response timeout.
Public methodAddAllDevices(eBACnetPriorityType) Populate all the devices discovered to the "RemoteBACnetDevices.RemoteDevices" collection with specified priority and with current response timeout.
Public methodAddAllObjects Populate all the objects discovered of all the discovered devices that were already added to the "RemoteBACnetDevices.RemoteDevices" collection and with current response timeout.
Public methodAddDevice(UInt32) Adds the specified remote device to the "RemoteBACnetDevices.RemoteDevices" collection.
Public methodAddDevice(UInt32, eBACnetPriorityType) Adds the specified remote device to the "RemoteBACnetDevices.RemoteDevices" collection with the specified priority.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventBACnetDiscoveryEvent Event triggered when device/object discovery completed/stopped status is received.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also