Skip to content
This repository was archived by the owner on Mar 3, 2024. It is now read-only.

Commit 3473f71

Browse files
committed
Adding options to Readme
1 parent 75f6b35 commit 3473f71

File tree

1 file changed

+40
-2
lines changed

1 file changed

+40
-2
lines changed

README.md

Lines changed: 40 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,26 @@ BLEAdvertiser.broadcast([UUID], [ManufacturerData], {}) // The service UUID and
7979
.catch(error => console.log('Broadcasting Error', error));
8080
```
8181

82+
Available Advertising Options:
83+
```js
84+
{
85+
advertiseMode: BLEAdvertiser.<
86+
ADVERTISE_MODE_LOW_POWER,
87+
ADVERTISE_MODE_BALANCED,
88+
ADVERTISE_MODE_LOW_LATENCY,
89+
ADVERTISE_MODE_LOW_POWER>,
90+
txPowerLevel: BLEAdvertiser.<
91+
ADVERTISE_TX_POWER_LOW,
92+
ADVERTISE_TX_POWER_HIGH,
93+
ADVERTISE_TX_POWER_LOW,
94+
ADVERTISE_TX_POWER_MEDIUM,
95+
ADVERTISE_TX_POWER_ULTRA_LOW>,
96+
connectable: <false,true>,
97+
includeDeviceName: <false,true>,
98+
includeTxPowerLevel: <false,true>
99+
}
100+
```
101+
82102
Stop broadcasting
83103

84104
```js
@@ -123,8 +143,26 @@ BLEAdvertiser.scan([ManufacturerData], {}) // manufacturer data and options
123143
.catch(error => console.log("Scan Error", error));
124144
```
125145

126-
Stop scanning.
127-
146+
Available Scanning Options:
147+
```js
148+
{
149+
scanMode: BLEAdvertiser.<
150+
SCAN_MODE_BALANCED,
151+
SCAN_MODE_LOW_LATENCY,
152+
SCAN_MODE_LOW_POWER,
153+
SCAN_MODE_OPPORTUNISTIC>,
154+
matchMode: BLEAdvertiser.<
155+
MATCH_MODE_AGGRESSIVE,
156+
MATCH_MODE_STICKY>,
157+
numberOfMatches: BLEAdvertiser.<
158+
MATCH_NUM_FEW_ADVERTISEMENT,
159+
MATCH_NUM_MAX_ADVERTISEMENT,
160+
MATCH_NUM_ONE_ADVERTISEMENT>,
161+
reportDelay: <int>
162+
}
163+
```
164+
165+
Stop scanning
128166
```js
129167
BLEAdvertiser.stopScan()
130168
.then(success => console.log("Stop Scan Successful", success))

0 commit comments

Comments
 (0)