grunt-blink1

grunt-blink1

Configures blink(1) inside your Gruntfile.

Getting Started

If you haven't used grunt before, be sure to check out the Getting Started guide.

From the same directory as your project's Gruntfile and package.json, install this plugin with the following command:

npm install grunt-blink1 --save-dev

Once that's done, add this line to your project's Gruntfile:

grunt.loadNpmTasks('grunt-blink1');

If the plugin has been installed correctly, running grunt --help at the command line should list the newly-installed plugin's task or tasks. In addition, the plugin should be listed in package.json as a devDependency, which ensures that it will be installed whenever the npm install command is run.

The "blink1" task

Overview

In your project's Gruntfile, add a section named blink1 to the data object passed into grunt.initConfig().

grunt.initConfig({
  blink1: {
    your_target: {
      colors: ['red', '#000', 'rgb(0, 255, 0)'],
      options: {
        turnOff: true,
        fadeMillis: 200
      }
    },
    your_target2: {
      color: 'green'
    }
  }
})

Properties

color or colors

Type: String or Array Default value: "black"

A value that is given to blink(1) for blink. CSS color string is available.

Options

options.turnOff

Type: Boolean Default value: false

If this value is true, blink(1) turns off at last.

options.fadeMillis

Type: Number Default value: 0

A value determining how long the blink(1) will change.

options.ledIndex

Type: Number Default value: 0

mk2 only. (0 - 2)

Examples

grunt.initConfig({
  blink1: {
    green: {
      color: 'green'
    },
    red: {
      color: 'red'
    }
  }
});
grunt.registerTask('test', ['blink1:red', 'mochacli', 'blink1:green']);

Contributing

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

Release History

• 2014-10-28   v0.3.0   Add ledIndex option for MK2.
• 2013-11-02   v0.2.0   Change API.
• 2013-11-02   v0.1.2   Update module dependencies.
• 2013-04-14   v0.1.1   Support Node v0.10.x and Grunt v0.4.x.
• 2012-12-29   v0.1.0   First release.

License

Copyright (c) 2012 Shogo Iwano Licensed under the MIT license.