From 2bc5db517e5b93d140e51a98c2c9e8278882455b Mon Sep 17 00:00:00 2001 From: Richard Knoll Date: Tue, 25 Oct 2016 16:39:13 -0700 Subject: [PATCH] Renaming the string in onDataPacketReceived and updating docs (#292) --- docs/reference/radio/on-data-packet-received.md | 15 +++++++++++++-- docs/reference/radio/packet.md | 4 ++-- docs/reference/radio/send-string.md | 4 ++-- docs/reference/radio/send-value.md | 6 +++--- libs/radio/radio.ts | 6 +++--- 5 files changed, 23 insertions(+), 12 deletions(-) diff --git a/docs/reference/radio/on-data-packet-received.md b/docs/reference/radio/on-data-packet-received.md index d4a626b5..52a90ca0 100644 --- a/docs/reference/radio/on-data-packet-received.md +++ b/docs/reference/radio/on-data-packet-received.md @@ -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 diff --git a/docs/reference/radio/packet.md b/docs/reference/radio/packet.md index 3f522458..02e298a7 100644 --- a/docs/reference/radio/packet.md +++ b/docs/reference/radio/packet.md @@ -4,8 +4,8 @@ A packet that was received by the radio. ## Properties -* `receivedNumber` - The 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) -* `text` - The 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) +* `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). diff --git a/docs/reference/radio/send-string.md b/docs/reference/radio/send-string.md index 74c770da..c5ed3ffc 100644 --- a/docs/reference/radio/send-string.md +++ b/docs/reference/radio/send-string.md @@ -24,8 +24,8 @@ input.onButtonPressed(Button.A, () => { basic.showString("SENT"); }) -radio.onDataPacketReceived(({ text }) => { - basic.showString(text); +radio.onDataPacketReceived(({ receivedString }) => { + basic.showString(receivedString); }); ``` diff --git a/docs/reference/radio/send-value.md b/docs/reference/radio/send-value.md index e0587e77..91cfea8f 100644 --- a/docs/reference/radio/send-value.md +++ b/docs/reference/radio/send-value.md @@ -22,7 +22,7 @@ or model rocket. ```blocks radio.setGroup(99) input.onButtonPressed(Button.A, () => { - radio.sendValue("acc",input.acceleration(Dimension.X)) + radio.sendValue("acc", input.acceleration(Dimension.X)) }) ``` @@ -31,8 +31,8 @@ Then it shows them on the LED screen. ```blocks radio.setGroup(99) -radio.onDataPacketReceived(({ text, receivedNumber }) => { - basic.showString(text); +radio.onDataPacketReceived(({ receivedString, receivedNumber }) => { + basic.showString(receivedString); basic.showNumber(receivedNumber); }); ``` diff --git a/libs/radio/radio.ts b/libs/radio/radio.ts index f6036b26..2bf93d57 100644 --- a/libs/radio/radio.ts +++ b/libs/radio/radio.ts @@ -13,7 +13,7 @@ namespace radio { * The string payload if a string was sent in this packet (via ``sendString()`` or ``sendValue()``) * or the empty string if this packet did not contain a string. */ - public text: string; + public receivedString: string; /** * The system time of the sender of the packet at the time the packet was sent. */ @@ -35,7 +35,7 @@ namespace radio { //% help=radio/on-data-packet-received //% mutate=true //% mutateText=Packet - //% mutateDefaults="receivedNumber;text,receivedNumber;text" + //% mutateDefaults="receivedNumber;receivedString,receivedNumber;receivedString" //% blockId=radio_on_packet block="on radio received" blockGap=8 export function onDataPacketReceived(cb: (packet: Packet) => void) { onDataReceived(() => { @@ -44,7 +44,7 @@ namespace radio { packet.receivedNumber = receivedNumber(); packet.time = receivedTime(); packet.serial = receivedSerial(); - packet.text = receivedString(); + packet.receivedString = receivedString(); packet.signal = receivedSignalStrength(); cb(packet) });