OSDP.Net.PanelCommands.DeviceDiscover.DiscoveryResult Class Reference

Contains the results of the device discovery. More...

Public Member Functions
override string	ToString ()

Properties
DiscoveryStatus	Status [get, set]
	Determines current state of the device discovery.
IOsdpConnection	Connection [get, set]
	When Status is DiscoveryStatus.LookingForDeviceOnConnection this property identifies connection being tested even if ultimately no device will be discovered on it.
byte	Address [get, set]
	When Status is DiscoveryStatus.LookingForDeviceAtAddress, this property identifies the address being polled to see if there is an available device.
DeviceIdentification	Id [get, set]
	After status DiscoveryStatus.DeviceIdentified, this property will contain the identification report from the device.
DeviceCapabilities	Capabilities [get, set]
	After status DiscoveryStatus.CapabilitiesDiscovered, this property will contain the capabilities report from the device.
bool	UsesDefaultSecurityKey [get, set]
	A flag that indicates whether or not discovered device responds to the default security key The security key will only be tested if a) PD returns a "Communication Security" capability and b) that capability indicates that it supports AES128.
Exception	Error [get, set]
	When status is set to DiscoveryStatus.Error or DiscoveryStatus.Cancelled this property will be set to the exception instance that terminated the device discovery.

Detailed Description

Contains the results of the device discovery.

When DiscoveryOptions.ProgressCallback is used, this instance will get incrementally filled in based on current value of the Status field

Definition at line 169 of file DeviceDiscover.cs.

Member Function Documentation

ToString()

override string OSDP.Net.PanelCommands.DeviceDiscover.DiscoveryResult.ToString ( )

inline

Definition at line 218 of file DeviceDiscover.cs.

References Capabilities, Id, and ToString().

Referenced by ToString().

Property Documentation

Address

byte OSDP.Net.PanelCommands.DeviceDiscover.DiscoveryResult.Address

getset

When Status is DiscoveryStatus.LookingForDeviceAtAddress, this property identifies the address being polled to see if there is an available device.

After DiscoveryStatus.DeviceIdentified status, this property identifies the address where a device was found

Definition at line 190 of file DeviceDiscover.cs.

Referenced by OSDP.Net.ControlPanel.DiscoverDevice().

Capabilities

DeviceCapabilities OSDP.Net.PanelCommands.DeviceDiscover.DiscoveryResult.Capabilities

getset

After status DiscoveryStatus.CapabilitiesDiscovered, this property will contain the capabilities report from the device.

Definition at line 202 of file DeviceDiscover.cs.

Referenced by ToString().

Connection

IOsdpConnection OSDP.Net.PanelCommands.DeviceDiscover.DiscoveryResult.Connection

getset

When Status is DiscoveryStatus.LookingForDeviceOnConnection this property identifies connection being tested even if ultimately no device will be discovered on it.

After DiscoveryStatus.ConnectionWithDeviceFound status, this property identifies connection with a valid device

Definition at line 182 of file DeviceDiscover.cs.

Referenced by OSDP.Net.ControlPanel.DiscoverDevice().

Error

Exception OSDP.Net.PanelCommands.DeviceDiscover.DiscoveryResult.Error

getset

When status is set to DiscoveryStatus.Error or DiscoveryStatus.Cancelled this property will be set to the exception instance that terminated the device discovery.

Definition at line 215 of file DeviceDiscover.cs.

Id

DeviceIdentification OSDP.Net.PanelCommands.DeviceDiscover.DiscoveryResult.Id

getset

After status DiscoveryStatus.DeviceIdentified, this property will contain the identification report from the device.

Definition at line 196 of file DeviceDiscover.cs.

Referenced by ToString().

Status

DiscoveryStatus OSDP.Net.PanelCommands.DeviceDiscover.DiscoveryResult.Status

getset

Determines current state of the device discovery.

Definition at line 174 of file DeviceDiscover.cs.

UsesDefaultSecurityKey

bool OSDP.Net.PanelCommands.DeviceDiscover.DiscoveryResult.UsesDefaultSecurityKey

getset

A flag that indicates whether or not discovered device responds to the default security key The security key will only be tested if a) PD returns a "Communication Security" capability and b) that capability indicates that it supports AES128.

Otherwise, this value will remain false.

Definition at line 209 of file DeviceDiscover.cs.

---

The documentation for this class was generated from the following file:

• OSDP.Net/PanelCommands/DeviceDiscover.cs