Deprecating old radio APIs and fixing docs (#289)

This commit is contained in:
Richard Knoll
2016-10-24 16:30:21 -07:00
committed by Peli de Halleux
parent ba69563bf4
commit ec404e5887
25 changed files with 205 additions and 163 deletions

View File

@ -244,7 +244,7 @@ namespace radio {
//% help=radio/receive-number
//% weight=46
//% blockId=radio_datagram_receive block="radio receive number" blockGap=8
//% advanced=true
//% deprecated=true
int receiveNumber()
{
if (radioEnable() != MICROBIT_OK) return 0;
@ -258,7 +258,7 @@ namespace radio {
//% help=radio/on-data-received
//% weight=50
//% blockId=radio_datagram_received_event block="radio on data received" blockGap=8
//% advanced=true
//% deprecated=true
void onDataReceived(Action body) {
if (radioEnable() != MICROBIT_OK) return;
registerWithDal(MICROBIT_ID_RADIO, MICROBIT_RADIO_EVT_DATAGRAM, body);
@ -274,7 +274,7 @@ namespace radio {
//% blockId=radio_datagram_receive_string block="radio receive string" blockGap=8
//% weight=44
//% help=radio/receive-string
//% advanced=true
//% deprecated=true
StringData* receiveString() {
if (radioEnable() != MICROBIT_OK) return ManagedString().leakData();
receivePacket(false);
@ -289,7 +289,7 @@ namespace radio {
//% help=radio/received-signal-strength
//% weight=40
//% blockId=radio_datagram_rssi block="radio received signal strength"
//% advanced=true
//% deprecated=true
int receivedSignalStrength() {
if (radioEnable() != MICROBIT_OK) return 0;
return packet.getRSSI();

View File

@ -32,6 +32,7 @@ namespace radio {
* Registers code to run when the radio receives a packet. Also takes the
* received packet from the radio queue.
*/
//% help=radio/on-data-packet-received
//% mutate=true
//% mutateText=Packet
//% mutateDefaults="receivedNumber;text,receivedNumber;text"

View File

@ -50,7 +50,7 @@ declare namespace radio {
//% help=radio/receive-number
//% weight=46
//% blockId=radio_datagram_receive block="radio receive number" blockGap=8
//% advanced=true shim=radio::receiveNumber
//% deprecated=true shim=radio::receiveNumber
function receiveNumber(): number;
/**
@ -59,7 +59,7 @@ declare namespace radio {
//% help=radio/on-data-received
//% weight=50
//% blockId=radio_datagram_received_event block="radio on data received" blockGap=8
//% advanced=true shim=radio::onDataReceived
//% deprecated=true shim=radio::onDataReceived
function onDataReceived(body: () => void): void;
/**
@ -69,7 +69,7 @@ declare namespace radio {
//% blockId=radio_datagram_receive_string block="radio receive string" blockGap=8
//% weight=44
//% help=radio/receive-string
//% advanced=true shim=radio::receiveString
//% deprecated=true shim=radio::receiveString
function receiveString(): string;
/**
@ -80,7 +80,7 @@ declare namespace radio {
//% help=radio/received-signal-strength
//% weight=40
//% blockId=radio_datagram_rssi block="radio received signal strength"
//% advanced=true shim=radio::receivedSignalStrength
//% deprecated=true shim=radio::receivedSignalStrength
function receivedSignalStrength(): number;
/**