Remove node-namespace from DigitalPin
This commit is contained in:
Andrew Stewart
parent
2cca04873d
commit
c99ce6571f
|
|
@ -1,179 +0,0 @@
|
||||||
/*
|
|
||||||
* Linux IO DigitalPin
|
|
||||||
* cylonjs.com
|
|
||||||
*
|
|
||||||
* Copyright (c) 2013-2014 The Hybrid Group
|
|
||||||
* Licensed under the Apache 2.0 license.
|
|
||||||
*/
|
|
||||||
|
|
||||||
"use strict";
|
|
||||||
|
|
||||||
var FS = require('fs'),
|
|
||||||
EventEmitter = require('events').EventEmitter,
|
|
||||||
namespace = require('node-namespace');
|
|
||||||
|
|
||||||
// DigitalPin class offers an interface with the Linux GPIO system present in
|
|
||||||
// single-board computers such as a Raspberry Pi, or a BeagleBone
|
|
||||||
namespace("Cylon.IO", function() {
|
|
||||||
this.DigitalPin = (function(klass) {
|
|
||||||
subclass(DigitalPin, klass);
|
|
||||||
|
|
||||||
var GPIO_PATH = "/sys/class/gpio";
|
|
||||||
|
|
||||||
var GPIO_READ = "in";
|
|
||||||
var GPIO_WRITE = "out";
|
|
||||||
|
|
||||||
var HIGH = 1;
|
|
||||||
var LOW = 0;
|
|
||||||
|
|
||||||
function DigitalPin(opts) {
|
|
||||||
this.pinNum = opts.pin.toString();
|
|
||||||
this.status = 'low';
|
|
||||||
this.ready = false;
|
|
||||||
this.mode = opts.mode;
|
|
||||||
}
|
|
||||||
|
|
||||||
DigitalPin.prototype.connect = function(mode) {
|
|
||||||
var _this = this;
|
|
||||||
|
|
||||||
if (this.mode == null) { this.mode = mode; }
|
|
||||||
|
|
||||||
FS.exists(this._pinPath(), function(exists) {
|
|
||||||
exists ? _this._openPin() : _this._createGPIOPin();
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
DigitalPin.prototype.close = function() {
|
|
||||||
var _this = this;
|
|
||||||
|
|
||||||
FS.writeFile(this._unexportPath(), this.pinNum, function(err) {
|
|
||||||
_this._closeCallback(err);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
DigitalPin.prototype.closeSync = function() {
|
|
||||||
FS.writeFileSync(this._unexportPath(), this.pinNum);
|
|
||||||
this._closeCallback(false);
|
|
||||||
};
|
|
||||||
|
|
||||||
DigitalPin.prototype.digitalWrite = function(value) {
|
|
||||||
if (this.mode !== 'w') { this._setMode('w'); }
|
|
||||||
|
|
||||||
var _this = this;
|
|
||||||
this.status = value === 1 ? 'high' : 'low';
|
|
||||||
|
|
||||||
FS.writeFile(this._valuePath(), value, function(err) {
|
|
||||||
if (err) {
|
|
||||||
_this.emit('error', "Error occurred while writing value " + value + " to pin " + _this.pinNum);
|
|
||||||
} else {
|
|
||||||
_this.emit('digitalWrite', value);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
return value;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Public: Reads the digial pin's value periodicly on a supplied interval,
|
|
||||||
// and emits the result or an error
|
|
||||||
//
|
|
||||||
// interval - time (in milliseconds) to read from the pin at
|
|
||||||
//
|
|
||||||
// Returns the defined interval
|
|
||||||
DigitalPin.prototype.digitalRead = function(interval) {
|
|
||||||
var _this = this;
|
|
||||||
|
|
||||||
if (this.mode !== 'r') { this._setMode('r'); }
|
|
||||||
|
|
||||||
every(interval, function() {
|
|
||||||
FS.readFile(_this._valuePath(), function(err, data) {
|
|
||||||
if (err) {
|
|
||||||
var error = "Error occurred while reading from pin " + _this.pinNum;
|
|
||||||
_this.emit('error', error);
|
|
||||||
} else {
|
|
||||||
var readData = parseInt(data.toString());
|
|
||||||
_this.emit('digitalRead', readData);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
DigitalPin.prototype.setHigh = function() { return this.digitalWrite(1); };
|
|
||||||
DigitalPin.prototype.setLow = function() { return this.digitalWrite(0); };
|
|
||||||
|
|
||||||
DigitalPin.prototype.toggle = function() {
|
|
||||||
return (this.status === 'low') ? this.setHigh() : this.setLow();
|
|
||||||
};
|
|
||||||
|
|
||||||
// Creates the GPIO file to read/write from
|
|
||||||
DigitalPin.prototype._createGPIOPin = function() {
|
|
||||||
var _this = this;
|
|
||||||
|
|
||||||
FS.writeFile(this._exportPath(), this.pinNum, function(err) {
|
|
||||||
if (err) {
|
|
||||||
_this.emit('error', 'Error while creating pin files');
|
|
||||||
} else {
|
|
||||||
_this._openPin();
|
|
||||||
}
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
DigitalPin.prototype._openPin = function() {
|
|
||||||
this._setMode(this.mode, true);
|
|
||||||
this.emit('open');
|
|
||||||
};
|
|
||||||
|
|
||||||
DigitalPin.prototype._closeCallback = function(err) {
|
|
||||||
if (err) {
|
|
||||||
this.emit('error', 'Error while closing pin files');
|
|
||||||
} else {
|
|
||||||
this.emit('close', this.pinNum);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
// Sets the mode for the GPIO pin by writing the correct values to the pin reference files
|
|
||||||
DigitalPin.prototype._setMode = function(mode, emitConnect) {
|
|
||||||
if (emitConnect == null) { emitConnect = false; }
|
|
||||||
|
|
||||||
this.mode = mode;
|
|
||||||
|
|
||||||
var _this = this,
|
|
||||||
data = (mode === 'w') ? GPIO_WRITE : GPIO_READ;
|
|
||||||
|
|
||||||
FS.writeFile(this._directionPath(), data, function(err) {
|
|
||||||
_this._setModeCallback(err, emitConnect);
|
|
||||||
});
|
|
||||||
};
|
|
||||||
|
|
||||||
DigitalPin.prototype._setModeCallback = function(err, emitConnect) {
|
|
||||||
if (err) {
|
|
||||||
this.emit('error', "Setting up pin direction failed");
|
|
||||||
} else {
|
|
||||||
this.ready = true;
|
|
||||||
if (emitConnect) { this.emit('connect', this.mode); }
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
DigitalPin.prototype._directionPath = function() {
|
|
||||||
return this._pinPath() + "/direction";
|
|
||||||
};
|
|
||||||
|
|
||||||
DigitalPin.prototype._valuePath = function() {
|
|
||||||
return this._pinPath() + "/value";
|
|
||||||
};
|
|
||||||
|
|
||||||
DigitalPin.prototype._pinPath = function() {
|
|
||||||
return GPIO_PATH + "/gpio" + this.pinNum;
|
|
||||||
};
|
|
||||||
|
|
||||||
DigitalPin.prototype._exportPath = function() {
|
|
||||||
return GPIO_PATH + "/export";
|
|
||||||
};
|
|
||||||
|
|
||||||
DigitalPin.prototype._unexportPath = function() {
|
|
||||||
return GPIO_PATH + "/unexport";
|
|
||||||
};
|
|
||||||
|
|
||||||
return DigitalPin;
|
|
||||||
|
|
||||||
})(EventEmitter);
|
|
||||||
});
|
|
||||||
|
|
@ -0,0 +1,171 @@
|
||||||
|
/*
|
||||||
|
* Linux IO DigitalPin
|
||||||
|
* cylonjs.com
|
||||||
|
*
|
||||||
|
* Copyright (c) 2013-2014 The Hybrid Group
|
||||||
|
* Licensed under the Apache 2.0 license.
|
||||||
|
*/
|
||||||
|
|
||||||
|
"use strict";
|
||||||
|
|
||||||
|
var FS = require('fs'),
|
||||||
|
EventEmitter = require('events').EventEmitter;
|
||||||
|
|
||||||
|
var GPIO_PATH = "/sys/class/gpio";
|
||||||
|
|
||||||
|
var GPIO_READ = "in";
|
||||||
|
var GPIO_WRITE = "out";
|
||||||
|
|
||||||
|
var HIGH = 1;
|
||||||
|
var LOW = 0;
|
||||||
|
|
||||||
|
// DigitalPin class offers an interface with the Linux GPIO system present in
|
||||||
|
// single-board computers such as a Raspberry Pi, or a BeagleBone
|
||||||
|
var DigitalPin = module.exports = function DigitalPin(opts) {
|
||||||
|
this.pinNum = opts.pin.toString();
|
||||||
|
this.status = 'low';
|
||||||
|
this.ready = false;
|
||||||
|
this.mode = opts.mode;
|
||||||
|
}
|
||||||
|
|
||||||
|
subclass(DigitalPin, EventEmitter);
|
||||||
|
|
||||||
|
DigitalPin.prototype.connect = function(mode) {
|
||||||
|
var _this = this;
|
||||||
|
|
||||||
|
if (this.mode == null) { this.mode = mode; }
|
||||||
|
|
||||||
|
FS.exists(this._pinPath(), function(exists) {
|
||||||
|
exists ? _this._openPin() : _this._createGPIOPin();
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
DigitalPin.prototype.close = function() {
|
||||||
|
var _this = this;
|
||||||
|
|
||||||
|
FS.writeFile(this._unexportPath(), this.pinNum, function(err) {
|
||||||
|
_this._closeCallback(err);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
DigitalPin.prototype.closeSync = function() {
|
||||||
|
FS.writeFileSync(this._unexportPath(), this.pinNum);
|
||||||
|
this._closeCallback(false);
|
||||||
|
};
|
||||||
|
|
||||||
|
DigitalPin.prototype.digitalWrite = function(value) {
|
||||||
|
if (this.mode !== 'w') { this._setMode('w'); }
|
||||||
|
|
||||||
|
var _this = this;
|
||||||
|
this.status = value === 1 ? 'high' : 'low';
|
||||||
|
|
||||||
|
FS.writeFile(this._valuePath(), value, function(err) {
|
||||||
|
if (err) {
|
||||||
|
_this.emit('error', "Error occurred while writing value " + value + " to pin " + _this.pinNum);
|
||||||
|
} else {
|
||||||
|
_this.emit('digitalWrite', value);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return value;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Public: Reads the digial pin's value periodicly on a supplied interval,
|
||||||
|
// and emits the result or an error
|
||||||
|
//
|
||||||
|
// interval - time (in milliseconds) to read from the pin at
|
||||||
|
//
|
||||||
|
// Returns the defined interval
|
||||||
|
DigitalPin.prototype.digitalRead = function(interval) {
|
||||||
|
var _this = this;
|
||||||
|
|
||||||
|
if (this.mode !== 'r') { this._setMode('r'); }
|
||||||
|
|
||||||
|
every(interval, function() {
|
||||||
|
FS.readFile(_this._valuePath(), function(err, data) {
|
||||||
|
if (err) {
|
||||||
|
var error = "Error occurred while reading from pin " + _this.pinNum;
|
||||||
|
_this.emit('error', error);
|
||||||
|
} else {
|
||||||
|
var readData = parseInt(data.toString());
|
||||||
|
_this.emit('digitalRead', readData);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
DigitalPin.prototype.setHigh = function() { return this.digitalWrite(1); };
|
||||||
|
DigitalPin.prototype.setLow = function() { return this.digitalWrite(0); };
|
||||||
|
|
||||||
|
DigitalPin.prototype.toggle = function() {
|
||||||
|
return (this.status === 'low') ? this.setHigh() : this.setLow();
|
||||||
|
};
|
||||||
|
|
||||||
|
// Creates the GPIO file to read/write from
|
||||||
|
DigitalPin.prototype._createGPIOPin = function() {
|
||||||
|
var _this = this;
|
||||||
|
|
||||||
|
FS.writeFile(this._exportPath(), this.pinNum, function(err) {
|
||||||
|
if (err) {
|
||||||
|
_this.emit('error', 'Error while creating pin files');
|
||||||
|
} else {
|
||||||
|
_this._openPin();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
DigitalPin.prototype._openPin = function() {
|
||||||
|
this._setMode(this.mode, true);
|
||||||
|
this.emit('open');
|
||||||
|
};
|
||||||
|
|
||||||
|
DigitalPin.prototype._closeCallback = function(err) {
|
||||||
|
if (err) {
|
||||||
|
this.emit('error', 'Error while closing pin files');
|
||||||
|
} else {
|
||||||
|
this.emit('close', this.pinNum);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Sets the mode for the GPIO pin by writing the correct values to the pin reference files
|
||||||
|
DigitalPin.prototype._setMode = function(mode, emitConnect) {
|
||||||
|
if (emitConnect == null) { emitConnect = false; }
|
||||||
|
|
||||||
|
this.mode = mode;
|
||||||
|
|
||||||
|
var _this = this,
|
||||||
|
data = (mode === 'w') ? GPIO_WRITE : GPIO_READ;
|
||||||
|
|
||||||
|
FS.writeFile(this._directionPath(), data, function(err) {
|
||||||
|
_this._setModeCallback(err, emitConnect);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
DigitalPin.prototype._setModeCallback = function(err, emitConnect) {
|
||||||
|
if (err) {
|
||||||
|
this.emit('error', "Setting up pin direction failed");
|
||||||
|
} else {
|
||||||
|
this.ready = true;
|
||||||
|
if (emitConnect) { this.emit('connect', this.mode); }
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
DigitalPin.prototype._directionPath = function() {
|
||||||
|
return this._pinPath() + "/direction";
|
||||||
|
};
|
||||||
|
|
||||||
|
DigitalPin.prototype._valuePath = function() {
|
||||||
|
return this._pinPath() + "/value";
|
||||||
|
};
|
||||||
|
|
||||||
|
DigitalPin.prototype._pinPath = function() {
|
||||||
|
return GPIO_PATH + "/gpio" + this.pinNum;
|
||||||
|
};
|
||||||
|
|
||||||
|
DigitalPin.prototype._exportPath = function() {
|
||||||
|
return GPIO_PATH + "/export";
|
||||||
|
};
|
||||||
|
|
||||||
|
DigitalPin.prototype._unexportPath = function() {
|
||||||
|
return GPIO_PATH + "/unexport";
|
||||||
|
};
|
||||||
|
|
@ -11,7 +11,6 @@
|
||||||
require('./utils');
|
require('./utils');
|
||||||
|
|
||||||
require('./cylon');
|
require('./cylon');
|
||||||
require('./digital-pin');
|
|
||||||
|
|
||||||
var Connection = require("./connection"),
|
var Connection = require("./connection"),
|
||||||
Device = require("./device"),
|
Device = require("./device"),
|
||||||
|
|
|
||||||
|
|
@ -2,10 +2,10 @@
|
||||||
|
|
||||||
var fs = require('fs');
|
var fs = require('fs');
|
||||||
|
|
||||||
source('digital-pin');
|
var DigitalPin = source('io/digital-pin');
|
||||||
|
|
||||||
describe("Cylon.IO.DigitalPin", function() {
|
describe("Cylon.IO.DigitalPin", function() {
|
||||||
var pin = new Cylon.IO.DigitalPin({ pin: '4', mode: 'w' })
|
var pin = new DigitalPin({ pin: '4', mode: 'w' })
|
||||||
|
|
||||||
describe("constructor", function() {
|
describe("constructor", function() {
|
||||||
it("sets @pinNum to the pin number passed in opts", function() {
|
it("sets @pinNum to the pin number passed in opts", function() {
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue