VLDBluetoothPeripheral Class Reference

Inherits from VLDPeripheral : VLDModel : NSObject
Declared in VLDBluetoothPeripheral.h

Overview

The VLDBluetoothPeripheral class represents Bluetooth peripheral models that can be discovered or read from by VLDBluetoothPeripheralController.

  requiresPairing

Indicates if a peripheral model requires a Bluetooth pairing before it can be used. If a peripheral requires pairing, you must first call pairPeripheral: on VLDBluetoothPeripheralController at least once before calling readFromPeripheral: on VLDBluetoothPeripheralController.

@property (nonatomic, assign) BOOL requiresPairing

Discussion

Indicates if a peripheral model requires a Bluetooth pairing before it can be used. If a peripheral requires pairing, you must first call pairPeripheral: on VLDBluetoothPeripheralController at least once before calling readFromPeripheral: on VLDBluetoothPeripheralController.

Declared In

VLDBluetoothPeripheral.h

  instructions

Text to be presented to the user when readFromPeripheral: is called on VLDBluetoothPeripheralController.

@property (nonatomic, copy, nullable) NSString *instructions

Discussion

Text to be presented to the user when readFromPeripheral: is called on VLDBluetoothPeripheralController.

Declared In

VLDBluetoothPeripheral.h

  readingInstructions

Text to be presented to the user when the isReadyToReadFromPeripheral: callback is sent to the VLDBluetoothPeripheralControllerDelegate.

@property (nonatomic, copy, nullable) NSString *readingInstructions

Discussion

Text to be presented to the user when the isReadyToReadFromPeripheral: callback is sent to the VLDBluetoothPeripheralControllerDelegate.

Declared In

VLDBluetoothPeripheral.h

  pairingInstructions

Text to be presented to the user when pairPeripheral: is called on VLDBluetoothPeripheralController and VLDBluetoothPeripheral property requiresPairing is TRUE

@property (nonatomic, copy, nullable) NSString *pairingInstructions

Discussion

Text to be presented to the user when pairPeripheral: is called on VLDBluetoothPeripheralController and VLDBluetoothPeripheral property requiresPairing is TRUE

Declared In

VLDBluetoothPeripheral.h

  version

A version string (e.g. 1.4.2) indicating which version of the library supports this peripheral model

@property (nonatomic, copy, nullable) NSString *version

Discussion

A version string (e.g. 1.4.2) indicating which version of the library supports this peripheral model

Declared In

VLDBluetoothPeripheral.h

+ peripheralForID:

Returns the peripheral for the given ID

+ (VLDBluetoothPeripheral *_Nullable)peripheralForID:(NSUInteger)peripheralID

Parameters

peripheralID

the ID of the peripheral to retrieve.

Discussion

Returns the peripheral for the given ID

Declared In

VLDBluetoothPeripheral.h