OSDP.Net 5.2.1
A .NET library for implementing the Open Supervised Device Protocol (OSDP)
Loading...
Searching...
No Matches
OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification Class Reference

The extended PD identification data sent as a reply to an osdp_ID command with data 0x01. More...

Inheritance diagram for OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification:
OSDP.Net.Model.PayloadData

Public Member Functions

 ExtendedDeviceIdentification (IEnumerable< ExtendedIdEntry > entries)
 Creates a new instance of ExtendedDeviceIdentification with the specified entries.
override ReadOnlySpan< byte > SecurityControlBlock ()
override byte[] BuildData ()
override string ToString ()
Public Member Functions inherited from OSDP.Net.Model.PayloadData
byte[] BuildData ()
 Converts the payload into a byte array to be sent over the wire.
ReadOnlySpan< byte > SecurityControlBlock ()
 Retrieves the security control block for a specific command data type.
virtual void CustomMessageUpdate (Span< byte > messageBuffer)
 Updates the message data before sending in the specified byte buffer.

Static Public Member Functions

static ExtendedDeviceIdentification ParseData (ReadOnlySpan< byte > data)
 Parses the TLV stream from the given data.

Properties

IReadOnlyList< ExtendedIdEntry > Entries [get]
 Gets all TLV entries in this identification.
IEnumerable< ExtendedIdEntry > UnknownEntries [get]
 Gets all entries with unknown/undefined tag types.
string Manufacturer [get]
 Gets the manufacturer name, or null if not present.
string ProductName [get]
 Gets the product name, or null if not present.
string SerialNumber [get]
 Gets the serial number, or null if not present.
IEnumerable< string > FirmwareVersions [get]
 Gets all firmware version entries.
string HardwareDescription [get]
 Gets the hardware description, or null if not present.
string Url [get]
 Gets the URL, or null if not present.
string ConfigurationReference [get]
 Gets the configuration reference, or null if not present.
override byte Code [get]
Properties inherited from OSDP.Net.Model.PayloadData
byte Code [get]
 Gets the command or reply code byte value that represent the type of data.
virtual bool IsSecurityInitialization [get]
 Gets a value indicating whether the security initialization is performed by this payload.

Detailed Description

The extended PD identification data sent as a reply to an osdp_ID command with data 0x01.

Contains a TLV (Tag-Length-Value) stream with detailed device information.

Definition at line 14 of file ExtendedDeviceIdentification.cs.

Constructor & Destructor Documentation

◆ ExtendedDeviceIdentification()

OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.ExtendedDeviceIdentification ( IEnumerable< ExtendedIdEntry > entries)
inline

Creates a new instance of ExtendedDeviceIdentification with the specified entries.

Parameters
entriesThe TLV entries for this identification.

Definition at line 22 of file ExtendedDeviceIdentification.cs.

Referenced by ParseData().

Member Function Documentation

◆ BuildData()

override byte[] OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.BuildData ( )
inline

Definition at line 129 of file ExtendedDeviceIdentification.cs.

◆ ParseData()

ExtendedDeviceIdentification OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.ParseData ( ReadOnlySpan< byte > data)
inlinestatic

Parses the TLV stream from the given data.

Parameters
dataThe complete message data which may include multipart message header.
Returns
The parsed ExtendedDeviceIdentification.

Definition at line 87 of file ExtendedDeviceIdentification.cs.

References ExtendedDeviceIdentification(), and OSDP.Net.Model.ReplyData.ExtendedIdEntry.ParseData().

◆ SecurityControlBlock()

override ReadOnlySpan< byte > OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.SecurityControlBlock ( )
inline

Definition at line 77 of file ExtendedDeviceIdentification.cs.

◆ ToString()

override string OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.ToString ( )
inline

Property Documentation

◆ Code

override byte OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.Code
get

Definition at line 74 of file ExtendedDeviceIdentification.cs.

◆ ConfigurationReference

string OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.ConfigurationReference
get

Gets the configuration reference, or null if not present.

Definition at line 71 of file ExtendedDeviceIdentification.cs.

Referenced by ToString().

◆ Entries

IReadOnlyList<ExtendedIdEntry> OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.Entries
get

Gets all TLV entries in this identification.

Definition at line 30 of file ExtendedDeviceIdentification.cs.

◆ FirmwareVersions

IEnumerable<string> OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.FirmwareVersions
get

Gets all firmware version entries.

Multiple entries are allowed for different microcontrollers.

Definition at line 56 of file ExtendedDeviceIdentification.cs.

Referenced by ToString().

◆ HardwareDescription

string OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.HardwareDescription
get

Gets the hardware description, or null if not present.

Definition at line 61 of file ExtendedDeviceIdentification.cs.

Referenced by ToString().

◆ Manufacturer

string OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.Manufacturer
get

Gets the manufacturer name, or null if not present.

Definition at line 41 of file ExtendedDeviceIdentification.cs.

Referenced by ToString().

◆ ProductName

string OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.ProductName
get

Gets the product name, or null if not present.

Definition at line 46 of file ExtendedDeviceIdentification.cs.

Referenced by ToString().

◆ SerialNumber

string OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.SerialNumber
get

Gets the serial number, or null if not present.

Definition at line 51 of file ExtendedDeviceIdentification.cs.

Referenced by ToString().

◆ UnknownEntries

IEnumerable<ExtendedIdEntry> OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.UnknownEntries
get

Gets all entries with unknown/undefined tag types.

These may be vendor-specific extensions or future OSDP specification additions.

Definition at line 36 of file ExtendedDeviceIdentification.cs.

Referenced by ToString().

◆ Url

string OSDP.Net.Model.ReplyData.ExtendedDeviceIdentification.Url
get

Gets the URL, or null if not present.

Definition at line 66 of file ExtendedDeviceIdentification.cs.

Referenced by ToString().


The documentation for this class was generated from the following file: