Skip to content

A .NET framework control panel implementation of the Open Supervised Device Protocol(OSDP)

License

Notifications You must be signed in to change notification settings

fattymatty195/OSDP.Net

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OSDP.Net

Build Status NuGet

OSDP.Net is a .NET framework 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.

Getting Started

The OSDP.Net library provides a Nuget package to quickly add OSDP capablitity to a .NET Framework or Core 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);

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 containsed 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

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. DM me on Twitter Follow NUnit if you are interesting in helping.

About

A .NET framework control panel implementation of the Open Supervised Device Protocol(OSDP)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 100.0%