pxt-calliope/libs/radio/shims.d.ts
2020-08-19 22:03:58 +02:00

74 lines
2.6 KiB
TypeScript

// Auto-generated. Do not edit.
//% color=#E3008C weight=96 icon="\uf012"
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;
/**
* Internal use only. Takes the next packet from the radio queue and returns its contents + RSSI in a Buffer.
* @returns NULL if no packet available
*/
//% shim=radio::readRawPacket
function readRawPacket(): Buffer;
/**
* Internal use only. Sends a raw packet through the radio (assumes RSSI appened to packet)
*/
//% async shim=radio::sendRawPacket
function sendRawPacket(msg: Buffer): void;
/**
* Used internally by the library.
*/
//% help=radio/on-data-received
//% weight=0
//% blockId=radio_datagram_received_event block="radio on data received" blockGap=8
//% deprecated=true blockHidden=1 shim=radio::onDataReceived
function onDataReceived(body: () => void): void;
/**
* 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
*/
//% help=radio/set-group
//% weight=100
//% blockId=radio_set_group block="radio set group %ID"
//% id.min=0 id.max=255 shim=radio::setGroup
function setGroup(id: int32): void;
/**
* Change the output power level of the transmitter to the given value.
* @param power a value in the range 0..7, where 0 is the lowest power and 7 is the highest. eg: 7
*/
//% help=radio/set-transmit-power
//% 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;
/**
* Change the transmission and reception band of the radio to the given channel
* @param band a frequency band in the range 0 - 83. Each step is 1MHz wide, based at 2400MHz.
**/
//% help=radio/set-frequency-band
//% weight=8 blockGap=8
//% blockId=radio_set_frequency_band block="radio set frequency band %band"
//% band.min=0 band.max=83
//% advanced=true shim=radio::setFrequencyBand
function setFrequencyBand(band: int32): void;
}
// Auto-generated. Do not edit. Really.