SpringCard SpringCore Library for .NET  20.04.16
High-level access to the SpringCore devices
Public Types | Static Public Member Functions | List of all members
SpringCard.SpringCore.Direct.DirectDevice.ProtocolI Class Reference

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

Public Types

enum  INS : byte {
  INS.Ping = 0x00, INS.PingEvent = 0x01, INS.GetDescriptor = 0x06, INS.SetConfiguration = 0x09,
  INS.Authenticate = 0x0A, INS.ChangeKey = 0x0C, INS.Internal = 0x0E, INS.Following = 0xFF
}
 INStructions exposed by this class. More...
 
enum  STA : byte {
  STA.Success = 0x00, STA.TimeExtension = 0xF0, STA.Rfu = 0xF1, STA.WrongData = 0xF2,
  STA.WrongParameters = 0xF3, STA.WrongLength = 0xF4, STA.InsNotSupported = 0xF5, STA.AuthenticationError = 0xF6,
  STA.ProtocolError = 0xF7, STA.BufferOverflow = 0xF8, STA.DeviceInternalError = 0xF9, STA.ClaNotSupported = 0xFA,
  STA.DeviceBusy = 0xFB, STA.OperationCancelled = 0xFC, STA.AccessDenied = 0xFD, STA.ExecutionFailed = 0xFE,
  STA.Following = 0xFF
}
 STAtus defined by this class (they could be used by other classes) too. More...
 

Static Public Member Functions

static string StatusToString (STA status)
 Translate a STAtus. More...
 
static string StatusToString (byte status)
 Translate a STAtus. More...
 

Detailed Description

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

Member Enumeration Documentation

◆ INS

enum SpringCard.SpringCore.Direct.DirectDevice.ProtocolI.INS : byte
strong

INStructions exposed by this class.

Enumerator
Ping 

PING (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/PROTOCOL_class/PING)

PingEvent 

PING_EVENT (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/PROTOCOL_class/PING_EVENT)

GetDescriptor 

RFU

SetConfiguration 

RFU

Authenticate 

AUTHENTICATE (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/PROTOCOL_class/AUTHENTICATE)

ChangeKey 

CHANGE_KEY (https://docs.springcard.com/books/SpringCore/Host_interfaces/Logical/Direct_Protocol/PROTOCOL_class/CHANGE_KEY)

Internal 

RFU

Following 

Used for chaining

◆ STA

enum SpringCard.SpringCore.Direct.DirectDevice.ProtocolI.STA : byte
strong

STAtus defined by this class (they could be used by other classes) too.

Enumerator
Success 

Success

TimeExtension 

Time extension request

Rfu 

RFU

WrongData 

Wrong data

WrongParameters 

Wrong parameters

WrongLength 

Wrong length

InsNotSupported 

INStruction not supported

AuthenticationError 

Authentication error

ProtocolError 

Protocol error

BufferOverflow 

Buffer overflow (in device)

DeviceInternalError 

Device internal error

ClaNotSupported 

CLAss not supported

DeviceBusy 

Device is busy

OperationCancelled 

The operation has been cancelled

AccessDenied 

Access denied

ExecutionFailed 

Execution failed (device error)

Following 

Used for chaining

Member Function Documentation

◆ StatusToString() [1/2]

static string SpringCard.SpringCore.Direct.DirectDevice.ProtocolI.StatusToString ( byte  status)
static

Translate a STAtus.

◆ StatusToString() [2/2]

static string SpringCard.SpringCore.Direct.DirectDevice.ProtocolI.StatusToString ( STA  status)
static

Translate a STAtus.

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