arduboy v0.0.8

arduboy

This is a general utility for the Arduboy.

The arduboy module uses NodeJS.

Installation: npm install -g arduboy

Example: Generate a C source file from an image.

$ arduboy image tobytes --input=arduboy_logo.png > arduboy_logo.c
info worked if it ends with ok
info using arduboy@0.0.8
info using node@v5.7.0
info ok

$ cat arduboy_logo.c
const static unsigned char arduboy_logo PROGMEM =
{
  0xf0,0xf8,0x9c,0x8e,0x87,0x83,0x87,0x8e,
  0x9c,0xf8,0xf0,0x00,0x00,0xfe,0xff,0x03,
  0x03,0x03,0x03,0x03,0x07,0x0e,0xfc,0xf8,
  0x00,0x00,0xfe,0xff,0x03,0x03,0x03,0x03,
  0x03,0x07,0x0e,0xfc,0xf8,0x00,0x00,0xff,
  0xff,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  0xff,0xff,0x00,0x00,0xfe,0xff,0x83,0x83,
  0x83,0x83,0x83,0xc7,0xee,0x7c,0x38,0x00,
  0x00,0xf8,0xfc,0x0e,0x07,0x03,0x03,0x03,
  0x07,0x0e,0xfc,0xf8,0x00,0x00,0x3f,0x7f,
  0xe0,0xc0,0x80,0x80,0xc0,0xe0,0x7f,0x3f,
  0xff,0xff,0x01,0x01,0x01,0x01,0x01,0x01,
  0x01,0xff,0xff,0x00,0x00,0xff,0xff,0x0c,
  0x0c,0x0c,0x0c,0x1c,0x3e,0x77,0xe3,0xc1,
  0x00,0x00,0x7f,0xff,0xc0,0xc0,0xc0,0xc0,
  0xc0,0xe0,0x70,0x3f,0x1f,0x00,0x00,0x1f,
  0x3f,0x70,0xe0,0xc0,0xc0,0xc0,0xe0,0x70,
  0x3f,0x1f,0x00,0x00,0x7f,0xff,0xc1,0xc1,
  0xc1,0xc1,0xc1,0xe3,0x77,0x3e,0x1c,0x00,
  0x00,0x1f,0x3f,0x70,0xe0,0xc0,0xc0,0xc0,
  0xe0,0x70,0x3f,0x1f,0x00,0x00,0x00,0x00,
  0x00,0x01,0xff,0xff,0x01,0x00,0x00,0x00
}

Install

Install using npm.

npm install --global arduboy

Using arduboy

From a command prompt, run the arduboy command. To see a complete list of commands, run arduboy --help.

Commands

help, config, image

Using image

Use arduboy help image to get details and a full list of commands.

test

To generate a series of test images run,

arduboy image test

tobytes

Convert an image provided with --input=a-file.bmp to the terminal or redirect stdout to a file, > source_file.c.

arduboy tobytes --input=./a-file.png > source_file.c

Develop

To help develop the Arduboy Node module: fork and clone the project locally. Use npm link in the folder the Arduboy repository is cloned into. You can now run arduboy from the command line interface.

Install Latest Source

This will locally install the current development build of the arduboy module.

npm install git+https://git@github.com/rogosher/ArduboyCLI.git

Or use npm link from the project directory after cloning the project.

'Special Features' Requirement

This module requires that Imagemagick be installed to generate the test images.

Linux

Ubuntu

apt-get install imagemagick

Windows

Install the Windows releases for each library.

ImageMagick · download

GraphicsMagick · download

Links

Node.js - https://nodejs.org/en/download/

ImageMagick - http://www.imagemagick.org/script/binary-releases.php

GraphicsMagick - http://www.graphicsmagick.org/download.html