config.js

exports.config = {
  // This file configures SwitchBoard to include any of your services, devices,
  // options and apps.  This file should be considered sensitive and unique to
  // your setup.
  //
  // NOTE: DO NOT EXPOSE CREDENTIALS TO A PUBLIC PLACE - LIKE GITHUB.
  config : {
    serverPort   : 8080,
    serverIp     : '192.168.1.145',
    serverMac    : '00:00:00:00:00:00',
    appCaching   : true,
    delegate     : ['gerty'],
    theme        : 'dark',
    language     : 'en',
    region       : 'us',
    default      : 'welcome',
    macroPause   : 1500,
    pollMinutes  : 5,
    pollSeconds  : 15,
    localTimeout : 1000,
    // Your SSL key and SCR will be generated for you.  If you want to use one
    // you've manually created, drop "ssl.key" and "ssl.csr" into /cache/.
    //
    // If you're using self-signed certs, be aware that appCaching may not work
    // in all (or any) browsers.  Also note that SmartThings cannot contact
    // SwitchBoard for real-time updates.
    ssl          : {
      country  : 'US',
      state    : 'Washington',
      city     : 'Seattle',
      org      : 'Switchboard',
      name     : 'Switchboard',
      disabled : true
    }
  },

  /*
   * Be sure to mark the "disabled" to true to remove the welcome message.
   */
  welcome : {
    typeClass : 'welcome',
    title     : 'Welcome!',
    disabled  : false
  },

  clientMp3 : {
    typeClass      : 'clientMp3',
    title          : 'Client MP3',
    disabled       : false,
    disabledMarkup : true
  },

  clientNotify : {
    typeClass      : 'clientNotify',
    title          : 'Desktop Notification',
    disabled       : false,
    disabledMarkup : true
  },

  clientSpeech : {
    typeClass      : 'clientSpeech',
    title          : 'Client Speech',
    voice          : 'male',
    disabled       : false,
    disabledMarkup : true
  },

  clientVibrate : {
    typeClass      : 'clientVibrate',
    title          : 'Client Vibrate',
    disabled       : false,
    disabledMarkup : true
  },

  samsung : {
    typeClass : 'samsung',
    title     : 'Samsung SmartTV',
    deviceIp  : '192.168.1.1',
    disabled  : true
  },

  roku : {
    typeClass : 'roku',
    title     : 'Roku',
    deviceIp  : '192.168.1.3',
    disabled  : true
  },

  /*
   * PS3 support is supplied by Gimx and is available on Windows and Linux
   * only.  Refer to the README for information on setup.
   */
  ps3 : {
    typeClass   : 'ps3',
    title       : 'PS3',
    // Bluetooth mac address of PS3
    // This is *NOT* the TCP network mac address
    deviceMac   : '00:00:00:00:00:00',
    // Gimx requires starting up a server and port.  You can set it to something
    // specific if you need, but this should be fine.
    serviceIp   : '127.0.0.1',
    servicePort : 8181,
    disabled    : true
  },

  panasonic : {
    typeClass : 'panasonic',
    title     : 'Panasonic',
    deviceIp  : '192.168.1.5',
    disabled  : true
  },

  /*
   * This device is incomplete.  If you have one to test on, please let me
   * know!
   */
  lg : {
    typeClass : 'lg',
    title     : 'LG TV',
    deviceIp  : '192.168.1.6',
    pairKey   : '123456',
    disabled  : true
  },

  /*
   * This device is incomplete.  If you have one to test on, please let me
   * know!
   */
  pioneer : {
    typeClass : 'pioneer',
    title     : 'Pioneer Amp',
    deviceIp  : '192.168.1.6',
    disabled  : true
  },

  /*
   * This device is incomplete.  If you have one to test on, please let me
   * know!
   */
  denon : {
    typeClass : 'denon',
    title     : 'Denon Receiver',
    deviceIp  : '192.168.1.6',
    disabled  : true
  },

  /*
   * Speech uses the "espeak" package on Linux, BSD and SunOS. For OSX, it uses
   * the built-in "say" command.  Windows is not supported.
   */
  speech : {
    typeClass      : 'speech',
    title          : 'Speech',
    voice          : 'male',
    disabledMarkup : true,
    disabled       : true
  },

  /*
   * Both stocks and weather are courtesy of Yahoo.
   */
  stocks : {
    typeClass : 'stocks',
    title     : 'Stocks',
    stocks    : ['YHOO', 'AAPL', 'GOOG', 'TSLA'],
    // Not to be considered investment advice, but this shows how you can set
    // stock prices to be notified of.
    apps      : { 'Notify' : { id            : 'announceStocks',
                               limits        : { YHOO : { buy : 30,  sell : 55 },
                                                 TSLA : { buy : 200, sell : 350 } },
                               controllerIds : ['pushover', 'speech', 'mp3', 'clientSpeech', 'clientMp3', 'clientNotify', 'gerty'] } },
    disabled  : true
  },

  weather : {
    typeClass : 'weather',
    title     : 'Weather',
    // Zip isn't available everywhere - and is imprecise, but is very easy to
    // recall and generally offers "good enough" precision.
    zip       : 98121,
    // WOEID can be more specific to a zip - so this will be used if available.
    // It's also available in places that don't have Zip codes.
    // Find your location's WOEID from: http://woeid.factormystic.net/
    woeid     : 12798963,
    celsius   : false,
    apps      : { 'Sun Phase' : { id            : 'sunPhase',
                                  macros        : { 'sunset' : 'smartthings=subdevice-mode-Night' },
                                  dayMode       : 'Home',
                                  // I personally don't like Night mode to
                                  // trigger automatically, so I stick with
                                  // Home.
                                  nightMode     : 'Home',
                                  controllerIds : ['smartthings', 'clientNotify', 'gerty'] } },
    disabled  : true
  },

  /*
   * This is insecure.  Your Foscam username and password will be sent in
   * plain-text and can be viewable within the source of the rendered
   * controller template.
   * Procede with caution.
   */
  foscam : {
    typeClass : 'foscam',
    title     : 'Foscam',
    deviceIp  : '192.168.1.7',
    username  : 'user',
    password  : 'password',
    apps      : { 'Announce'      : { id            : 'announceFoscam',
                                      controllerIds : ['speech', 'clientSpeech', 'clientNotify', 'gerty'] },
                  'Foscam Change' : { id            : 'foscamChange' } },
    disabled  : true
  },

  /*
   * Most states have a DOT site with available traffic cams.  Drop in the
   * actual image URL and title for each that you're interested in.  Some images
   * will already include some sort of cache-busting suffix - be sure to omit
   * that.  SwitchBoard will automatically append a unique cache bust param for
   * every request.
   *
   * You can use this site to look up any local webcams to use:
   * http://www.leonardsworlds.com/traffic/traffic_camera_directory.htm
   * Simply right click on any standard .jpg image and "copy image URL".
   */
  traffic : {
    typeClass : 'traffic',
    title     : 'Traffic Cams',
    cameras   : [{ title : 'I-5 & Denny',           image : 'http://images.wsdot.wa.gov/nw/005vc16645.jpg' },
                 { title : 'I-5 & Pine',            image : 'http://images.wsdot.wa.gov/nw/005vc16607.jpg' },
                 { title : 'I-5 & Mercer',          image : 'http://images.wsdot.wa.gov/nw/005vc16702.jpg' },
                 { title : 'I-5 & Northgate',       image : 'http://images.wsdot.wa.gov/nw/005vc17277.jpg' },
                 { title : 'I-5 & Roanoke',         image : 'http://images.wsdot.wa.gov/nw/005vc16802.jpg' },
                 { title : 'I-5 & Yesler',          image : 'http://images.wsdot.wa.gov/nw/005vc16508.jpg' },
                 { title : '99 & S King',           image : 'http://images.wsdot.wa.gov/nw/099vc03072.jpg' },
                 { title : 'Elliot & Broad',        image : 'https://www.seattle.gov/trafficcams/images/Elliott_Broad.jpg' },
                 { title : 'Stewart, Yale & Denny', image : 'https://www.seattle.gov/trafficcams/images/Yale_Denny.jpg' },
                 { title : '15th & Emerson',        image : 'https://www.seattle.gov/trafficcams/images/15W_Emerson.jpg' },
                 { title : 'SeaTac Airport',            image : 'http://archive.king5.com/weather/images/core/webcam/seatac.jpg' }],
    disabled  : true
  },

  /*
   * Simple device type to include a website in an iframe.
   * Visit this link to find the specific Waze params that work for you:
   * https://support.google.com/waze/partners/answer/6287370
   */
  website : {
    typeClass : 'website',
    title     : 'Waze',
    source    : 'https://embed.waze.com/iframe?zoom=14&lat=47.6205819&lon=-122.3493387',
    disabled  : true
  },

  /*
   * Configure Tasker on Android to ping your location while driving to a PHP
   * endpoint: https://github.com/imbrianj/switchboard-phpServer
   */
  location : {
    typeClass : 'location',
    title     : 'Location',
    host      : 'example.com',
    port      : 80,
    path      : '/location/',
    username  : 'username',
    password  : 'password',
    maxCount  : 15,
    disabled  : true
  },

  /*
   * MP3 uses the "mpg123" package on Linux, BSD and SunOS. For OSX, it uses
   * the built-in "afplay" command.  Windows is not supported.
   */
  mp3 : {
    typeClass      : 'mp3',
    title          : 'MP3',
    disabledMarkup : true,
    disabled       : true
  },

  /*
   * SMS uses the twilio service that you must register for and populate your
   * own twilioSid, twilioToken and twilioPhone values with.  Registration is
   * free, however each message will be prefixed with a notice from Twilio:
   * https://www.twilio.com/try-twilio
   *
   * Find your your twilioSid and twilioToken values here:
   * https://www.twilio.com/user/account
   *
   * Find your your twilioPhone (phone number at Twilio) here:
   * https://www.twilio.com/user/account/phone-numbers/incoming
   */
  sms : {
    typeClass      : 'sms',
    title          : 'SMS',
    // Your phone number to send texts to by default
    phone          : '1234567890',
    twilioSid      : 'somethingSecret',
    twilioToken    : 'somethingSecret',
    // Your assigned Twilio phone number
    twilioPhone    : '0987654321',
    disabledMarkup : true,
    disabled       : true
  },

  /*
   * Pushover is a neat IFTTT integrated push notification service.  Learn more
   * at https://pushover.net
   *
   * Find your your Pushover userKey:
   * https://pushover.net
   *
   * Generate your Pushover token here:
   * https://pushover.net/apps/build
   */
  pushover : {
    typeClass : 'pushover',
    title     : 'Pushover',
    userKey   : 'somethingSecret',
    token     : 'somethingSecret',
    disabled  : true
  },

  /*
   * SmartThings is a home automation system that integrates IP controlled,
   * Zigbee and Z-wave devices.  They allow OAuth control of their API.  Learn
   * more at http://smartthings.com
   *
   * To use their OAuth API, you'll need to have an account on their site and
   * create the OAuth endpoint SmartApp:
   * https://graph.api.smartthings.com/ide/app/create
   * Name: SwitchBoard OAuth Endpoint
   * Description: SwitchBoard OAuth Endpoint
   * Click "Enable OAuth in Smart App" and copy the "OAuth Client ID" and
   * "OAuth Client Secret" to the fields below.
   * Click "Create" to be presented with the SmartThings IDE.  Simply paste the
   * sourcecode from the companion app:
   * https://github.com/imbrianj/oauth_controller/blob/master/oauth_controller.groovy
   * Click "Save", then "Publish" in the upper right.
   *
   * On initial startup of SwitchBoard with this configuration, you'll be
   * prompted in the command line for a URL to generate the security token used.
   * Simply visit the URL, grant the permissions you desire and click
   * "Authorize".
   */
  smartthings : {
    typeClass      : 'smartthings',
    title          : 'SmartThings',
    clientId       : 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    clientSecret   : 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
    // You may group your devices together for display by using the group name
    // you'd like shown as the object name.  Devices within that group should
    // be the same name as you give them in SmartThings.
    groups         : { 'Bedroom'           : ['Bedroom Lamps', 'Bedroom Switch', 'Bedroom Window'],
                       'Office'            : ['Office Switch'],
                       'Hallway'           : ['Hall Light', 'Front Door'],
                       'Living Room'       : ['Living Room Lamp', 'Chandelier'],
                       'Kitchen'           : ['Kitchen Light', 'Dining Lights'] },
    /*
    apps           : { 'Announce'          : { id            : 'announcePresence',
                                               presence      : ['Brian', 'Goblin'],
                                               controllerIds : ['speech', 'cientSpeech', 'clientNotify', 'gerty'],
                                               disabled      : true },
                       'Announce Moisture' : { id            : 'announceMoisture',
                                               controllerIds : ['speech', 'clientNotify', 'clientSpeech', 'gerty'],
                                               disabled      : true },
                       'Window Open'       : { id            : 'windowOpen',
                                               contact       : ['Bedroom Window'],
                                               thermostat    : ['Living Room'],
                                               controllerIds : ['nest', 'pushover', 'speech', 'gerty'],
                                               disabled      : true },
                       'Mode Change'       : { id            : 'smartthingsModeChange',
                                               controllerIds : [],
                                               Away          : 'nest=Away;foscam=Preset1,Sleep,Sleep,Alarm_On',
                                               Night         : 'nest=Home;foscam=Alarm_Off,Preset3',
                                               Home          : 'nest=Home;foscam=Alarm_Off,Preset3',
                                               disabled      : true },
                       'Door Knock'        : { id            : 'doorKnock',
                                               contact       : 'Front Door',
                                               vibrate       : 'Front Door',
                                               delay         : 5,
                                               controllerIds : ['pushover', 'sms', 'speech', 'mp3', 'clientSpeech', 'clientNotify', 'clientMp3', 'gerty'],
                                               disabled      : true },
                       'Presence Mode'     : { id            : 'presenceMode',
                                               presence      : ['Brian', 'Goblin'],
                                               delay         : 10,
                                               dayMode       : 'Home',
                                               // I personally don't like Night
                                               // mode to trigger automatically,
                                               // so I stick with Home.
                                               nightMode     : 'Home',
                                               controllerIds : ['weather', 'clientNotify', 'gerty'] },
                       'Hall Light Home'   : { id            : 'hallLightHome',
                                               presence      : ['Brian', 'Goblin'],
                                               contact       : ['Front Door'],
                                               action        : ['Hall Light'],
                                               delay         : 15,
                                               macro         : '' },
                       'Home Watch'        : { id            : 'homeWatch',
                                               contact       : ['Front Door'],
                                               motion        : ['Living Room Motion'],
                                               secureModes   : ['Away'],
                                               delay         : 15,
                                               controllerIds : ['pushover', 'sms', 'clientSpeech', 'clientNotify', 'gerty'] }
                     },
    */
    className      : { Goblin : 'fa-female' },
    disabledMarkup : false,
    disabled       : true
  },

  nest : {
    typeClass : 'nest',
    title     : 'Nest',
    username  : 'user@example.com',
    password  : 'password',
    apps      : { 'Nest Change'   : { id            : 'nestChange' },
    /*
                  'Window Open'   : { id            : 'windowOpen',
                                      thermostats   : ['Living Room'],
                                      contact       : ['Balcony Door', 'Office Window', 'Bedroom Window', 'Dining Room Window', 'Living Room Window'],
                                      controllerIds : ['smartthings', 'pushover', 'speech', 'clientSpeech', 'clientNotify', 'gerty'] },
                  'Protect Alarm' : { id            : 'announceNest',
                                      macro         : 'smartthings=subdevice-on-Hall+Light',
                                      controllerIds : ['pushover', 'sms', 'speech', 'clientSpeech', 'clientNotify', 'gerty'] }
    */
                },
    disabled  : true
  },

  switchBoardCI : {
    typeClass      : 'travis',
    title          : 'Travis',
    travisOwner    : 'imbrianj',
    travisRepo     : 'switchBoard',
    apps           : { 'Announce' : { id            : 'announceTravis',
                                      controllerIds : ['clientNotify', 'clientSpeech', 'speech', 'gerty'] } },
    disabledMarkup : false,
    disabled       : true
  },

  /*
   * You must first enable control of XBMC via HTTP.
   *
   * Go to: "Settings" > "Services" > "Web Server"
   * Activate "Allow control of XBMC via HTTP"
   */
  xbmc : {
    typeClass  : 'xbmc',
    title      : 'XBMC',
    deviceIp   : '192.168.1.8',
    devicePort : 8080,
    disabled   : true
  },

  /*
   * Use your Raspberry Pi GPIO pins to control lighting and devices via 434Mhz
   * RF.  See http://xkonni.github.io/raspberry-remote/ for more details.
   */
  raspberryRemote : {
    typeClass  : 'raspberryRemote',
    title      : 'Raspberry Remote',
    system     : 11111,
    subdevices : { 'Lights' : 1,
                   'TV'     : 2,
                   'LED'    : 3,
                   'HDD'    : 4,
                   'Power'  : 5 },
    className  : { 'TV'     : 'fa-desktop' },
    disabled   : true
  },

  wemo : {
    typeClass  : 'wemo',
    title      : 'Wemo',
    subdevices : { 'Desk Lamp' : '192.168.1.9',
                   'Fan'       : '192.168.1.10' },
    // You may group your devices together for display by using the group name
    // you'd like shown as the object name.  Devices within that group should
    // be the same name as you give them in as subdevices above.
    groups     : { 'Office'    : ['Desk Lamp', 'Fan'] },
    className  : { 'Fan'       : 'fa-asterisk' },
    disabled   : true
  },

  /*
   * ActiveBuilding is a condo community portal.  We can poll their leaderboard
   * display to find out if you have any packages to be picked up.
   *
   * You will need to find the "appId" and "communityId" associated with your
   * unit.  Ask your concierge or building manager for more information.
   */
  activeBuilding : {
    typeClass   : 'activeBuilding',
    title       : 'Packages',
    appId       : '12345',
    communityId : '1234',
    unitNumber  : '123',
    apps        : { 'Announce' : { id            : 'announceActiveBuilding',
                                   controllerIds : ['speech', 'clientSpeech', 'clientNotify', 'gerty'] } },
    disabled    : true
  },

  /*
   * Simple RSS and Atom reader.
   */
  rss : {
    typeClass   : 'rss',
    title       : 'Gym',
    host        : 'crossfitbelltown.com',
    port        : 80,
    path        : '/feed/',
    maxCount    : 3,
    apps        : { 'Announce' : { id            : 'announceRss',
                                   controllerIds : ['speech', 'clientSpeech', 'clientNotify', 'gerty'] } },
    disabled    : true
  },

  /*
   * Same reader can be used to pull in news.
   */
  news : {
    typeClass : 'rss',
    title     : 'News',
    host      : 'news.google.com',
    port      : 443,
    path      : '/news?cf=all&hl=en&pz=1&ned=us&output=atom',
    maxCount  : 10,
    disabled  : true
  },

  sports : {
    typeClass : 'sports',
    title     : 'Sports',
    disabled  : true
  },

  /*
   * Read GitHub commits.  If checking against SwitchBoard, can alert you to
   * changes integrated into master and suggest an update.
   */
  github : {
    typeClass    : 'github',
    title        : 'GitHub',
    owner        : 'imbrianj',
    repo         : 'switchboard',
    // checkVersion will only work against the main SwitchBoard repo.
    checkVersion : true,
    apps         : { 'Announce' : { id            : 'announceGithub',
                                    controllerIds : ['speech', 'clientSpeech', 'clientNotify', 'gerty'] } },
    disabled     : true
  },

  /*
   * Subscribe to a feed of tweets mentioning a given user.
   * To get your required keys and tokens, you'll need to visit:
   * https://apps.twitter.com/
   * Click "Create New App"
   * Enter whatever you'd like for "Name" and "Description".
   * Enter "https://github.com/imbrianj/switchBoard" for "Website"
   * Leave "Callback URL" empty
   * "Yes, I agree" to the terms - and click "Create your Twitter application"
   *
   * Once you have your application created, click the "Keys and Access Tokens"
   * tab.  This will take you to a page with your "Consumer Key", "Consumer
   * Secret", "Access Token" and "Access Token Secret".  Take these values and
   * populate them below.
   */
  twitter : {
    typeClass        : 'twitter',
    title            : 'Twitter',
    consumerKey      : 'xxxxxxxxxxxxxxxxxxxxxx',
    accessToken      : 'xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    consumerSecret   : 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    oauthTokenSecret : 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
    disabledMarkup   : true,
    disabled         : true
  },

  gerty : {
    typeClass      : 'gerty',
    title          : 'Gerty',
    // Number of comments to remain visible in Gerty's chat log.
    maxCount       : 250,
    // The higher the number, the more likely he is to change emojis and act
    // out.
    personality    : 80,
    // Gerty will only act on inputted text that addresses him based on his
    // given name.  This should be true if you intend to use the inputted text
    // log as a simple chat app regularly.
    address        : false,
    // Gerty will try to act on any inputted text - but will not reply to the
    // negative of any command it does not understand.  This should be true if
    // you intend to use the inputted text log as a simple chat app some of the
    // time.
    ignoreNegative : true,
    // Sometimes, words are transcribed incorrectly.  Since I'm 100% certain
    // I'll never say something like "bedroom lambs", I can list some words or
    // phrases that will carry some actual meaning.
    corrections    : { 'bedroom lambs' : 'bedroom lamps',
                       'office which'  : 'office switch',
                       'hall life'     : 'hall light',
                       'kitchen life'  : 'kitchen light',
                       'dining life'   : 'dining light' },
    names          : { '192.168.1.1'   : 'Brian\'s Phone',
                       '192.168.1.2'   : 'Brian\'s Computer' },
    apps           : { 'Gerty' : { id            : 'gerty',
                                   macros        : { 'Watch A Movie' : 'ps3=PowerOn;samsung=sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,sleep,HDMI4,sleep,RIGHT,sleep,RIGHT,sleep,RIGHT,sleep,RIGHT,sleep,RIGHT,sleep,DOWN,sleep,ENTER,sleep,RETURN,sleep,sleep,sleep,LEFT',
                                                     'Goodnight'     : 'smartthings=subdevice-mode-Night',
                                                     'Good Night'    : 'smartthings=subdevice-mode-Night',
                                                     'Goodbye'       : 'smartthings=subdevice-mode-Away;nest=Away',
                                                     'Good Bye'      : 'smartthings=subdevice-mode-Away;nest=Away',
                                                     'I\'m Back'     : 'smartthings=subdevice-mode-Home;nest=Home',
                                                     'Welcome Home'  : 'smartthings=subdevice-mode-Home;nest=Home' },
                                   controllerIds : ['samsung', 'roku', 'ps3', 'panasonic', 'lg', 'pioneer', 'denon', 'speech', 'stocks', 'weather', 'foscam', 'mp3', 'sms', 'pushover', 'smartthings', 'nest', 'switchBoardCI', 'xbmc', 'raspberryRemote', 'wemo', 'activeBuilding', 'clientMp3', 'clientNotify', 'clientSpeech'] } },
    disabled       : true
  },

  /*
   * Prints out basic debug info (uptime, memory usage, cpu load).
   */
  debug : {
    typeClass : 'debug',
    title     : 'Debug',
    disabled  : true
  }
};