Bluetooth Serial

Improve this doc

This plugin enables serial communication over Bluetooth. It was written for communicating between Android or iOS and an Arduino (not Android to Android or iOS to iOS).

Repo: https://github.com/don/BluetoothSerial

Installation

1. Install the Cordova and Ionic Native plugins:
   

   $ ionic cordova plugin add cordova-plugin-bluetooth-serial
   $ npm install --save @ionic-native/bluetooth-serial@4
   

2. Add this plugin to your app's module

Supported platforms

• Android
• iOS
• Windows Phone 8

Usage

import { BluetoothSerial } from '@ionic-native/bluetooth-serial';

constructor(private bluetoothSerial: BluetoothSerial) { }


// Write a string
this.bluetoothSerial.write('hello world').then(success, failure);

// Array of int or bytes
this.bluetoothSerial.write([186, 220, 222]).then(success, failure);

// Typed Array
var data = new Uint8Array(4);
data[0] = 0x41;
data[1] = 0x42;
data[2] = 0x43;
data[3] = 0x44;
this.bluetoothSerial.write(data).then(success, failure);

// Array Buffer
this.bluetoothSerial.write(data.buffer).then(success, failure);

Instance Members

connect(macAddress_or_uuid)

Platforms:Android iOS Windows Phone 

Connect to a Bluetooth device

connectInsecure(macAddress)

Platforms:Android 

Connect insecurely to a Bluetooth device

disconnect()

Disconnect from the connected device

write(data)

Platforms:Android iOS Windows Phone 

Writes data to the serial port

available()

Platforms:Android iOS Windows Phone 

Gets the number of bytes of data available

read()

Platforms:Android iOS Windows Phone 

Reads data from the buffer

readUntil(delimiter)

Platforms:Android iOS Windows Phone 

Reads data from the buffer until it reaches a delimiter

subscribe(delimiter)

Platforms:Android iOS Windows Phone 

Subscribe to be notified when data is received

subscribeRawData()

Platforms:Android iOS Windows Phone 

Subscribe to be notified when data is received

clear()

Platforms:Android iOS Windows Phone 

Clears data in buffer

list()

Platforms:Android iOS Windows Phone 

Lists bonded devices

isEnabled()

Platforms:Android iOS Windows Phone 

Reports if bluetooth is enabled

isConnected()

Platforms:Android iOS Windows Phone 

Reports the connection status

readRSSI()

Platforms:Android iOS Windows Phone 

Reads the RSSI from the connected peripheral

showBluetoothSettings()

Platforms:Android iOS Windows Phone 

Show the Bluetooth settings on the device

enable()

Platforms:Android iOS Windows Phone 

Enable Bluetooth on the device

discoverUnpaired()

Platforms:Android iOS Windows Phone 

Discover unpaired devices

setDeviceDiscoveredListener()

Platforms:Android iOS Windows Phone 

Subscribe to be notified on Bluetooth device discovery. Discovery process must be initiated with the discoverUnpaired function.

setName(newName)

Platforms:Android 

Sets the human readable device name that is broadcasted to other devices

setDiscoverable(discoverableDuration)

Platforms:Android 

Makes the device discoverable by other devices