updated devices docs
This commit is contained in:
@ -1,15 +1,15 @@
|
||||
# raise alert to
|
||||
|
||||
The raise alert to function.
|
||||
|
||||
Raise an alert on a remote device.
|
||||
|
||||
## Bluetooth required
|
||||
|
||||
The functions in the ``devices`` namespace allow the BBC micro:bit to communicate with a separate (remote) device, such as a smartphone, over Bluetooth (Smart).
|
||||
### ~hint
|
||||
|
||||
The functions in the ``devices`` namespace allow the BBC micro:bit to communicate with a separate (remote) device,
|
||||
such as a smartphone, over Bluetooth (Smart).
|
||||
The set of supported events will depend on the remote device and the BBC micro:bit apps available for the remote device.
|
||||
|
||||
### ~
|
||||
|
||||
|
||||
```sig
|
||||
export function raiseAlertTo(event: string)
|
||||
@ -23,37 +23,37 @@ export function raiseAlertTo(event: string)
|
||||
|
||||
To tell the connected device to display toast
|
||||
|
||||
```
|
||||
```blocks
|
||||
devices.raiseAlertTo("display toast")
|
||||
```
|
||||
|
||||
To tell the connected device to vibrate
|
||||
|
||||
```
|
||||
```blocks
|
||||
devices.raiseAlertTo("vibrate")
|
||||
```
|
||||
|
||||
To tell the connected device to play a sound
|
||||
|
||||
```
|
||||
```blocks
|
||||
devices.raiseAlertTo("play sound")
|
||||
```
|
||||
|
||||
To tell the connected device to play a ringtone
|
||||
|
||||
```
|
||||
```blocks
|
||||
devices.raiseAlertTo("play ringtone")
|
||||
```
|
||||
|
||||
To tell the connected device to find my phone
|
||||
|
||||
```
|
||||
```blocks
|
||||
devices.raiseAlertTo("find my phone")
|
||||
```
|
||||
|
||||
To tell the connected device to ring alarm
|
||||
|
||||
```
|
||||
```blocks
|
||||
devices.raiseAlertTo("ring alarm")
|
||||
```
|
||||
|
||||
@ -61,3 +61,6 @@ devices.raiseAlertTo("ring alarm")
|
||||
|
||||
[tell remote control to](/reference/devices/tell-remote-control-to), [tell camera to](/reference/devices/tell-camera-to)
|
||||
|
||||
```package
|
||||
microbit-devices
|
||||
```
|
Reference in New Issue
Block a user