com.alexscottrhodes.actions

Class NestFunctions

java.lang.Object

com.alexscottrhodes.actions.NestFunctions

public class NestFunctions
extends java.lang.Object

This class contains the main business logic for the Nest operations.

Author:

Alex Rhodes

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	apiKey
private static com.google.gson.JsonObject	model
private static java.lang.String	thermId
private static java.lang.String	thermName
private static java.lang.String	units

Constructor Summary

Constructors

Constructor and Description
NestFunctions()

Method Summary

Modifier and Type	Method and Description
static com.amazon.speech.speechlet.SpeechletResponse	failedCard(java.lang.String message, java.lang.String cardContent) A method for sending a failure response to the user
static com.amazon.speech.speechlet.SpeechletResponse	fanSwitch(boolean on) Sets the fan on or off
static com.amazon.speech.speechlet.SpeechletResponse	InitiateResponse(com.amazon.speech.slu.Intent intent)
static com.amazon.speech.speechlet.SpeechletResponse	modeChange(com.amazon.speech.slu.Intent intent) A method to change between thermostat modes, either heat, cool, heat-cool or off
static java.lang.String	nameToThermId(java.lang.String thermNameRaw) A utility for identifying the thermostat ID based on the name passed by the user
private static java.util.HashMap<java.lang.String,java.lang.String>	nestCom(java.lang.String JSON) A method that sends data to the Nest via the Nest API
private static java.util.HashMap<java.lang.String,com.google.gson.JsonObject>	queryDevice() A method that builds a model of the device's current state
static com.amazon.speech.speechlet.SpeechletResponse	quickAdjust(boolean warmer) Method to quickly adjust temperature by two degrees with a simple "quick" request
static com.amazon.speech.speechlet.SpeechletResponse	quickFilter(com.amazon.speech.slu.Intent intent) A utility method to determine which direction a user desired the temperature to move in a "quick" 2 degree adjustment
static com.amazon.speech.speechlet.SpeechletResponse	setTemp(boolean high, int temp) Sets either the high or low temperature of the range in heat-cool mode
static com.amazon.speech.speechlet.SpeechletResponse	setTemp(int low, int high) The following method sets the tempearutre between the given values
static com.amazon.speech.speechlet.SpeechletResponse	singleTemp(com.amazon.speech.slu.Intent intent) Sets a temperature when in heat or cool mode
static com.amazon.speech.speechlet.SpeechletResponse	specAdjustment(com.amazon.speech.slu.Intent intent) Method to adjust the temperature a given direction and specified number of degrees.
static com.amazon.speech.speechlet.SpeechletResponse	tempAdjuster(int degrees, java.lang.String direction) A method for adjusting the temperature the given amount in the given direction
static com.amazon.speech.speechlet.SpeechletResponse	tempCall(com.amazon.speech.slu.Intent intent) Interprets the type of temperature call, whether it be range or single temperature
static com.amazon.speech.speechlet.SpeechletResponse	tempCall(com.amazon.speech.slu.Slot lowSlot, com.amazon.speech.slu.Slot highSlot, com.amazon.speech.slu.Slot rangeSlot)
static com.amazon.speech.speechlet.SpeechletResponse	tempQuery() Returns an information response to the user including the current temperature and settings
static com.amazon.speech.speechlet.SpeechletResponse	whereTempCall(com.amazon.speech.slu.Intent intent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

thermName

private static java.lang.String thermName

thermId

private static java.lang.String thermId

apiKey

private static java.lang.String apiKey

units

private static java.lang.String units

model

private static com.google.gson.JsonObject model

Constructor Detail

NestFunctions

public NestFunctions()

Method Detail

InitiateResponse

public static com.amazon.speech.speechlet.SpeechletResponse InitiateResponse(com.amazon.speech.slu.Intent intent)
                                                                      throws com.amazon.speech.speechlet.SpeechletException

Throws:

com.amazon.speech.speechlet.SpeechletException

whereTempCall

public static com.amazon.speech.speechlet.SpeechletResponse whereTempCall(com.amazon.speech.slu.Intent intent)

tempCall

public static com.amazon.speech.speechlet.SpeechletResponse tempCall(com.amazon.speech.slu.Intent intent)

Interprets the type of temperature call, whether it be range or single temperature

Parameters:

intent - an Intent indicating a temperature request

Returns:

a SpeechletResponse to the user

tempCall

public static com.amazon.speech.speechlet.SpeechletResponse tempCall(com.amazon.speech.slu.Slot lowSlot,
                                                                     com.amazon.speech.slu.Slot highSlot,
                                                                     com.amazon.speech.slu.Slot rangeSlot)

setTemp

public static com.amazon.speech.speechlet.SpeechletResponse setTemp(int low,
                                                                    int high)

The following method sets the tempearutre between the given values

Parameters:

low - an Integer indicating the low value for the temperature range in heat-cool mode

high - an Integer indicating the high value for the temperature range in heat-cool mode

Returns:

a SpeecheltResponse for the user with a message repeating back the desired range so that he or she may ensure it was accurately interpreted

setTemp

public static com.amazon.speech.speechlet.SpeechletResponse setTemp(boolean high,
                                                                    int temp)

Sets either the high or low temperature of the range in heat-cool mode

Parameters:

high - a Boolean indicating if the temperature to be changed is the high (true) or low (false)

temp - an Integer of the desired temperature for the range

Returns:

a SpeecheltResponse for the user with a message repeating back the desired range so that he or she may ensure it was accurately interpreted

tempQuery

public static com.amazon.speech.speechlet.SpeechletResponse tempQuery()

Returns an information response to the user including the current temperature and settings

Returns:

a SpeecheltResponse with the current temperature and setting information

singleTemp

public static com.amazon.speech.speechlet.SpeechletResponse singleTemp(com.amazon.speech.slu.Intent intent)

Sets a temperature when in heat or cool mode

Parameters:

intent - an Intent indicating a single temperature change

Returns:

SpeecheltResponse for the user with a message repeating back the desired range so that he or she may ensure it was accurately interpreted

modeChange

public static com.amazon.speech.speechlet.SpeechletResponse modeChange(com.amazon.speech.slu.Intent intent)

A method to change between thermostat modes, either heat, cool, heat-cool or off

Parameters:

intent - an Intent indicating a mode change request

Returns:

a SpeecheltResponse for the user with a message repeating back the desired range so that he or she may ensure it was accurately interpreted

fanSwitch

public static com.amazon.speech.speechlet.SpeechletResponse fanSwitch(boolean on)

Sets the fan on or off

Parameters:

on - a Boolean indicating if the fan is to be turned on or shut off

Returns:

a SpeecheltResponse for the user with a message repeating back the desired range so that he or she may ensure it was accurately interpreted

quickFilter

public static com.amazon.speech.speechlet.SpeechletResponse quickFilter(com.amazon.speech.slu.Intent intent)

A utility method to determine which direction a user desired the temperature to move in a "quick" 2 degree adjustment

Parameters:

intent - an Intent indicating a "quick" adjustment intent

Returns:

a SpeecheltResponse for the user with a message repeating back the desired range so that he or she may ensure it was accurately interpreted

quickAdjust

public static com.amazon.speech.speechlet.SpeechletResponse quickAdjust(boolean warmer)

Method to quickly adjust temperature by two degrees with a simple "quick" request

Parameters:

warmer - a Boolean to indicate if the temperature should be increased or decreased

Returns:

a SpeecheltResponse for the user with a message repeating back the desired range so that he or she may ensure it was accurately interpreted

specAdjustment

public static com.amazon.speech.speechlet.SpeechletResponse specAdjustment(com.amazon.speech.slu.Intent intent)

Method to adjust the temperature a given direction and specified number of degrees. Will adjust either a single temperature or shift the range in heat-cool mode.

Parameters:

intent - an Intent indicating a directional temperature command

Returns:

a SpeecheltResponse for the user with a message repeating back the desired range so that he or she may ensure it was accurately interpreted

tempAdjuster

public static com.amazon.speech.speechlet.SpeechletResponse tempAdjuster(int degrees,
                                                                         java.lang.String direction)

A method for adjusting the temperature the given amount in the given direction

Parameters:

degrees - an Integer representing the desired number of degrees

direction - the direction to move the temperature

Returns:

a SpeecheltResponse for the user with a message repeating back the desired range so that he or she may ensure it was accurately interpreted

failedCard

public static com.amazon.speech.speechlet.SpeechletResponse failedCard(java.lang.String message,
                                                                       java.lang.String cardContent)

A method for sending a failure response to the user

Parameters:

message - a String with the method-specific failure message to read to the user

cardContent - a String with content for a card to be passed with the response

Returns:

a SpeecheltResponse with an informative failure message to the user

queryDevice

private static java.util.HashMap<java.lang.String,com.google.gson.JsonObject> queryDevice()

A method that builds a model of the device's current state

Returns:

a HashMap with data about the device keyed by the name of the respective field

nestCom

private static java.util.HashMap<java.lang.String,java.lang.String> nestCom(java.lang.String JSON)

A method that sends data to the Nest via the Nest API

Parameters:

JSON - a JSON string of the fields to be updated

Returns:

a HashMap containing the response information from the request

nameToThermId

public static java.lang.String nameToThermId(java.lang.String thermNameRaw)

A utility for identifying the thermostat ID based on the name passed by the user

Parameters:

thermNameRaw - a String representing the thermostat's raw name

Returns:

a String of the thermostats ID within the Nest structure model