ESPBleTransport

class ESPBleTransport : NSObject, ESPCommunicable

extension ESPBleTransport: CBCentralManagerDelegate

extension ESPBleTransport: CBPeripheralDelegate

The ESPBleTransport class conforms and implememnt methods of ESPCommunicable protocol. This class provides methods for sending configuration and session related data to ESPDevice.

utility
Instance of ‘ESPUtility’ class.
Declaration
Swift

var utility: ESPUtility
proofOfPossession
Stores Proof of Possesion for a device.
Declaration
Swift

var proofOfPossession: String?
username
Store username for device
Declaration
Swift

var username: String?
centralManager
Undocumented
Declaration
Swift

var centralManager: CBCentralManager!


                    
                    
                    espressifPeripherals

Undocumented

Declaration

Swift

var espressifPeripherals: [String : ESPDevice]

currentPeripheral
Undocumented
Declaration
Swift

var currentPeripheral: CBPeripheral?
currentService
Undocumented
Declaration
Swift

var currentService: CBService?
bleConnectTimer
Undocumented
Declaration
Swift

var bleConnectTimer: Timer
bleScanTimer
Undocumented
Declaration
Swift

var bleScanTimer: Timer?
bleDeviceConnected
Undocumented
Declaration
Swift

var bleDeviceConnected: Bool
peripheralCanRead
Undocumented
Declaration
Swift

var peripheralCanRead: Bool
peripheralCanWrite
Undocumented
Declaration
Swift

var peripheralCanWrite: Bool


                    
                    
                    currentRequestCompletionHandler

Undocumented

Declaration

Swift

var currentRequestCompletionHandler: ((Data?, Error?) -> Void)?


                    
                    
                    delegate

Undocumented

Declaration

Swift

public var delegate: ESPBLETransportDelegate?


                    
                    
                    bleStatusDelegate

Undocumented

Declaration

Swift

var bleStatusDelegate: ESPBLEStatusDelegate?


                    
                    
                    init(scanTimeout:deviceNamePrefix:proofOfPossession:username:)

Create BLETransport object.

Declaration

Swift

init(scanTimeout: TimeInterval, deviceNamePrefix: String, proofOfPossession: String? = nil, username: String? = nil)

Parameters

`deviceNamePrefix`	Device name prefix.
`scanTimeout`	Timeout in seconds for which BLE scan should happen.


                    
                    
                    SendSessionData(data:sessionPath:completionHandler:)

BLE implementation of ESPCommunicable protocol.

Declaration

Swift

func SendSessionData(data: Data, sessionPath: String?, completionHandler: @escaping (Data?, Error?) -> Void)

Parameters

`data`	Data to be sent.
`sessionPath`	Not required.
`completionHandler`	Handler called when data is sent.


                    
                    
                    SendConfigData(path:data:completionHandler:)

BLE implemenation of the ESPCommunicable protocol

Declaration

Swift

func SendConfigData(path: String,
                    data: Data,
                    completionHandler: @escaping (Data?, Error?) -> Void)

Parameters

`path`	Path of the configuration endpoint.
`data`	Data to be sent.
`completionHandler`	Handler called when data is sent.


                    
                    
                    connect(peripheral:withOptions:delegate:)

Connect to a BLE peripheral device.

Declaration

Swift

func connect(peripheral: CBPeripheral, withOptions options: [String : Any]?, delegate: ESPBLEStatusDelegate)

Parameters

`peripheral`	The peripheral device
`options`	An optional dictionary specifying connection behavior options. Sent as is to the CBCentralManager.connect function.

bleConnectionTimeout()
This method is invoked on timeout of connection with BLE device.
Declaration
Swift

@objc func bleConnectionTimeout()
disconnect()
Disconnect from the current connected peripheral.
Declaration
Swift

func disconnect()


                    
                    
                    scan(delegate:)

Scan for BLE devices.

Declaration

Swift

func scan(delegate: ESPBLETransportDelegate)

Parameters


                                delegate

Delegate which will receive resulting events.

stopScan(timer:)
Stop scan when timer runs off.
Declaration
Swift

@objc func stopScan(timer: Timer)
stopSearch()
Undocumented
Declaration
Swift

func stopSearch()
isDeviceConfigured()
BLE implementation of ESPCommunicable protocol.
Declaration
Swift

func isDeviceConfigured() -> Bool

CBCentralManagerDelegate


                    
                    
                    centralManagerDidUpdateState(_:)

Undocumented

Declaration

Swift

func centralManagerDidUpdateState(_ central: CBCentralManager)


                    
                    
                    centralManager(_:didDiscover:advertisementData:rssi:)

Undocumented

Declaration

Swift

func centralManager(_: CBCentralManager,
                    didDiscover peripheral: CBPeripheral,
                    advertisementData data: [String: Any],
                    rssi _: NSNumber)


                    
                    
                    centralManager(_:didConnect:)

Undocumented

Declaration

Swift

func centralManager(_: CBCentralManager, didConnect _: CBPeripheral)


                    
                    
                    centralManager(_:didFailToConnect:error:)

Undocumented

Declaration

Swift

func centralManager(_: CBCentralManager, didFailToConnect peripheral: CBPeripheral, error: Error?)


                    
                    
                    centralManager(_:didDisconnectPeripheral:error:)

Undocumented

Declaration

Swift

func centralManager(_: CBCentralManager, didDisconnectPeripheral peripheral: CBPeripheral, error: Error?)

CBPeripheralDelegate


                    
                    
                    peripheral(_:didDiscoverServices:)

Undocumented

Declaration

Swift

func peripheral(_ peripheral: CBPeripheral, didDiscoverServices _: Error?)


                    
                    
                    peripheral(_:didDiscoverCharacteristicsFor:error:)

Undocumented

Declaration

Swift

func peripheral(_ peripheral: CBPeripheral, didDiscoverCharacteristicsFor service: CBService, error _: Error?)


                    
                    
                    peripheral(_:didWriteValueFor:error:)

Undocumented

Declaration

Swift

func peripheral(_ peripheral: CBPeripheral, didWriteValueFor characteristic: CBCharacteristic, error: Error?)


                    
                    
                    peripheral(_:didUpdateValueFor:error:)

Undocumented

Declaration

Swift

func peripheral(_: CBPeripheral, didUpdateValueFor characteristic: CBCharacteristic, error: Error?)


                    
                    
                    peripheral(_:didDiscoverDescriptorsFor:error:)

Undocumented

Declaration

Swift

func peripheral(_: CBPeripheral, didDiscoverDescriptorsFor characteristic: CBCharacteristic, error _: Error?)


                    
                    
                    peripheral(_:didUpdateValueFor:error:)

Undocumented

Declaration

Swift

func peripheral(_: CBPeripheral, didUpdateValueFor descriptor: CBDescriptor, error _: Error?)