pxt-calliope/libs/radio/shims.d.ts

73 lines
2.5 KiB
TypeScript
Raw Normal View History

2016-04-03 02:34:06 +02:00
// Auto-generated. Do not edit.
//% color=#E3008C weight=96 icon="\uf012"
2016-04-03 02:34:06 +02:00
declare namespace radio {
/**
* Sends an event over radio to neigboring devices
*/
//% blockId=radioRaiseEvent block="radio raise event|from source %src=control_event_source_id|with value %value=control_event_value_id"
//% blockExternalInputs=1
//% advanced=true
//% weight=1
//% help=radio/raise-event shim=radio::raiseEvent
function raiseEvent(src: int32, value: int32): void;
2016-04-03 02:34:06 +02:00
/**
* Takes the next packet from the radio queue and returns its contents in a Buffer
2016-04-03 02:34:06 +02:00
*/
//% help=radio/received-packet shim=radio::readRawPacket
function readRawPacket(): Buffer;
2016-04-03 02:34:06 +02:00
/**
* Sends a raw packet through the radio
*/
//% advanced=true shim=radio::sendRawPacket
function sendRawPacket(msg: Buffer): void;
2016-04-03 02:34:06 +02:00
/**
* Registers code to run when a packet is received over radio.
*/
//% help=radio/on-data-received
//% weight=50
//% blockId=radio_datagram_received_event block="radio on data received" blockGap=8
//% deprecated=true shim=radio::onDataReceived
function onDataReceived(body: () => void): void;
2016-04-03 02:34:06 +02:00
/**
* Gets the received signal strength indicator (RSSI) from the last packet taken
* from the radio queue (via ``receiveNumber``, ``receiveString``, etc). Not supported in simulator.
2016-04-03 02:34:06 +02:00
* namespace=radio
*/
//% help=radio/received-signal-strength
//% weight=40
//% blockId=radio_datagram_rssi block="radio received signal strength"
//% deprecated=true shim=radio::receivedSignalStrength
function receivedSignalStrength(): int32;
2016-04-03 02:34:06 +02:00
/**
* Sets the group id for radio communications. A micro:bit can only listen to one group ID at any time.
* @param id the group id between ``0`` and ``255``, eg: 1
2016-04-03 02:34:06 +02:00
*/
//% help=radio/set-group
//% weight=10 blockGap=8
//% blockId=radio_set_group block="radio set group %ID"
//% id.min=0 id.max=255 shim=radio::setGroup
function setGroup(id: int32): void;
2016-04-03 02:34:06 +02:00
/**
* Change the output power level of the transmitter to the given value.
2016-06-19 14:15:13 +02:00
* @param power a value in the range 0..7, where 0 is the lowest power and 7 is the highest. eg: 7
2016-04-03 02:34:06 +02:00
*/
//% help=radio/set-transmit-power
2016-08-02 01:02:06 +02:00
//% weight=9 blockGap=8
//% blockId=radio_set_transmit_power block="radio set transmit power %power"
//% power.min=0 power.max=7
//% advanced=true shim=radio::setTransmitPower
function setTransmitPower(power: int32): void;
2016-04-03 02:34:06 +02:00
}
// Auto-generated. Do not edit. Really.