diff --git a/hardware/unicorn/README.md b/hardware/unicorn/README.md index 127890e9..02a3691f 100644 --- a/hardware/unicorn/README.md +++ b/hardware/unicorn/README.md @@ -8,8 +8,8 @@ Pre-requisites -------------- The Unicorn HAT python drivers need to be pre-installed... see the - -Pimorini Getting Started with Unicorn HAT page. + +Pimoroni Getting Started with Unicorn HAT page. curl -sS get.pimoroni.com/unicornhat | bash @@ -27,17 +27,20 @@ Usage The background of the array can be configured using an 8x8 pixel sized png image, or by specifying a single colour using an r,g,b triple. -The brightness can also be set in the configuration. Defaults to 20% so as not to blind you. +The brightness can also be set in the configuration. Defaults to 20% so as not +to blind you. -A pixel is set by **msg.payload** with a CSV string `x,y,r,g,b` , where x and y are 0 to 7, and r, g and b are 0 - 255. +A pixel is set by **msg.payload** with a CSV string `x,y,r,g,b` , where x and y +are 0 to 7, and r, g and b are 0 - 255. If `x` or `y` are set to `*` then the complete row or column can be set. Setting both `x` and `y` to `*` fills the background. The background can also be set to a colour by setting **msg.payload** to an r,g,b triple. -Any msg with a **msg.topic** identifies a 'sprite' pixel, which can then be moved independently of the background. +Any msg with a **msg.topic** identifies a 'sprite' pixel, which can then be moved +independently of the background. A 'sprite' can be a single pixel or a complete line. -Setting **msg.payload** to `0` will delete the sprite from the list. +Setting **msg.payload** to `0` will delete the sprite from the list identified by **msg.topic**. Setting **msg.payload** to `DEL` delete any sprites - leaving the background. @@ -45,4 +48,4 @@ Setting **msg.payload** to `CLS` will clear the display to off and delete any sp The overall brightness may be set by setting **msg.payload** to `brightness,nn`, where `nn` is 0 to 100. -The rotation may be set by setting ••msg.payload•• to 'rotate,rr', where 'rr' is 0, 90, 180 or 270.

+The rotation may be set by setting ••msg.payload•• to 'rotate,rr', where 'rr' is 0, 90, 180 or 270. diff --git a/hardware/unicorn/package.json b/hardware/unicorn/package.json index caf16680..6359f866 100644 --- a/hardware/unicorn/package.json +++ b/hardware/unicorn/package.json @@ -1,6 +1,6 @@ { "name" : "node-red-node-pi-unicorn-hat", - "version" : "0.0.1", + "version" : "0.0.2", "description" : "A Node-RED node to output to a Raspberry Pi Unicorn HAT from Pimorini.", "dependencies" : { "pngjs": "2.2.*" diff --git a/hardware/unicorn/unicorn.html b/hardware/unicorn/unicorn.html index 9007f53a..d2274224 100644 --- a/hardware/unicorn/unicorn.html +++ b/hardware/unicorn/unicorn.html @@ -37,7 +37,8 @@

A pixel is set by msg.payload with a CSV string x,y,r,g,b . If x or y are set to * then the complete row or column can be set.

The background can be set to a colour by setting msg.payload to an r,g,b triple.

-

Any msg with a msg.topic identifies a 'sprite' pixel, which can then be moved independently.

+

Any msg with a msg.topic identifies a 'sprite' pixel, which can then + be moved independently. A 'sprite' can be a single pixel or a complete row.

Setting msg.payload to 0 will delete the sprite from the list.

Setting msg.payload to "CLS" will clear the display to off and delete any sprites.

Setting msg.payload to "DEL" will delete any sprites, and leave the background.