As an open-source project, rwaldron/particle-io has picked up 172 stars on GitHub (JavaScript). Particle/Spark Core/Photon IO Plugin for Johnny-Five
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Particle-io is a Firmata-compatibility IO class for writing node programs that interact with Particle devices (formerly Spark). Particle-io was built at Bocoup
Getting Started
In order to use the particle-io library, you will need to load the special
voodoospark firmware onto your
device. We recommend you review VoodooSpark's Getting Started before continuing. There is also a screencast of how to get started: Get Your Motor Running: Particle Photon and Johnny Five.
We also recommend storing your Particle token and device ID in a dot file so they can be accessed as properties of process.env. Create a file in your home directory called .particlerc that contains:
Then add the following to your dot-rc file of choice:
source ~/.particlerc
Ensure your host computer (where you're running your Node.js application) and the Particle are on the same local network.
Blink an Led
The "Hello World" of microcontroller programming:
var Particle = require("particle-io");
var board = new Particle({
token: process.env.PARTICLE_TOKEN,
deviceId: process.env.PARTICLE_DEVICE_ID
});
board.on("ready", function() {
console.log("Device Ready..");
this.pinMode("D7", this.MODES.OUTPUT);
var byte = 0;
// This will "blink" the on board led
setInterval(function() {
this.digitalWrite("D7", (byte ^= 1));
}.bind(this), 500);
});
Troubleshooting
If your board is connecting, but the board.on("ready", ...) event is not occuring, ensure the wifi network you are connected to allows for direct TCP client/server sockets (this form of communication is often blocked by public wifi networks).
Johnny-Five IO Plugin
Particle-io can be used as an IO Plugin for Johnny-Five:
var five = require("johnny-five");
var Particle = require("particle-io");
var board = new five.Board({
io: new Particle({
token: process.env.PARTICLE_TOKEN,
deviceId: process.env.PARTICLE_DEVICE_ID
})
});
board.on("ready", function() {
console.log("Device Ready..");
var led = new five.Led("D7");
led.blink();
});
See the above Troubleshooting section if your board is connecting, but the board.on("ready", ...) event is not occuring.
API
Constructor
The Particle component can be connected using one of three mechanisms: deviceId, deviceName, or host/port. Both deviceId and deviceName require an additional token so that the host and port of the device can be retrieved from the Particle cloud.
Example:
var Particle = require("particle-io");
var byId = new Particle({
token: process.env.PARTICLE_TOKEN,
deviceId: process.env.PARTICLE_DEVICE_ID
});
var byName = new Particle({
token: process.env.PARTICLE_TOKEN,
deviceName: process.env.PARTICLE_DEVICE_NAME || "crazy_pickle"
});
var byIp = new Particle({
host: '192.168.0.111',
port: 48879
});
device properties
You can get the information that the component knows about the chip with some read-only device properties. This is useful for retrieving the IP address of the Particle so that you can swith over to host/port mode if necessary.
The available properties are:
deviceId: The ID of the device
deviceName: The name of the device
deviceIp: The IP address of the device on the local network
devicePort: The port the device is listening on for connections
The MODES property is available as a Particle instance property:
var board = new Particle(...);
board.MODES;
INPUT: 0
OUTPUT: 1
ANALOG: 2
PWM: 3
SERVO: 4
pinMode(pin, MODE)
Set a pin's mode to any one of the MODES.
Example:
var board = new Particle(...);
board.on("ready", function() {
// Set digital pin 7 to OUTPUT:
this.pinMode("D7", this.MODES.OUTPUT);
// or just use the integer:
this.pinMode("D7", 1);
});
PWM Support (Servo support is also limited to these pins):
Core pins: A0, A1, A4, A5, A6, A7, D0, D1.
Photon pins: A4, A5, D0, D1, D2, D3
P1 pins: A4, A5, D0, D1, D2, D3
digitalWrite(pin, value)
Sets the pin to 1 or 0, which either connects it to 3.3V (the maximum voltage of the system) or to GND (ground).
Example:
var board = new Particle(...);
board.on("ready", function() {
// This will turn ON the on-board LED
this.digitalWrite("D7", 1);
// OR...
// This will turn OFF the on-board LED
this.digitalWrite("D7", 0);
});
analogWrite(pin, value)
Sets the pin to an 8-bit value between 0 and 255, where 0 is the same as LOW and 255 is the same as HIGH. This is sort of like sending a voltage between 0 and 3.3V, but since this is a digital system, it uses a mechanism called Pulse Width Modulation, or PWM. You could use analogWrite to dim an LED, as an example. PWM is available on D0, D1, A0, A1, A4, A5, A6 and A7.
Example:
var board = new Particle(...);
board.on("ready", function() {
// Set an LED to full brightness
this.analogWrite("A7", 255);
// OR...
// Set an LED to half brightness
this.analogWrite("A7", 128);
});
servoWrite(pin, value)
Sets the pin to a value between 0 and 180, where the value represents degrees of the servo horn. The value is converted to a PWM signal. PWM is available on D0, D1, A0, A1, A4, A5, A6 and A7.
Example:
var board = new Particle(...);
board.on("ready", function() {
// Move a servo to 90 degrees
this.servoWrite("D0", 90);
});
digitalRead(pin, handler) Setup a continuous read handler for specific digital pin (D0-D7).
This will read the digital value of a pin, which can be read as either HIGH or LOW. If you were to connect the pin to a 3.3V source, it would read HIGH (1); if you connect it to GND, it would read LOW (0).
Example:
var board = new Particle(...);
board.on("ready", function() {
// Log all the readings for D1
this.digitalRead("D1", function(data) {
console.log(data);
});
});
analogRead(pin, handler) Setup a continuous read handler for specific analog pin (A0-A7). Use with all analog sensors
Example:
var board = new Particle(...);
board.on("ready", function() {
// Log all the readings for A1
this.analogRead("A1", function(data) {
console.log(data);
});
});
How active is development on rwaldron/particle-io?
The most recent commit recorded on rwaldron/particle-io was 3.2 years ago, based on the GitHub push timestamp. The repository has 30 forks — one of the better signals of community interest.
How many stars does rwaldron/particle-io have?
rwaldron/particle-io has 172 GitHub stars — refresh the page for the live number, or check github.com/rwaldron/particle-io. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is rwaldron/particle-io open source?
Yes — rwaldron/particle-io ships under the MIT license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/rwaldron/particle-io.
What is rwaldron/particle-io?
rwaldron/particle-io (rwaldron/particle-io) is a JavaScript project on GitHub. From the project's own README: Particle/Spark Core/Photon IO Plugin for Johnny-Five
What language is rwaldron/particle-io written in?
rwaldron/particle-io is written primarily in JavaScript. GitHub's language field is based on the largest share of bytes in the default branch.
What license does rwaldron/particle-io use?
rwaldron/particle-io is released under the MIT license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
Where do I read more about rwaldron/particle-io?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/rwaldron/particle-io is the definitive source.
Read full README in the tab above.
Is particle-io worth your time?
ChatGPT, Claude and Perplexity can all read this page. Ask one of them what it makes of particle-io.