61aae94d8b
* Refactoring radio into the ts * Moving the rest of the radio functionality to the TypeScript * Removing sim implementation of old radio cpp * Adding test script * Removing handler key * Rename internal functions * PR feedback * Refactoring to use event bus
48 lines
5.8 KiB
JSON
48 lines
5.8 KiB
JSON
{
|
|
"radio": "Communicate data using radio packets",
|
|
"radio.Packet.receivedBuffer": "The buffer payload if a buffer was sent in this packet\r\nor the empty buffer",
|
|
"radio.Packet.receivedNumber": "The number payload if a number was sent in this packet (via ``sendNumber()`` or ``sendValue()``)\r\nor 0 if this packet did not contain a number.",
|
|
"radio.Packet.receivedString": "The string payload if a string was sent in this packet (via ``sendString()`` or ``sendValue()``)\r\nor the empty string if this packet did not contain a string.",
|
|
"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._packetProperty": "Gets a packet property.",
|
|
"radio._packetProperty|param|type": "the packet property type, eg: PacketProperty.time",
|
|
"radio.onDataPacketReceived": "Deprecated. Use onDataReceived() instead\r\nRegisters code to run when the radio receives a packet. Also takes the\r\nreceived packet from the radio queue.",
|
|
"radio.onDataReceived": "Registers code to run when a packet is received over radio.",
|
|
"radio.onReceivedBuffer": "Registers code to run when the radio receives a buffer.",
|
|
"radio.onReceivedBufferDeprecated": "Registers code to run when the radio receives a buffer. Deprecated, use\r\nonReceivedBuffer instead.",
|
|
"radio.onReceivedNumber": "Registers code to run when the radio receives a number.",
|
|
"radio.onReceivedNumberDeprecated": "Registers code to run when the radio receives a number. Deprecated, use\r\nonReceivedNumber instead.",
|
|
"radio.onReceivedString": "Registers code to run when the radio receives a string.",
|
|
"radio.onReceivedStringDeprecated": "Registers code to run when the radio receives a string. Deprecated, use\r\nonReceivedString instead.",
|
|
"radio.onReceivedValue": "Registers code to run when the radio receives a key value pair.",
|
|
"radio.onReceivedValueDeprecated": "Registers code to run when the radio receives a key value pair. Deprecated, use\r\nonReceivedValue instead.",
|
|
"radio.raiseEvent": "Sends an event over radio to neigboring devices",
|
|
"radio.readRawPacket": "Takes the next packet from the radio queue and returns its contents in a Buffer",
|
|
"radio.receiveNumber": "Reads the next packet from the radio queue and returns the packet's number\r\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\r\npayload or the empty string if the packet did not contain a string.",
|
|
"radio.receivedBuffer": "Returns the buffer payload from the last packet taken from the radio queue\r\n(via ``receiveNumber``, ``receiveString``, etc) or the empty string if that\r\npacket did not contain a string.",
|
|
"radio.receivedNumber": "Returns the number payload from the last packet taken from the radio queue\r\n(via ``receiveNumber``, ``receiveString``, etc) or 0 if that packet did not\r\ncontain a number.",
|
|
"radio.receivedPacket": "Returns properties of the last radio packet received.",
|
|
"radio.receivedPacket|param|type": "the type of property to retrieve from the last packet",
|
|
"radio.receivedSerial": "Returns the serial number of the sender micro:bit from the last packet taken\r\nfrom the radio queue (via ``receiveNumber``, ``receiveString``, etc) or 0 if\r\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\r\n(via ``receiveNumber``, ``receiveString``, etc) or the empty string if that\r\npacket did not contain a string.",
|
|
"radio.receivedTime": "Returns the system time of the sender micro:bit at the moment when it sent the\r\nlast packet taken from the radio queue (via ``receiveNumber``,\r\n``receiveString``, etc).",
|
|
"radio.sendBuffer": "Broadcasts a buffer (up to 19 bytes long) along with the device serial number\nand running time to any connected micro:bit in the group.",
|
|
"radio.sendNumber": "Broadcasts a number over radio to any connected micro:bit in the group.",
|
|
"radio.sendRawPacket": "Sends a raw packet through the radio",
|
|
"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. The name can\ninclude no more than 8 characters.",
|
|
"radio.sendValue|param|name": "the field name (max 8 characters), eg: \"name\"",
|
|
"radio.sendValue|param|value": "the numeric value",
|
|
"radio.setGroup": "Sets the group id for radio communications. A micro:bit can only listen to one group ID at any time.",
|
|
"radio.setGroup|param|id": "the group id between ``0`` and ``255``, eg: 1",
|
|
"radio.setTransmitPower": "Change the output power level of the transmitter to the given value.",
|
|
"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.writeReceivedPacketToSerial": "Writes the last received packet to serial as JSON. This should be called\nwithin an ``onDataPacketReceived`` callback.",
|
|
"radio.writeValueToSerial": "Reads the next packet from the radio queue and and writes it to serial\r\nas JSON."
|
|
} |