Updating radio JSON writing API (#290)
This commit is contained in:
committed by
Peli de Halleux
parent
7d912110f4
commit
f191d9033d
48
docs/reference/radio/write-received-packet-to-serial.md
Normal file
48
docs/reference/radio/write-received-packet-to-serial.md
Normal file
@ -0,0 +1,48 @@
|
||||
# Write Received Packet To Serial
|
||||
|
||||
Writes the last packet received by the ``radio`` to serial in JSON format.
|
||||
Should be called within a callback to
|
||||
[on data packet received](/reference/radio/on-data-packet-received).
|
||||
|
||||
```sig
|
||||
radio.writeReceivedPacketToSerial();
|
||||
```
|
||||
|
||||
### Data received format
|
||||
|
||||
The format for received data printed to serial is as follows:
|
||||
|
||||
- [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"}```
|
||||
|
||||
### Examples
|
||||
|
||||
When ```radio``` data is received (after pressing the ``A`` button on
|
||||
the second micro:bit), this program sends temperature data to
|
||||
serial.
|
||||
|
||||
```blocks
|
||||
input.onButtonPressed(Button.A, () => {
|
||||
radio.sendNumber(input.temperature());
|
||||
});
|
||||
radio.onDataPacketReceived(() => {
|
||||
radio.writeReceivedPacketToSerial();
|
||||
});
|
||||
```
|
||||
Sample output to serial when ``A`` button pressed:
|
||||
|
||||
```Text
|
||||
{v:27,t:323,s:0}
|
||||
```
|
||||
|
||||
### 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)
|
||||
|
||||
```package
|
||||
radio
|
||||
```
|
@ -1,5 +1,7 @@
|
||||
# Write Value To Serial
|
||||
|
||||
> Note: This API has been deprecated! Use [write received packet to serial](/reference/radio/write-received-packet-to-serial) instead.
|
||||
|
||||
Writes the data received by ``radio`` to serial in JSON format.
|
||||
|
||||
```sig
|
||||
|
Reference in New Issue
Block a user