OSDP.Net.DeviceConfiguration Class Reference

Represents a set of configuration options to be used when initializing a new instance of the Device class. More...

Inheritance diagram for OSDP.Net.DeviceConfiguration:

Public Member Functions
	DeviceConfiguration (ClientIdentification identification)
	Creates a new DeviceConfiguration with the required client identification.
DeviceConfiguration	Clone ()
	Creates a new object that is a copy of the current instance.

Properties
byte	Address [get, set]
	Address the device is assigned.
bool	RequireSecurity = true [get, set]
	Indicates whether the device will require an establishment of a secure channel.
byte[]	SecurityKey = SecurityContext.DefaultKey [get, set]
	Security Key if one was previously set via osdp_KeySet command or some other out-of-band means.
CommandType[]	AllowUnsecured [get, set]
	List of commands the PD will allow to be sent unsecured when a device is operating in "Full Security" mode as defined by the OSDP spec.
ClientIdentification	Identification [get]
	Client identification (cUID) used during secure channel establishment.

Detailed Description

Represents a set of configuration options to be used when initializing a new instance of the Device class.

Definition at line 622 of file Device.cs.

Constructor & Destructor Documentation

DeviceConfiguration()

OSDP.Net.DeviceConfiguration.DeviceConfiguration ( ClientIdentification identification )

inline

Creates a new DeviceConfiguration with the required client identification.

Parameters

identification

Client identification used during secure channel establishment

Definition at line 628 of file Device.cs.

References Identification.

Referenced by Clone().

Property Documentation

Address

byte OSDP.Net.DeviceConfiguration.Address

getset

Address the device is assigned.

Definition at line 636 of file Device.cs.

AllowUnsecured

CommandType [] OSDP.Net.DeviceConfiguration.AllowUnsecured

getset

Initial value:

=
    [
        CommandType.IdReport, CommandType.DeviceCapabilities, CommandType.CommunicationSet
    ]

List of commands the PD will allow to be sent unsecured when a device is operating in "Full Security" mode as defined by the OSDP spec.

NOTE: per the OSDP committee's decision, by default, this list will include IdReport, DeviceCapabilities and CommSet commands, but a PD manufacturer can use this property to override that default

Definition at line 658 of file Device.cs.

Identification

ClientIdentification OSDP.Net.DeviceConfiguration.Identification

get

Client identification (cUID) used during secure channel establishment.

Composed of vendor code (3 bytes) and serial number (4 bytes). This is required for OSDP secure channel compliance. See OSDP specification for osdp_CCRYPT response format.

Definition at line 669 of file Device.cs.

Referenced by DeviceConfiguration().

RequireSecurity

bool OSDP.Net.DeviceConfiguration.RequireSecurity = true

getset

Indicates whether the device will require an establishment of a secure channel.

When this value is 'true', PD will be initialized with SCBK (non-default SecurityKey) in full-security mode; or with SCBK_D in "installation mode" if SecurityKey is not set to a non-default installation value.

Definition at line 644 of file Device.cs.

SecurityKey

byte [] OSDP.Net.DeviceConfiguration.SecurityKey = SecurityContext.DefaultKey

getset

Security Key if one was previously set via osdp_KeySet command or some other out-of-band means.

Definition at line 650 of file Device.cs.

---

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

• OSDP.Net/Device.cs