8x8matrix/README.md

A simple node.js-based helper for the Raspberry Pi and the Adafruit 8x8 Matrix

# Adafruit 8x8-Matrix with NodeJS

![](https://img.shields.io/npm/v/8x8matrix.svg) ![](https://img.shields.io/bundlephobia/min/8x8matrix.svg) ![](https://img.shields.io/npm/dt/8x8matrix.svg)

Control your [Adafruit 8x8 Matrix](https://www.adafruit.com/products/959) with NodeJS. Your nodejs script have to run as root.

## Setup

```
$ npm i 8x8matrix
```

```js
const Matrix = require('8x8matrix');

let matrix = new Matrix();
matrix.writeArray(matrix.smily);
```

## Options

```js
let matrix = new Matrix({
	brightness: 15,
	slaveAddress: 0x70,
	bautrate: 10000
});
```

## API

Pixels can be written by a simple js-array with 64 objects.

```js
var smily = [
	0,0,1,1,1,1,0,0,
	0,1,0,0,0,0,1,0,
	1,0,1,0,1,0,0,1,
	1,0,1,0,1,0,0,1,
	1,0,0,0,0,1,0,1,
	1,0,1,1,1,0,0,1,
	0,1,0,0,0,0,1,0,
	0,0,1,1,1,1,0,0
];

matrix.writeArray(smily);

/**
  * Set brightness of all LED
  * Values: 1 (very low) to 15 (very bright)
  */

matrix.setBrightness(8);

/**
  * Set first top-left LED to on
  * matrix.setLED(x, y, true/false);
  */

matrix.setLED(0, 0, 1);
```

## Test

```
$ sudo node test.js
```