Nondeterministic Postrequisite Metaprotocol
Miss any of our Open RFC calls?Watch the recordings here! »

j5-io

3.2.0 • Public • Published

J5 IO

Gitter Build Status Coverage Status

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:

Argument Type Description
options Object The configuration options.
Property Type Description
pluginName String A display name for this IO Plugin, e.g. "Raspi IO"
serialIds (optional) Object A dictionary of available serial ports. Each key is a friendly name for the port, and the value is a black box value used by the serial platform module. This object is required if platform.serial is specified. There must be one entry with a key of DEFAULT
i2cIds (optional) Object A dictionary of available I2C ports. Each key is a friendly name for the port, and the value is a black box value used by the I2C platform module. This object is required if platform.i2c is specified. There must be one entry with a key of DEFAULT
pinInfo Object Pin information about all available pins. Each key is the normalized value for each pin in the system. Each value is itself an object, as documented below. Note that this object is used to construct the pins array on the IO Plugin instance.
Property Type Description
pins Array<Number|String> All of the aliases for this pin, excluding the normalized pin value.
peripherals Array<PeripheralType> All of the supported peripherals for this pin. If writing in TypeScript, use the PeripheralType enum from the j5-io-types package. If writing in vanilla JavaScript, is one of "gpio", "pwm", "i2c", "spi", "uart". Note that these values are used to determine the available modes for each pin
platform Object The set of platform plugins
Property Type Description
base Object The "base" module to use, e.g. https://github.com/nebrius/raspi
gpio Object The "gpio" module to use, e.g. https://github.com/nebrius/raspi-gpio
pwm Object The "pwm" module to use, e.g. https://github.com/nebrius/raspi-soft-pwm
i2c (optional) Object The "i2c" module to use, e.g. https://github.com/nebrius/raspi-i2c
led (optional) Object The "led" module to use for the on-board LED not associated with pins, e.g. https://github.com/nebrius/raspi-led
serial (optional) Object The "serial" module to use, e.g. https://github.com/nebrius/raspi-serial

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.

Install

npm i j5-io

DownloadsWeekly Downloads

118

Version

3.2.0

License

MIT

Unpacked Size

105 kB

Total Files

26

Last publish

Collaborators

  • avatar