j5-io

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 core-io

Usage

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

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

export function RaspiIO({ includePins, excludePins, enableSoftPwm = false } = {}) {

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

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

API

new CoreIO(options)

Instantiates a new Core IO instance with the given options

Arguments:

Argument	Type	Description
options	Object	The configuration options.
	Property Type Description enableSerial (optional) boolean Enables the use of the serial port by Johnny-Five. The default value is false enableSoftPwm (optional) boolean Use a software-based approach to PWM on GPIO pins that do not support hardware PWM. The raspi-soft-pwm library is used to enable this. The default value is false. Note: the timing of software PWM may not be as accurate as hardware PWM. includePins (optional) Array<Number|String> A list of pins to include in initialization. Any pins not listed here will not be initialized or available for use by Raspi IO excludePins (optional) Array<Number|String> A list of pins to exclude from initialization. Any pins listed here will not be initialized or available for use by Raspi IO platform Object The set of platform plugins Property Type Description raspi Object The "raspi" module to use, e.g. https://github.com/nebrius/raspi raspi-board Object The "raspi-board" module to use, e.g. https://github.com/nebrius/raspi-board raspi-gpio Object The "raspi-gpio" module to use, e.g. https://github.com/nebrius/raspi-gpio raspi-i2c Object The "raspi-i2c" module to use, e.g. https://github.com/nebrius/raspi-i2c raspi-led Object The "raspi-led" module to use, e.g. https://github.com/nebrius/raspi-led raspi-pwm Object The "raspi-pwm" module to use, e.g. https://github.com/nebrius/raspi-pwm raspi-serial Object The "raspi-serial" module to use, e.g. https://github.com/nebrius/raspi-serial raspi-soft-pwm (optional) Object The "raspi-soft-pwm" module to use, e.g. https://github.com/nebrius/raspi-soft-pwm. This only needs to be supplied if the enableSoftPwm flag is set to true

License

The MIT License (MIT)

Copyright (c) Bryan Hughes [e-mail]

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.