PeripheralManager

public class PeripheralManager : ManagerType

PeripheralManager is a class implementing ReactiveX API which wraps all the Core Bluetooth Peripheral’s functions, that allow to advertise, to publish L2CAP channels and more. You can start using this class by adding services and starting advertising. Before calling any public PeripheralManager‘s functions you should make sure that Bluetooth is turned on and powered on. It can be done by observeStateWithInitialValue(), observing it’s value and then chaining it with add(_:) and startAdvertising(_:):

let disposable = centralManager.observeStateWithInitialValue()
    .filter { $0 == .poweredOn }
    .take(1)
    .flatMap { centralManager.add(myService) }
    .flatMap { centralManager.startAdvertising(myAdvertisementData) }

As a result, your peripheral will start advertising. To stop advertising simply dispose it:

disposable.dispose()

Show on GitHub

manager
Implementation of CBPeripheralManager
Declaration
Swift

public let manager: CBPeripheralManager
Show on GitHub

Initialization


                    
                    
                    init(queue:options:)

Creates new PeripheralManager instance. By default all operations and events are executed and received on main thread.

Warning

If you pass background queue to the method make sure to observe results on main thread for UI related code.

Declaration

Swift

public convenience init(queue: DispatchQueue = .main,
                        options: [String: AnyObject]? = nil)

Parameters

`queue`	Queue on which bluetooth callbacks are received. By default main thread is used.
`options`	An optional dictionary containing initialization options for a peripheral manager. For more info about it please refer to Peripheral Manager initialization options

Show on GitHub

State


                    
                    
                    state

Declaration

Swift

public var state: BluetoothState { get }

Show on GitHub


                    
                    
                    observeState()

Declaration

Swift

public func observeState() -> Observable<BluetoothState>

Show on GitHub


                    
                    
                    observeStateWithInitialValue()

Declaration

Swift

public func observeStateWithInitialValue() -> Observable<BluetoothState>

Show on GitHub

Advertising


                    
                    
                    startAdvertising(_:)

