DeviceDiscover.cs

using OSDP.Net.Connections;
using OSDP.Net.Model.ReplyData;
using OSDP.Net.Tracing;
using System;
using System.Text;
using System.Threading;
 
namespace OSDP.Net.PanelCommands
{
    namespace DeviceDiscover
    {
        public class DeviceDiscoveryException : OSDPNetException
        {
            public DeviceDiscoveryException(string message) : base(message) { }
        }

        public class ControlPanelInUseException : DeviceDiscoveryException
        {
            public ControlPanelInUseException() 
                : base("To perform device discovery control panel cannot have any open connections") { }
        }

        public enum DiscoveryStatus
        {
            Started,

            LookingForDeviceOnConnection,

            ConnectionWithDeviceFound,

            LookingForDeviceAtAddress,

            DeviceIdentified,

            CapabilitiesDiscovered,

            Succeeded,

            DeviceNotFound,

            Error,

            Cancelled
        }

        public delegate void DiscoveryProgress(DiscoveryResult current);

        public class DiscoveryOptions
        {
            public DiscoveryProgress ProgressCallback { get; set; }

            public TimeSpan ResponseTimeout { get; set; } = TimeSpan.FromMilliseconds(500);

            public TimeSpan ReconnectDelay { get; set; } = TimeSpan.Zero;

            public Action<TraceEntry> Tracer { get; set; }

            public CancellationToken CancellationToken { get; set; }

            public DiscoveryOptions WithDefaultTracer(bool setDefault=true)
            {
                if (setDefault) Tracer = OSDPFileCaptureTracer.Trace;
                return this;
            }
        }

        public class DiscoveryResult
        {
            public DiscoveryStatus Status { get; internal set; }

            public IOsdpConnection Connection { get; internal set; }

            public byte Address { get; internal set; }

            public DeviceIdentification Id { get; internal set; }

            public DeviceCapabilities Capabilities { get; internal set; }

            public bool UsesDefaultSecurityKey { get; set; }

            public Exception Error { get; internal set; }

            public override string ToString()
            {
                var sb = new StringBuilder();
 
                sb.AppendLine($"    Baud Rate: {Connection.BaudRate}");
                sb.AppendLine($"      Address: {Address}");
                sb.AppendLine("Identification:");
                sb.Append("        ");
                sb.AppendLine(Id?.ToString()?.TrimEnd().Replace("\n", "\n        "));
                sb.AppendLine("  Capabilities:");
                sb.Append("        ");
                sb.AppendLine(Capabilities.ToString().TrimEnd().Replace("\n", "\n        "));
                sb.AppendLine($"Responds to Default Security Key: {(UsesDefaultSecurityKey ? "Yes" : "No")}");
 
                return sb.ToString();
            }
        }
    }
}