chip-io - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

lib/pcf8574a.js

@@ -39,3 +39,3 @@ var I2C = require('./i2c');
 
-  this._i2c.write(~this._readMask & this._writeMask & 0xff);
+  this._i2c.write(new Buffer([~this._readMask & this._writeMask & 0xff]));
 };
@@ -42,0 +42,0 @@

package.json

 {
   "name": "chip-io",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Johnny-Five IO Plugin for the Next Thing Co. C.H.I.P.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,2 +0,57 @@
-# node-chip-io
+# chip-io
+
+![logo](images/CHIP-J5.png)
+
 [Johnny-Five](https://github.com/rwaldron/johnny-five) [IO Plugin](https://github.com/rwaldron/io-plugins) for the [Next Thing Co. C.H.I.P.](http://nextthing.co/index.html)
+
+## Prerequisites
+
+ * Next Thing Co. C.H.I.P. board
+ * Node.js installed
+
+## Getting Started
+
+```sh
+npm install chip-io johnny-five
+```
+
+## Boilerplate Program
+
+```javascript
+var five = require('johnny-five');
+var ChipIO = require('chip-io');
+
+var board = new five.Board({
+  io: new ChipIO()
+});
+
+board.on('ready', function() {
+  // do Johnny-Five stuff
+});
+```
+
+## Examples
+
+See [examples](examples folder) as well as [Johnny-Five examples](http://johnny-five.io/examples/).
+
+## API
+
+See  [Johnny-Five API docs](http://johnny-five.io/api/).
+
+## Pin Guide
+
+| Johnny-Five Compatible Name | Number | Supported Modes | Info |
+|-----------------------------|--------|-----------------|------|
+| XIO-PO | 0 | Input, Output | Connected to the PCF8574A IO extender |
+| XIO-P1 | 1 | Input, Output | Connected to the PCF8574A IO extender |
+| XIO-P2 | 2 | Input, Output | Connected to the PCF8574A IO extender |
+| XIO-P3 | 3 | Input, Output | Connected to the PCF8574A IO extender |
+| XIO-P4 | 4 | Input, Output | Connected to the PCF8574A IO extender |
+| XIO-P5 | 5 | Input, Output | Connected to the PCF8574A IO extender |
+| XIO-P6 | 6 | Input, Output | Connected to the PCF8574A IO extender |
+| XIO-P7 | 7 | Input, Output | Connected to the PCF8574A IO extender |
+| STATUS | 8 | Output | Connected to status LED via GPIO2 of the AXP290 |
+| BAT | 9 | Input | Reads battery voltage from the AXP290 |
+| INTTEMP | 10 | Input | Reads internal temperature from the AXP290 |
+
+![C.H.I.P. pinouts](http://docs.getchip.com/images/chip_pinouts.jpg)

No alert changes

Improved metrics

Total package byte prevSize

171986

increased by300.96%

Number of package files

18

increased by5.88%

Number of lines in readme file

58

increased by1833.33%

No dependency changes