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

The PD identification data sent as a reply. More...

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

Public Member Functions

 DeviceIdentification (byte[] vendorCode, byte modelNumber, byte version, int serialNumber, byte firmwareMajor, byte firmwareMinor, byte firmwareBuild)
 Creates a new instance of DeviceIdentification.
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 DeviceIdentification ParseData (ReadOnlySpan< byte > data)
 Parses the message payload bytes.

Properties

IEnumerable< byte > VendorCode [get]
 Gets the vendor code.
byte ModelNumber [get]
 Gets the model number.
byte Version [get]
 Gets the hardware version.
int SerialNumber [get]
 Gets the serial number.
byte FirmwareMajor [get]
 Gets the firmware major version.
byte FirmwareMinor [get]
 Gets the firmware minor version.
byte FirmwareBuild [get]
 Gets the firmware build.
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 PD identification data sent as a reply.

Definition at line 13 of file DeviceIdentification.cs.

Constructor & Destructor Documentation

◆ DeviceIdentification()

OSDP.Net.Model.ReplyData.DeviceIdentification.DeviceIdentification ( byte[] vendorCode,
byte modelNumber,
byte version,
int serialNumber,
byte firmwareMajor,
byte firmwareMinor,
byte firmwareBuild )
inline

Creates a new instance of DeviceIdentification.

Definition at line 18 of file DeviceIdentification.cs.

References FirmwareBuild, FirmwareMajor, FirmwareMinor, ModelNumber, SerialNumber, VendorCode, and Version.

Referenced by ParseData().

Member Function Documentation

◆ BuildData()

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

◆ ParseData()

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

Parses the message payload bytes.

Parameters
dataMessage payload as bytes
Returns
An instance of DeviceIdentification representing the message payload

Definition at line 69 of file DeviceIdentification.cs.

References DeviceIdentification().

Referenced by OSDP.Net.ControlPanel.IdReport(), and OSDP.Net.Model.Packet.ParsePayloadData().

◆ SecurityControlBlock()

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

Definition at line 61 of file DeviceIdentification.cs.

◆ ToString()

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

Definition at line 101 of file DeviceIdentification.cs.

Property Documentation

◆ Code

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

Definition at line 58 of file DeviceIdentification.cs.

◆ FirmwareBuild

byte OSDP.Net.Model.ReplyData.DeviceIdentification.FirmwareBuild
get

Gets the firmware build.

Definition at line 55 of file DeviceIdentification.cs.

Referenced by BuildData(), and DeviceIdentification().

◆ FirmwareMajor

byte OSDP.Net.Model.ReplyData.DeviceIdentification.FirmwareMajor
get

Gets the firmware major version.

Definition at line 45 of file DeviceIdentification.cs.

Referenced by BuildData(), and DeviceIdentification().

◆ FirmwareMinor

byte OSDP.Net.Model.ReplyData.DeviceIdentification.FirmwareMinor
get

Gets the firmware minor version.

Definition at line 50 of file DeviceIdentification.cs.

Referenced by BuildData(), and DeviceIdentification().

◆ ModelNumber

byte OSDP.Net.Model.ReplyData.DeviceIdentification.ModelNumber
get

Gets the model number.

Definition at line 34 of file DeviceIdentification.cs.

Referenced by BuildData(), and DeviceIdentification().

◆ SerialNumber

int OSDP.Net.Model.ReplyData.DeviceIdentification.SerialNumber
get

Gets the serial number.

Definition at line 40 of file DeviceIdentification.cs.

Referenced by BuildData(), and DeviceIdentification().

◆ VendorCode

IEnumerable<byte> OSDP.Net.Model.ReplyData.DeviceIdentification.VendorCode
get

Gets the vendor code.

Definition at line 31 of file DeviceIdentification.cs.

Referenced by BuildData(), and DeviceIdentification().

◆ Version

byte OSDP.Net.Model.ReplyData.DeviceIdentification.Version
get

Gets the hardware version.

Definition at line 37 of file DeviceIdentification.cs.

Referenced by BuildData(), and DeviceIdentification().


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