Implementation of the CONTROL class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/) More...

Inheritance diagram for SpringCard.SpringCore.Direct.DirectDevice.ControlI:

Public Types
enum	INS : byte { INS.SetBuzzerCompat = 0x1C, INS.SetLedsCompat = 0x1E, INS.GetData = 0x20, INS.GetCcidSlotName = 0x21, INS.CcidStopSlot = 0x22, INS.CcidStartSlot = 0x23, INS.ReadFreeRegister = 0x80, INS.ReadRegister = 0x81, INS.WriteRegister = 0x82, INS.LoadFactoryConfig = 0x83, INS.SaveFactoryConfig = 0x84, INS.GetDateTime = 0x85, INS.SetDateTime = 0x86, INS.Reset = 0x8E, INS.ReloadConfig = 0x8F, INS.PlaySequence = 0x90, INS.SetLedRGB = 0x91, INS.SetLeds = 0x92, INS.SetBuzzer = 0x93, INS.SetLight = 0x97, INS.PlaySequenceString = 0x98, INS.SetAutoDimmLight = 0x9A, INS.SetAutoSequences = 0x9B, INS.Wink = 0x9F, INS.RDRStop = 0xA0, INS.RDRStartOnce = 0xA1, INS.RDRStartOne = 0xA2, INS.RDRStart = 0xA3, INS.iBeacon = 0xAB, INS.RemoteDisconnect = 0xAE, INS.Shutdown = 0xAF, GetPkiSubject = 0xD0, ReadPkiCertificate = 0xD1, WritePkiCertificate = 0xD2, INS.IsSealGenuine = 0xE0, INS.GetSealSubject = 0xE1, INS.GetSealHash = 0xE2, INS.ReadSealSignature = 0xE3, INS.WriteSealSignature = 0xE4 }
	INStructions exposed by this class. More...

Public Member Functions
bool	GetData (GetData.Entries idx, out byte[] data)
	GET_DATA. More...

bool	GetData (byte idx, out byte[] data)
	GET_DATA. More...

string	GetDataString (GetData.Entries idx)
	GET_DATA. More...

string	GetDataString (byte idx)
	GET_DATA. More...

byte[]	GetDataRaw (GetData.Entries idx)
	GET_DATA. More...

byte[]	GetDataRaw (byte idx)
	GET_DATA. More...

bool	IsDeviceGenuine ()
	IS_SEAL_GENUINE. More...

bool	GetSealSubject (out byte[] buffer)
	GET_SEAL_SUBJECT. More...

bool	GetSealHash (out byte[] buffer)
	GET_SEAL_HASH. More...

bool	ReadSealSignature (out byte[] buffer)
	READ_SEAL_SIGNATURE. More...

bool	WriteSealSignature (byte[] buffer)
	WRITE_SEAL_SIGNATURE. More...

bool	ReadFreeRegister (ushort register, out byte[] value)
	READ_FREE_REGISTER. More...

bool	ReadRegister (ushort register, out byte[] value)
	READ_REGISTER. More...

bool	WriteRegister (ushort register, byte[] value)
	WRITE_REGISTER. More...

bool	LoadFactoryConfig ()
	LOAD_FACTORY_CONFIG. More...

bool	LoadFactoryConfigEx (ushort flags)

bool	SaveFactoryConfig ()
	SAVE_FACTORY_CONFIG. More...

bool	LockFuses (byte lock_mask)
	LOCK_FUSES. More...

bool	UnlockFuses (byte clear_mask)
	UNLOCK_FUSES. More...

bool	SetDateTime (DateTime dt)
	SET_DATE_TIME. More...

bool	GetDateTime (out DateTime dt)
	GET_DATETIME. More...

bool	ReloadConfig ()
	RELOAD_CONFIG. More...

bool	Reset ()
	RESET. More...

bool	Shutdown ()
	SHUTDOWN. More...

bool	Wink ()
	WINK. More...

