OSDP.Net 5.2.1
A .NET library for implementing the Open Supervised Device Protocol (OSDP)
Loading...
Searching...
No Matches
OSDP.Net.Messages Namespace Reference

Classes

class  CommandReplyExtensions
 Extension methods for CommandType and ReplyType enums. More...
class  Control
class  Helpers
class  IncomingMessage
 Represents a message that was received from the wire. More...
class  Message
 A base message class for sending or replying. More...
class  OutgoingMessage
class  OutgoingReply
class  ReplyTracker

Enumerations

enum  CommandType : byte {
  Poll = 0x60 , IdReport = 0x61 , DeviceCapabilities = 0x62 , LocalStatus = 0x64 ,
  InputStatus = 0x65 , OutputStatus = 0x66 , ReaderStatus = 0x67 , OutputControl = 0x68 ,
  LEDControl = 0x69 , BuzzerControl = 0x6A , TextOutput = 0x6B , CommunicationSet = 0x6E ,
  BioRead = 0x73 , BioMatch = 0x74 , KeySet = 0x75 , SessionChallenge = 0x76 ,
  ServerCryptogram = 0x77 , MaxReplySize = 0x7B , FileTransfer = 0x7C , ManufacturerSpecific = 0x80 ,
  ExtendedWrite = 0xA1 , Abort = 0xA2 , PivData = 0xA3 , GenerateChallenge = 0xA4 ,
  AuthenticateChallenge = 0xA5 , KeepActive = 0xA7
}
 Identifies the type of OSDP protocol command (ACU -> PD) message. More...
enum  MessageType { Command , Reply }
 The type of message. More...
enum  ReplyType : byte {
  Ack = 0x40 , Nak = 0x41 , PdIdReport = 0x45 , PdCapabilitiesReport = 0x46 ,
  LocalStatusReport = 0x48 , InputStatusReport = 0x49 , OutputStatusReport = 0x4A , ReaderStatusReport = 0x4B ,
  RawReaderData = 0x50 , FormattedReaderData = 0x51 , KeypadData = 0x53 , PdCommunicationsConfigurationReport = 0x54 ,
  BiometricData = 0x57 , BiometricMatchResult = 0x58 , ExtendedPdIdReport = 0x59 , CrypticData = 0x76 ,
  InitialRMac = 0x78 , Busy = 0x79 , FileTransferStatus = 0x7A , PIVData = 0x80 ,
  ResponseToChallenge = 0x82 , ManufactureSpecific = 0x90 , ExtendedRead = 0xB1
}
 Identifies the type of OSDP protocol reply (PD -> ACU) message. More...

Enumeration Type Documentation

◆ CommandType

Identifies the type of OSDP protocol command (ACU -> PD) message.

Enumerator
Poll 

osdp_POLL - poll request

IdReport 

osdp_ID - ID report request

DeviceCapabilities 

osdp_CAP - peripheral device capabilities request

LocalStatus 

osdp_LSTAT - local status report request

InputStatus 

osdp_ISTAT - input status report request

OutputStatus 

osdp_OSTAT - output status report request

ReaderStatus 

osdp_RSTAT - reader status report request

OutputControl 

osdp_OUT - output control command

LEDControl 

osdp_LED - Reader LED control command

BuzzerControl 

osdp_BUZ - Reader buzzer control command

TextOutput 

osdp_TEXT - Reader text output command

CommunicationSet 

osdp_COMSET - communication configuration command

BioRead 

osdp_BIOREAD - scan and match biometric data

BioMatch 

osdp_BIOMATCH - scan and match biometric template

KeySet 

osdp_KEYSET - Encryption key set

SessionChallenge 

osdp_CHLNG - challenge and secure session initialization request

ServerCryptogram 

osdp_SCRYPT - server's random number and server cryptogram

MaxReplySize 

osdp_ACURXSIZE - ACU receive size

FileTransfer 

osdp_FILETRANSFER - file transfer command

ManufacturerSpecific 

osdp_MFG - manufacturer specific command

ExtendedWrite 

osdp_XWR - extended write data

Abort 

osdp_ABORT - abort current operation

PivData 

osdp_PIVDATA - get PIV data

GenerateChallenge 

osdp_GENAUTH - generate authenticate

AuthenticateChallenge 

osdp_CRAUTH - authenticate challenge

KeepActive 

osdp_KEEPACTIVE - keep reader active

Definition at line 6 of file CommandType.cs.

◆ MessageType

The type of message.

Enumerator
Command 

Command message.

Reply 

Reply message.

Definition at line 6 of file MessageType.cs.

◆ ReplyType

Identifies the type of OSDP protocol reply (PD -> ACU) message.

Enumerator
Ack 

osdp_ACK - general acknowledge; nothing to report

Nak 

osdp_NAK - acknowledge; error response

PdIdReport 

osdp_PDID - device identification report

PdCapabilitiesReport 

osdp_PDCAP - device capabilities report

LocalStatusReport 

osdp_LSTATR - local status report

InputStatusReport 

osdp_ISTATR - input status report

OutputStatusReport 

osdp_OSTATR - output status report

ReaderStatusReport 

osdp_RSTATR - reader tamper status report

RawReaderData 

osdp_RAW - card data report; raw bits array

FormattedReaderData 

osdp_FMT - card data report; character array

KeypadData 

osdp_KEYPAD - keypad data report

PdCommunicationsConfigurationReport 

osdp_COM - communication configuration report

BiometricData 

osdp_BIOREADR - scan and send biometric data

BiometricMatchResult 

osdp_BIOMATCHR - scan and match biometric template

ExtendedPdIdReport 

osdp_EXT_PDID - extended device identification report

CrypticData 

osdp_CCRYPT - client's ID and client's random number

InitialRMac 

osdp_RMAC_I - client cryptogram packet and the initial R-MAC

Busy 

osdp_BUSY - PD busy reply

FileTransferStatus 

osdp_FTSTAT - file transfer status

PIVData 

osdp_PIVDATAR - PIV data reply

ResponseToChallenge 

osdp_CRAUTHR - response to challenge

ManufactureSpecific 

osdp_MFGREP - manufacturer specific reply

Per OSDP v2.2.2 Annex A.2 this code is osdp_MFGREP. osdp_MFGSTATR is a separate reply at 0x83.

ExtendedRead 

osdp_XRD - extended read reply

Definition at line 6 of file ReplyType.cs.