diff --git a/libs/radio/_locales/radio-jsdoc-strings.json b/libs/radio/_locales/radio-jsdoc-strings.json index 9b04a86b..dffb66c5 100644 --- a/libs/radio/_locales/radio-jsdoc-strings.json +++ b/libs/radio/_locales/radio-jsdoc-strings.json @@ -1,13 +1,15 @@ { "radio": "Communicate data using radio packets", "radio.onDataReceived": "Registers code to run when a packet is received over radio.", - "radio.receiveNumber": "Reads the next packet as a number from the radio queue.", - "radio.receiveString": "Reads the next packet as a string and returns it.", - "radio.receivedNumberAt": "Reads a number at a given index, between ``0`` and ``3``, from the packet received by ``receive number``. Not supported in simulator.", - "radio.receivedNumberAt|param|index": "index of the number to read from 0 to 3. 1 eg", - "radio.receivedSignalStrength": "Gets the received signal strength indicator (RSSI) from the packet received by ``receive number``. Not supported in simulator.\nnamespace=radio", + "radio.receiveNumber": "Reads the next packet from the radio queue and returns the packet's number\npayload or 0 if the packet did not contain a number.", + "radio.receiveString": "Reads the next packet from the radio queue and returns the packet's string\npayload or the empty string if the packet did not contain a string.", + "radio.receivedNumber": "Returns the number payload from the last packet taken from the radio queue\n(via ``receiveNumber``, ``receiveString``, etc) or 0 if that packet did not\ncontain a number.", + "radio.receivedSerial": "Returns the serial number of the sender micro:bit from the last packet taken\nfrom the radio queue (via ``receiveNumber``, ``receiveString``, etc) or 0 if\nthat packet did not send a serial number.", + "radio.receivedSignalStrength": "Gets the received signal strength indicator (RSSI) from the last packet taken\nfrom the radio queue (via ``receiveNumber``, ``receiveString``, etc). Not supported in simulator.\nnamespace=radio", + "radio.receivedString": "Returns the string payload from the last packet taken from the radio queue\n(via ``receiveNumber``, ``receiveString``, etc) or the empty string if that\npacket did not contain a string.", + "radio.receivedTime": "Returns the system time of the sender micro:bit at the moment when it sent the\nlast packet taken from the radio queue (via ``receiveNumber``,\n``receiveString``, etc).", "radio.sendNumber": "Broadcasts a number over radio to any connected micro:bit in the group.", - "radio.sendString": "Broadcasts a number over radio to any connected micro:bit in the group.", + "radio.sendString": "Broadcasts a string along with the device serial number\nand running time to any connected micro:bit in the group.", "radio.sendValue": "Broadcasts a name / value pair along with the device serial number\nand running time to any connected micro:bit in the group.", "radio.sendValue|param|name": "the field name (max 12 characters), eg: \"data\"", "radio.sendValue|param|value": "the numberic value", @@ -16,5 +18,5 @@ "radio.setTransmitPower|param|power": "a value in the range 0..7, where 0 is the lowest power and 7 is the highest. eg: 7", "radio.setTransmitSerialNumber": "Set the radio to transmit the serial number in each message.", "radio.setTransmitSerialNumber|param|transmit": "value indicating if the serial number is transmitted, eg: true", - "radio.writeValueToSerial": "Reads a value sent with `stream value` and writes it\nto the serial stream as JSON" + "radio.writeValueToSerial": "Reads the next packet from the radio queue and and writes it to serial\nas JSON." } \ No newline at end of file