GetData.BatteryState	GetBatteryState ()
	GET_DATA(BatteryState) More...

GetData.BootloaderFlags	GetBootloaderFlags ()
	GET_DATA(BootloaderFlags) More...

GetData.HardwareCharacteristics	GetHardwareCharacteristics ()
	GET_DATA(Characteristics) More...

virtual bool	CcidStart ()

virtual bool	CcidStart (byte slot)

virtual bool	CcidStop ()

virtual bool	CcidStop (byte slot)

virtual bool	ReaderStart ()

virtual bool	ReaderStop ()

bool	iBeaconStop ()
	iBeacon stop More...

bool	iBeaconStart (byte duration_s, byte[] id, string name)
	iBeacon start More...

bool	iBeaconStart (byte duration_s, uint id, string name)
	iBeacon start More...

bool	iBeaconStart (byte[] id, string name)
	iBeacon start More...

bool	iBeaconStart (uint id, string name)
	iBeacon start More...

bool	iBeaconStart (byte[] id)
	iBeacon start More...

bool	iBeaconStart (uint id)
	iBeacon start More...

bool	GetPkiSubject (byte subjectIdx, out byte[] buffer)

bool	ReadPkiCertificate (byte certIdx, out byte[] buffer)

bool	WritePkiCertificate (byte certIdx, byte[] buffer)

Additional Inherited Members
Protected Member Functions inherited from SpringCard.SpringCore.Direct.DirectDevice.ExchangeI
	ExchangeI (CLA _CLA, DirectDevice parent)

bool	Exchange (CLA Cla, byte[] Cmd, out byte[] Rsp, ExchangeOptions options=null)

bool	Exchange (byte Cmd, byte[] CmdData, out byte Sta, out byte[] RspData, ExchangeOptions options=null)

bool	Exchange (byte Cmd, byte[] CmdData, out byte[] RspData, ExchangeOptions options=null)

bool	Exchange (byte Cmd, byte[] CmdData, out byte Sta, ExchangeOptions options=null)

bool	Exchange (byte Cmd, byte[] CmdData, ExchangeOptions options=null)

bool	Exchange (byte Cmd, ExchangeOptions options=null)

bool	Exchange (byte Cmd, out byte[] RspData, ExchangeOptions options=null)

Properties inherited from SpringCard.SpringCore.Direct.DirectDevice.ExchangeI
DirectDevice	parent `[get]`

CLA	_CLA `[get]`

Detailed Description

Implementation of the CONTROL class (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/)

Member Enumeration Documentation

◆ INS

enum SpringCard.SpringCore.Direct.DirectDevice.ControlI.INS : byte

strong

INStructions exposed by this class.

