pxt-calliope/docs/reference/radio/received-signal-strength.md

46 lines
1.2 KiB
Markdown
Raw Normal View History

2016-06-08 20:21:58 +02:00
# Received Signal Strength
> Note: This API has been deprecated! Use [on data packet received](/reference/radio/on-data-packet-received) instead.
2016-06-08 20:21:58 +02:00
Find how strong the ``radio`` signal is, from `255` to `0`.
(`255` means a weak signal and `0` means a strong one.)
2016-11-02 01:44:37 +01:00
The @boardname@ finds the signal strength by checking how strong it was
2016-06-08 20:21:58 +02:00
the last time it ran the
[on data packet received](/reference/radio/on-data-packet-received) function. That means
2016-06-08 20:21:58 +02:00
it needs to run **receive number** first.
2016-07-18 23:04:15 +02:00
```sig
radio.receivedSignalStrength();
```
2016-06-08 20:21:58 +02:00
### Returns
* a [number](/reference/types/number) between `255` and `0` that means
how strong the signal is.
2016-06-10 00:30:47 +02:00
### Simulator
2016-06-08 20:21:58 +02:00
2016-11-02 01:44:37 +01:00
This function only works on the @boardname@, not in browsers.
2016-06-08 20:21:58 +02:00
### Example
This example shows how strong the radio signal of the
2016-06-15 13:55:19 +02:00
[light level sender example](/reference/radio/send-number) is.
2016-06-08 20:21:58 +02:00
```blocks
let x = 0;
radio.setGroup(99);
basic.forever(() => {
x = radio.receiveNumber();
basic.showNumber(radio.receivedSignalStrength());
});
```
### See also
[on data packet received](/reference/radio/on-data-packet-received), [send number](/reference/radio/send-number), [on data received](/reference/radio/on-data-received)
```package
radio
```