@types/cordovarduino
TypeScript icon, indicating that this package has built-in type declarations

0.0.33 • Public • Published

Installation

npm install --save @types/cordovarduino

Summary

This package contains type definitions for cordovarduino (https://github.com/stereolux/cordovarduino).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cordovarduino.

index.d.ts

declare namespace Cordovardunio {
    interface Serial {
        /**
         * Request permission to interact with the serial port.
         *
         * @param successCallback Function to call on success
         * @param errorCallback   Function to call on error
         */
        requestPermission(successCallback: Function, errorCallback: Function): void;

        /**
         * Open a connection.
         *
         * @param opts            SerialOptions object
         * @param successCallback Function to call on success
         * @param errorCallback   Function to call on error
         */
        open(opts: SerialOptions, successCallback: Function, errorCallback: Function): void;

        /**
         * Write to the serial port.
         *
         * @param data            String data to write to serial port
         * @param successCallback Function to call on success
         * @param errorCallback   Function to call on error
         */
        write(data: string, successCallback: Function, errorCallback: Function): void;

        /**
         * Read from the serial port.
         *
         * @param successCallback Function to call on success
         * @param errorCallback   Function to call on error
         */
        read(successCallback: Function, errorCallback: Function): void;

        /**
         * Close connection.
         *
         * @param successCallback Function to call on success
         * @param errorCallback   Function to call on error
         */
        close(successCallback: Function, errorCallback: Function): void;

        /**
         * Register a callback for the driver reading incoming data from the serial device
         *
         * @param successCallback Function to call on success
         * @param errorCallback   Function to call on error
         */
        registerReadCallback(successCallback: Function, errorCallback: Function): void;
    }

    interface SerialOptions {
        /**
         * @defaultValue 9600
         */
        baudRate?: number | undefined;

        /**
         * @defaultValue 8
         */
        dataBits?: number | undefined;

        /**
         * @defaultValue 1
         */
        stopBits?: number | undefined;

        /**
         * @defaultValue 0
         */
        parity?: number | undefined;
    }
}

// Plugin will be surfaced as window.serial
declare var serial: Cordovardunio.Serial;

Additional Details

  • Last updated: Mon, 06 Nov 2023 22:41:05 GMT
  • Dependencies: none

Credits

These definitions were written by Hendrik Maus.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/cordovarduino

Weekly Downloads

1

Version

0.0.33

License

MIT

Unpacked Size

7.4 kB

Total Files

5

Last publish

Collaborators

  • types