Skip to content

Commit 32aeb32

Browse files
authored
Merge pull request #134 from dunhamjared/master
Improved readability
2 parents 94a00c4 + 991edb9 commit 32aeb32

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

docs/installation.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ run the pixels. These boards can be had for about $2 with a bit of searching.
2222

2323
## Prerequisites
2424

25-
It is assumed you have an [Arduino](http://arduino.cc/en/Guide/HomePage) or
26-
similar board.
25+
- Arduino or similar board
26+
- Adafruit NeoPixels or standard WS2812b LEDs
27+
- NodeJS
28+
- Johnny-Five
2729

2830
For the purposes of this guide I will assume you're using Adafruit NeoPixels and I'm going
2931
to assume you've read the [NeoPixel Uber Guide](http://learn.adafruit.com/adafruit-neopixel-uberguide/overview)
@@ -33,7 +35,9 @@ Standard WS2812b LEDs from any other supplier will work just as well.
3335
I'm going to assume you have NodeJS all ready to go too and you've gone through
3436
the [Johnny-Five getting started guide](http://johnny-five.io).
3537

36-
### Get the node-pixel code
38+
## Software Installation
39+
40+
### 1. Install the node-pixel code
3741

3842
As per most NodeJS projects you can either clone the repo;
3943

@@ -49,7 +53,7 @@ or just install from npm
4953
npm install node-pixel
5054
```
5155

52-
### Install firmware to your board
56+
### 2. Install firmware to your board
5357

5458
The first thing you'll need is Interchange to manage the firmware for your
5559
target board. [Find out more about what Interchange does here.](http://github.com/j5js/nodebots-interchange).
@@ -59,7 +63,7 @@ To install, run `npm install -g nodebots-interchange` from your project folder.
5963
Now plug in your board and you can install the firmware to it. For the purposes
6064
of this doc it's assumed you have an Arduino Nano.
6165

62-
#### I2C Backpack
66+
#### A. I2C Backpack
6367

6468
This is the preferred set up as it can run more pixels faster than a normal
6569
arduino having to manage pixels AND firmata at the same time. To install:
@@ -68,7 +72,7 @@ arduino having to manage pixels AND firmata at the same time. To install:
6872
interchange install git+https://github.com/ajfisher/node-pixel -a nano
6973
```
7074

71-
#### Node Pixel Firmata
75+
#### B. Node Pixel Firmata
7276

7377
If you don't have a spare board to dedicate to your LEDs, you can run the
7478
node-pixel firmware inside Firmata. This does limit how many pixels you can
@@ -80,7 +84,9 @@ interchange install git+https://github.com/ajfisher/node-pixel -a uno --firmata
8084

8185
If everything proceeds without error then you should be good to go.
8286

83-
### Hardware installation
87+
## Hardware Installation
88+
89+
### Standard Installation
8490

8591
With the hardware off, attach your pixels to the arduino. Usually this involves
8692
getting a 5V source, a ground and then attaching the data line to an arduino
@@ -90,7 +96,7 @@ _Wiring diagram_
9096

9197
![Custom Firmata Diagram](breadboard/custom_firmata_bb.png)
9298

93-
## I2C Backpack Installation
99+
### I2C Backpack
94100

95101
This installation method installs a custom "Backpack" firmware onto an arduino
96102
Nano or Pro Mini which is then connected to the board using I2C connections.
@@ -104,7 +110,7 @@ if you are used to using only Uno boards.
104110
Compile, check for errors and then upload to your arduino. Assuming no errors
105111
you should be ready to go.
106112

107-
### Hardware installation
113+
#### Hardware installation
108114

109115
For the purposes of this `Board` will mean the board that is talking to NodeJS
110116
and `Backpack` will mean the custom arduino used to provide I2C support.

0 commit comments

Comments
 (0)