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

66 lines
1.2 KiB
Markdown
Raw Normal View History

2016-03-26 00:47:20 +01:00
# raise alert to
Raise an alert on a remote device.
2016-06-21 07:06:19 +02:00
### ~hint
2016-03-26 00:47:20 +01:00
2016-06-21 07:06:19 +02: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).
2016-03-26 00:47:20 +01:00
The set of supported events will depend on the remote device and the BBC micro:bit apps available for the remote device.
2016-06-21 07:06:19 +02:00
### ~
2016-03-26 00:47:20 +01:00
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
2016-06-21 07:06:19 +02:00
```blocks
2016-03-26 00:47:20 +01:00
devices.raiseAlertTo("display toast")
```
To tell the connected device to vibrate
2016-06-21 07:06:19 +02:00
```blocks
2016-03-26 00:47:20 +01:00
devices.raiseAlertTo("vibrate")
```
To tell the connected device to play a sound
2016-06-21 07:06:19 +02:00
```blocks
2016-03-26 00:47:20 +01:00
devices.raiseAlertTo("play sound")
```
To tell the connected device to play a ringtone
2016-06-21 07:06:19 +02:00
```blocks
2016-03-26 00:47:20 +01:00
devices.raiseAlertTo("play ringtone")
```
To tell the connected device to find my phone
2016-06-21 07:06:19 +02:00
```blocks
2016-03-26 00:47:20 +01:00
devices.raiseAlertTo("find my phone")
```
To tell the connected device to ring alarm
2016-06-21 07:06:19 +02:00
```blocks
2016-03-26 00:47:20 +01:00
devices.raiseAlertTo("ring alarm")
```
### See also
2016-06-19 14:28:46 +02:00
[tell remote control to](/reference/devices/tell-remote-control-to), [tell camera to](/reference/devices/tell-camera-to)
2016-03-26 00:47:20 +01:00
2016-06-21 07:06:19 +02:00
```package
devices
2016-06-21 07:06:19 +02:00
```