# appcelerator.ble

> A collection of API's to connect and communicate with BLE compatible devices via Bluetooth LE

- Source: https://titaniumsdk.com/modules/appcelerator.ble
- Module id: `appcelerator.ble`
- Repository: https://github.com/tidev/appcelerator.ble
- Curation: tidev

## Latest release, per platform

- android: 2.0.0, requires Titanium SDK 10.0.0 or later
- ios: 3.0.0, requires Titanium SDK 12.0.0 or later

## Install

Declare it in `tiapp.xml`. The CLI resolves and downloads it on the next build:

```xml
<modules>
  <module platform="android" version="2.0.0">appcelerator.ble</module>
  <module platform="ios" version="3.0.0">appcelerator.ble</module>
</modules>
```

## API, at 3.0.0

- `Modules.BLE`: Add-on Bluetooth Low Energy module
- `Modules.BLE.Beacon`: Represents a beacon that was encountered during region monitoring. You do not create instances of this class directly. They will be delivered via the rangedBeacons event.
- `Modules.BLE.BeaconIdentityConstraint`: Represents a beacon that was encountered during region monitoring. You do not create instances of this class directly. They will be delivered via the rangedBeacons event.
- `Modules.BLE.BeaconRegion`: A region used to detect the presence of iBeacon devices.
- `Modules.BLE.Central`: represent a remote device acting as central, connected to a local app, which is acting as a peripheral.
- `Modules.BLE.CentralManager`: An object that scans for, discovers, connects to, and manages peripherals.
- `Modules.BLE.Characteristic`: A characteristic of a remote peripheral’s service.
- `Modules.BLE.Descriptor`: An object that provides further information about a remote peripheral’s characteristic.
- `Modules.BLE.DescriptorRequest`: A request that uses the Attribute Protocol (ATT).
- `Modules.BLE.L2CAPChannel`: L2Cap allow us to open a side channel, with it we can directly read and write without any framing limitation, packet size limitations. It’s a direct way to talk between our devices and accessories.
- `Modules.BLE.MutableCharacteristic`: A characteristic of a local peripheral’s service.
- `Modules.BLE.Peer`: An object that represents a remote device.
- `Modules.BLE.Peripheral`: A remote peripheral device.
- `Modules.BLE.PeripheralManager`: An object that manages and advertises peripheral services exposed by this app.
- `Modules.BLE.RegionManager`: An object that manages and scan beacons.
- `Modules.BLE.Request`: A request that uses the Attribute Protocol (ATT).
- `Modules.BLE.Service`: A collection of data and associated behaviors that accomplish a function or feature of a device.

---

- This corpus documents Titanium SDK 13.4.1. Anything here that does not name a version describes 13.4.1.
- Titanium is maintained by TiDev. The Appcelerator toolchain is retired: there is no `appc` CLI, no Appcelerator Studio and no hosted build service. The supported CLI is `titanium` on npm, invoked as `ti`.