example.js

/**
 *  An example for the Tommy library
 *
 *  Creator: Aaron Vontell, Vontech Software LLC (aaron@vontech.org)
 *  Contributors: Aaron Vontell
 *  Version: ex0.0.1-alpha
 */

/**
 *  A simple example of Tommy
 */
function setupTommy() {
    
    // First, we configure Tommy
    var definitions = [
        {
            path: "/index.html",                // The path destination when Tommy is clicked
            keywords: "home tommy homepage",             // The speech keywords that cause Tommy to show up
            title: "Home Page",                 // The title for this suggestion
            description: "Home page for Tommy", // The description for the suggestion
            icon: "img/star.png",               // The icon for the the suggestion
            titleFunction: undefined,           // Instead, generate title from a function (given payload)
            descriptionFunction: undefined,     // Instead, generate description from a function (given payload)
            iconFunction: undefined,            // Instead, generate icon from a function (given payload)
            displayHTML: undefined,             // Instead, generate the entire suggestion HTML
        },
        {
            path: "/contacts.html",
            keywords: "contacts contact email phone team",
            description: "View contact information for the Tommy project",
        }
    ]
    
    var tail = [
        {
            path: "http://vontech.org",
            keywords: "vontech",
            title: "Visit vontech.org",
            description: "Want to learn more about this project? Visit vontech.org!",
        }
    ]
    
    var t = Tommy('tommy', definitions, {debug: true, feelingLucky: false, tail: tail})
    
    // Get the context that led to this page (null if Tommy didn't get to this page)
    var context = t.context
    //console.log(context.payload)    // The full speech string used to reach this page
    //console.log(context.previous)   // The path that the user came from
    //console.log(context.timeSpent)  // Time spent using Tommy in the last page
    
    // Open Tommy programmatically on your own
    //t.open()
    
    // Have Tommy begin listening programmatically on your own
    //t.listen()
    
    // Have Tommy stop listening programmatically on your own
    //t.deafen()
    
    // Close Tommy programmatically on your own
    //t.close()
    
    // Have tommy listen for only a few seconds (4 seconds)
    //t.listen(4000)
    
    // Retrieve the current suggestions and current payload
    var current = t.current.suggestions;
    var payload = t.current.payload;
    //console.log(current)
    //console.log(payload)
    
    // Show some basic properties of Tommy
    console.log(t.version)
    
}

setupTommy();