Starts peripheral advertising on subscription. It create inifinite observable which emits only one next value, of enum type StartAdvertisingResult, just after advertising start succeeds. For more info of what specific StartAdvertisingResult enum cases means please refer to `StartAdvertisingResult documentation.

There can be only one ongoing advertising (CoreBluetooth limit). It will return advertisingInProgress error if this method is called when it is already advertising.

Advertising is automatically stopped just after disposing of the subscription.

It can return BluetoothError.advertisingStartFailed error, when start advertisement failed

Observable can ends with following errors:

BluetoothError.advertisingInProgress
BluetoothError.advertisingStartFailed
BluetoothError.destroyed
BluetoothError.bluetoothUnsupported
BluetoothError.bluetoothUnauthorized
BluetoothError.bluetoothPoweredOff
BluetoothError.bluetoothInUnknownState
BluetoothError.bluetoothResetting

Declaration

Swift

public func startAdvertising(_ advertisementData: [String : Any]?) -> Observable<StartAdvertisingResult>

Parameters


                                advertisementData

Services of peripherals to search for. Nil value will accept all peripherals.

Return Value

Infinite observable which emit StartAdvertisingResult when advertisement started.

Show on GitHub

Services


                    
                    
                    add(_:)

Function that triggers CBPeripheralManager.add(_:) and waits for delegate CBPeripheralManagerDelegate.peripheralManager(_:didAdd:error:) result. If it receives a non nil in the result, it will emit BluetoothError.addingServiceFailed error. Add method is called after subscription to Observable is made.

Observable can ends with following errors:

BluetoothError.addingServiceFailed
BluetoothError.destroyed
BluetoothError.bluetoothUnsupported
BluetoothError.bluetoothUnauthorized
BluetoothError.bluetoothPoweredOff
BluetoothError.bluetoothInUnknownState
BluetoothError.bluetoothResetting

Declaration

Swift

public func add(_ service: CBMutableService) -> Single<CBService>

Parameters


                                service

Characteristic to read value from

Return Value

Single which emits next with given characteristic when value is ready to read.

Show on GitHub

remove(_:)
Wrapper for CBPeripheralManager.remove(_:) method
Declaration
Swift

public func remove(_ service: CBMutableService)
Show on GitHub
removeAllServices()
Wrapper for CBPeripheralManager.removeAllServices() method
Declaration
Swift

public func removeAllServices()
Show on GitHub

Read & Write

observeDidReceiveRead()
Continuous observer for CBPeripheralManagerDelegate.peripheralManager(_:didReceiveRead:) results

It’s infinite stream, so .complete is never called.

Observable can ends with following errors:
Declaration
Swift

public func observeDidReceiveRead() -> Observable<CBATTRequest>
Return Value

Observable that emits next event whenever didReceiveRead occurs.

Show on GitHub
observeDidReceiveWrite()
Continuous observer for CBPeripheralManagerDelegate.peripheralManager(_:didReceiveWrite:) results

It’s infinite stream, so .complete is never called.

Observable can ends with following errors:
Declaration
Swift

public func observeDidReceiveWrite() -> Observable<[CBATTRequest]>
Return Value

Observable that emits next event whenever didReceiveWrite occurs.

Show on GitHub
respond(to:withResult:)
Wrapper for CBPeripheralManager.respond(to:withResult:) method
Declaration
Swift

public func respond(to request: CBATTRequest, withResult result: CBATTError.Code)
Show on GitHub

Updating value


                    
                    
                    updateValue(_:for:onSubscribedCentrals:)

Wrapper for CBPeripheralManager.updateValue(_:for:onSubscribedCentrals:) method

Declaration

Swift

public func updateValue(
    _ value: Data,
    for characteristic: CBMutableCharacteristic,
    onSubscribedCentrals centrals: [CBCentral]?) -> Bool

Show on GitHub

observeIsReadyToUpdateSubscribers()
Continuous observer for CBPeripheralManagerDelegate.peripheralManagerIsReady(toUpdateSubscribers:) results

It’s infinite stream, so .complete is never called.

Observable can ends with following errors:
Declaration
Swift

public func observeIsReadyToUpdateSubscribers() -> Observable<Void>
Return Value

Observable that emits next event whenever isReadyToUpdateSubscribers occurs.

Show on GitHub

Subscribing

observeOnSubscribe()
Continuous observer for CBPeripheralManagerDelegate.peripheralManager(_:central:didSubscribeTo:) results

It’s infinite stream, so .complete is never called.

Observable can ends with following errors:
Declaration
Swift

public func observeOnSubscribe() -> Observable<(CBCentral, CBCharacteristic)>
Return Value

Observable that emits next event whenever didSubscribeTo occurs.

Show on GitHub
observeOnUnsubscribe()
Continuous observer for CBPeripheralManagerDelegate.peripheralManager(_:central:didUnsubscribeFrom:) results

It’s infinite stream, so .complete is never called.

Observable can ends with following errors:
Declaration
Swift

public func observeOnUnsubscribe() -> Observable<(CBCentral, CBCharacteristic)>
Return Value

Observable that emits next event whenever didUnsubscribeFrom occurs.

Show on GitHub

L2CAP


                    
                    
                    publishL2CAPChannel(withEncryption:)

Starts publishing L2CAP channel on a subscription. It creates an infinite observable which emits only one next value, of CBL2CAPPSM type, just after L2CAP channel has been published.

Channel is automatically unpublished just after disposing of the subscription.

It can return publishingL2CAPChannelFailed error when publishing channel failed

Observable can ends with following errors:

BluetoothError.publishingL2CAPChannelFailed
BluetoothError.destroyed
BluetoothError.bluetoothUnsupported
BluetoothError.bluetoothUnauthorized
BluetoothError.bluetoothPoweredOff
BluetoothError.bluetoothInUnknownState
BluetoothError.bluetoothResetting

Declaration

Swift

@available(iOS 11, tvOS 11, watchOS 4, *)
public func publishL2CAPChannel(withEncryption encryptionRequired: Bool) -> Observable<CBL2CAPPSM>

Parameters


                                encryptionRequired

Publishing channel with or without encryption.

Return Value

Infinite observable which emit CBL2CAPPSM when channel published.

Show on GitHub

observeDidOpenL2CAPChannel()
Continuous observer for CBPeripheralManagerDelegate.peripheralManager(_:didOpen:error:) results

It’s infinite stream, so .complete is never called.

Observable can ends with following errors:
Declaration
Swift

@available(iOS 11, tvOS 11, watchOS 4, *) public func observeDidOpenL2CAPChannel() -> Observable<(CBL2CAPChannel?, Error?)>
Return Value

Observable that emits next event whenever didOpen occurs.

Show on GitHub

State restoration


                    
                    
                    init(queue:options:onWillRestorePeripheralManagerState:)

Creates new PeripheralManager instance, which supports bluetooth state restoration.

Warning

If you pass background queue to the method make sure to observe results on main thread for UI related code.

Seealso

RestoredState

Declaration

Swift

public convenience init(queue: DispatchQueue = .main,
                        options: [String: AnyObject]? = nil,
                        onWillRestorePeripheralManagerState: OnWillRestorePeripheralManagerState? = nil)

Parameters

`queue`	Queue on which bluetooth callbacks are received. By default main thread is used and all operations and events are executed and received on main thread.
`options`	An optional dictionary containing initialization options for a peripheral manager. For more info about it please refer to Peripheral Manager initialization options
`onWillRestorePeripheralManagerState`	Closure called when state has been restored.

Show on GitHub