pixdisp/README.md

[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)
[![Known Vulnerabilities](https://snyk.io/test/github/sexybiggetje/pixdisp/badge.svg?targetFile=package.json)](https://snyk.io/test/github/sexybiggetje/pixdisp?targetFile=package.json)
[![Maintainability](https://api.codeclimate.com/v1/badges/7178fe123a6aed4cd277/maintainability)](https://codeclimate.com/github/sexybiggetje/pixdisp/maintainability)

A small application to drive LED matrix displays, such as the [Pimoroni Unicorn](https://shop.pimoroni.com/?q=unicorn%20hat), from nodejs. My intention is to create a digital graffiti/guestbook system and a general animation system. This is a project for fun, so if you have a feature just request it! Or add it and I'll review it. Social coding ftw.

Make sure you are on a recent nodejs version. Raspbian has an old version. Use [Nodesource](https://github.com/nodesource/distributions) ;).

Also, use a decent modern browser. I wrote recent syntax, so probably works best in Chrome 62+. Firefox is known to have some issues, Edge works, Safari is a PITA. Just wait for your browser to play catch up then with recent standards. If you dislike Chrome, you can put this trough Babel. But you're on your own there.

Copy config.example.json to config.json and pick a driver + display size.

execute:

    npm install
    nodejs pixdisp.js

Navigate to http://localhost:8080/

Matrix driver & Unicorn Hat HD driver inspired by https://github.com/vesteraas/node-unicornhathd

### Unit tests
This application has some unit tests, making use of [Jest](http://facebook.github.io/jest/). Jest is configured as a dev dependency.

execute:

    npm test

### Drawing
![Device drawing](https://raw.githubusercontent.com/sexybiggetje/pixdisp/screenshots/device.jpg "Drawing on the device")

Simple clicking on the canvas in the responsive webinterface makes things light up.

### Camera
![Using your camera](https://raw.githubusercontent.com/sexybiggetje/pixdisp/screenshots/camera.jpg "Using your camera")

The webinterface allows you to capture your camera and submit images from there.

### Webinterface
![Web interface](https://raw.githubusercontent.com/sexybiggetje/pixdisp/screenshots/webui.png "Webinterface")

A simple web interface is included for drawing on the device. Defaults to port 8080.
Add badges/browser notification to README Add badges and browser notice to the readme. 2018-01-04 23:16:22 +01:00			`[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)`
			`[![Known Vulnerabilities](https://snyk.io/test/github/sexybiggetje/pixdisp/badge.svg?targetFile=package.json)](https://snyk.io/test/github/sexybiggetje/pixdisp?targetFile=package.json)`
Add codecoverage badge 2018-01-04 23:37:36 +01:00			`[![Maintainability](https://api.codeclimate.com/v1/badges/7178fe123a6aed4cd277/maintainability)](https://codeclimate.com/github/sexybiggetje/pixdisp/maintainability)`
Add badges/browser notification to README Add badges and browser notice to the readme. 2018-01-04 23:16:22 +01:00
Add some links to the content 2018-01-04 23:25:51 +01:00			`A small application to drive LED matrix displays, such as the [Pimoroni Unicorn](https://shop.pimoroni.com/?q=unicorn%20hat), from nodejs. My intention is to create a digital graffiti/guestbook system and a general animation system. This is a project for fun, so if you have a feature just request it! Or add it and I'll review it. Social coding ftw.`
First work in progress app 2017-12-12 20:41:32 +01:00
Add some links to the content 2018-01-04 23:25:51 +01:00			`Make sure you are on a recent nodejs version. Raspbian has an old version. Use [Nodesource](https://github.com/nodesource/distributions) ;).`
Working implementation of drivers, and drawing application. Things light up! 2017-12-18 20:39:51 +01:00
Add badges/browser notification to README Add badges and browser notice to the readme. 2018-01-04 23:16:22 +01:00			`Also, use a decent modern browser. I wrote recent syntax, so probably works best in Chrome 62+. Firefox is known to have some issues, Edge works, Safari is a PITA. Just wait for your browser to play catch up then with recent standards. If you dislike Chrome, you can put this trough Babel. But you're on your own there.`

README.md: spelling, grammar and format suggestions 2018-01-04 01:59:19 +01:00			`Copy config.example.json to config.json and pick a driver + display size.`
Dynamically load display size from the driver to the canvas on app init 2017-12-25 21:05:14 +01:00
README.md: spelling, grammar and format suggestions 2018-01-04 01:59:19 +01:00			`execute:`
First work in progress app 2017-12-12 20:41:32 +01:00
README.md: spelling, grammar and format suggestions 2018-01-04 01:59:19 +01:00			`npm install`
			`nodejs pixdisp.js`
First work in progress app 2017-12-12 20:41:32 +01:00
README.md: spelling, grammar and format suggestions 2018-01-04 01:59:19 +01:00			`Navigate to http://localhost:8080/`
First work in progress app 2017-12-12 20:41:32 +01:00
Update README.md 2017-12-28 10:29:50 +01:00			`Matrix driver & Unicorn Hat HD driver inspired by https://github.com/vesteraas/node-unicornhathd`

Update README with test info, add drowingoperations tests, add getMatrix function to driver for tests. 2018-01-05 18:25:27 +01:00			`### Unit tests`
			`This application has some unit tests, making use of [Jest](http://facebook.github.io/jest/). Jest is configured as a dev dependency.`

			`execute:`

			`npm test`

Update README.md 2017-12-28 10:29:50 +01:00			`### Drawing`
			`![Device drawing](https://raw.githubusercontent.com/sexybiggetje/pixdisp/screenshots/device.jpg "Drawing on the device")`
Update README.md 2017-12-28 10:41:31 +01:00
Update README.md 2017-12-28 10:29:50 +01:00			`Simple clicking on the canvas in the responsive webinterface makes things light up.`

			`### Camera`
			`![Using your camera](https://raw.githubusercontent.com/sexybiggetje/pixdisp/screenshots/camera.jpg "Using your camera")`
Update README.md 2017-12-28 10:41:31 +01:00
			`The webinterface allows you to capture your camera and submit images from there.`

			`### Webinterface`
			`![Web interface](https://raw.githubusercontent.com/sexybiggetje/pixdisp/screenshots/webui.png "Webinterface")`

README.md: spelling, grammar and format suggestions 2018-01-04 01:59:19 +01:00			`A simple web interface is included for drawing on the device. Defaults to port 8080.`