Add radio methods to replace the radio mutator (#773)

* Add radio methods to replace the object destructing behaviour
This commit is contained in:
Sam El-Husseini
2018-05-14 13:18:19 -07:00
committed by GitHub
parent 66b320d633
commit d2858f122f
5 changed files with 153 additions and 79 deletions

View File

@ -6,9 +6,14 @@
"radio.Packet.serial": "The serial number of the sender of the packet or 0 if the sender did not sent their serial number.",
"radio.Packet.signal": "The received signal strength indicator (RSSI) of the packet.",
"radio.Packet.time": "The system time of the sender of the packet at the time the packet was sent.",
"radio.onReceivedNumber": "Registers code to run when the radio receives a packet. Also takes the\nreceived packet from the radio queue.",
"radio.onReceivedString": "Registers code to run when the radio receives a packet. Also takes the\nreceived packet from the radio queue.",
"radio.onReceivedValue": "Registers code to run when the radio receives a packet. Also takes the\nreceived packet from the radio queue.",
"radio._packetProperty": "Gets a packet property.",
"radio._packetProperty|param|type": "the packet property type, eg: PacketProperty.time",
"radio.getReceivedPacketProperty": "Returns properties of the last radio packet received.",
"radio.getReceivedPacketProperty|param|type": "the type of property to retrieve from the last packet",
"radio.onReceivedBuffer": "Registers code to run when the radio receives a buffer.",
"radio.onReceivedNumber": "Registers code to run when the radio receives a number.",
"radio.onReceivedString": "Registers code to run when the radio receives a string.",
"radio.onReceivedValue": "Registers code to run when the radio receives a key value pair.",
"radio.receivedBuffer": "Returns the buffer 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.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.",