{"_id":"@aeroniemi/inky","_rev":"3-011ce2b771fcf8003cb9608d42ea351b","name":"@aeroniemi/inky","dist-tags":{"latest":"0.2.0"},"versions":{"0.1.0":{"name":"@aeroniemi/inky","version":"0.1.0","description":"Typescript bindings for Pimoroni's Inky Impression 7.3","main":"dist/main.js","homepage":"https://github.com/aeroniemi/inky-ts","repository":{"type":"git","url":"git+https://github.com/aeroniemi/inky-ts.git"},"scripts":{"build":"tsc","build:dev":"tsc --watch"},"author":{"name":"@aeroniemi"},"license":"MIT","devDependencies":{"@types/node":"^20.6.0","@types/pngjs":"^6.0.1","@types/react":"^18.2.21","@types/rpio":"^2.4.3","typescript":"^5.2.2"},"dependencies":{"chalk":"^4.1.2","pngjs":"^7.0.0","rpio":"^2.4.2","@resvg/resvg-js":"^2.4.1"},"optionalDependencies":{"@resvg/resvg-js":"^2.4.1"},"types":"./dist/main.d.ts","gitHead":"fe49ba92b67b2ddc7eb88fd58f7a7682f6311e49","bugs":{"url":"https://github.com/aeroniemi/inky-ts/issues"},"_id":"@aeroniemi/inky@0.1.0","_nodeVersion":"18.17.1","_npmVersion":"9.6.7","dist":{"integrity":"sha512-4R3fdzqCkPGdpbtPhgHhm1GWE8I/ZJ3IcIbdH3EgfEnBpHyJAeaXn5Lu8avAIZgatEwrnkmcKAiKvYSQcv/yvA==","shasum":"e6622a296ff51a84fecd6991a8d9d9ffff3209e2","tarball":"https://registry.npmjs.org/@aeroniemi/inky/-/inky-0.1.0.tgz","fileCount":8,"unpackedSize":24325,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHl+46Yoopc0ux8nAQtAtah2i50p11DnyMQm93Qlmb2XAiAcIYse7KJbf/vT/ravbzrzzirb+sz/o84LFHYl6ctK2w=="}]},"_npmUser":{"name":"aeroniemi","email":"alex@aeroniemi.com"},"directories":{},"maintainers":[{"name":"aeroniemi","email":"alex@aeroniemi.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/inky_0.1.0_1695728965676_0.05074947738584412"},"_hasShrinkwrap":false},"0.1.1":{"name":"@aeroniemi/inky","version":"0.1.1","description":"Typescript bindings for Pimoroni's Inky Impression 7.3","main":"dist/main.js","homepage":"https://github.com/aeroniemi/inky-ts","keywords":["inky","e-ink","eink","e-paper","epaper","pimoroni","inky impression","raspberry pi"],"repository":{"type":"git","url":"git+https://github.com/aeroniemi/inky-ts.git"},"scripts":{"build":"tsc","build:dev":"tsc --watch"},"author":{"name":"@aeroniemi"},"license":"MIT","devDependencies":{"@types/node":"^20.6.0","@types/pngjs":"^6.0.1","@types/rpio":"^2.4.3","typescript":"^5.2.2"},"dependencies":{"chalk":"^4.1.2","pngjs":"^7.0.0","rpio":"^2.4.2","@resvg/resvg-js":"^2.4.1"},"optionalDependencies":{"@resvg/resvg-js":"^2.4.1"},"types":"./dist/main.d.ts","gitHead":"54f1b108441e28f2e69031be23918f0efc86bb3c","bugs":{"url":"https://github.com/aeroniemi/inky-ts/issues"},"_id":"@aeroniemi/inky@0.1.1","_nodeVersion":"18.17.1","_npmVersion":"9.6.7","dist":{"integrity":"sha512-ElTRczaF15iPjK+k4s3FHL2lzvO14lCPFNKRKeYzcgDbygI60r/QeLMQ3yVI8Jes/0bj6qbxfJND9oQgwsjOZw==","shasum":"4915789b747003b15bfa58f687beab23a4f91401","tarball":"https://registry.npmjs.org/@aeroniemi/inky/-/inky-0.1.1.tgz","fileCount":8,"unpackedSize":24763,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFSbQ6gOsxaXFXOPb+jLhfCLok1mkhm0gOg6xFq/9ldwAiBdEc148QQPlou5pIbCpqPyF6W6IucF+HefdH6c2ycjfA=="}]},"_npmUser":{"name":"aeroniemi","email":"alex@aeroniemi.com"},"directories":{},"maintainers":[{"name":"aeroniemi","email":"alex@aeroniemi.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/inky_0.1.1_1695730168723_0.6742990435941776"},"_hasShrinkwrap":false},"0.1.2":{"name":"@aeroniemi/inky","version":"0.1.2","description":"Typescript bindings for Pimoroni's Inky Impression 7.3","main":"dist/main.js","homepage":"https://github.com/aeroniemi/inky-ts","keywords":["inky","e-ink","eink","e-paper","epaper","pimoroni","inky impression","raspberry pi"],"repository":{"type":"git","url":"git+https://github.com/aeroniemi/inky-ts.git"},"scripts":{"build":"tsc","build:dev":"tsc --watch"},"author":{"name":"@aeroniemi"},"license":"MIT","devDependencies":{"@types/node":"^20.6.0","@types/pngjs":"^6.0.1","@types/rpio":"^2.4.3","typescript":"^5.2.2"},"dependencies":{"chalk":"^4.1.2","pngjs":"^7.0.0","rpio":"^2.4.2","@resvg/resvg-js":"^2.4.1"},"optionalDependencies":{"@resvg/resvg-js":"^2.4.1"},"types":"./dist/main.d.ts","gitHead":"ad7d08d7703e1bd812538903f99cc619354d50e1","bugs":{"url":"https://github.com/aeroniemi/inky-ts/issues"},"_id":"@aeroniemi/inky@0.1.2","_nodeVersion":"18.17.1","_npmVersion":"9.6.7","dist":{"integrity":"sha512-DxeI44o6AgQXQqvSDmbCZ2kl2X/tsZpTFLwWJw982e/eMpsR9j6LtbTPMecUxKajCSp+yNOg/7xmk/J1c90agw==","shasum":"3b721d650c050642e41e15184d7515b530c888c7","tarball":"https://registry.npmjs.org/@aeroniemi/inky/-/inky-0.1.2.tgz","fileCount":8,"unpackedSize":24792,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGY+kjNeDFpTkhK9ogyA8tDj9RktC2b2DX4uOocbIJhkAiEA784Ez5Sd3ykg/0YZvbG1pw9wXRKVM5P1Yac+JRzQX2A="}]},"_npmUser":{"name":"aeroniemi","email":"alex@aeroniemi.com"},"directories":{},"maintainers":[{"name":"aeroniemi","email":"alex@aeroniemi.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/inky_0.1.2_1695730993580_0.5016735787494038"},"_hasShrinkwrap":false},"0.2.0":{"name":"@aeroniemi/inky","version":"0.2.0","description":"Typescript bindings for Pimoroni's Inky Impression 7.3","main":"dist/main.js","homepage":"https://github.com/aeroniemi/inky-ts","keywords":["inky","e-ink","eink","e-paper","epaper","pimoroni","inky impression","raspberry pi"],"repository":{"type":"git","url":"git+https://github.com/aeroniemi/inky-ts.git"},"scripts":{"build":"tsc","build:dev":"tsc --watch"},"author":{"name":"@aeroniemi"},"license":"MIT","devDependencies":{"@types/node":"^20.6.0","@types/pngjs":"^6.0.1","@types/rpio":"^2.4.3","typescript":"^5.2.2"},"dependencies":{"chalk":"^4.1.2","pngjs":"^7.0.0","rpio":"^2.4.2","@resvg/resvg-js":"^2.4.1"},"optionalDependencies":{"@resvg/resvg-js":"^2.4.1"},"types":"./dist/main.d.ts","gitHead":"0a17c397324d8416d4976ba53306a7475e262d70","bugs":{"url":"https://github.com/aeroniemi/inky-ts/issues"},"_id":"@aeroniemi/inky@0.2.0","_nodeVersion":"18.17.1","_npmVersion":"9.6.7","dist":{"integrity":"sha512-5mHcPrkMzhW3/W7s2jPI4mMdE8+wdP2R5KGKdjgNVWizPq2AB8uzb5eN2+yjDtRyLbPHdZBY8x7gfH5bmicQZA==","shasum":"a660320e12aa2414e91b1d273a7815bbfa326bae","tarball":"https://registry.npmjs.org/@aeroniemi/inky/-/inky-0.2.0.tgz","fileCount":12,"unpackedSize":40103,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCID+WMmyxGtRJFTuoTsGiSFeMDw3pEoAdAGnSD/3QqXcrAiAFW92ZWW8LvspIIBuwe9SWjeFuPotVudhvOj0Fgm25Zw=="}]},"_npmUser":{"name":"aeroniemi","email":"alex@aeroniemi.com"},"directories":{},"maintainers":[{"name":"aeroniemi","email":"alex@aeroniemi.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/inky_0.2.0_1698342981081_0.9922770875729379"},"_hasShrinkwrap":false}},"time":{"created":"2023-09-26T11:49:25.553Z","0.1.0":"2023-09-26T11:49:25.844Z","modified":"2023-10-26T17:56:21.429Z","0.1.1":"2023-09-26T12:09:28.878Z","0.1.2":"2023-09-26T12:23:13.802Z","0.2.0":"2023-10-26T17:56:21.249Z"},"maintainers":[{"name":"aeroniemi","email":"alex@aeroniemi.com"}],"description":"Typescript bindings for Pimoroni's Inky Impression 7.3","homepage":"https://github.com/aeroniemi/inky-ts","repository":{"type":"git","url":"git+https://github.com/aeroniemi/inky-ts.git"},"author":{"name":"@aeroniemi"},"bugs":{"url":"https://github.com/aeroniemi/inky-ts/issues"},"license":"MIT","readme":"# inky\r\n> A typescript package to interact with Pimoroni's Inky Impression series of displays. Implemenents a subset of the features of [@pimoroni/inky](https://github.com/pimoroni/inky)\r\n\r\n## Features\r\n- Support for:\r\n    - [Inky Impression 7.3](https://shop.pimoroni.com/products/inky-impression-7-3)\r\n    - [Inky Impression 5.7](https://shop.pimoroni.com/products/inky-impression-5-7)\r\n    - [Inky Impression 4.0](https://shop.pimoroni.com/products/inky-impression-4)\r\n- Individual pixel interaction\r\n- Setting images in:\r\n    - PNG\r\n    - SVG (using optional resvg-js dependency)\r\n\r\n## Usage\r\n### Install inky\r\n- ``npm install --save @aeroniemi/inky``\r\n\r\n### Setup GPIO\r\n-  This package uses [rpio](https://www.npmjs.com/package/rpio) for GPIO interactions, so you'll need a working install of that\r\n-  In particular, you need to:\r\n    -  Disable GPIO interrupts\r\n    -  Enable /dev/gpiomem access\r\n    -  Run as root user (for access to the SPI device)\r\n\r\n### (Optional) Setup resvg\r\n- ``npm install --save @resvg/resvg-js``\r\n- If you're using a Raspberry Pi 3/4/Zero 2W it'll probably \"just work\", but if you're on a Zero or Zero W you'll need to compile resvg to get it to run properly. See [this issue](https://github.com/yisibl/resvg-js/issues/231) for more details on how.\r\n\r\n\r\n## Example\r\n### Display a PNG \r\n```ts\r\nimport { Impression73 } from \"@aeroniemi/inky\"\r\n\r\nasync function main() {\r\n    let screen = new Impression73()\r\n    screen.display_png(\"./[IMAGE.png]\")\r\n    await screen.show()\r\n}\r\nmain()\r\n```\r\n\r\n### Display a SVG\r\n```ts\r\nimport { Inky_ac } from \"@aeroniemi/inky\"\r\n\r\nasync function main() {\r\n    let screen = new Impression73()\r\n    screen.display_svg(\"./[IMAGE.svg]\")\r\n    await screen.show()\r\n}\r\nmain()\r\n```\r\n\r\n### Display a PNG with Node.js and Javascript\r\n```js\r\nconst epaper = require('@aeroniemi/inky');\r\n\r\nasync function main() {\r\n    let screen = new epaper.Impression57();\r\n    screen.display_png(\"./[IMAGE.png]\");\r\n\r\n    // draw white square\r\n    let w = 100;\r\n    let h = 100;\r\n    let sx = 100;\r\n    let sy = 100;\r\n    for (let x = 0; x < w; x++) {\r\n        for (let y = 0; y < h; y++) {\r\n            screen.set_pixel(x + sx, y + sy, 1);\r\n        }\r\n    }\r\n    await screen.show();\r\n}\r\nmain();\r\n```\r\n","readmeFilename":"readme.md","keywords":["inky","e-ink","eink","e-paper","epaper","pimoroni","inky impression","raspberry pi"]}