234 lines
7.1 KiB
TypeScript
234 lines
7.1 KiB
TypeScript
// Auto-generated. Do not edit.
|
|
|
|
|
|
|
|
//% indexerGet=BufferMethods::getByte indexerSet=BufferMethods::setByte
|
|
declare interface Buffer {
|
|
/**
|
|
* Reads an unsigned byte at a particular location
|
|
*/
|
|
//% shim=BufferMethods::getUint8
|
|
getUint8(off: int32): int32;
|
|
|
|
/**
|
|
* Returns false when the buffer can be written to.
|
|
*/
|
|
//% shim=BufferMethods::isReadOnly
|
|
isReadOnly(): boolean;
|
|
|
|
/**
|
|
* Writes an unsigned byte at a particular location
|
|
*/
|
|
//% shim=BufferMethods::setUint8
|
|
setUint8(off: int32, v: int32): void;
|
|
|
|
/**
|
|
* Write a number in specified format in the buffer.
|
|
*/
|
|
//% shim=BufferMethods::setNumber
|
|
setNumber(format: NumberFormat, offset: int32, value: number): void;
|
|
|
|
/**
|
|
* Read a number in specified format from the buffer.
|
|
*/
|
|
//% shim=BufferMethods::getNumber
|
|
getNumber(format: NumberFormat, offset: int32): number;
|
|
|
|
/** Returns the length of a Buffer object. */
|
|
//% property shim=BufferMethods::length
|
|
length: int32;
|
|
|
|
/**
|
|
* Fill (a fragment) of the buffer with given value.
|
|
*/
|
|
//% offset.defl=0 length.defl=-1 shim=BufferMethods::fill
|
|
fill(value: int32, offset?: int32, length?: int32): void;
|
|
|
|
/**
|
|
* Return a copy of a fragment of a buffer.
|
|
*/
|
|
//% offset.defl=0 length.defl=-1 shim=BufferMethods::slice
|
|
slice(offset?: int32, length?: int32): Buffer;
|
|
|
|
/**
|
|
* Shift buffer left in place, with zero padding.
|
|
* @param offset number of bytes to shift; use negative value to shift right
|
|
* @param start start offset in buffer. Default is 0.
|
|
* @param length number of elements in buffer. If negative, length is set as the buffer length minus
|
|
* start. eg: -1
|
|
*/
|
|
//% start.defl=0 length.defl=-1 shim=BufferMethods::shift
|
|
shift(offset: int32, start?: int32, length?: int32): void;
|
|
|
|
/**
|
|
* Convert a buffer to string assuming UTF8 encoding
|
|
*/
|
|
//% shim=BufferMethods::toString
|
|
toString(): string;
|
|
|
|
/**
|
|
* Convert a buffer to its hexadecimal representation.
|
|
*/
|
|
//% shim=BufferMethods::toHex
|
|
toHex(): string;
|
|
|
|
/**
|
|
* Rotate buffer left in place.
|
|
* @param offset number of bytes to shift; use negative value to shift right
|
|
* @param start start offset in buffer. Default is 0.
|
|
* @param length number of elements in buffer. If negative, length is set as the buffer length minus
|
|
* start. eg: -1
|
|
*/
|
|
//% start.defl=0 length.defl=-1 shim=BufferMethods::rotate
|
|
rotate(offset: int32, start?: int32, length?: int32): void;
|
|
|
|
/**
|
|
* Write contents of `src` at `dstOffset` in current buffer.
|
|
*/
|
|
//% shim=BufferMethods::write
|
|
write(dstOffset: int32, src: Buffer): void;
|
|
}
|
|
declare namespace control {
|
|
|
|
/**
|
|
* Create a new zero-initialized buffer.
|
|
* @param size number of bytes in the buffer
|
|
*/
|
|
//% shim=control::createBuffer
|
|
function createBuffer(size: int32): Buffer;
|
|
|
|
/**
|
|
* Create a new buffer with UTF8-encoded string
|
|
* @param str the string to put in the buffer
|
|
*/
|
|
//% shim=control::createBufferFromUTF8
|
|
function createBufferFromUTF8(str: string): Buffer;
|
|
}
|
|
declare namespace loops {
|
|
|
|
/**
|
|
* Repeats the code forever in the background. On each iteration, allows other codes to run.
|
|
* @param body code to execute
|
|
*/
|
|
//% help=loops/forever weight=100 afterOnStart=true deprecated=true
|
|
//% blockId=forever_deprecated block="forever" blockAllowMultiple=1 shim=loops::forever
|
|
function forever(a: () => void): void;
|
|
|
|
/**
|
|
* Pause for the specified time in milliseconds
|
|
* @param ms how long to pause for, eg: 100, 200, 500, 1000, 2000
|
|
*/
|
|
//% help=loops/pause weight=99 deprecated=true
|
|
//% async block="pause %pause=timePicker|ms"
|
|
//% blockId=device_pause_deprecated shim=loops::pause
|
|
function pause(ms: int32): void;
|
|
}
|
|
declare namespace control {
|
|
|
|
/**
|
|
* Gets the number of milliseconds elapsed since power on.
|
|
*/
|
|
//% help=control/millis weight=50
|
|
//% blockId=control_running_time block="millis (ms)" shim=control::millis
|
|
function millis(): int32;
|
|
|
|
/**
|
|
* Gets current time in microseconds. Overflows every ~18 minutes.
|
|
*/
|
|
//% shim=control::micros
|
|
function micros(): int32;
|
|
|
|
/**
|
|
* Used internally
|
|
*/
|
|
//% flags.defl=16 shim=control::internalOnEvent
|
|
function internalOnEvent(src: int32, value: int32, handler: () => void, flags?: int32): void;
|
|
|
|
/**
|
|
* Reset the device.
|
|
*/
|
|
//% weight=30 async help=control/reset blockGap=8
|
|
//% blockId="control_reset" block="reset" shim=control::reset
|
|
function reset(): void;
|
|
|
|
/**
|
|
* Block the current fiber for the given microseconds
|
|
* @param micros number of micro-seconds to wait. eg: 4
|
|
*/
|
|
//% help=control/wait-micros weight=29 async
|
|
//% blockId="control_wait_us" block="wait (µs)%micros" shim=control::waitMicros
|
|
function waitMicros(micros: int32): void;
|
|
|
|
/**
|
|
* Run other code in the parallel.
|
|
*/
|
|
//% help=control/run-in-parallel handlerStatement=1
|
|
//% blockId="control_run_in_parallel" block="run in parallel" blockGap=8 shim=control::runInParallel
|
|
function runInParallel(a: () => void): void;
|
|
|
|
/**
|
|
* Blocks the calling thread until the specified event is raised.
|
|
*/
|
|
//% help=control/wait-for-event async
|
|
//% blockId=control_wait_for_event block="wait for event|from %src|with value %value" shim=control::waitForEvent
|
|
function waitForEvent(src: int32, value: int32): void;
|
|
|
|
/**
|
|
* Derive a unique, consistent serial number of this device from internal data.
|
|
*/
|
|
//% blockId="control_device_serial_number" block="device serial number" weight=9
|
|
//% help=control/device-serial-number shim=control::deviceSerialNumber
|
|
function deviceSerialNumber(): int32;
|
|
|
|
/**
|
|
* Derive a unique, consistent 64-bit serial number of this device from internal data.
|
|
*/
|
|
//% blockId="control_device_long_serial_number" block="device long serial number" weight=9
|
|
//% help=control/device-long-serial-number shim=control::deviceLongSerialNumber
|
|
function deviceLongSerialNumber(): Buffer;
|
|
|
|
/**
|
|
*
|
|
*/
|
|
//% shim=control::__log
|
|
function __log(prority: int32, text: string): void;
|
|
|
|
/**
|
|
* Dump internal information about a value.
|
|
*/
|
|
//% shim=control::dmesgValue
|
|
function dmesgValue(v: any): void;
|
|
|
|
/**
|
|
* Force GC and dump basic information about heap.
|
|
*/
|
|
//% shim=control::gc
|
|
function gc(): void;
|
|
|
|
/**
|
|
* Force GC and halt waiting for debugger to do a full heap dump.
|
|
*/
|
|
//% shim=control::heapDump
|
|
function heapDump(): void;
|
|
|
|
/**
|
|
* Set flags used when connecting an external debugger.
|
|
*/
|
|
//% shim=control::setDebugFlags
|
|
function setDebugFlags(flags: int32): void;
|
|
|
|
/**
|
|
* Record a heap snapshot to debug memory leaks.
|
|
*/
|
|
//% shim=control::heapSnapshot
|
|
function heapSnapshot(): void;
|
|
|
|
/**
|
|
* Return true if profiling is enabled in the current build.
|
|
*/
|
|
//% shim=control::profilingEnabled
|
|
function profilingEnabled(): boolean;
|
|
}
|
|
|
|
// Auto-generated. Do not edit. Really.
|