Enumerator
SetBuzzerCompat	For compatibility with SpringProx products
SetLedsCompat	For compatibility with SpringProx products
GetData	GET_DATA (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Queries/GET_DATA)
GetCcidSlotName	CCID_GET_SLOT_NAME (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/CCID/CCID_GET_SLOT_NAME)
CcidStopSlot	CCID_STOP_SLOT (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/CCID/CCID_STOP_SLOT)
CcidStartSlot	CCID_START_SLOT (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/CCID/CCID_START_SLOT)
ReadFreeRegister	READ_FREE_REGISTER
ReadRegister	READ_REGISTER (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Configuration/READ_REGISTER)
WriteRegister	WRITE_REGISTER (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Configuration/WRITE_REGISTER)
LoadFactoryConfig	LOAD_FACTORY_CONFIG (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Configuration/LOAD_FACTORY_CONFIG)
SaveFactoryConfig	SAVE_FACTORY_CONFIG (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Configuration/SAVE_FACTORY_CONFIG)
GetDateTime	GET_DATE_TIME (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Configuration/GET_DATETIME)
SetDateTime	SET_DATE_TIME (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Configuration/SET_DATETIME)
Reset	RESET (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Actions/RESET)
ReloadConfig	RELOAD_CONFIG (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Configuration/RELOAD_CONFIG)
PlaySequence	PLAY_SEQUENCE (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/User_Interface/PLAY_SEQUENCE)
SetLedRGB	SET_LED_RGB (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/User_Interface/SET_LED_RGB)
SetLeds	SET_LEDS (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/User_Interface/SET_LEDS)
SetBuzzer	SET_BUZZER (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/User_Interface/SET_BUZZER)
SetLight	SET_LIGHT (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/User_Interface/SET_LIGHT)
PlaySequenceString	PLAY_SEQUENCE_STRING (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/User_Interface/PLAY_SEQUENCE_STRING)
SetAutoDimmLight	SET_AUTO_DIMM_LIGHT (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/User_Interface/AUTO_DIMM_LIGHT)
SetAutoSequences	SET_AUTO_SEQUENCES (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/User_Interface/AUTO_SEQUENCES)
Wink	WINK (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/User_Interface/WINK)
RDRStop	READER_STOP (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Reader/READER_STOP)
RDRStartOnce	READER_ONCE (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Reader/READER_ONCE)
RDRStartOne	READER_START_ONE (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Reader/READER_START_ONE)
RDRStart	READER_START (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Reader/READER_START)
iBeacon	IBEACON (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Actions/IBEACON)
RemoteDisconnect	REMOTE_DISCONNECT (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Actions/REMOTE_DISCONNECT)
Shutdown	SHUTDOWN (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Actions/SHUTDOWN)
IsSealGenuine	IS_SEAL_GENUINE (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Authenticity/IS_SEAL_GENUINE)
GetSealSubject	GET_SEAL_SUBJECT (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Authenticity/GET_SEAL_SUBJECT)
GetSealHash	GET_SEAL_HASH
ReadSealSignature	READ_SEAL_SIGNATURE (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Authenticity/READ_SEAL_SIGNATURE)
WriteSealSignature	WRITE_SEAL_SIGNATURE (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/CONTROL_class/Authenticity/WRITE_SEAL_SIGNATURE)

Member Function Documentation

◆ GetBatteryState()

GetData.BatteryState SpringCard.SpringCore.Direct.DirectDevice.ControlI.GetBatteryState ( )

GET_DATA(BatteryState)

◆ GetBootloaderFlags()

GetData.BootloaderFlags SpringCard.SpringCore.Direct.DirectDevice.ControlI.GetBootloaderFlags ( )

GET_DATA(BootloaderFlags)

◆ GetData() [1/2]

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.GetData	(	byte	idx,
		out byte[]	data
	)

GET_DATA.

◆ GetData() [2/2]

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.GetData	(	GetData.Entries	idx,
		out byte[]	data
	)

GET_DATA.

◆ GetDataRaw() [1/2]

byte [] SpringCard.SpringCore.Direct.DirectDevice.ControlI.GetDataRaw ( byte idx )

GET_DATA.

◆ GetDataRaw() [2/2]

byte [] SpringCard.SpringCore.Direct.DirectDevice.ControlI.GetDataRaw ( GetData.Entries idx )

GET_DATA.

◆ GetDataString() [1/2]

string SpringCard.SpringCore.Direct.DirectDevice.ControlI.GetDataString ( byte idx )

GET_DATA.

◆ GetDataString() [2/2]

string SpringCard.SpringCore.Direct.DirectDevice.ControlI.GetDataString ( GetData.Entries idx )

GET_DATA.

◆ GetDateTime()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.GetDateTime ( out DateTime dt )

GET_DATETIME.

◆ GetHardwareCharacteristics()

GetData.HardwareCharacteristics SpringCard.SpringCore.Direct.DirectDevice.ControlI.GetHardwareCharacteristics ( )

GET_DATA(Characteristics)

◆ GetSealHash()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.GetSealHash ( out byte[] buffer )

GET_SEAL_HASH.

◆ GetSealSubject()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.GetSealSubject ( out byte[] buffer )

