Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 1.49 KB

README.md

File metadata and controls

41 lines (23 loc) · 1.49 KB
Raw

inkyphat

Build Status Coverage Status dependencies Status devDependencies Status npm version npm downloads

A NodeJS Module to allow you to control the Inkyphat for Raspberry Pi. Based on the Python code available from Pimoroni.

Installation

npm install inkyphat

Usage

const inkyphat = require('inkyphat')();

async function main() {

  await inkyphat.init();

  inkyphat.setPixel(1, 5, inkyphat.RED);

  inkyphat.drawRect(50, 100, inkyphat.BLACK);

  await inkyphat.redraw();

  await inkyphat.destroy();
}
main();

Tests

npm test - Run Tests.

npm run coverage - Run Tests and display coverage.

npm run lint - Run ES Lint

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.