c_meyer/pxt-calliope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Renaming the string in onDataPacketReceived and updating docs (#292)

Browse Source
This commit is contained in:
Richard Knoll
2016-10-25 16:39:13 -07:00
committed by Peli de Halleux
parent f191d9033d
commit 2bc5db517e
5 changed files with 23 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/reference/radio/on-data-packet-received.md
View File

@ -5,12 +5,23 @@ Run part of a program when the micro:bit receives a
```sig
radio.onDataPacketReceived((packet: Packet) => { });
radio.onDataPacketReceived(({receivedNumber, receivedString, time, serial, signal}) => { });
```
### ~hint
To add or remove the parts of the packet from the block, try clicking the blue gear in the corner!
### ~
### Callback Parameters
* ``packet`` - the [packet](/reference/radio/packet) that was received by the radio
* ``packet`` - the [packet](/reference/radio/packet) that was received by the radio. The packet has the following properties:
* `receivedNumber` - The [number](/reference/types/number) that was sent in this packet or `0` if this packet did not contain a number. See [send number](/reference/radio/send-number) and [send value](/reference/radio/send-value)
* `receivedString` - The [string](/reference/types/string) that was sent in this packet or the empty string if this packet did not contain a string. See [send string](/reference/radio/send-string) and [send value](/reference/radio/send-value)
* `time` - The system time of the micro:bit that sent this packet at the time the packet was sent.
* `serial` - The serial number of the micro:bit that sent this packet or `0` if the micro:bit did not include its serial number.
* `signal` - How strong the radio signal is from `255` (weak) to `0` (strong).
### Example