OSDP.Net.PanelCommands.DeviceDiscover Namespace Reference

Classes
class	DeviceDiscoveryException
	Represents an error condition encountered during device discovery. More...
class	ControlPanelInUseException
	This exception will be thrown if a caller attempts to perform device discovery on a control panel that already has open connections. More...
class	DiscoveryOptions
	Defines a set of optional parameters the caller can pass in to the ControlPanel.DiscoverDevice(System.Collections.Generic.IEnumerable<IOsdpConnection>, DiscoveryOptions) call. More...
class	DiscoveryResult
	Contains the results of the device discovery. More...

Enumerations
enum	DiscoveryStatus {   Started , LookingForDeviceOnConnection , ConnectionWithDeviceFound , LookingForDeviceAtAddress ,   DeviceIdentified , CapabilitiesDiscovered , Succeeded , DeviceNotFound ,   Error , Cancelled }
	Represents current state of the device discovery process. More...

Functions
delegate void	DiscoveryProgress (DiscoveryResult current)
	Callback used for reporting device discovery status updates.

Enumeration Type Documentation

DiscoveryStatus

enum OSDP.Net.PanelCommands.DeviceDiscover.DiscoveryStatus

Represents current state of the device discovery process.

As the device discovery unfolds, this status value indicates which fields of the DiscoveryResult instance have been filled in.

Enumerator
Started	Device discovery has been started.
LookingForDeviceOnConnection	About to send an osdp_POLL to configuration address (0x7f) to see if a device will respond on a connection instance being tested.
ConnectionWithDeviceFound	Received a valid reply too osdp_POLL indicating that the right connection has been found.
LookingForDeviceAtAddress	About to send an osdp_PDID to a specific address to see if a device will respond and if it does to get its identification report.
DeviceIdentified	Received a valid reply to osdp_PDID command, device has been found and its address determined.
CapabilitiesDiscovered	Received a valid reply to osdp_CAM command.
Succeeded	Device discovery completed successfully.
DeviceNotFound	No devices have been found.
Error	Something unexpected has gone wrong during the device discovery process.
Cancelled	Device discovery process terminated due to a cancellation request.

Definition at line 44 of file DeviceDiscover.cs.

Function Documentation

DiscoveryProgress()

delegate void OSDP.Net.PanelCommands.DeviceDiscover.DiscoveryProgress

(

DiscoveryResult

current

)

Callback used for reporting device discovery status updates.

Parameters

current

Discover results instance. This object will get incrementally filled in as the device discovery progresses. Check status field to determine which fields have valid values in them.