extends uci-i2c-device to support mcp 230xx chips via UCI packets
Go to file
David Kebler 3847ba8711 0.3.3 udpate deps 2020-07-26 15:45:19 -07:00
examples 0.3.1 mcp230xxi rework 2020-03-24 14:51:03 -07:00
src fix default socket options for mcp230xxi so socket name only need include the word 'interrupt' 2020-03-24 15:58:47 -07:00
test moved to master branch after copying master to V1 2018-05-28 15:14:30 -07:00
.eslintrc.js first commit of packet based mcp code. 2018-02-08 09:19:46 -08:00
.gitignore 0.1.39 2020-01-16 22:04:21 -08:00
.npmignore 0.3.0 bump version for 3-2020 deployment of light code 2020-03-15 16:22:35 -07:00
package.json 0.3.3 udpate deps 2020-07-26 15:45:19 -07:00
readme.md 0.1.24 bump version for @uci-utils/byte 2019-03-22 11:25:35 -07:00


uCOMmandIt MCP - An I2C Micro Chip NodeJS Class Library

Build Status Inline docs Dependencies devDependencies codecov

What is it

This module contains ES6 Classes for the Micro Chip (MCP) I2C GPIO (general purpose input output) expander chips. The chips contain 8 GPIO pins organized in ports. The MCP23008 has a single port and the MCP23017 has two ports (A,B). Each port has a single interrupt pin which can be used to determine when any pin of a port has changed state. With this module after creating an instance of a chip class you'll be able to easily read and write to the chip's pins with simple methods such as .read(),.on()',.off(), and .toggle()

What's it good for

Lots of I2C devices make use of these chips. In particular many of Control Everything's boards use these chips including their relay boards and their general purpose DIO boards. To control and read them (and any other board using these chips) using nodejs all you need is this module!


  1. You'll need a computer with an I2C interface which is typically a set of reserved GPIO pins found on most ARM based single board computer (SBC) like the Raspberry Pi. You'll probably want a pin header shield (e.g. Control Everything's RPi shield) to make connecting your IC2 MCP device to your SBC easy.

  2. You'll need to have an I2C bus interface library with NodeJS bindings and it will need to compile on your specific SBC. One such library, Fivdi's I2C-Bus, already exists for the Raspberry Pi and will likely compile on many other ARM7 SBCs (e.g. BeagleBone Black). This module makes use the Fivdi I2C library via the UCI-I2C module. It is possible that other I2C libraries with a nodeJS binding could be used but for now the Fivdi library is the only one.

Getting Started

  1. Prepare an SBC (e.g. Raspberry Pi) with an appropriate OS (e.g. Raspbian).

  2. Connect your MCP based I2C device and check that the SBC can talk to it usingi2cdetect which is part of the i2ctools linux package. Assuming your I2c linux device is number 1 that would be

    sudo i2cdetect -y 1

  3. Install the latest nodeJS. NOTE! You MUST be using at least node 7.6 for this module to work so just load and maintain the latest version for the best result. Node source has the easiest way to do that.

    Using Ubuntu
    curl -sL https://deb.nodesource.com/setup_7.x | sudo -E bash -
    sudo apt-get install -y nodejs
    Using Debian, as root
    curl -sL https://deb.nodesource.com/setup_7.x | bash -
    apt-get install -y nodejs
  4. Start an npm project and install the uci mpc module

npm init npm install @uci/mcp

  1. Now simply run the sample.js code in the demo/ directory by typing

npm run sample

if all went well the device should have been written to and read back and you can confirm the writes and reads were correct by looking at the console output. If you hook up a mcp based relay board you should see the relays being turned on and off.

Use the sample.js code as the basis for your mcp i2c project.