obniz
Version:
obniz sdk for javascript
76 lines (75 loc) • 1.71 kB
TypeScript
/**
* @packageDocumentation
* @module ObnizCore.Components
*/
/// <reference types="node" />
/// <reference types="node" />
import Obniz from '../../index';
/**
* @param PluginReceiveCallbackFunction.data
* received data
*/
declare type PluginReceiveCallbackFunction = (data: number[], str: string | null) => void;
export declare class Plugin {
/**
* Callback function is called when Plugin is received.
*
* ```javascript
* // Javascript Example
* obniz.plugin.onreceive = data => {
* console.log(data);
* };
* ```
*
*/
onreceive?: PluginReceiveCallbackFunction;
/**
* Callback function is called when Frame Information Received
*
* ```javascript
* // Javascript Example
* obniz.plugin.onFrameStart = length => {
* console.log(`${length} bytes will be start`);
* };
* ```
*
*/
onFrameStart?: (length: number) => void;
/**
* Callback function is called when Frame Information Received
*
* ```javascript
* // Javascript Example
* obniz.plugin.onFrameEnd = length => {
* console.log(`frame ended`);
* };
* ```
*
*/
onFrameEnd?: () => void;
private Obniz;
constructor(obniz: Obniz, id: number);
/**
* Scan WiFi
*
* ```javascript
* // Javascript Example
* obniz.plugin.send("obniz.js send data")
*
* obniz.plugin.send([0x00, 0x01, 0x02])
* ```
*
*/
send(data: string | number | number[] | Buffer): void;
/**
* @ignore
* @private
*/
_reset(): void;
/**
* @ignore
* @param obj
*/
notified(obj: any): void;
}
export {};