Add sun phase to weather data - and have a (currently) simple app to …

…execute a macro when sunset or sunrise occurs. Start some work on Gerty to answer preset questions.

apps/gerty.js

@@ -40,22 +40,29 @@ module.exports = (function () {
           gertyRunCommand = require(__dirname + '/gerty/runCommand'),
           gertyMood       = require(__dirname + '/gerty/mood'),
           utterance       = translate.findSynonyms('gerty', controllers.config.language),
-          text            = '';
+          text            = '',
+          acted           = false;
 
       // If it's a command explicitly sent to Gerty to act on.
       if((controllers[device]) && (controllers[device].config) && (controllers[device].config.typeClass === 'gerty') && (command.indexOf('text-') === 0)) {
         text = command.replace('text-', '').toUpperCase();
 
         gertyMood.setEmotion(text, device, controllers.config.language);
 
-        if(gertyRunCommand.setDevice(text, controllers, device, config.macros, controllers.config.language)) {
+        acted = gertyRunCommand.setDevice(text, controllers, device, config.macros, controllers.config.language);
+
+        if(acted === true) {
           utterance = utterance.AFFIRMATIVE[Math.floor(Math.random() * utterance.AFFIRMATIVE.length)];
         }
 
-        else {
+        else if(acted === false) {
           utterance = utterance.NEGATIVE[Math.floor(Math.random() * utterance.NEGATIVE.length)];
         }
 
+        else {
+          utterance = acted || '';
+        }
+
         for(device in controllers) {
           if(device !== 'config') {
             if(controllers[device].config.typeClass === 'speech') {

apps/sunPhase.js

@@ -0,0 +1,58 @@
+/*jslint white: true */
+/*global module, require, console */
+
+/**
+ * Copyright (c) 2014 [email protected]
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to
+ * deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+ * sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+ * IN THE SOFTWARE.
+ */
+
+/**
+ * @author [email protected]
+ * @fileoverview Execute specified macros based on sunset or sunrise.
+ */
+
+module.exports = (function () {
+  'use strict';
+
+  return {
+    version : 20150624,
+
+    lastState : null,
+
+    sunPhase : function(device, command, controllers, values, config) {
+      var state = values.phase,
+          newPhase = '',
+          rawMacro,
+          macro,
+          runCommand;
+
+      if(state !== this.lastState) {
+        this.lastState = state;
+        runCommand     = require(__dirname + '/../../lib/runCommand');
+        newPhase       = state === 'Day' ? 'Sunrise' : 'Sunset';
+        rawMacro       = config.macros[newPhase].split(';');
+
+        for(macro in rawMacro) {
+          runCommand.macroCommands(rawMacro[macro]);
+        }
+      }
+    }
+  };
+}());

config/config.js

@@ -144,6 +144,8 @@ exports.config = {
     // It's also available in places that don't have Zip codes.
     // Find your location's WOEID from: http://woeid.factormystic.net/
     woeid     : 12798963,
+    apps      : { 'Sun Phase' : { id      : 'sunPhase',
+                                  macros  : { 'sunset' : 'smartthings=subdevice-mode-Night' } } },
     disabled  : true
   },
 

controllers/weather.js

@@ -32,7 +32,7 @@ module.exports = (function () {
    * @fileoverview Basic weather information, courtesy of Yahoo.
    */
   return {
-    version : 20140813,
+    version : 20150624,
 
     inputs  : ['list'],
 
@@ -64,8 +64,58 @@ module.exports = (function () {
       runCommand.runCommand(controller.config.deviceId, 'list', controller.config.deviceId);
     },
 
+    /**
+     * Accept a plain-text time ("7:52 pm") and find the unix timestamp for that
+     * time on the current day.
+     */
+    formatTime : function (time) {
+      var hour   = time.split(':')[0],
+          minute = time.split(':')[1].split(' ')[0],
+          ampm   = time.split(' ')[1];
+
+      hour = ampm === 'pm' ? (hour + 12) : hour;
+
+      return { hour : hour, minute : minute };
+    },
+
+    /**
+     * Accept sunrise and sunset times as deliverd from the API - and determine
+     * what the current sun phase is.  Can either be "Day" or "Night".
+     */
+    findSunPhase : function (sunriseRaw, sunsetRaw) {
+      var sunrise = this.formatTime(sunriseRaw),
+          sunset  = this.formatTime(sunsetRaw),
+          now     = new Date(),
+          unixNow = now.getTime(),
+          year    = now.getFullYear(),
+          month   = now.getMonth(),
+          date    = now.getDate(),
+          state   = '';
+
+      sunrise.unix = new Date(year, month, date, sunrise.hour, sunrise.minute);
+      sunset.unix  = new Date(year, month, date, sunrise.hour, sunrise.minute);
+
+      // The sun hasn't come up yet.
+      if(sunrise.unix > unixNow) {
+        state = 'Night';
+      }
+
+      // The sun has come up - but has not gone down.
+      else if(sunset.unix > unixNow) {
+        state = 'Day';
+      }
+
+      // The sun has gone down.
+      else {
+        state = 'Night';
+      }
+
+      return state;
+    },
+
     send : function (config) {
-      var https     = require('https'),
+      var that      = this,
+          https     = require('https'),
           weather   = {},
           dataReply = '',
           request;
@@ -112,7 +162,8 @@ module.exports = (function () {
                                             'sunrise'  : city.astronomy.sunrise,
                                             'sunset'   : city.astronomy.sunset,
                                             'code'     : city.item.condition.code,
-                                            'forecast' : city.item.forecast
+                                            'forecast' : city.item.forecast,
+                                            'phase'    : that.findSunPhase(city.astronomy.sunrise, city.astronomy.sunset)
                                           };
 
                             deviceState.updateState(weather.deviceId, 'weather', { state : 'ok', value : weatherData });