Table of Contents

Class OtpStatus

Namespace
Yubico.YubiKey.Otp
Assembly
Yubico.YubiKey.dll

Represents the current status of the YubiKey OTP application.

public class OtpStatus
Inheritance
object
OtpStatus

Constructors

OtpStatus()

Constructs a new instance of the OtpStatus class.

public OtpStatus()

Properties

FirmwareVersion

The version of the firmware running on the YubiKey.

public FirmwareVersion FirmwareVersion { get; set; }

Property Value

FirmwareVersion

LedBehaviorInverted

The indicator LED behavior is inverted.

public bool LedBehaviorInverted { get; set; }

Property Value

bool

LongPressConfigured

Indicates that the long-press configuration (slot 2) is present and valid.

public bool LongPressConfigured { get; set; }

Property Value

bool

LongPressRequiresTouch

Indicates that the long-press configuration (slot 2) requires touch for operation.

public bool LongPressRequiresTouch { get; set; }

Property Value

bool

SequenceNumber

The configuration sequence number, used to see if the OTP configuration has been modified.

public byte SequenceNumber { get; set; }

Property Value

byte

Remarks

Operations that modify the OTP configuration, such as programming a slot or NDEF, will result in the sequence number being incremented. In cases where the command class is partnered with the ReadStatusResponse class, the sequence number must be compared with its prior value. If the sequence number has incremented, the configuration has been applied. If it hasn't, then there was some issue encountered when trying to apply the configuration.

The sequence number is only internally consistent for as long as the device is powered. That is, if the YubiKey is unplugged or otherwise loses power, the sequence number will reset its value to `1`.

Note that the sequence number may be `0` if no valid configurations are present within the OTP application.

ShortPressConfigured

Indicates that the short-press configuration (slot 1) is present and valid.

public bool ShortPressConfigured { get; set; }

Property Value

bool

ShortPressRequiresTouch

Indicates that the short-press configuration (slot 1) requires touch for operation.

public bool ShortPressRequiresTouch { get; set; }

Property Value

bool

TouchLevel

The capacitive touch level reported by the YubiKey. Reserved for Yubico internal use.

public byte TouchLevel { get; set; }

Property Value

byte

Remarks

The touch level should not be used or relied upon in normal applications. It is a value that is used during the manufacturing and production testing of YubiKey devices prior to customer fulfillment.