j5-io v3.2.0

J5 IO

J5 IO is a Firmata API compatible abstract library for creating Johnny-Five IO plugins. The API docs for this module can be found on the Johnny-Five Wiki, except for the constructor which is documented below.

If you have a bug report, feature request, or wish to contribute code, please be sure to check out the Raspi IO Contributing Guide.

Installation

Install with npm:

npm install j5-io

Usage

Using J5 IO to create a Johnny-Five IO plugin should look something like this:

import { J5IO } from 'j5-io';
import { getPins } from 'raspi-board';

export function RaspiIO() {

  // Create the platform options
  const platform = {
    base: require('raspi'),
    gpio: require('raspi-gpio'),
    pwm: require('raspi-soft-pwm')
  };

  return new J5IO({
    pluginName: 'Raspi IO',
    pinInfo: getPins(),
    platform
  });
}

For a complete example, take a look at Raspi IO which is based on this module.

API

new J5IO(options)

Instantiates a new J5 IO instance with the given options

Arguments:

License

The MIT License (MIT)

Copyright (c) Bryan Hughes bryan@nebri.us

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.