- OSDP.Net on z-bitco.com
- Generated by
1.15.0
|
OSDP.Net 5.2.1
A .NET library for implementing the Open Supervised Device Protocol (OSDP)
|
Classes | |
| class | Ack |
| Generic ACK reply. More... | |
| class | BiometricMatchResult |
| A biometric match reply after a scan. More... | |
| class | BiometricReadResult |
| A biometric read reply. More... | |
| class | ChallengeResponse |
| Represents a reply to osdp_CHLNG command and contain's PD's ID, PD-generated random number and PD cryptogram. | |
| class | CommunicationConfiguration |
| The actual communication configuration of the PD sent as a reply. More... | |
| class | DataFragmentResponse |
| A multi-part message data fragment reply. More... | |
| class | DeviceCapabilities |
| The PD device capabilities data sent as a reply. More... | |
| class | DeviceCapability |
| Generic capability data for a PD. More... | |
| class | MsgSizeDeviceCap |
| Common base for the device capabilities that identify byte sizes. More... | |
| class | CommSecurityDeviceCap |
| Receive Buffer Size PD capability. More... | |
| class | DeviceIdentification |
| The PD identification data sent as a reply. More... | |
| class | ExtendedDeviceIdentification |
| The extended PD identification data sent as a reply to an osdp_ID command with data 0x01. More... | |
| class | ExtendedDeviceIdentificationBuilder |
| Fluent builder for creating ExtendedDeviceIdentification instances. More... | |
| class | ExtendedIdEntry |
| Represents a single TLV (Tag-Length-Value) entry in the extended device identification response. More... | |
| class | ExtendedRead |
| An extended read (transparent mode) reply. More... | |
| class | FileTransferStatus |
| The PD file transfer status sent as a reply. More... | |
| class | FormattedCardData |
| A formated card data reply. More... | |
| class | InitialRMac |
| Represents the payload of osdp_RMAC_I reply. | |
| class | InputStatus |
| A input status report reply as defined in OSDP v2.2.2 specification. More... | |
| class | KeypadData |
| A keypad reply. More... | |
| class | LocalStatus |
| A local status report reply. More... | |
| class | ManufacturerSpecific |
| A manufacturer specific reply. More... | |
| class | Nak |
| A negative reply. More... | |
| class | OutputStatus |
| A output status report reply. More... | |
| class | RawCardData |
| A raw card data reply. More... | |
| class | ReaderStatus |
| A reader status report reply. More... | |
| class | ReturnReplyData< T > |
| Reply from a command that has different possible results. More... | |
Enumerations | |
| enum | BiometricStatus { Success = 0x00 , Timeout = 0x01 , UnknownError = 0xFF } |
| Results of the biometric scanning. More... | |
| enum | CapabilityFunction { Unknown = 0 , ContactStatusMonitoring = 1 , OutputControl = 2 , CardDataFormat = 3 , ReaderLEDControl = 4 , ReaderAudibleOutput = 5 , ReaderTextOutput = 6 , TimeKeeping = 7 , CheckCharacterSupport = 8 , CommunicationSecurity = 9 , ReceiveBufferSize = 10 , LargestCombinedMessageSize = 11 , SmartCardSupport = 12 , Readers = 13 , Biometrics = 14 , SecurePINEntry = 15 , OSDPVersion = 16 , ExtendedIdResponse = 17 } |
| Definitions of the capability function codes. More... | |
| enum | ExtendedIdTag : byte { Manufacturer = 0 , ProductName = 1 , SerialNumber = 2 , FirmwareVersion = 3 , HardwareDescription = 4 , Url = 5 , ConfigurationReference = 6 } |
| Defines the tag types used in the extended device identification TLV stream. More... | |
| enum | ReadDirection { Forward = 0x00 , Reverse = 0x01 } |
| The direction for reading the formatted card data. More... | |
| enum | InputStatusValue : byte { Inactive = 0x00 , Active = 0x01 , Short = 0x02 , Open = 0x03 , Fault = 0x04 , Unknown = 0x05 } |
| Represents the possible states of an input as defined in Table 52 of the OSDP v2.2.2 specification. More... | |
| enum | ErrorCode { NoError = 0x0 , BadChecksumOrCrc = 0x1 , InvalidCommandLength = 0x2 , UnknownCommandCode = 0x3 , UnexpectedSequenceNumber = 0x4 , DoesNotSupportSecurityBlock = 0x5 , CommunicationSecurityNotMet = 0x6 , BioTypeNotSupported = 0x7 , BioFormatNotSupported = 0x8 , UnableToProcessCommand = 0x9 , GenericError = 0xFF } |
| Error code. More... | |
| enum | FormatCode { NotSpecified = 0x0 , Wiegand = 0x1 } |
| The raw card format code. More... | |
| enum | ReaderTamperStatus { Normal = 0x00 , NotConnected = 0x01 , Tamper = 0x02 } |
| Possible states that the reader is currently reporting. More... | |
Results of the biometric scanning.
Definition at line 6 of file BiometricStatus.cs.
Definitions of the capability function codes.
| Enumerator | |
|---|---|
| Unknown | Capability is not defined. |
| ContactStatusMonitoring | The compliance level of contact status monitoring. Compliance Levels: 01 - PD monitors and reports the state of the circuit without any supervision. The PD encodes the circuit status per its default interpretation of contact state to active/inactive status. 02 - Like 1, plus: The PD accepts configuration of the encoding of the open/closed circuit status to the reported active/inactive status. (User may configure each circuit as "normally closed" or "normally open".) 03 - Like 2, plus: PD supports supervised monitoring. The operating mode for each circuit is determined by configuration settings. 04 - Like 3, plus: the PD supports custom End-Of-Line settings within the Manufacturer's guidelines. Number Of: The number of Inputs. |
| OutputControl | The compliance level of output control. Compliance Levels: 01 - The PD is able to activate and deactivate the Output per direct command from the ACU. 02 - Like 1, plus: The PD is able to accept configuration of the Output driver to set the inactive state of the Output. The typical state of an inactive Output is the state of the Output when no power is applied to the PD and the Output device (relay) is not energized. The inverted drive setting causes the PD to energize the Output during the inactive state and de- energize the Output during the active state. 03 - Like 2, plus: PD supports supervised monitoring. The operating mode for each circuit is determined by configuration settings. 04 - Like 3, plus: the PD supports custom End-Of-Line settings within the Manufacturer's guidelines. Number Of: The number of Outputs. |
| CardDataFormat | The form card data format presented to the control panel. Compliance Levels: 01 - The PD sends card data to the ACU as array of bits, not exceeding 1024 bits. 02 - The PD sends card data to the ACU as array of BCD characters, not exceeding 256 characters. 03 - The PD can send card data to the ACU as array of bits, or as an array of BCD characters. Number Of: N/A, set to 0. |
| ReaderLEDControl | The compliance level of reader LEDs. Compliance Levels: 01 - The PD support on/off control only. 02 - The PD supports timed commands. 03 - Like 2, plus bi-color LEDs. 04 - Like 2, plus tri-color LEDs. Number Of: The number of LEDs per reader. |
| ReaderAudibleOutput | The compliance level of reader audio output. Compliance Levels: 01 - The PD supports on/off control only. 02 - The PD supports timed commands. Number Of: This field is ignored. |
| ReaderTextOutput | The compliance level of reader text output. Compliance Levels: 00 - The PD has no text display support. 01 - The PD supports 1 row of 16 characters. 02 - The PD supports 2 rows of 16 characters. 03 - The PD supports 4 rows of 16 characters. Number Of: Number of textual displays per reader. |
| CheckCharacterSupport | Check character support for the PD. Compliance Levels: 00 - The PD does not support CRC-16, only checksum mode. 01 -The PD supports the 16-bit CRC-16 mode. Number Of: N/A, set to 0. |
| CommunicationSecurity | Secure communications support for the PD. Compliance Levels: Bit 0 (mask 0x01) - AES128 support. Number Of: (Bit-0) default AES128 key. |
| ReceiveBufferSize | Maximum size single message the PD can receive. Compliance Levels: LSB of the buffer size. Number Of: MSB of the buffer size. |
| LargestCombinedMessageSize | Maximum size multi-part message the PD can handle. Compliance Levels: LSB of the combined buffer size. Number Of: MSB of the combined buffer size. |
| SmartCardSupport | Smart card communication support for the PD. Compliance Levels: Bit 0 (mask 0x01) - PD supports transparent reader mode. Bit 1 (mask 0x02) - PD supports extended packet mode. Number Of: N/A, set to 0. |
| Readers | Number of readers present on PD. Compliance Levels: Must be zero. Number Of: Indicates the number of attached downstream readers. |
| Biometrics | The compliance level of reader biometric input. Compliance Levels: 0 - No Biometric. 1 - Fingerprint, Template 1. 2 - Fingerprint, Template 2. 3 - Iris, Template 1. Number Of: N/A, set to 0. |
| SecurePINEntry | Secure PIN entry support for the PD. Compliance Levels: 0 - Does not support SPE. 1 - Supports SPE. Number Of: N/A, set to 0. |
| OSDPVersion | Version of OSDP support by the PD. Compliance Levels: 0 - Unspecified 1 - IEC 60839-11-5 . 2 - SIA OSDP 2.2 Number Of: N/A, set to 0. |
| ExtendedIdResponse | Extended ID response support for the PD. Compliance Levels: 0x00 - Capability not supported. 0x01 - Extended ID response is supported. Number Of: Must be 0x00. |
Definition at line 8 of file CapabilityFunction.cs.
Error code.
| Enumerator | |
|---|---|
| NoError | No error. |
| BadChecksumOrCrc | Message check character(s) error (bad checksum/crc). |
| InvalidCommandLength | Command length error. |
| UnknownCommandCode | Unknown command code. |
| UnexpectedSequenceNumber | Unexpected sequence number detected in the header. |
| DoesNotSupportSecurityBlock | This PD does not support the security block that was received. |
| CommunicationSecurityNotMet | Encrypted communication is required to process this command. |
| BioTypeNotSupported | The Bio type is not supported. |
| BioFormatNotSupported | The Bio format is not supported. |
| UnableToProcessCommand | Unable to process command record. |
| GenericError | The generic error. |
| enum OSDP.Net.Model.ReplyData.ExtendedIdTag : byte |
Defines the tag types used in the extended device identification TLV stream.
Definition at line 6 of file ExtendedIdTag.cs.
The raw card format code.
| Enumerator | |
|---|---|
| NotSpecified | Card format not specified. |
| Wiegand | Wiegand card format. |
Definition at line 163 of file RawCardData.cs.
| enum OSDP.Net.Model.ReplyData.InputStatusValue : byte |
Represents the possible states of an input as defined in Table 52 of the OSDP v2.2.2 specification.
Definition at line 6 of file InputStatusValue.cs.
The direction for reading the formatted card data.
| Enumerator | |
|---|---|
| Forward | Forward direction. |
| Reverse | Reverse direction. |
Definition at line 113 of file FormattedCardData.cs.
Possible states that the reader is currently reporting.
| Enumerator | |
|---|---|
| Normal | Reader is in a normal state. |
| NotConnected | Reader is in a not connected state. |
| Tamper | Reader is in a tamper state. |
Definition at line 6 of file ReaderTamperStatus.cs.
1.15.0