updated docs

This commit is contained in:
Peli de Halleux 2016-11-30 04:19:17 -08:00
parent be0984cc4a
commit adef3a6487
4 changed files with 22 additions and 10 deletions

View File

@ -29,9 +29,13 @@ bluetooth.advertiseUrl("https://pxt.microbit.org/", 7);
### Example: Broadcast a secret code
```blocks
bluetooth.advertiseUrl("https://pxt.io?secret=42")
bluetooth.advertiseUrl("https://pxt.io?secret=42", 7);
```
## See Also
[stop-advertising](/reference/bluetooth/stop-advertising)
```package
bluetooth
```

View File

@ -18,9 +18,17 @@ Read more at https://lancaster-university.github.io/microbit-docs/ble/eddystone/
## ~
```sig
bluetooth.stop-advertising();
bluetooth.stopAdvertising();
```
## See Also
[advertise-url](/reference/bluetooth/advertise-url)
```blocks
bluetooth.stopAdvertising();
```
```package
bluetooth
```

View File

@ -127,8 +127,8 @@ namespace bluetooth {
* @param url the url to transmit. Must be no longer than the supported eddystone url length
* @param power power level between 0 and 7, e.g.: 7
*/
//% blockId=eddystone_advertise_url block="eddystone advertise url %url|power %powerLevel"
//% parts=bluetooth
//% blockId=eddystone_advertise_url block="advertise url %url|power %power"
//% parts=bluetooth weight=11
//% help=bluetooth/advertise-url
void advertiseUrl(StringData* url, int power) {
int8_t level = CALIBRATED_POWERS[min(7, max(0, power))];
@ -138,8 +138,8 @@ namespace bluetooth {
/**
* Stops advertising Eddystone end points
*/
//% blockId=eddystone_stop_advertising block="eddystone stop advertising"
//% parts=bluetooth
//% blockId=eddystone_stop_advertising block="stop advertising"
//% parts=bluetooth weight=10
//% help=bluetooth/stop-advertising
void stopAdvertising() {
uBit.bleManager.stopAdvertising();

View File

@ -86,16 +86,16 @@ declare namespace bluetooth {
* @param url the url to transmit. Must be no longer than the supported eddystone url length
* @param power power level between 0 and 7, e.g.: 7
*/
//% blockId=eddystone_advertise_url block="eddystone advertise url %url|power %powerLevel"
//% parts=bluetooth
//% blockId=eddystone_advertise_url block="advertise url %url|power %power"
//% parts=bluetooth weight=11
//% help=bluetooth/advertise-url shim=bluetooth::advertiseUrl
function advertiseUrl(url: string, power: number): void;
/**
* Stops advertising Eddystone end points
*/
//% blockId=eddystone_stop_advertising block="eddystone stop advertising"
//% parts=bluetooth
//% blockId=eddystone_stop_advertising block="stop advertising"
//% parts=bluetooth weight=10
//% help=bluetooth/stop-advertising shim=bluetooth::stopAdvertising
function stopAdvertising(): void;
}