pxt-calliope/docs/reference/radio/write-received-packet-to-serial.md
Sam Kent cc06e91c25 Update write-received-packet-to-serial.md (#2217)
A support ticket pointed out issues that they'd encountered when trying to follow this document:

- `sendValue` only supports an 8 character string. This is documented in the `sendValue` docs but a longer string had been used here
- Only `radio.onReceivedNumber` is used so the sample output is not consistent with the users experience. I've changed it so that all packets are handled
2019-06-18 11:23:37 -07:00

67 lines
1.9 KiB
Markdown

# write Received Packet To Serial
Writes the last packet received by the ``radio`` to serial in JSON format.
```sig
radio.writeReceivedPacketToSerial();
```
This should be called within a callback to
[on data packet received](/reference/radio/on-data-packet-received).
## Data received format
The format for received data when these send functions are used:
- [send number](/reference/radio/send-number): ```{v:ValueSent,t:MicrobitTimeAlive,s:SerialNumber}```
- [send value](/reference/radio/send-value): ```{v:ValueSent,t:MicrobitTimeAlive,s:SerialNumber,n:"Name"}```
- [send string](/reference/radio/send-string): ```{t:MicrobitTimeAlive,s:SerialNumber,n:"Text"}```
### ~hint
The serial number value sent in the packet is set to `0` unless transmission of the serial number is enabled with ``||radio:radio set transmit serial number||``.
### ~
## Example
When ```radio``` data is received (after pressing the ``A`` button on
the second @boardname@), this program sends temperature data to the
serial port.
```blocks
input.onButtonPressed(Button.A, function () {
radio.sendNumber(input.temperature())
radio.sendValue("temp", input.temperature())
radio.sendString("It's warm now")
})
radio.onReceivedNumber(function (receivedNumber) {
radio.writeReceivedPacketToSerial()
})
radio.onReceivedValue(function (name, value) {
radio.writeReceivedPacketToSerial()
})
radio.onReceivedString(function (receivedString) {
radio.writeReceivedPacketToSerial()
})
```
Sample output to serial when ``A`` button pressed:
```json
{"t":323,"s":0,"v":27}
{"t":325,"s":0,"n":"temp","v":27}
{"t":326,"s":0,"n":"It's warm now"}
```
## See also
[send number](/reference/radio/send-number),
[send value](/reference/radio/send-value),
[send string](/reference/radio/send-string),
[on data packet received](/reference/radio/on-data-packet-received),
[set transmit serial number](/reference/radio/set-transmit-serial-number)
```package
radio
```