Skip to content

Commit d870e16

Browse files
authored
Merge pull request #557 from luciopaiva/patch-1
Add table of contents to README.md
2 parents 2c35583 + 909fd6c commit d870e16

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed

readme.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,96 @@
11
# Cordova Bluetooth LE Plugin
22
This plugin allows you to interact with Bluetooth LE devices on Android, iOS, and Windows.
33

4+
## Table of contents
5+
6+
- [Requirements](#requirements)
7+
- [Limitations / Issues](#limitations--issues)
8+
- [Upgrade 2.x to 3.x](#upgrade-2x-to-3x)
9+
- [Upgrade 3.x to 4.x](#upgrade-3x-to-4x)
10+
- [To Do](#to-do)
11+
- [Using AngularJS](#using-angularjs)
12+
- [Installation](#installation)
13+
- [Debugging](#debugging)
14+
- [Installation Quirks (Android)](#installation-quirks-android)
15+
- [Background Modes (iOS)](#background-modes-ios)
16+
- [Usage Description (iOS)](#usage-description-ios)
17+
- [Discovery Quirks (iOS vs Android)](#discovery-quirks-ios-vs-android)
18+
- [Queuing (Android)](#queuing-android)
19+
- [UUIDs](#uuids)
20+
- [Advertisement Data / MAC Address](#advertisement-data--mac-address)
21+
- [Emulator](#emulator)
22+
- [Methods](#methods)
23+
- [Errors](#errors)
24+
- [Permissions (Android)](#permissions-android)
25+
- [Properties](#properties)
26+
- [Central Life Cycle](#central-life-cycle)
27+
- [initialize](#initialize)
28+
- [enable](#enable)
29+
- [disable](#disable)
30+
- [getAdapterInfo](#getadapterinfo)
31+
- [startScan](#startscan)
32+
- [stopScan](#stopscan)
33+
- [retrieveConnected](#retrieveconnected)
34+
- [bond](#bond)
35+
- [unbond](#unbond)
36+
- [connect](#connect)
37+
- [reconnect](#reconnect)
38+
- [disconnect](#disconnect)
39+
- [close](#close)
40+
- [discover](#discover)
41+
- [services](#services)
42+
- [characteristics](#characteristics)
43+
- [descriptors](#descriptors)
44+
- [read](#read)
45+
- [subscribe](#subscribe)
46+
- [unsubscribe](#unsubscribe)
47+
- [write](#write)
48+
- [writeQ](#writeq)
49+
- [readDescriptor](#readdescriptor)
50+
- [writeDescriptor](#writedescriptor)
51+
- [rssi](#rssi)
52+
- [mtu](#mtu)
53+
- [requestConnectionPriority](#requestconnectionpriority)
54+
- [isInitialized](#isinitialized)
55+
- [isEnabled](#isenabled)
56+
- [isScanning](#isscanning)
57+
- [isBonded](#isbonded)
58+
- [wasConnected](#wasconnected)
59+
- [isConnected](#isconnected)
60+
- [isDiscovered](#isdiscovered)
61+
- [hasPermission](#haspermission)
62+
- [requestPermission](#requestpermission)
63+
- [isLocationEnabled](#islocationenabled)
64+
- [requestLocation](#requestlocation)
65+
- [Peripheral Life Cycle](#peripheral-life-cycle)
66+
- [Initilization](#initilization)
67+
- [Notifications](#notifications)
68+
- [Descriptors](#descriptors)
69+
- [initializePeripheral](#initializeperipheral)
70+
- [addService](#addservice)
71+
- [removeService](#removeservice)
72+
- [removeAllServices](#removeallservices)
73+
- [startAdvertising](#startadvertising)
74+
- [stopAdvertising](#stopadvertising)
75+
- [isAdvertising](#isadvertising)
76+
- [respond](#respond)
77+
- [notify](#notify)
78+
- [encodedStringToBytes](#encodedstringtobytes)
79+
- [bytesToEncodedString](#bytestoencodedstring)
80+
- [stringToBytes](#stringtobytes)
81+
- [bytesToString](#bytestostring)
82+
- [Example](#example)
83+
- [Data Parsing Example](#data-parsing-example)
84+
- [Sample: Discover and interact with Bluetooth LE devices](#sample-discover-and-interact-with-bluetooth-le-devices)
85+
- [Initialize the Bluetooth adapter](#initialize-the-bluetooth-adapter)
86+
- [Scan for devices](#scan-for-devices)
87+
- [Connect to a device](#connect-to-a-device)
88+
- [Get device services](#get-device-services)
89+
- [Get services on an Android device](#get-services-on-an-android-device)
90+
- [Get services on a Windows device](#get-services-on-a-windows-device)
91+
- [Show services and characteristics in an app page](#show-services-and-characteristics-in-an-app-page)
92+
- [More information](#more-information)
93+
- [License](#license)
494

595
## Requirements ##
696

0 commit comments

Comments
 (0)