node-firefox-find-devices
v1.0.0
Published
Find attached FirefoxOS devices using ADB
Downloads
17
Readme
node-firefox-find-devices
Find attached FirefoxOS devices using ADB.
This is part of the node-firefox project.
When Firefox OS devices are plugged in via USB, they can be found using the Android Debug Bridge. Once found, a test for the presence of Firefox OS on the device can separate them from normal Android devices.
Installation
From git
git clone https://github.com/mozilla/node-firefox-find-devices.git
cd node-firefox-find-devices
npm install
If you want to update later on:
cd node-firefox-find-devices
git pull origin master
npm install
npm
npm install node-firefox-find-devices
Usage
findDevices() // returns a Promise
Finding devices
var findDevices = require('node-firefox-find-devices');
// Return all listening runtimes
findDevices().then(function(results) {
console.log(results);
});
Running the tests
After installing, you can simply run the following from the module folder:
npm test
To add a new unit test file, create a new file in the tests/unit
folder. Any file that matches test.*.js
will be run as a test by the appropriate test runner, based on the folder location.
We use gulp
behind the scenes to run the test; if you don't have it installed globally you can use npm gulp
from inside the project's root folder to run gulp
.
Code quality and style
Because we have multiple contributors working on our projects, we value consistent code styles. It makes it easier to read code written by many people! :-)
Our tests include unit tests as well as code quality ("linting") tests that make sure our test pass a style guide and JSHint. Instead of submitting code with the wrong indentation or a different style, run the tests and you will be told where your code quality/style differs from ours and instructions on how to fix it.
This program is free software; it is distributed under an Apache License.
Copyright
Copyright (c) 2015 Mozilla (Contributors).