pxt-calliope/docs/reference/devices/raise-alert-to.md

64 lines
1.2 KiB
Markdown
Raw Normal View History

2016-03-26 00:47:20 +01:00
# raise alert to
2016-04-02 01:22:47 +02:00
The raise alert to function.
2016-03-26 00:47:20 +01:00
Raise an alert on a remote device.
2016-04-16 01:15:08 +02:00
## Bluetooth required
2016-03-26 00:47:20 +01:00
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.
2016-04-16 01:15:08 +02:00
```sig
2016-03-26 00:47:20 +01:00
export function raiseAlertTo(event: string)
```
### Parameters
* event - an event identifier
### Examples
To tell the connected device to display toast
```
devices.raiseAlertTo("display toast")
```
To tell the connected device to vibrate
```
devices.raiseAlertTo("vibrate")
```
To tell the connected device to play a sound
```
devices.raiseAlertTo("play sound")
```
To tell the connected device to play a ringtone
```
devices.raiseAlertTo("play ringtone")
```
To tell the connected device to find my phone
```
devices.raiseAlertTo("find my phone")
```
To tell the connected device to ring alarm
```
devices.raiseAlertTo("ring alarm")
```
### See also
2016-04-13 17:27:45 +02:00
[tell remote control to](/reference/devices/tell-remote-control-to), [tell camera to](/reference/devices/tell-camera-to), [on notified](/reference/devices/on-notified)
2016-03-26 00:47:20 +01:00