updated api definitions
This commit is contained in:
parent
adef3a6487
commit
d873cbb6c3
@ -21,14 +21,18 @@ Read more at https://lancaster-university.github.io/microbit-docs/ble/eddystone/
|
|||||||
bluetooth.stopAdvertising();
|
bluetooth.stopAdvertising();
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Example: stop advertising on button pressed
|
||||||
|
|
||||||
|
```blocks
|
||||||
|
input.onButtonPressed(Button.A, () => {
|
||||||
|
bluetooth.stopAdvertising();
|
||||||
|
})
|
||||||
|
```
|
||||||
|
|
||||||
## See Also
|
## See Also
|
||||||
|
|
||||||
[advertise-url](/reference/bluetooth/advertise-url)
|
[advertise-url](/reference/bluetooth/advertise-url)
|
||||||
|
|
||||||
```blocks
|
|
||||||
bluetooth.stopAdvertising();
|
|
||||||
```
|
|
||||||
|
|
||||||
```package
|
```package
|
||||||
bluetooth
|
bluetooth
|
||||||
```
|
```
|
@ -1,5 +1,8 @@
|
|||||||
{
|
{
|
||||||
"bluetooth": "Support for additional Bluetooth services.",
|
"bluetooth": "Support for additional Bluetooth services.",
|
||||||
|
"bluetooth.advertiseUrl": "Advertise an Eddystone URL",
|
||||||
|
"bluetooth.advertiseUrl|param|power": "power level between 0 and 7, e.g.: 7",
|
||||||
|
"bluetooth.advertiseUrl|param|url": "the url to transmit. Must be no longer than the supported eddystone url length",
|
||||||
"bluetooth.onBluetoothConnected": "Register code to run when the micro:bit is connected to over Bluetooth",
|
"bluetooth.onBluetoothConnected": "Register code to run when the micro:bit is connected to over Bluetooth",
|
||||||
"bluetooth.onBluetoothConnected|param|body": "Code to run when a Bluetooth connection is established",
|
"bluetooth.onBluetoothConnected|param|body": "Code to run when a Bluetooth connection is established",
|
||||||
"bluetooth.onBluetoothDisconnected": "Register code to run when a bluetooth connection to the micro:bit is lost",
|
"bluetooth.onBluetoothDisconnected": "Register code to run when a bluetooth connection to the micro:bit is lost",
|
||||||
@ -11,6 +14,7 @@
|
|||||||
"bluetooth.startMagnetometerService": "Starts the Bluetooth magnetometer service",
|
"bluetooth.startMagnetometerService": "Starts the Bluetooth magnetometer service",
|
||||||
"bluetooth.startTemperatureService": "Starts the Bluetooth temperature service",
|
"bluetooth.startTemperatureService": "Starts the Bluetooth temperature service",
|
||||||
"bluetooth.startUartService": "Starts the Bluetooth UART service",
|
"bluetooth.startUartService": "Starts the Bluetooth UART service",
|
||||||
|
"bluetooth.stopAdvertising": "Stops advertising Eddystone end points",
|
||||||
"bluetooth.uartReadUntil": "Reads from the Bluetooth UART service buffer, returning its contents when the specified delimiter character is encountered.",
|
"bluetooth.uartReadUntil": "Reads from the Bluetooth UART service buffer, returning its contents when the specified delimiter character is encountered.",
|
||||||
"bluetooth.uartWriteNumber": "Prints a numeric value to the serial",
|
"bluetooth.uartWriteNumber": "Prints a numeric value to the serial",
|
||||||
"bluetooth.uartWriteString": "Writes to the Bluetooth UART service buffer. From there the data is transmitted over Bluetooth to a connected device.",
|
"bluetooth.uartWriteString": "Writes to the Bluetooth UART service buffer. From there the data is transmitted over Bluetooth to a connected device.",
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
{
|
{
|
||||||
|
"bluetooth.advertiseUrl|block": "bluetooth advertise url %url|with power %power",
|
||||||
"bluetooth.onBluetoothConnected|block": "on bluetooth connected",
|
"bluetooth.onBluetoothConnected|block": "on bluetooth connected",
|
||||||
"bluetooth.onBluetoothDisconnected|block": "on bluetooth disconnected",
|
"bluetooth.onBluetoothDisconnected|block": "on bluetooth disconnected",
|
||||||
"bluetooth.startAccelerometerService|block": "bluetooth accelerometer service",
|
"bluetooth.startAccelerometerService|block": "bluetooth accelerometer service",
|
||||||
@ -8,6 +9,7 @@
|
|||||||
"bluetooth.startMagnetometerService|block": "bluetooth magnetometer service",
|
"bluetooth.startMagnetometerService|block": "bluetooth magnetometer service",
|
||||||
"bluetooth.startTemperatureService|block": "bluetooth temperature service",
|
"bluetooth.startTemperatureService|block": "bluetooth temperature service",
|
||||||
"bluetooth.startUartService|block": "bluetooth uart service",
|
"bluetooth.startUartService|block": "bluetooth uart service",
|
||||||
|
"bluetooth.stopAdvertising|block": "bluetooth stop advertising",
|
||||||
"bluetooth.uartReadUntil|block": "bluetooth uart|read until %del=serial_delimiter_conv",
|
"bluetooth.uartReadUntil|block": "bluetooth uart|read until %del=serial_delimiter_conv",
|
||||||
"bluetooth.uartWriteNumber|block": "bluetooth uart|write number %value",
|
"bluetooth.uartWriteNumber|block": "bluetooth uart|write number %value",
|
||||||
"bluetooth.uartWriteString|block": "bluetooth uart|write string %data",
|
"bluetooth.uartWriteString|block": "bluetooth uart|write string %data",
|
||||||
|
@ -127,8 +127,8 @@ namespace bluetooth {
|
|||||||
* @param url the url to transmit. Must be no longer than the supported eddystone url length
|
* @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
|
* @param power power level between 0 and 7, e.g.: 7
|
||||||
*/
|
*/
|
||||||
//% blockId=eddystone_advertise_url block="advertise url %url|power %power"
|
//% blockId=eddystone_advertise_url block="bluetooth advertise url %url|with power %power"
|
||||||
//% parts=bluetooth weight=11
|
//% parts=bluetooth weight=11 blockGap=8
|
||||||
//% help=bluetooth/advertise-url
|
//% help=bluetooth/advertise-url
|
||||||
void advertiseUrl(StringData* url, int power) {
|
void advertiseUrl(StringData* url, int power) {
|
||||||
int8_t level = CALIBRATED_POWERS[min(7, max(0, power))];
|
int8_t level = CALIBRATED_POWERS[min(7, max(0, power))];
|
||||||
@ -138,7 +138,7 @@ namespace bluetooth {
|
|||||||
/**
|
/**
|
||||||
* Stops advertising Eddystone end points
|
* Stops advertising Eddystone end points
|
||||||
*/
|
*/
|
||||||
//% blockId=eddystone_stop_advertising block="stop advertising"
|
//% blockId=eddystone_stop_advertising block="bluetooth stop advertising"
|
||||||
//% parts=bluetooth weight=10
|
//% parts=bluetooth weight=10
|
||||||
//% help=bluetooth/stop-advertising
|
//% help=bluetooth/stop-advertising
|
||||||
void stopAdvertising() {
|
void stopAdvertising() {
|
||||||
|
@ -46,13 +46,4 @@ namespace bluetooth {
|
|||||||
// dummy implementation for simulator
|
// dummy implementation for simulator
|
||||||
return "???"
|
return "???"
|
||||||
}
|
}
|
||||||
|
|
||||||
//% shim=bluetooth::advertiseUrl
|
|
||||||
export function advertiseUrl(url: string, powerLevel: number) {
|
|
||||||
}
|
|
||||||
|
|
||||||
//% shim=bluetooth::stopAdvertising
|
|
||||||
export function stopAdvertising() {
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
6
libs/bluetooth/shims.d.ts
vendored
6
libs/bluetooth/shims.d.ts
vendored
@ -86,15 +86,15 @@ declare namespace bluetooth {
|
|||||||
* @param url the url to transmit. Must be no longer than the supported eddystone url length
|
* @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
|
* @param power power level between 0 and 7, e.g.: 7
|
||||||
*/
|
*/
|
||||||
//% blockId=eddystone_advertise_url block="advertise url %url|power %power"
|
//% blockId=eddystone_advertise_url block="bluetooth advertise url %url|with power %power"
|
||||||
//% parts=bluetooth weight=11
|
//% parts=bluetooth weight=11 blockGap=8
|
||||||
//% help=bluetooth/advertise-url shim=bluetooth::advertiseUrl
|
//% help=bluetooth/advertise-url shim=bluetooth::advertiseUrl
|
||||||
function advertiseUrl(url: string, power: number): void;
|
function advertiseUrl(url: string, power: number): void;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Stops advertising Eddystone end points
|
* Stops advertising Eddystone end points
|
||||||
*/
|
*/
|
||||||
//% blockId=eddystone_stop_advertising block="stop advertising"
|
//% blockId=eddystone_stop_advertising block="bluetooth stop advertising"
|
||||||
//% parts=bluetooth weight=10
|
//% parts=bluetooth weight=10
|
||||||
//% help=bluetooth/stop-advertising shim=bluetooth::stopAdvertising
|
//% help=bluetooth/stop-advertising shim=bluetooth::stopAdvertising
|
||||||
function stopAdvertising(): void;
|
function stopAdvertising(): void;
|
||||||
|
Loading…
Reference in New Issue
Block a user