# cylon-i2c

> Cylon.js drivers for i2c devices

Latest version **0.26.1** (published 2016-05-15) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install cylon-i2c
pnpm add cylon-i2c
yarn add cylon-i2c
bun add cylon-i2c
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.26.1 |
| Published | 2016-05-15 |
| First published | 2013-11-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | The Hybrid Group |
| Maintainers | andrewstewart, deadprogram, edgarsilva |
| Keywords | cylon, cylonjs, cylons, robot, robots, robotics, iot, hardware, i2c |

## Links

- npm: https://www.npmjs.com/package/cylon-i2c
- Repository: https://github.com/hybridgroup/cylon-i2c
- Homepage: http://cylonjs.com
- Issues: https://github.com/hybridgroup/cylon-i2c/issues
- npm.io page: https://npm.io/package/cylon-i2c

## Dependencies (1)

- [cylon](https://npm.io/package/cylon.md) ^1.3.0

## Recent versions

- 0.26.1 (latest) — 2016-05-15
- 0.26.0 — 2016-04-25
- 0.25.0 — 2016-04-22
- 0.24.0 — 2016-02-26
- 0.23.0 — 2015-09-08
- 0.22.0 — 2015-07-01
- 0.21.3 — 2015-05-25
- 0.21.2 — 2015-05-23
- 0.21.1 — 2015-04-15
- 0.21.0 — 2015-04-08
- 0.20.1 — 2015-03-31
- 0.20.0 — 2015-02-25
- 0.19.0 — 2015-01-14
- 0.18.0 — 2014-11-28
- 0.17.0 — 2014-11-06
- … 22 more at https://npm.io/package/cylon-i2c/versions

## README

# Cylon.js For i2c

Cylon.js (http://cylonjs.com) is a JavaScript framework for robotics, physical computing, and the Internet of Things (IoT) using Node.js.

This module provides drivers for i2c devices (https://en.wikipedia.org/wiki/I%C2%B2C). You must use this module alongside Cylon.js adaptors that have i2c support, such as [cylon-firmata](https://github.com/hybridgroup/cylon-firmata).

Want to use Ruby on robots? Check out our sister project Artoo (http://artoo.io)

Want to use the Go programming language to power your robots? Check out our sister project Gobot (http://gobot.io).

[![Build Status](https://secure.travis-ci.org/hybridgroup/cylon-i2c.png?branch=master)](http://travis-ci.org/hybridgroup/cylon-i2c) [![Code Climate](https://codeclimate.com/github/hybridgroup/cylon-i2c/badges/gpa.svg)](https://codeclimate.com/github/hybridgroup/cylon-i2c) [![Test Coverage](https://codeclimate.com/github/hybridgroup/cylon-i2c/badges/coverage.svg)](https://codeclimate.com/github/hybridgroup/cylon-i2c)

## Getting Started

Install the module with: `npm install cylon cylon-i2c`

Note you must also install whichever adaptor you want to use, such as: `npm install cylon-firmata`

## Example

```javascript
var Cylon = require('cylon');

// Initialize the robot
Cylon.robot({
  connections: {
    arduino: { adaptor: 'firmata', port: '/dev/ttyACM0' }
  },

  devices: {
    blinkm: { driver: 'blinkm'}
  },

  work: function(my) {
    var lit = false;
    my.blinkm.off()
    every((1).seconds(), function() {
      if (lit === true) {
        lit = false;
        my.blinkm.rgb(0xaa, 0, 0);
      } else {
        lit = true;
        my.blinkm.rgb(0, 0, 0);
      }
    });
  }
}).start();
```

## Hardware Support
Cylon.js has a extensible system for connecting to hardware devices. The following 15 different i2c devices are currently supported:

  - BlinkM RGB LED
  - BMP180 Barometric Pressure + Temperature sensor
  - Direct I2C
  - HMC5883L 3-Axis Digital Compass
  - HMC6352 Digital Compass
  - JHD1313M1 LCD with RGB Backlight  
  - LCD
  - LIDAR-Lite
  - LSM9DS0G 9 Degrees of Freedom IMU
  - LSM9DS0XM 9 Degrees of Freedom IMU
  - MAG3110 3-Axis Digital Magnetometer
  - MPL115A2 Digital Barometer & Thermometer
  - MPU6050 Triple Axis Accelerometer and Gyro
  - PCA9544a 4-Channel I2C Mux
  - PCA9685 16-Channel 12-bit PWM/Servo Driver

More drivers are coming soon...

## Documentation
We're busy adding documentation to our web site at http://cylonjs.com/ please check there as we continue to work on Cylon.js

Thank you!

## Contributing

For our contribution guidelines, please go to [https://github.com/hybridgroup/cylon/blob/master/CONTRIBUTING.md
](https://github.com/hybridgroup/cylon/blob/master/CONTRIBUTING.md
).

## Release History

For the release history, please go to [https://github.com/hybridgroup/cylon-i2c/blob/master/RELEASES.md
](https://github.com/hybridgroup/cylon-i2c/blob/master/RELEASES.md
).

## License
Copyright (c) 2013-2016 The Hybrid Group. Licensed under the Apache 2.0 license.

---
_Source: https://npm.io/package/cylon-i2c · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._