Nefariously Programmed Mecha

    particle-usb

    2.1.2 • Public • Published

    particle-usb

    CI

    A library for accessing Particle USB devices.

    Note: This library requires Particle firmware 0.8.0 or later.

    Installation | Usage | API Reference | Development | Testing | Releasing | License

    Installation

    Using npm:

    $ npm install particle-usb @particle/device-constants

    NOTE: particle-usb declares @particle/device-constants as a peerDependency - this ensures your app only ever has one copy of that dependency

    Usage

    In Node.js:

    import * as usb from 'particle-usb';

    Enumerating devices

    const devices = await usb.getDevices();
    for (let device of devices) {
      console.log(device.type); // Prints device type, e.g. "Photon"
    }

    Opening devices

    Most of the device methods, such as reset(), require the device to be open:

    const devices = await usb.getDevices();
    if (devices.length == 0) {
      throw new Error('No devices found');
    }
    const device = devices[0];
    await device.open();
    await device.reset(); // Resets the device

    It is possible to open a device by ID:

    const device = await usb.openDeviceById('0123456789abcdef01234567');
    await device.reset();

    The device should be closed when it is no longer needed:

    await device.close();

    API reference

    For more information, read the API reference on GitHub.

    Development

    Installing

    1. Install Node.js [node@12.x and npm@8.x are required]
    2. Clone this repository $ git clone git@github.com:particle-iot/particle-usb.git && cd ./particle-usb
    3. Install dependencies $ npm install
    4. View available commands $ npm run
    5. Run the tests $ npm test
    6. Start Hacking!

    Testing

    Particle USB has a number of automated test suites and related commands. The most important are:

    • npm test - run all tests
    • npm run lint - run the linter and print any errors to your terminal
    • npm run coverage - report code coverage stats

    All tests use mocha, chai, and sinon with coverage handled by nyc.

    We recommend running locally if you can as it greatly shortens your feedback loop. However, CI also runs against every PR and error reporting is publicly available.

    Releasing

    For release instructions, see RELEASE.md

    License

    This library is released under the Apache 2.0 license. See LICENSE for details.

    Keywords

    Install

    npm i particle-usb

    DownloadsWeekly Downloads

    1,775

    Version

    2.1.2

    License

    Apache-2.0

    Unpacked Size

    781 kB

    Total Files

    50

    Last publish

    Collaborators

    • sergeuz
    • particlebot