Framework

Core Bluetooth

Communicate with Bluetooth low energy and BR/EDR (“Classic”) Devices.

Overview

The Core Bluetooth framework provides the classes needed for your apps to communicate with Bluetooth-equipped low energy (LE) and Basic Rate / Enhanced Data Rate (BR/EDR) wireless technology.

Don’t subclass any of the classes of the Core Bluetooth framework. Overriding these classes isn’t supported and results in undefined behavior.

Core Bluetooth background execution modes aren’t supported in iPad apps running on macOS.

Topics

Centrals

classCBCentral

A remote device connected to a local app, which is acting as a peripheral.

classCBCentralManager

An object that scans for, discovers, connects to, and manages peripherals.

protocolCBCentralManagerDelegate

A protocol that provides updates for the discovery and management of peripheral devices.

Peripherals

classCBPeripheral

A remote peripheral device.

protocolCBPeripheralDelegate

A protocol that provides updates on the use of a peripheral’s services.

classCBPeripheralManager

An object that manages and advertises peripheral services exposed by this app.

protocolCBPeripheralManagerDelegate

A protocol that provides updates for local peripheral state and interactions with remote central devices.

classCBAttribute

A representation of common aspects of services offered by a peripheral.

structCBAttributePermissions

Values that represent the read, write, and encryption permissions for a characteristic’s value.

Data Transfer

Transferring Data Between Bluetooth Low Energy Devices

Create a Bluetooth low energy central and peripheral device, and allow them to discover each other and exchange data.

Services

classCBService

A collection of data and associated behaviors that accomplish a function or feature of a device.

classCBMutableService

A service with writeable property values.

classCBCharacteristic

A characteristic of a remote peripheral’s service.

classCBMutableCharacteristic

A characteristic of a local peripheral’s service.

classCBDescriptor

An object that provides further information about a remote peripheral’s characteristic.

classCBMutableDescriptor

An object that provides additional information about a local peripheral’s characteristic.

Supporting Types

classCBManager

The abstract base class that manages central and peripheral objects.

classCBATTRequest

A request that uses the Attribute Protocol (ATT).

classCBPeer

An object that represents a remote device.

classCBUUID

A universally unique identifier, as defined by Bluetooth standards.

Bluetooth Classic Support

Using Core Bluetooth Classic

Discover and communicate with a Bluetooth Classic device by using the Core Bluetooth APIs.

Errors

structCBError

An error that Core Bluetooth returns during Bluetooth transactions.

letCBErrorDomain: String

The domain for Core Bluetooth errors.

enumCode

The codes for errors that Core Bluetooth returns during Bluetooth transactions.

structCBATTError

An error that Core Bluetooth returns while using Attribute Protocol (ATT).

letCBATTErrorDomain: String

The domain for Core Bluetooth ATT errors.

enumCode

The possible errors returned by a GATT server (a remote peripheral) during Bluetooth low energy ATT transactions.

structCBATTError

An error that Core Bluetooth returns while using Attribute Protocol (ATT).

Deprecated

enumCBCentralManagerState

Values that represent the current state of a central manager object.

Deprecated

enumCBPeripheralManagerState

Values that represent the current state of the peripheral manager.

Deprecated

Deprecated Constants

This document describes the constants found in the Core Bluetooth framework.

Variables

letCBUUIDCharacteristicObservationScheduleString: String