SMP Pairing Process state definition. More...

Collaboration diagram for org.direct_bt.SMPPairingState:

Public Member Functions
	SMPPairingState (final byte v)

Static Public Member Functions
static SMPPairingState	get (final byte value)
	Maps the specified integer value to a constant of `SMPPairingState`. More...

static SMPPairingState	get (final String name) throws IllegalArgumentException
	Maps the specified name to a constant of `SMPPairingState`. More...

Public Attributes
	COMPLETED =((byte)10)
	Phase 3: Key & value distribution completed by responding (slave) device sending SMPIdentInfoMsg (#1) , SMPIdentAddrInfoMsg (#2) or SMPSignInfoMsg (#3), depending on the key distribution field SMPKeyDistFormat SMPPairingMsg::getInitKeyDist() and SMPPairingMsg::getRespKeyDist(). More...

	FAILED =((byte)1)
	Pairing failed. More...

	FEATURE_EXCHANGE_COMPLETED =((byte)4)
	Phase 1: Pairing responded by responding (slave) device via SMPPairingMsg. More...

	FEATURE_EXCHANGE_STARTED =((byte)3)
	Phase 1: Pairing requested by initiating (master) device via SMPPairingMsg. More...

	KEY_DISTRIBUTION =((byte)9)
	Phase 3: Key & value distribution started after SMPPairConfirmMsg or SMPPairPubKeyMsg (LE Secure Connection) exchange between initiating (master) and responding (slave) device. More...

	NONE =((byte)0)
	No pairing in process. More...

	NUMERIC_COMPARE_EXPECTED =((byte)6)
	Phase 2: Authentication (MITM) Numeric Comparison Reply expected, see `PairingMode#NUMERIC_COMPARE_ini`. More...

	OOB_EXPECTED =((byte)8)
	Phase 2: Authentication (MITM) OOB data expected, see `PairingMode#OUT_OF_BAND`. More...

	PASSKEY_EXPECTED =((byte)5)
	Phase 2: Authentication (MITM) PASSKEY expected, see `PairingMode#PASSKEY_ENTRY_ini`. More...

	PASSKEY_NOTIFY =((byte)7)
	Phase 2: Authentication (MITM) PASSKEY has been produced (this device is responder, peripheral GATT server) and shall be displayed for the remote device, see `PairingMode#NUMERIC_COMPARE_ini`. More...

	REQUESTED_BY_RESPONDER =((byte)2)
	Phase 0: Pairing requested by responding (slave) device via SMPSecurityReqMsg. More...

final byte	value

Detailed Description

SMP Pairing Process state definition.

Vol 3, Part H (SM): APPENDIX C MESSAGE SEQUENCE CHARTS

<p<blockquote>‍

See get(byte) for its native integer mapping.

See also: PairingMode

Since: 2.1.0

Definition at line 38 of file SMPPairingState.java.

Constructor & Destructor Documentation

◆ SMPPairingState()

org.direct_bt.SMPPairingState.SMPPairingState ( final byte v )

Definition at line 128 of file SMPPairingState.java.

Member Function Documentation

◆ get() [1/2]

static SMPPairingState org.direct_bt.SMPPairingState.get ( final String name ) throws IllegalArgumentException

static

Maps the specified name to a constant of SMPPairingState.

Implementation simply returns valueOf(String). This maps the constant names itself to their respective constant.

Parameters

name	the string name to be mapped to a constant of this enum type.

Returns: the corresponding constant of this enum type.

Exceptions

IllegalArgumentException if the specified name can't be mapped to a constant of this enum type as described above.

Definition at line 103 of file SMPPairingState.java.

Here is the caller graph for this function:

◆ get() [2/2]

static SMPPairingState org.direct_bt.SMPPairingState.get ( final byte value )

static

Maps the specified integer value to a constant of SMPPairingState.

Parameters

value the integer value to be mapped to a constant of this enum type.

Returns: the corresponding constant of this enum type, using NONE if not supported.

Definition at line 112 of file SMPPairingState.java.

Member Data Documentation

◆ NONE

org.direct_bt.SMPPairingState.NONE =((byte)0)

No pairing in process.

Current PairingMode shall be PairingMode#NONE.

Definition at line 40 of file SMPPairingState.java.

◆ FAILED

org.direct_bt.SMPPairingState.FAILED =((byte)1)

Pairing failed.

Current PairingMode shall be PairingMode#NONE.

Definition at line 43 of file SMPPairingState.java.

◆ REQUESTED_BY_RESPONDER

org.direct_bt.SMPPairingState.REQUESTED_BY_RESPONDER =((byte)2)

Phase 0: Pairing requested by responding (slave) device via SMPSecurityReqMsg.

Signals initiating (host) device to start the Pairing Feature Exchange.
Current PairingMode shall be PairingMode#NEGOTIATING.

Definition at line 50 of file SMPPairingState.java.

◆ FEATURE_EXCHANGE_STARTED

org.direct_bt.SMPPairingState.FEATURE_EXCHANGE_STARTED =((byte)3)

Phase 1: Pairing requested by initiating (master) device via SMPPairingMsg.

Starts the Pairing Feature Exchange.
Current PairingMode shall be PairingMode#NEGOTIATING.

Definition at line 57 of file SMPPairingState.java.

◆ FEATURE_EXCHANGE_COMPLETED

org.direct_bt.SMPPairingState.FEATURE_EXCHANGE_COMPLETED =((byte)4)

Phase 1: Pairing responded by responding (slave) device via SMPPairingMsg.

Completes the Pairing Feature Exchange. Optional user input shall be given for Phase 2.
Current PairingMode shall be set to a definitive value.

Definition at line 64 of file SMPPairingState.java.

◆ PASSKEY_EXPECTED

org.direct_bt.SMPPairingState.PASSKEY_EXPECTED =((byte)5)

Phase 2: Authentication (MITM) PASSKEY expected, see PairingMode#PASSKEY_ENTRY_ini.

Definition at line 67 of file SMPPairingState.java.

◆ NUMERIC_COMPARE_EXPECTED

org.direct_bt.SMPPairingState.NUMERIC_COMPARE_EXPECTED =((byte)6)

Phase 2: Authentication (MITM) Numeric Comparison Reply expected, see PairingMode#NUMERIC_COMPARE_ini.

Definition at line 69 of file SMPPairingState.java.

◆ PASSKEY_NOTIFY

org.direct_bt.SMPPairingState.PASSKEY_NOTIFY =((byte)7)

Phase 2: Authentication (MITM) PASSKEY has been produced (this device is responder, peripheral GATT server) and shall be displayed for the remote device, see PairingMode#NUMERIC_COMPARE_ini.

User application shall display BTDevice#getResponderSMPPassKeyString().

Definition at line 74 of file SMPPairingState.java.

◆ OOB_EXPECTED

org.direct_bt.SMPPairingState.OOB_EXPECTED =((byte)8)

Phase 2: Authentication (MITM) OOB data expected, see PairingMode#OUT_OF_BAND.

Definition at line 76 of file SMPPairingState.java.

◆ KEY_DISTRIBUTION

org.direct_bt.SMPPairingState.KEY_DISTRIBUTION =((byte)9)

Phase 3: Key & value distribution started after SMPPairConfirmMsg or SMPPairPubKeyMsg (LE Secure Connection) exchange between initiating (master) and responding (slave) device.

Definition at line 79 of file SMPPairingState.java.

◆ COMPLETED

org.direct_bt.SMPPairingState.COMPLETED =((byte)10)

Phase 3: Key & value distribution completed by responding (slave) device sending SMPIdentInfoMsg (#1) , SMPIdentAddrInfoMsg (#2) or SMPSignInfoMsg (#3),
depending on the key distribution field SMPKeyDistFormat SMPPairingMsg::getInitKeyDist() and SMPPairingMsg::getRespKeyDist().

The link is assumed to be encrypted from here on and AdapterStatusListener#deviceReady(BluetoothDevice, long) gets called on all listener.

Definition at line 88 of file SMPPairingState.java.

◆ value

final byte org.direct_bt.SMPPairingState.value

Definition at line 90 of file SMPPairingState.java.

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

java/org/direct_bt/SMPPairingState.java

Public Member Functions

Static Public Member Functions

Public Attributes