pxt-calliope/docs/reference/bluetooth/stop-advertising.md
2020-03-19 16:26:40 +01:00

38 lines
983 B
Markdown

# Stop Advertising
Stops advertising URL via the Eddystone protocol over Bluetooth.
## ~hint
## Eddystone
Bluetooth beacons are used to indicate proximity to a place or object of interest.
Beacons use Bluetooth advertising to broadcast a small amount of data,
which can be received and acted upon by anyone in range with a suitable device and software, typically a smartphone and application.
There are various beacon message formats, which define the way Bluetooth advertising packets are used as containers for beacon data.
iBeacon is Apple's beacon message format. Eddystone comes from Google.
Read more at https://lancaster-university.github.io/microbit-docs/ble/eddystone/ .
## ~
```sig
bluetooth.stopAdvertising();
```
## Example: stop advertising on button pressed
```blocks
input.onButtonEvent(Button.A, ButtonEvent.Click, () => {
bluetooth.stopAdvertising();
})
```
## See Also
[advertise-url](/reference/bluetooth/advertise-url)
```package
bluetooth
```