Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
randdusing committed Nov 10, 2019
2 parents 30c2c4b + d870e16 commit bf2ce54
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 1 deletion.
90 changes: 90 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,96 @@
# Cordova Bluetooth LE Plugin
This plugin allows you to interact with Bluetooth LE devices on Android, iOS, and Windows.

## Table of contents

- [Requirements](#requirements)
- [Limitations / Issues](#limitations--issues)
- [Upgrade 2.x to 3.x](#upgrade-2x-to-3x)
- [Upgrade 3.x to 4.x](#upgrade-3x-to-4x)
- [To Do](#to-do)
- [Using AngularJS](#using-angularjs)
- [Installation](#installation)
- [Debugging](#debugging)
- [Installation Quirks (Android)](#installation-quirks-android)
- [Background Modes (iOS)](#background-modes-ios)
- [Usage Description (iOS)](#usage-description-ios)
- [Discovery Quirks (iOS vs Android)](#discovery-quirks-ios-vs-android)
- [Queuing (Android)](#queuing-android)
- [UUIDs](#uuids)
- [Advertisement Data / MAC Address](#advertisement-data--mac-address)
- [Emulator](#emulator)
- [Methods](#methods)
- [Errors](#errors)
- [Permissions (Android)](#permissions-android)
- [Properties](#properties)
- [Central Life Cycle](#central-life-cycle)
- [initialize](#initialize)
- [enable](#enable)
- [disable](#disable)
- [getAdapterInfo](#getadapterinfo)
- [startScan](#startscan)
- [stopScan](#stopscan)
- [retrieveConnected](#retrieveconnected)
- [bond](#bond)
- [unbond](#unbond)
- [connect](#connect)
- [reconnect](#reconnect)
- [disconnect](#disconnect)
- [close](#close)
- [discover](#discover)
- [services](#services)
- [characteristics](#characteristics)
- [descriptors](#descriptors)
- [read](#read)
- [subscribe](#subscribe)
- [unsubscribe](#unsubscribe)
- [write](#write)
- [writeQ](#writeq)
- [readDescriptor](#readdescriptor)
- [writeDescriptor](#writedescriptor)
- [rssi](#rssi)
- [mtu](#mtu)
- [requestConnectionPriority](#requestconnectionpriority)
- [isInitialized](#isinitialized)
- [isEnabled](#isenabled)
- [isScanning](#isscanning)
- [isBonded](#isbonded)
- [wasConnected](#wasconnected)
- [isConnected](#isconnected)
- [isDiscovered](#isdiscovered)
- [hasPermission](#haspermission)
- [requestPermission](#requestpermission)
- [isLocationEnabled](#islocationenabled)
- [requestLocation](#requestlocation)
- [Peripheral Life Cycle](#peripheral-life-cycle)
- [Initilization](#initilization)
- [Notifications](#notifications)
- [Descriptors](#descriptors)
- [initializePeripheral](#initializeperipheral)
- [addService](#addservice)
- [removeService](#removeservice)
- [removeAllServices](#removeallservices)
- [startAdvertising](#startadvertising)
- [stopAdvertising](#stopadvertising)
- [isAdvertising](#isadvertising)
- [respond](#respond)
- [notify](#notify)
- [encodedStringToBytes](#encodedstringtobytes)
- [bytesToEncodedString](#bytestoencodedstring)
- [stringToBytes](#stringtobytes)
- [bytesToString](#bytestostring)
- [Example](#example)
- [Data Parsing Example](#data-parsing-example)
- [Sample: Discover and interact with Bluetooth LE devices](#sample-discover-and-interact-with-bluetooth-le-devices)
- [Initialize the Bluetooth adapter](#initialize-the-bluetooth-adapter)
- [Scan for devices](#scan-for-devices)
- [Connect to a device](#connect-to-a-device)
- [Get device services](#get-device-services)
- [Get services on an Android device](#get-services-on-an-android-device)
- [Get services on a Windows device](#get-services-on-a-windows-device)
- [Show services and characteristics in an app page](#show-services-and-characteristics-in-an-app-page)
- [More information](#more-information)
- [License](#license)

## Requirements ##

Expand Down
4 changes: 3 additions & 1 deletion types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -614,7 +614,9 @@ declare namespace BluetoothlePlugin {
/** Defaults to One Advertisement. Available from API23 (Android) */
matchNum?: BluetoothMatchNum,
/** Defaults to All Matches. Available from API21 / API 23. (Android) */
callbackType?: BluetoothCallbackType
callbackType?: BluetoothCallbackType,
/** True/false to show only connectable devices, rather than all devices ever seen, defaults to false (Windows)*/
isConnectable?: boolean
}

interface NotifyParams {
Expand Down

0 comments on commit bf2ce54

Please sign in to comment.