Classes
class	ACUReceiveSize
	Command data to set the maximum message size the ACU can receive. More...
class	BiometricReadData
	Command data to send a request to the PD to perform a biometric scan and match. More...
class	BiometricTemplateData
	Command data to send a request to the PD to perform a biometric scan and return data. More...
class	CommandData
	Base class representing a payload of a PD command message. More...
class	CommunicationConfiguration
	Command data to set the communication configuration on a PD. More...
class	DeviceCapabilities
	Represents the capabilities of a device within the context of OSDP (Open Supervised Device Protocol). More...
class	EncryptionKeyConfiguration
	Command data to set the encryption key configuration on a PD. More...
class	ExtendedWrite
	Extended write (transparent mode) command data sent to a PD. More...
class	FileTransferFragment
	Command data to send a data fragment of a file to a PD. More...
class	GetPIVData
	Command data to get the PIV data. More...
class	IdReport
	Represents a command data type for generating an ID report request. More...
class	KeepReaderActive
	Command data to set the keep alive time. More...
class	ManufacturerSpecific
	Manufacture specific command data sent to a PD. More...
class	MessageDataFragment
	Represents a fragment of data for a multipart message. More...
class	NoPayloadCommandData
	Represents a command data object that doesn't have any payload data.
class	OutputControl
	Contains data to control a single output on a PD. More...
class	OutputControls
	Command data to control the outputs of a PD. More...
class	ReaderBuzzerControl
	Command data to control the buzzer on a PD. More...
class	ReaderLedControl
	Contains data to control the color of a single LED on a PD. More...
class	ReaderLedControls
	Command data to control the color of LEDs. More...
class	ReaderTextOutput
	Command data for sending text to be shown on a PD. More...
class	SecurityInitialization
class	ServerCryptogramData
	Represents the server cryptogram data used in a secure communication sequence. More...

Enumerations
enum	BiometricFormat { NotSpecified = 0x00 , RawFingerprintData = 0x01 , FingerPrintTemplate = 0x02 }
	Format of data to be scanned. More...
enum	BiometricType { NotSpecified = 0x00 , RightThumbPrint = 0x01 , RightIndexFingerPrint = 0x02 , RightMiddleFingerPrint = 0x03 , RightRingFingerPrint = 0x04 , RightLittleFingerPrint = 0x05 , LeftThumbPrint = 0x06 , LeftIndexFingerPrint = 0x07 , LeftMiddleFingerPrint = 0x08 , LeftRingFingerPrint = 0x09 , LeftLittleFingerPrint = 0x0A , RightIrisScan = 0x0B , RightRetinaScan = 0x0C , LeftIrisScan = 0x0D , LeftRetinaScan = 0x0E , FullFaceImage = 0x0F , RightHandGeometry = 0x10 , LeftHandGeometry = 0x11 }
	The body part that is to be scanned. More...
enum	ObjectId { CardholderUniqueIdentifier , CertificateForPIVAuthentication , CertificateForCardAuthentication , CardholderFingerprintTemplate }
	Enum ObjectId. More...
enum	MessageDataFragmentFieldSize { TwoBytes , FourBytes }
	Defines the field size used for the MessageDataFragment.TotalSize and MessageDataFragment.Offset values. More...
enum	OutputControlCode { Nop = 0x00 , PermanentStateOffAbortTimedOperation = 0x01 , PermanentStateOnAbortTimedOperation = 0x02 , PermanentStateOffAllowTimedOperation = 0x03 , PermanentStateOnAllowTimedOperation = 0x04 , TemporaryStateOnResumePermanentState = 0x05 , TemporaryStateOffResumePermanentState = 0x06 }
	Output Control Code. More...
enum	ToneCode { None = 0x00 , Off = 0x01 , Default = 0x02 }
	Tone codes values. More...
enum	TemporaryReaderControlCode { Nop = 0x00 , CancelAnyTemporaryAndDisplayPermanent = 0x01 , SetTemporaryAndStartTimer = 0x02 }
	Temporary control code values. More...
enum	PermanentReaderControlCode { Nop = 0x00 , SetPermanentState = 0x01 }
	Permanent control code values. More...
enum	LedColor { Black = 0 , Red = 1 , Green = 2 , Amber = 3 , Blue = 4 , Magenta = 5 , Cyan = 6 , White = 7 }
	Color values. More...
