OSDP.Net.Model.CommandData.ReaderLedControl Class Reference

Contains data to control the color of a single LED on a PD. More...

Public Member Functions
	ReaderLedControl (byte readerNumber, byte ledNumber, TemporaryReaderControlCode temporaryMode, byte temporaryOnTime, byte temporaryOffTime, LedColor temporaryOnColor, LedColor temporaryOffColor, ushort temporaryTimer, PermanentReaderControlCode permanentMode, byte permanentOnTime, byte permanentOffTime, LedColor permanentOnColor, LedColor permanentOffColor)
	Initializes a new instance of the ReaderLedControl class.

Static Public Member Functions
static ReaderLedControl	ParseData (ReadOnlySpan< byte > data)
	Parses the message payload bytes.

Properties
byte	ReaderNumber [get]
	Gets the reader number starting at 0.
byte	LedNumber [get]
	Gets the LED number.
TemporaryReaderControlCode	TemporaryMode [get]
	Gets the temporary mode.
byte	TemporaryOnTime [get]
	Gets the temporary on time in units of 100ms.
byte	TemporaryOffTime [get]
	Gets the temporary off time in units of 100ms.
LedColor	TemporaryOnColor [get]
	Gets the color of the temporary on.
LedColor	TemporaryOffColor [get]
	Gets the color of the temporary off.
ushort	TemporaryTimer [get]
	Gets the temporary timer in units of 100ms.
PermanentReaderControlCode	PermanentMode [get]
	Gets the permanent mode.
byte	PermanentOnTime [get]
	Gets the permanent on time in units of 100ms.
byte	PermanentOffTime [get]
	Gets the permanent off time in units of 100ms.
LedColor	PermanentOnColor [get]
	Gets the color of the permanent on.
LedColor	PermanentOffColor [get]
	Gets the color of the permanent off.

Detailed Description

Contains data to control the color of a single LED on a PD.

Definition at line 11 of file ReaderLedControl.cs.

Constructor & Destructor Documentation

ReaderLedControl()

OSDP.Net.Model.CommandData.ReaderLedControl.ReaderLedControl ( byte readerNumber, byte ledNumber, TemporaryReaderControlCode temporaryMode, byte temporaryOnTime, byte temporaryOffTime, LedColor temporaryOnColor, LedColor temporaryOffColor, ushort temporaryTimer, PermanentReaderControlCode permanentMode, byte permanentOnTime, byte permanentOffTime, LedColor permanentOnColor, LedColor permanentOffColor )

inline

Initializes a new instance of the ReaderLedControl class.

Parameters

readerNumber	The reader number starting at 0.
ledNumber	The LED number.
temporaryMode	The temporary mode.
temporaryOnTime	The temporary on time in units of 100ms. NOTE: Both On and Off time shouldn't be zero, set this to one if not needed.
temporaryOffTime	The temporary off time in units of 100ms.
temporaryOnColor	Color of the temporary on.
temporaryOffColor	Color of the temporary off.
temporaryTimer	The temporary timer in units of 100ms.
permanentMode	The permanent mode.
permanentOnTime	The permanent on time in units of 100ms. NOTE: Both On and Off time shouldn't be zero, set this to one if not needed.
permanentOffTime	The permanent off time in units of 100ms.
permanentOnColor	Color of the permanent on.
permanentOffColor	Color of the permanent off.

Definition at line 29 of file ReaderLedControl.cs.

References LedNumber, PermanentMode, PermanentOffColor, PermanentOffTime, PermanentOnColor, PermanentOnTime, ReaderNumber, TemporaryMode, TemporaryOffColor, TemporaryOffTime, TemporaryOnColor, TemporaryOnTime, and TemporaryTimer.

Referenced by ParseData().

Member Function Documentation

ParseData()

ReaderLedControl OSDP.Net.Model.CommandData.ReaderLedControl.ParseData ( ReadOnlySpan< byte > data )

inlinestatic

Parses the message payload bytes.

Parameters

data	Message payload as bytes

Returns

An instance of ReaderLedControl representing the message payload

Definition at line 148 of file ReaderLedControl.cs.

References ReaderLedControl().

Referenced by OSDP.Net.Model.CommandData.ReaderLedControls.ParseData().

Property Documentation

LedNumber

byte OSDP.Net.Model.CommandData.ReaderLedControl.LedNumber

get

Gets the LED number.

Definition at line 65 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

PermanentMode

PermanentReaderControlCode OSDP.Net.Model.CommandData.ReaderLedControl.PermanentMode

get

Gets the permanent mode.

Definition at line 100 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

PermanentOffColor

LedColor OSDP.Net.Model.CommandData.ReaderLedControl.PermanentOffColor

get

Gets the color of the permanent off.

Definition at line 120 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

PermanentOffTime

byte OSDP.Net.Model.CommandData.ReaderLedControl.PermanentOffTime

get

Gets the permanent off time in units of 100ms.

Definition at line 110 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

PermanentOnColor

LedColor OSDP.Net.Model.CommandData.ReaderLedControl.PermanentOnColor

get

Gets the color of the permanent on.

Definition at line 115 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

PermanentOnTime

byte OSDP.Net.Model.CommandData.ReaderLedControl.PermanentOnTime

get

Gets the permanent on time in units of 100ms.

Definition at line 105 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

ReaderNumber

byte OSDP.Net.Model.CommandData.ReaderLedControl.ReaderNumber

get

Gets the reader number starting at 0.

Definition at line 60 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

TemporaryMode

TemporaryReaderControlCode OSDP.Net.Model.CommandData.ReaderLedControl.TemporaryMode

get

Gets the temporary mode.

Definition at line 70 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

TemporaryOffColor

LedColor OSDP.Net.Model.CommandData.ReaderLedControl.TemporaryOffColor

get

Gets the color of the temporary off.

Definition at line 90 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

TemporaryOffTime

byte OSDP.Net.Model.CommandData.ReaderLedControl.TemporaryOffTime

get

Gets the temporary off time in units of 100ms.

Definition at line 80 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

TemporaryOnColor

LedColor OSDP.Net.Model.CommandData.ReaderLedControl.TemporaryOnColor

get

Gets the color of the temporary on.

Definition at line 85 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

TemporaryOnTime

byte OSDP.Net.Model.CommandData.ReaderLedControl.TemporaryOnTime

get

Gets the temporary on time in units of 100ms.

Definition at line 75 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

TemporaryTimer

ushort OSDP.Net.Model.CommandData.ReaderLedControl.TemporaryTimer

get

Gets the temporary timer in units of 100ms.

Definition at line 95 of file ReaderLedControl.cs.

Referenced by ReaderLedControl().

---

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

• OSDP.Net/Model/CommandData/ReaderLedControl.cs