uci-i2c-bus/readme.md

1.6 KiB

uCOMmandIt (UCI) - I2C Bus Class

Raspberry Pi ONLY!

Build Status Inline docs Dependencies devDependencies codecov

This is an Raspberry Pi only I2C bus socket packet listener and I2C bus master processor. See /examples/bus.js for how to implement an instance. The rest of the examples are client examples that will talk to a running i2c-bus instance

Here is a simple script to get an instance going (on an RPI only)

/*
*  Raspberry Pi (only) I2C-Bus listener
* named pipe socket 'i2c-bus' is always created by default /tmp directory unless
* env variable SOCKETS_DIR='' is used to create a 'i2c-bus.sock' in a particular directory
* e.g. command >SOCKETS_DIR=/opt/sockets node -r esm i2cbus
* add TCP listener with tcp:true.  Will listen on port 1776 by default
*/

import Bus from  '@uci/i2c-bus'
;
(async () => {

  let i2cbus  = new Bus({id:'i2c-bus',tcp:true})

  await i2cbus.init()

})().catch(err => {
  console.error('FATAL: UNABLE TO START SYSTEM!\n',err)
})