enum	TextCommand { PermanentTextNoWrap = 0x01 , PermanentTextWithWrap = 0x02 , TemporaryTextNoWrap = 0x03 , TemporaryTextWithWrap = 0x04 }
	Text command for displaying values. More...
enum	KeyType { SecureChannelBaseKey = 0x01 }
	Key Type. More...

Enumeration Type Documentation

◆ BiometricFormat

enum OSDP.Net.Model.CommandData.BiometricFormat

Format of data to be scanned.

Enumerator
NotSpecified	Default method to scan.
RawFingerprintData	Send raw fingerprint data as PGM.
FingerPrintTemplate	ANSI/INCITS 378 fingerprint template.

Definition at line 6 of file BiometricFormat.cs.

◆ BiometricType

enum OSDP.Net.Model.CommandData.BiometricType

The body part that is to be scanned.

Definition at line 6 of file BiometricType.cs.

◆ KeyType

enum OSDP.Net.Model.CommandData.KeyType

Key Type.

Enumerator
SecureChannelBaseKey	The secure channel base key.

Definition at line 6 of file SecureChannelConfiguration.cs.

◆ LedColor

enum OSDP.Net.Model.CommandData.LedColor

Color values.

Definition at line 207 of file ReaderLedControl.cs.

◆ MessageDataFragmentFieldSize

enum OSDP.Net.Model.CommandData.MessageDataFragmentFieldSize

Defines the field size used for the MessageDataFragment.TotalSize and MessageDataFragment.Offset values.

Enumerator
TwoBytes	Use 2-byte unsigned integer fields.
FourBytes	Use 4-byte signed integer fields.

Definition at line 11 of file MessageDataFragment.cs.

◆ ObjectId

enum OSDP.Net.Model.CommandData.ObjectId

Enum ObjectId.

Enumerator
CardholderUniqueIdentifier	The cardholder unique identifier.
CertificateForPIVAuthentication	The certificate for piv authentication.
CertificateForCardAuthentication	The certificate for card authentication.
CardholderFingerprintTemplate	The cardholder fingerprint template.

Definition at line 129 of file GetPIVData.cs.

◆ OutputControlCode

enum OSDP.Net.Model.CommandData.OutputControlCode

Output Control Code.

Enumerator
Nop	NOP � do not alter this output.
PermanentStateOffAbortTimedOperation	Set the permanent state to OFF, abort timed operation (if any).
PermanentStateOnAbortTimedOperation	Set the permanent state to ON, abort timed operation (if any).
PermanentStateOffAllowTimedOperation	Set the permanent state to OFF, allow timed operation to complete.
PermanentStateOnAllowTimedOperation	Set the permanent state to ON, allow timed operation to complete.
TemporaryStateOnResumePermanentState	Set the temporary state to ON, resume permanent state on timeout.
TemporaryStateOffResumePermanentState	Set the temporary state to OFF, resume permanent state on timeout.

Definition at line 6 of file OutputControlCode.cs.

◆ PermanentReaderControlCode

enum OSDP.Net.Model.CommandData.PermanentReaderControlCode

Permanent control code values.

Enumerator

Nop

Do not alter this LED's permanent settings.

The remaining values of the temporary settings record are ignored.

SetPermanentState

Set the permanent state as given.

Definition at line 191 of file ReaderLedControl.cs.

◆ TemporaryReaderControlCode

enum OSDP.Net.Model.CommandData.TemporaryReaderControlCode

Temporary control code values.

Enumerator

Nop

Do not alter this LED's temporary settings.

The remaining values of the temporary settings record are ignored.

CancelAnyTemporaryAndDisplayPermanent

Cancel any temporary operation and display this LED's permanent state immediately.

SetTemporaryAndStartTimer

Set the temporary state as given and start timer immediately.

Definition at line 170 of file ReaderLedControl.cs.

◆ TextCommand

enum OSDP.Net.Model.CommandData.TextCommand

Text command for displaying values.

Enumerator
PermanentTextNoWrap	Display text permanently with no wrap.
PermanentTextWithWrap	Display text permanently with wrap.
TemporaryTextNoWrap	Display text temporarily with no wrap.
TemporaryTextWithWrap	Display text temporarily with wrap.

Definition at line 105 of file ReaderTextOutput.cs.

◆ ToneCode

enum OSDP.Net.Model.CommandData.ToneCode

Tone codes values.

Enumerator
Off	Turn off the tone.
Default	Turn on the default tone.

Definition at line 100 of file ReaderBuzzerControl.cs.

Classes

Enumerations