monome-grid/README.md

simple monome grid library

# node-monome-grid

Simple monome grid library.

# Installation

Install via NPM:

```
npm install monome-grid
```

# Example

```javascript
const monomeGrid = require('monome-grid')('m1000079');

async function run() {
  let grid = await monomeGrid();
  
  grid.key((x, y, s) => console.log(`x: ${x}, y: ${y}, s: ${s}`));

  setInterval(() => {
    let led = [];
    for (let y = 0; y < 8; y++) {
      led[y] = [];
      for (let x = 0; x < 16; x++) {
        led[y][x] = Math.floor(Math.random() * 16);
      }
    }
    grid.refresh(led);
  }, 100);
}

run();

```

# Usage

First create a grid object:

```javascript
const grid = require('monome-grid')('m1000079');
```

You can leave the id (m1000079) empty to bind to the first grid object:

```javascript
const grid = require('monome-grid')();
```

## Key Listener

You can define a key listener that gets called whenever a key press event is received.  The x and y arguments represent the coordinates of the button press and the s argument represents the state (1 = pressed, 0 = released):

```javascript
// prints x: 2, y: 3, s: 1
grid.key((x, y, s) => console.log('x: ' + x + ', y: ' + y + ', s: ' + s));
```

## Refresh LED State

The refresh() method takes a 2-dimensional LED array as an argument.  The first dimension is y and the second dimension is x.  This will automatically adjust for varibright or non-varibright grids.  For example:

```javascript
// initialize empty led array
let led = [];
// iterate over 8 columns
for (let y = 0; y < 8; y++) {
  // initialize second dimension of array (x values)
  led[y] = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15];
}
grid.refresh(led)
```

You should initialize the LED array to the size of your monome.  For example, a 128 should use an 8x16 array.