OSDP.Net

OSDP.Net is a .NET implementation of the Open Supervised Device Protocol (OSDP). This protocol has been adopted by the Security Industry Association (SIA) to standardize access control hardware communication. Further information can be found at SIA OSDP Homepage.

Prerequisites

OSDP.Net supports the following .NET implementations:

• .NET Framework 4.6.2 and later
• NET 5.0 and later

Getting Started

The OSDP.Net library provides a Nuget package to quickly add OSDP capability to a .NET project. You can install it using the NuGet Package Console window:

PM> Install-Package OSDP.Net

A control panel can be created and started with a few lines. Be sure to register events before start the connection.

var panel = new ControlPanel();
panel.ConnectionStatusChanged += (sender, eventArgs) =>
{
    // NOTE: Avoid blocking the thread so the control panel can continue polling
    Task.Run(async () =>
    {
        // Handle connection change event
    });
};
Guid connectionId = panel.StartConnection(new SerialPortOsdpConnection(portName, baudRate));

Once the connection has started, add Peripheral Devices (PD).

panel.AddDevice(connectionId, address, useCrc, useSecureChannel, secureChannelKey);

The following code will install a PD with a unique Secure Channel key. The OSDP standard requires that setting the secure key can only occur while communications are secure.

panel.AddDevice(connectionId, address, useCrc, useSecureChannel); // connect using default SC key
bool successfulSet = await panel.EncryptionKeySet(connectionId, address, 
    new EncryptionKeyConfiguration(KeyType.SecureChannelBaseKey, uniqueKey));

The ControlPanel object can then be used to send command to the PD.

var returnReplyData = await panel.OutputControl(connectionId, address, new OutputControls(new[]
{
    new OutputControl(outputNumber, activate
        ? OutputControlCode.PermanentStateOnAbortTimedOperation
        : OutputControlCode.PermanentStateOffAbortTimedOperation, 0)
});

The reader number parameter found in some commands is used for devices with multiple readers attached. If the device has a single reader, a value of zero should be used.

byte defaultReaderNumber = 0;
bool success = await panel.ReaderBuzzerControl(connectionId, address, 
    new ReaderBuzzerControl(defaultReaderNumber, ToneCode.Default, 2, 2, repeatNumber))

Common Usage Examples

Reading Card Data

// Register for card read events
panel.CardRead += async (sender, eventArgs) =>
{
    await Task.Run(() =>
    {
        Console.WriteLine($"Card read from device {eventArgs.Address}");
        if (eventArgs.CardData is RawCardData rawData)
        {
            Console.WriteLine($"Raw card data: {BitConverter.ToString(rawData.Data)}");
        }
        else if (eventArgs.CardData is FormattedCardData formattedData)
        {
            Console.WriteLine($"Formatted card data: {formattedData.CardNumber}");
        }
    });
};

Handling Device Events

// Monitor device status changes
panel.InputStatusReport += async (sender, eventArgs) =>
{
    await Task.Run(() =>
    {
        Console.WriteLine($"Input status changed on device {eventArgs.Address}");
        foreach (var input in eventArgs.InputStatuses)
        {
            Console.WriteLine($"Input {input.Number}: {(input.Active ? "Active" : "Inactive")}");
        }
    });
};

// Handle NAK responses
panel.NakReplyReceived += async (sender, eventArgs) =>
{
    await Task.Run(() =>
    {
        Console.WriteLine($"NAK received from device {eventArgs.Address}: {eventArgs.Nak.ErrorCode}");
    });
};

Managing Multiple Devices

// Add multiple devices on the same connection
var devices = new[] { 0, 1, 2, 3 }; // Device addresses
foreach (var address in devices)
{
    panel.AddDevice(connectionId, address, useCrc: true, useSecureChannel: true);
}

// Send commands to all devices
foreach (var address in devices)
{
    await panel.ReaderLedControl(connectionId, address, new ReaderLedControls(new[]
    {
        new ReaderLedControl(0, 0, LedColor.Green, LedColor.Black, 
            30, 30, PermanentControlCode.SetPermanentState)
    }));
}

Error Handling

try
{
    var deviceId = await panel.IdReport(connectionId, address);
    Console.WriteLine($"Device ID: {deviceId.VendorCode:X}-{deviceId.ModelNumber}-{deviceId.Version}");
}
catch (TimeoutException)
{
    Console.WriteLine("Device communication timeout");
}
catch (Exception ex)
{
    Console.WriteLine($"Error communicating with device: {ex.Message}");
}

Custom Communication Implementations

OSDP.Net is able to plugin different methods of communications beyond what is included with the default package. It simply requires the installation a new NuGet package. The code needs to be updated by using it's implementation of the IOsdpConnection interface when starting a connection for the ControlPanel.

• SerialPortStream
  • Author: Fredrik Hall
  • Links: GitHub Nuget
  • Notes: Requires compilation of native libraries for non-Windows platforms

Test Console

There is compiled version of the test console application for all the major platforms available for download. It has all the required assemblies included to run as a self-contained executable. The latest version of the package can be found at https://www.z-bitco.com/downloads/OSDPTestConsole.zip

NOTE: First determine the COM port identifier of the 485 bus connected to the computer. This will need to be entered when starting the connection. Be sure to save configuration before exiting.

Documentation

• PowerShell Support
• Supported Commands and Replies

Contributing

The current goal is to properly support all the commands and replies outlined the OSDP v2.2 standard. The document that outlines the specific of the standard can be found on the SIA website. Contact me through my consulting company Z-bit System, LLC if you're interested in collaborating on the OSDP.Net library.