grunt-awot v0.1.2

grunt-awot

Generate aWOT payloads.

Transform files to hex payloads compatible with the aWOT web server library.

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-awot --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-awot');

The "awot" task

Overview

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

grunt.initConfig({
  awot: {
    options: {
      sketch: 'example/example.ino'
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

options.sketch

Type: String

A string value that is used to define the sketch file where generated routes will be injected.

options.needle

Type: String Default value: '// asset router'

A comment line in the sketch file that marks where the generated asset router will be inserted.

options.appName

Type: String Default value: 'app'

Main WebApp name you are using in the sketch.

options.rootPath

Type: String Default value: 'index.html'

A string value that is used to define the file that will be served from the root url of the server.

Usage Example

grunt.initConfig({
  awot: {
    options: {
      sketch: 'dist/example/example.ino'
    },
    files: {
      expand: true,
      src: '**/*.*',
      cwd: '.tmp/build',
      dest: 'dist/example'
    }
  },
});