GET_SEAL_SUBJECT.

◆ iBeaconStart() [1/6]

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.iBeaconStart	(	byte	duration_s,
		byte[]	id,
		string	name
	)

iBeacon start

◆ iBeaconStart() [2/6]

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.iBeaconStart	(	byte	duration_s,
		uint	id,
		string	name
	)

iBeacon start

◆ iBeaconStart() [3/6]

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.iBeaconStart ( byte[] id )

iBeacon start

◆ iBeaconStart() [4/6]

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.iBeaconStart	(	byte[]	id,
		string	name
	)

iBeacon start

◆ iBeaconStart() [5/6]

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.iBeaconStart ( uint id )

iBeacon start

◆ iBeaconStart() [6/6]

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.iBeaconStart	(	uint	id,
		string	name
	)

iBeacon start

◆ iBeaconStop()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.iBeaconStop ( )

iBeacon stop

◆ IsDeviceGenuine()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.IsDeviceGenuine ( )

IS_SEAL_GENUINE.

◆ LoadFactoryConfig()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.LoadFactoryConfig ( )

LOAD_FACTORY_CONFIG.

◆ LockFuses()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.LockFuses ( byte lock_mask )

LOCK_FUSES.

◆ ReadFreeRegister()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.ReadFreeRegister	(	ushort	register,
		out byte[]	value
	)

READ_FREE_REGISTER.

◆ ReadRegister()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.ReadRegister	(	ushort	register,
		out byte[]	value
	)

READ_REGISTER.

◆ ReadSealSignature()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.ReadSealSignature ( out byte[] buffer )

READ_SEAL_SIGNATURE.

◆ ReloadConfig()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.ReloadConfig ( )

RELOAD_CONFIG.

◆ Reset()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.Reset ( )

RESET.

◆ SaveFactoryConfig()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.SaveFactoryConfig ( )

SAVE_FACTORY_CONFIG.

◆ SetDateTime()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.SetDateTime ( DateTime dt )

SET_DATE_TIME.

◆ Shutdown()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.Shutdown ( )

SHUTDOWN.

◆ UnlockFuses()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.UnlockFuses ( byte clear_mask )

UNLOCK_FUSES.

◆ Wink()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.Wink ( )

WINK.

◆ WriteRegister()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.WriteRegister	(	ushort	register,
		byte[]	value
	)

WRITE_REGISTER.

◆ WriteSealSignature()

bool SpringCard.SpringCore.Direct.DirectDevice.ControlI.WriteSealSignature ( byte[] buffer )

WRITE_SEAL_SIGNATURE.

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

D:/dev/companion/springcard.software.companion-service/src/common/lib-cs/springcore/DirectDeviceControl.cs

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ INS

Member Function Documentation

◆ GetBatteryState()

◆ GetBootloaderFlags()

◆ GetData() [1/2]

◆ GetData() [2/2]

◆ GetDataRaw() [1/2]

◆ GetDataRaw() [2/2]

◆ GetDataString() [1/2]

◆ GetDataString() [2/2]

◆ GetDateTime()

◆ GetHardwareCharacteristics()

◆ GetSealHash()

◆ GetSealSubject()

◆ iBeaconStart() [1/6]

◆ iBeaconStart() [2/6]

◆ iBeaconStart() [3/6]

◆ iBeaconStart() [4/6]

◆ iBeaconStart() [5/6]

◆ iBeaconStart() [6/6]

◆ iBeaconStop()

◆ IsDeviceGenuine()

◆ LoadFactoryConfig()

◆ LockFuses()

◆ ReadFreeRegister()

◆ ReadRegister()

◆ ReadSealSignature()

◆ ReloadConfig()

◆ Reset()

◆ SaveFactoryConfig()

◆ SetDateTime()

◆ Shutdown()

◆ UnlockFuses()

◆ Wink()

◆ WriteRegister()

◆ WriteSealSignature()