Hubitat Documentation - User contributions [en]

EventStream Interface

2021-11-15T02:11:34Z

Dman2306: /* connect */

=Overview=
Hubitat allows for opening and maintaining a connection to an event stream endpoint from the hub. All code needs to be contained in a driver, there is no option to open an event stream connection from an app. Hubitat provides methods to connect and disconnect to the endpoint, in addition it is required to create a method in the driver that accepts incoming messages (parse) and another method that will be called with any status updates for the endpoint (eventStreamStatus).

=Methods=

==Hubitat Provided Methods==

===<code>connect</code>===
:;Signature
:: <code>void connect(String url)</code>
:: <code>void connect(String url, [options (name/value pairs)])</code>

:;Parameters
:: url - The url to connect to.
:: options - Optional parameters to configure the web socket connection. Possible values:
:::''pingInterval'' - The number of seconds to send a ping message. Defaults to 0 (disabled).
:::''headers'' - A Map of key/value pairs to send as header values when connecting to the web socket server.
:::''ignoreSSLIssues'' (since 2.2.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
:::''rawData'' (since 2.2.2) - possible values: true, false. Prevents parsing of the data read from the stream and returns the raw data to the caller. Defaults to false.
:::''readTimeout'' (since 2.2.9) - The number of seconds before a read times out. Defaults to 60.

===<code>close</code>===

:;Signature
:: <code>void close()</code>

:;Examples

// Close connection
interfaces.eventStream.close()

==User defined methods==

: '''<code>parse(String message)</code>''' - This method is called with any incoming messages from the event stream server. This is a standard method for drivers.

: '''<code>eventStreamStatus(String message)</code>''' - This method is called with any status messages from the event stream client connection (disconnections, errors during connect, etc)

Common Methods Object

2021-11-15T00:34:09Z

Dman2306: /* asynchttpGet */

{{Top}}

These methods can be used in both Apps and Drivers

===<code>celsiusToFahrenheit</code>===
:Converts a given Celsius temperature to Fahrenheit.

:;Signature
:: <code>BigDecimal celsiusToFahrenheit(BigDecimal val)</code>

:;Parameters
:: A temperature in Celsius.

:;Returns
:: The specified temperature in Fahrenheit.

===<code>fahrenheitToCelsius</code>===
:Converts a given Fahrenheit temperature to Celsius

:;Signature
:: <code>BigDecimal fahrenheitToCelsius(BigDecimal val)</code>

:;Parameters
:: A temperature in Fahrenheit.

:;Returns
:: The specified temperature in Celsius.

===<code>getLocation</code>===
:;Signature
:: <code>Location getLocation()</code>

===<code>getSunriseAndSunset</code>===
:Returns the sunset and sunrise values for the current day. (Common method since 2.1.0)

:;Signature
:: <code>Map getSunriseAndSunset()</code>
:: <code>Map getSunriseAndSunset(Map options)</code>

:;Parameters
:: options - Map with optional offset for sunrise or sunset, possible values are sunriseOffset and sunsetOffset and can either be a number of minutes or a String of the format Hours:Minutes

:;Returns
:: Map with with key values 'sunrise' and 'sunset' of type Date

:;Examples

// get today's sunrise and sunset
def riseAndSet = getSunriseAndSunset()
log.debug riseAndSet.sunrise
log.debug riseAndSet.sunset

// get sunrise time offset by 1 minute early, and get sunset offset by 1 hour, 5 minutes later
def offsetRiseAndSet = getSunriseAndSunset(sunriseOffset: -1, sunsetOffset: "1:05")

===<code>getTemperatureScale</code>===
:Get the current temperature scale set for the hub.

:;Signature
:: <code>String getTemperatureScale()</code>

:;Parameters
:: none

:;Returns
:: String - "F" or "C" based on the setting in the hub.

===<code>now</code>===
:;Signature
:: long now()

===<code>timeToday</code>===
: Get a Date object with today's date and the time specified

:;Signature
:: <code>Date timeToday(String timeString, TimeZone timeZone = null)</code>

:;Parameters
:: timeString - The time to use, can be either "HH:mm" or and ISO8601 date/time string
:: timeZone - (Optional) The timezone to use for the new Date.

:;Returns
:: Date - A Date object with today's date and the time that was passed as timeString

===<code>timeOfDayIsBetween</code>===
:Check if a date is between two dates.

:;Signature
:: <code>boolean timeOfDayIsBetween(Date start, Date stop, Date value[, TimeZone timeZone])</code>

:;Parameters

:: start - The date to start comparison against.
:: stop - The date to stop comparison against.
:: value - The date to compare
:: timezone - (Optional) The timezone to use for the comparison

:;Returns
:: boolean - true if the value date is between the start and stop dates, otherwise returns false.

===<code>unschedule</code>===
:Remove any scheduled tasks. If method is called without paramters, all schedules will be removed.

:;Signature
:: <code>void unschedule()</code>
:: <code>void unschedule(handlerMethod)</code>

:;Parameters
:: handlerMethod - Only remove schedules for this handlerMethod

===<code>asynchttpGet</code>===
:Send an http GET request and return control to the calling code. Any response from the call will be passed to the callback method.

:;Signature
:: <code>void asynchttpGet(callbackMethod, Map params, Map data = null)</code>

:;Parameters
:: callbackMethod - The name of a callback method to send the response to. Can be null if the response can be ignored.
:: params - the parameters to use to build the http GET call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
:::''followRedirects'' (since 2.2.9) - possible values: true, false. Determines whether or not redirects will be automatically followed. Defaults to true.
::data - optional data to be passed to the callback method.

===<code>asynchttpPost</code>===
:;Signature
::<code>void asynchttpPost(String callbackMethod = null, Map params, Map data = null)</code>

:;Parameters
::callbackMethod - The name of a callback method to send the response to. Can be null if the response can be ignored.
::params - the parameters to use to build the http GET call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
:::''followRedirects'' (since 2.2.9) - possible values: true, false. Determines whether or not redirects will be automatically followed. Defaults to true.
::data - optional data to be passed to the callback method.

===<code>asynchttpPatch</code>===
:;Signature
::<code>void asynchttpPatch(String callbackMethod = null, Map params, Map data = null)</code>

:;Parameters
::callbackMethod - The name of a callback method to send the response to. Can be null if the response can be ignored.
::params - the parameters to use to build the http PATCH call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
:::''followRedirects'' (since 2.2.9) - possible values: true, false. Determines whether or not redirects will be automatically followed. Defaults to true.
::data - optional data to be passed to the callback method.

===<code>httpGet</code>===
:Send an http GET request. Any response from the call will be passed to the closure.

:;Signature
:: <code>void httpGet(String uri, Closure closure)</code>
:: <code>void httpGet(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::params - the parameters to use to build the http GET call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''textParser'' (since 2.1.1) - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
:::''followRedirects'' (since 2.2.9) - possible values: true, false. Determines whether or not redirects will be automatically followed. Defaults to true.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>httpPost</code>===
:;Signature
:: <code>void httpPost(String uri, String body, Closure closure)</code>
:: <code>void httpPost(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::body - The body of the request as a String. Any encoding should be done before passing to the system.
::params - the parameters to use to build the http call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''textParser'' (since 2.1.1) - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
:::''followRedirects'' (since 2.2.9) - possible values: true, false. Determines whether or not redirects will be automatically followed. Defaults to true.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>httpPostJson</code>===
:Similar to httpPost except that the contentType parameter is set to "application/json"
:;Signature
:: <code>void httpPostJson(String uri, String stringBody, Closure closure)</code>
:: <code>void httpPostJson(String uri, Map mapBody, Closure closure)</code>
:: <code>void httpPostJson(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::stringBody - The body of the request as a String. Any encoding should be done before passing to the system.
::mapBody - The body of the request as a Map.
::params - the parameters to use to build the http call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it as JSON.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''textParser'' (since 2.1.8) - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
:::''followRedirects'' (since 2.2.9) - possible values: true, false. Determines whether or not redirects will be automatically followed. Defaults to true.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>httpPut</code>===
:;Signature
:: <code>void httpPut(String uri, String body, Closure closure)</code>
:: <code>void httpPut(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::body - The body of the request as a String. Any encoding should be done before passing to the system.
::params - the parameters to use to build the http call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''textParser'' (since 2.1.1) - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
:::''followRedirects'' (since 2.2.9) - possible values: true, false. Determines whether or not redirects will be automatically followed. Defaults to true.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>httpPatch (Since 2.1.7)</code>===
:;Signature
:: <code>void httpPatch(String uri, String body, Closure closure)</code>
:: <code>void httpPatch(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::body - The body of the request as a String. Any encoding should be done before passing to the system.
::params - the parameters to use to build the http call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' - timeout in seconds for the request, max timeout is 300
:::''textParser'' - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
:::''followRedirects'' (since 2.2.9) - possible values: true, false. Determines whether or not redirects will be automatically followed. Defaults to true.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>runIn</code>===
:;Signature
::<code>void runIn(Long delayInSeconds, String handlerMethod, Map options = null)</code>

:;Parameters
::delayInSeconds - How long to wait in seconds until the handler should be called, don't expect that it will be called in exactly that time.
::handlerMethod - The name of a handler method in your driver or app. The method name should not contain parentheses.
::options - Optional values to control the scheduling of this method
:::''overwrite'' - defaults to true which cancels the previous scheduled running of the handler method and schedules new, if set to false this will create a duplicate schedule.
:::''data'' - optional data to be passed to the handler method.
:::''misfire'' - If set to "ignore" then the scheduler will simply try to fire it as soon as it can. NOTE: if a scheduler uses this instruction, and it has missed several of its scheduled firings, then several rapid firings may occur as the scheduler attempts to catch back up to where it would have been.

:;Example:
<pre>
runIn(50, 'myMethod', [data: ["myKey":"myValue"]])
</pre>

===<code>runInMillis</code>===
:;Signature
:: <code>void runInMillis(Long delayInMilliSeconds, String handlerMethod, Map options = null)</code>

:;Parameters
:: delayInMilliseconds - How long to wait until the handler should be called, don't expect that it will be called in exactly that time.
:: handlerMethod - the name of a handler method in your driver or app. The method name should not contain parentheses.
::options - Optional values to control the scheduling of this method
:::''overwrite'' - defaults to true which cancels the previous scheduled running of the handler method and schedules new, if set to false this will create a duplicate schedule.
:::''data'' - optional data to be passed to the handler method.
:::''misfire'' - If set to "ignore" then the scheduler will simply try to fire it as soon as it can. NOTE: if a schduler uses this instruction, and it has missed several of its scheduled firings, then several rapid firings may occur as the scheduler attempts to catch back up to where it would have been.

:;Example:
<pre>
private processQueue(Map queue) {
if (isQueueEmpty(queue)) {
sendEvent name: 'lifxdiscovery', value: 'complete'
return
}
def data = getNext(queue)
sendPacket data.ipAddress, data.packet
runInMillis(queue.delay, 'processQueue', [data: queue])
}

runInMillis(50, 'processQueue', [data: queue])
</pre>

===<code>pauseExecution</code>===
:;Signature
:: <code> void pauseExecution(Long millisecs)</code>

:;Parameters
:: millisecs - The amount of time in milliseconds to pause.

===<code>textToSpeech</code>===
:Converts text to speech.

:;Signature
:: <code> Map textToSpeech(String stringToBeSynthesized, String voice = null)</code>

:;Parameters
::stringToBeSynthesized - The text to be converted to audio. The text may contain supported [https://docs.aws.amazon.com/polly/latest/dg/supportedtags.html SSML tags].
::voice - The name of a voice supported by Amazon Polly, you can find a list of voices [https://docs.aws.amazon.com/polly/latest/dg/voicelist.html here]. If not specified the default system setting is used.

:;Returns
:: Map - Returns a Map with two entries, <code>uri</code> which contains a URI to the MP3 file and <code>duration</code> is the length of the MP3 in seconds.

===<code>getTTSVoices</code>===
:Returns a list of the supported text-to-speech voices.

:;Signature
:: <code> Map getTTSVoices()</code>

:;Parameters
::None

:;Returns
:: Map - Returns a Map with three entries <code>name</code> which is the name of a voice that can be specified to <code>textToSpeech</code>, <code>gender</code> which contains either Male or Female, and <code>language</code> which contains the language of this voice.

===<code>toDateTime</code>===
:;Signature
:: <code>Date toDateTime(String dateTimeString)</code>

:;Parameters
::dateTimeString - A date/time string in ISO8601 format. ("yyyy-MM-dd", "yyyyMMdd'T'HHmmssX", "yyyy-MM-dd'T'HH:mm:ssX", "yyyy-MM-dd'T'HH:mm:ss.SSSX")

===<code>schedule</code>===
:;Signature
:: <code>void schedule(String expression, String handlerMethod, Map options = null)</code>

:;Parameters
::expression - a [http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html 7] parameter [http://www.quartz-scheduler.org/ quartz] cron string where the expression is: "Seconds" "Minutes" "Hours" "Day Of Month" "Month" "Day Of Week" "Year"
::handlerMethod - method to run at given schedule
::options - Optional values to control the scheduling of this method
:::''overwrite'' - defaults to true which cancels the previous scheduled running of the handler method and schedules new, if set to false this will create a duplicate schedule.
:::''data'' - optional data to be passed to the handler method.

:;Example
// run 'mymethod' every tenth minute.
schedule('0 */10 * ? * *', mymethod)

==<code>Additional to be documented</code>==

'''Signature:'''
void httpPutJson(String uri, String body, Closure closure)
void httpPutJson(String uri, Map body, Closure closure)
void httpPutJson(Map params, Closure closure)
void httpDelete(Map params, Closure closure)
String getMACFromIP(String ipAddr)
String convertTemperatureIfNeeded(BigDecimal value, String scale, Integer precision)
Object parseJson(String stringToParse)
Object parseJsonFromBase64(String stringToParse)
GPathResult parseXML(String stringToParse)
Map parseLanMessage(String stringToParse)
void runEvery1Minute(String handlerMethod, Map options = null)
void runEvery5Minutes(String handlerMethod, Map options = null)
void runEvery10Minutes(String handlerMethod, Map options = null)
void runEvery15Minutes(String handlerMethod, Map options = null)
void runEvery30Minutes(String handlerMethod, Map options = null)
void runEvery1Hour(String handlerMethod, Map options = null)
void runEvery3Hours(String handlerMethod, Map options = null)
void runOnce(Date dateTime, String handlerMethod, Map options = null)
void runOnce(String dateTime, String handlerMethod, Map options = null)
void schedule(Date dateTime, String handlerMethod, Map options = null)
void asynchttpPut(String callbackMethod = null, Map params, Map data = null)
void asynchttpDelete(String callbackMethod = null, Map params, Map data = null)
void asynchttpHead(String callbackMethod = null, Map params, Map data = null)
String encrypt(String value)
String decrypt(String value)
void sendLocationEvent(Map properties)
Date timeTodayAfter(String startTimeString, String timeString, TimeZone timeZone = null) (Common method since 2.1.0)
Long timeOffset(Number minutes) (Common method since 2.1.0)
Long timeOffset(String hoursAndMinutesString) (Common method since 2.1.0)

NetworkUtils Object

2021-05-27T01:52:34Z

Dman2306: Created page with "==Description== The package name of this class is hubitat.helper. So to use in an App or Driver you would reference it with hubitat.helper.NetworkUtils. == <code>ping</code>..."

==Description==
The package name of this class is hubitat.helper. So to use in an App or Driver you would reference it with hubitat.helper.NetworkUtils.

== <code>ping</code> ==
Performs an ICMP ping and returns the results.

'''Signature'''
PingData ping(String IPAddress)
PingData ping(String IPAddress, Integer count)

'''Parameters'''

IPAddress - The IP Address to ping
count - The number of ping requests to send (defaults to 3, maximum is 5).

'''Returns'''

PingData - An object containing the following properties:
Double rttAvg - Average Round Trip Time
Double rttMin - Minimum Round Trip Time
Double rttMax - Maximum Round Trip Time
Integer packetsTransmitted - Ping requests sent
Integer packetsReceived - Responses received
Integer packetLoss - Responses lost

Developer Documentation

2021-05-27T01:46:01Z

Dman2306: /* Method Documentation */

{{Top}}

==<big>App Structure</big>==

:[[App_Definition|<big>Definition</big>]]
:[[App_Preferences|<big>Preferences</big>]]
:[[App_Code|<big>Code</big>]]
:[[App_OAuth|<big>OAuth Process</big>]]

==<big>Driver Structure</big>==

:[[Device_Definition|<big>Definition</big>]]
:[[Device_Preferences|<big>Preferences</big>]]
:[[Device_Code|<big>Code</big>]]

==<big>Method Documentation</big>==

:[[App_Object|<big>App</big>]]
:[[Driver_Object|<big>Driver</big>]]
:[[Common_Methods_Object|<big>Common Methods</big>]]
:[[Attribute_Object|<big>Attribute</big>]]
:[[Capability_Object|<big>Capability</big>]]
:[[Command_Object|<big>Command</big>]]
:[[Device_Object|<big>Device</big>]]
:[[Event_Object|<big>Event</big>]]
:[[Hub_Object|<big>Hub</big>]]
:[[HubAction_Object|<big>HubAction</big>]]
:[[HubMultiAction_Object|<big>HubMultiAction</big>]]
:[[Protocol_Object|<big>Protocol</big>]]
:[[InstalledApp_Object|<big>InstalledApp</big>]]
:[[Location_Object|<big>Location</big>]]
:[[Mode_Object|<big>Mode</big>]]
:[[State_Object|<big>State</big>]]
:[[Zwave_Object|<big>Zwave</big>]]
:[[Zigbee_Object|<big>Zigbee</big>]]
:[[HexUtils_Object|<big>HexUtils</big>]]
:[[ColorUtils_Object|<big>ColorUtils</big>]]
:[[NetworkUtils_Object|<big>NetworkUtils</big>]]

==<big>App Interfaces</big>==

:[[Hubitat® Safety Monitor Interface|<big>Hubitat® Safety Monitor Interface</big>]]

==<big>Driver Interfaces</big>==

:[[EventStream_Interface|<big>EventStream Interface</big>]]
:[[Telnet_Interface|<big>Telnet Interface</big>]]
:[[Websocket_Interface|<big>Websocket Interface</big>]]
:[[Raw_Socket_Interface|<big>Raw Socket Interface</big>]]
:[[MQTT_Interface|<big>MQTT Interface</big>]]

==<big>ZWave Classes</big>==

:[[ZWave_Classes|<big>ZWave Classes</big>]]

==<big>Capabilities</big>==

:[[Driver_Capability_List|<big>Driver</big> <big>Capability List</big>]]

[[File:Doc Card Document List.png|frameless|alt=Go to the full document list|link=Hubitat_Elevation_Documentation]]

App OAuth

2020-06-07T21:23:20Z

Dman2306: Created page with "== OAuth Workflow == When communicating with a 3rd Party REST API, it may be necessary to provide OAuth authentication. OAuth is an industry standard way of allowing two appl..."

== OAuth Workflow ==

When communicating with a 3rd Party REST API, it may be necessary to provide OAuth authentication. OAuth is an industry standard way of allowing two applications to talk to each other without having to share your username and password. In this case it means the 3rd party API has your credentials, but Hubitat Elevation will not.

The first step to supporting OAuth in your app is to enable it following the directions listed at https://docs.hubitat.com/index.php?title=How_to_Install_Custom_Apps

You will then need to create an access token done using <code>createAccessToken()</code>. Calling this method will automatically store the access token in `state.accessToken`.

You will next need to redirect the user to the API's OAuth endpoint. The URL should be provided by the vendor. Traditionally you will need to specify the following query string parameters:

* response_type=code
* client_id=valueProvidedByVendorAPI
* scope=scopesAvailableInVendorAPI
* redirect_uri=https://cloud.hubitat.com/oauth/stateredirect
* state=urlPathToRedirectToAfterOAuth

The value of state should be set to a webservice endpoint in your App (defined using <code>mappings</code>). The value will look like:
<code>${getHubUID()}/apps/${app.id}/yourWebserviceNameHere?access_token=${state.accessToken}</code>

After the user authorizes your App through the vendor's website, they will be redirected to your URL so that you can continue the OAuth process.

At this point you will need to request the OAuth token. This is done, usually, via a POST method to an API endpoint provided by the vendor. Traditionally you will pass the following in the body or query string depending on the vendor:

* grant_type=authorization_code
* code=authCodePassedInQueryStringToWebserviceMethod
* client_id=valueProvidedByVendorAPI
* redirect_uri=https://cloud.hubitat.com/oauth/stateredirect

Consult the vendor's API documentation for the exact parameters.

At this point you will receive a result that includes both the token and your refresh token. Consult the vendor's documentation for information on how frequently you must refresh the token and how to supply the token to each REST API call.

Developer Documentation

2020-06-07T21:21:47Z

Dman2306: /* App Structure */

Location Object

2020-05-15T19:03:26Z

Dman2306: /* getTimeFormat */

The Location object is composed of methods that allow you to interact with the settings and values of a location. This object is available to Apps and Drivers via the "getLocation()" method or simply using the property "location".

==Properties==
===<code>id</code>===
A unique id for the location, as a Long.
===<code>name</code>===
The name of the location as a String.
===<code>temperatureScale</code>===
The temperature scale of the location as a String (C or F).
===<code>timeZone</code>===
The time zone of the location as a TimeZone object.
===<code>zipCode</code>===
The zip code of the location as a String.
===<code>latitude</code>===
The latitude of the location as a BigDecimal.
===<code>longitude</code>===
The longitude of the location as a BigDecimal.
===<code>sunrise</code>===
The sunrise of the location as a Date.
===<code>sunset</code>===
The sunset of the location as a Date.
===<code>hsmStatus</code>===
The current status of the Hubitat Safety Monitor. This is a String of one of the following values: armedAway, armingAway, armedHome, armingHome, armedNight, armingNight, disarmed, allDisarmed
===<code>hubs</code>===
A list of hubs for this location as a List<Hub>. In Hubitat there is only one Hub in the list.
===<code>hub</code>===
The Hub for this location.

==Methods==
===<code>getFormattedLatitude</code>===
===<code>getFormattedLongitude</code>===
===<code>getTimeFormat</code>===
:Retrieves whether or not the hub is set to 12 or 24 hour time.

:;Signature
:: <code>int getTimeFormat()</code>

:;Returns
:: 12 if the time is set to 12 hour (am/pm), 24 if it is set to 24 hour.

===<code>getModes</code>===
:Get a list of modes for the location.

:;Signature
:: <code>List<Mode> getModes()</code>

===<code>getMode</code>===
:Get the current mode of the location.

:;Signature
:: <code>String getMode()</code>

===<code>setMode</code>===
===<code>currentMode</code>===

Device Code

2020-04-16T18:54:21Z

Dman2306: Initial work on describing the code inside a device driver.

==Overview==
The bulk of the work a driver does is done inside it's general code section. This is where you write methods and members using the Groovy programming language to define how you driver functions. Drivers can be very different depending on what they do. A driver that communicates with a ZWave device is going to look very different than one that is a virtual device with nothing physical in the real world or one that communicates over Telnet to a LAN device. This article gives you a general overview of device driver code but they will vary greatly depending on what the device driver is intended to do.

==Built-In Callback Methods==
Device drivers can contain a few built-in callback methods that are triggered but the Hubitat environment in response to certain actions.

===<code>installed</code>===
:This method is called when the device is first created and can be used to initialize any device specific configuration and setup.

:;Signature
:: <code>void installed()</code>

===<code>uninstalled</code>===
:This method is called when the device is removed to allow for any necessary cleanup.

:;Signature
:: <code>void uninstalled()</code>

===<code>updated</code>===
:This method is called when the preferences of a device are updated.

:;Signature
:: <code>void updated()</code>

===<code>parse</code>===
:This method is called in response to a message received by the device driver. Depending on the driver this could be from any number of sources. This could be a Z-Wave message, Zigbee message, telnet message, websocket message, etc. Depending on the type of message received you will likely need to parse the <code>description</code> string into something more useful. The following list of methods are useful for decoding the description:

:* MQTT - <code>interfaces.mqtt.parseMessage</code>
:* RAW_LAN - <code>parseLanMessage</code>
:* Zigbee - <code>zigbee.parse</code>
:* Z-Wave - <code>zwave.parse</code>

:;Signature
:: <code>Event parse(String description)</code>

==User Defined Methods==
User defined methods are where your driver does "everything else." It is where you implement commands, define callbacks for scheduled events, create callbacks for event subscriptions, etc. Essentially you can do just about anything in a user defined method that you can do in a normal Groovy method.

InstalledApp Object

2020-04-08T16:47:25Z

Dman2306: Added getid documentation

===<code>getId</code>===
: Returns the internal ID that represents the installed app in Hubitat.

:;Signature
:: <code>Long getId()</code>

:;Parameters
::None

:;Returns
::The internal ID of the current app.

===<code>getInstallationState</code>===
:Returns a value indicating whether the app is currently installed or, if you are in the initial setup, that it is not.

:;Signature
:: <code>String getInstallationState()</code>

:;Parameters
::None

:;Returns
::<code>COMPLETE</code> if the app is installed, otherwise <code>INCOMPLETE</code>.

=== <code>getLabel</code> ===
:Get the current label of the installed app.

:;Signature
:: <code>String getLabel()</code>

:;Parameters
::None

:;Returns
::The current label of the installed app

:;Example
def appLabel = app.getLabel()
log.debug "app label is ${appLabel}"

=== <code>updateLabel</code> ===
:Update the label of the installed app

:;Signature
::void updateLabel(String label)

:;Parameters
::label - new label for installed app

:;Returns
::None

===<code>updateSetting</code>===
:Updates the value of a setting (preference) to the specified value. If the setting does not exist, this method will create it.

:;Signature
::<code>void updateSetting(String name, Long value)</code>
::<code>void updateSetting(String name, Boolean value)</code>
::<code>void updateSetting(String name, String value)</code>
::<code>void updateSetting(String name, Double value)</code>
::<code>void updateSetting(String name, Date value)</code>
::<code>void updateSetting(String name, List value)</code>

:;Parameters
::name - The name of the setting to update
::value - The value to store in the setting

:;Returns
::None

== <code>Additional Methods to Document</code> ==
void updateSetting(String name, Map options)
void removeSetting(String name)
void clearSetting(String name)
Long getName()
List<EventSubscriptionWrapper> getSubscriptions()

Device Definition

2020-04-07T02:23:35Z

Dman2306: Fixed a typo

==Overview==
The driver definition provides the Hubitat Elevation hub with information about a Driver you wish to install. The format is slightly different from an App as the definition must appear inside of a <code>metadata</code> block. Additionally it allows you to define the capabilities, commands, and attributes associated with the driver.

==Structure==
metadata {
definition(
...
) {
...
}
}

==Entries==
:: author - The author of this driver
:: description - A text description of the app that is displayed in the popup when the '''Add User App'' button is clicked
:: importUrl - The URL where the Groovy code for this app can be found
:: name - The name of the app
:: namespace - The namespace within which the Groovy class for the application will be stored

==Capabilities==
A device driver can provide one or more capabilities. Capabilities are defined by the Hubitat environment. When you specify that a driver supports a specific capability, you must also implement any commands it requires. The list of supported capabilities can be found on the [[Driver_Capability_List|Driver Capability List]]

===Syntax===
:: <code>capability "Capability Name"</code>

==Fingerprints==
Fingerprints provide a way for you to tell Hubitat how to identify a Zigbee or ZWave device based on certain properties and characteristics of the device.

===Zigbee===

====Syntax====
::<code>fingerprint profileId: "profileId", inClusters: "clusters", outClusters: "clusters", manufacturer: "manufacturerId", model: "modelId", deviceJoinName: "name"</code>

===Zwave===
====Syntax====
::<code>fingerprint deviceId: "id", inClusters: "clusters", outClusters: "clusters", mfr: "manufacturerId", prod: "productTypeId", deviceJoinName: "name"</code>

==Commands==
Sometimes you will work with a device that has a command that does not exist in one of the existing capabilities. Hubitat gives you the ability to define custom commands to support these scenarios. Commands can also have parameters allowing you to define how data is passed to the command.

===Parameters===
:: parameters - a list of the parameters to pass to the command. Each parameter is, itself, a map that defines details about the parameter. See below for information on defining parameters.

====Defining Parameters====
:: The simplest way of defining parameters is to just specify a list of types. The parameters can be of type <code>string</code>, <code>number</code>, <code>date</code>, <code>enum</code>, and <code>json_object</code>. When specified as a list of types, no validation is performed.

:: An example of this simple format is:
:: <code>command "myCommand", ["string", "number"]</code>

:: An expanded format also exists that allows you to provide more details about the parameter such as its name, whether or not it is required, and in the case of an enum, the available values. In this mode each parameter is specified as a map with the following entries:

:: name - The name of the parameter. If the name ends with an asterisk (*) the parameter is considered required.
:: type - The type of the parameter which can be any of <code>STRING</code>, <code>NUMBER</code>, <code>DATE</code>, <code>ENUM</code>, <code>JSON_OBJECT</code>, or <code>COLOR_MAP</code>. Note that a driver can only have a single command that accepts a <code>COLOR_MAP</code>.
:: description - The description of the parameter that is shown in the tooltip when you hover over the parameter.
:: constraints - A list of the valid options for an <code>ENUM</code>

===Syntax===
:: <code>command "commandName"</code>
:: <code>command "commandName", parameters</code>

==Attributes==
Sometimes you will work with a device that has an attribute that does not exist in one of the existing capabilities. Hubitat gives you the ability to define custom attributes to support these scenarios.

===Syntax===
:: <code>attribute "AttributeName", "type"</code>
:: <code>attribute "EnumAttribute", "enum", values</code>

===Parameters===
:: type - The type of the attribute. This can be <code>string</code>, <code>number</code>, or <code>enum</code>.
:: values - If the type is enum, you must also provide a Groovy list of values that the enum accepts.

==Example==
definition(
name: "My First Driver",
namespace: "myfirstdriver",
author: "John Smith"
) {
capability "Actuator"
capability "Switch"

command "myCommand"

attribute "myAttribute", "string"
attribute "enumAttribute", "enum", ["value 1", "value 2"]
}

InstalledApp Object

2020-04-05T18:22:23Z

Dman2306: fixed an example that was formatted incorrectly and documented most of the updateSetting overloads.

===<code>getInstallationState</code>===
:Returns a value indicating whether the app is currently installed or, if you are in the initial setup, that it is not.

:;Signature
:: <code>String getInstallationState()</code>

:;Parameters
::None

:;Returns
::<code>COMPLETE</code> if the app is installed, otherwise <code>INCOMPLETE</code>.

=== <code>getLabel</code> ===
:Get the current label of the installed app.

:;Signature
:: <code>String getLabel()</code>

:;Parameters
::None

:;Returns
::The current label of the installed app

:;Example
def appLabel = app.getLabel()
log.debug "app label is ${appLabel}"

=== <code>updateLabel</code> ===
:Update the label of the installed app

:;Signature
::void updateLabel(String label)

:;Parameters
::label - new label for installed app

:;Returns
::None

===<code>updateSetting</code>===
:Updates the value of a setting (preference) to the specified value. If the setting does not exist, this method will create it.

:;Signature
::<code>void updateSetting(String name, Long value)</code>
::<code>void updateSetting(String name, Boolean value)</code>
::<code>void updateSetting(String name, String value)</code>
::<code>void updateSetting(String name, Double value)</code>
::<code>void updateSetting(String name, Date value)</code>
::<code>void updateSetting(String name, List value)</code>

:;Parameters
::name - The name of the setting to update
::value - The value to store in the setting

:;Returns
::None

== <code>Additional Methods to Document</code> ==
void updateSetting(String name, Map options)
void removeSetting(String name)
void clearSetting(String name)
Long getId()
Long getName()
List<EventSubscriptionWrapper> getSubscriptions()

Device Preferences

2020-04-05T18:17:20Z

Dman2306: Provides information on defining preferences for a driver

==Overview==
The driver preferences provides the Hubitat Elevation hub with user settings for the driver. Preferences for a driver are more simplistic than the preferences for an app as they all appear on a single page. Preferences are also different from an app in that they are defined within the metadata block.

==Structure==
metadata {
preferences {
...
}
}

==Entries==
Each entry within the preferences section is an <code>input</code> which is a single setting for the device.

===Input===
Each input must have a <code>name</code> and <code>type</code>. Depending on the <code>type</code> additional settings may also be required.

====Input Settings====
:: name - Uniquely identifies this setting
:: type - The data type of the setting which may be one of <code>bool</code>, <code>date</code>, <code>decimal</code>, <code>email</code>, <code>enum</code>, <code>number</code>, <code>password</code>, <code>time</code>, <code>text</code>.
:: title - The text to be shown in the driver UI
:: description - The long text description of the setting
:: required - [true/false] - Specifies whether or not this setting requires a value
:: defaultValue - The default value of the setting if none is specified
:: options - Only available when the type is <code>enum</code>. Allows you to specify the values that appear in the dropdown.
:: multiple - Only available when the type is <code>enum</code>. Specifies that multiple values can be selected from the dropdown.
:: range - Only available when the type is <code>number</code> or <code>decimal</code>. A string in the format <code>low..high</code> that specifies the range of valid numeric values.

==Example==
preferences {
input name: "settingName", type: "text", title: "My Setting", description: "Enter Setting Text", required: true
}

Device Definition

2020-04-05T17:47:27Z

Dman2306: Fingerprinting needs some work, I can't find any good info in the community forum that defines how fingerprinting works

HubAction Object

2020-04-05T16:03:10Z

Dman2306: Added an SSDP discovery example

===<code>Constructor</code>===

Create a HubAction object. While protocol is optional, it is recommended that it be provided. If it is not specified the system will default to the LAN protocol.

:;Signature
:: <code>HubAction()</code>
:: <code>HubAction(String request)</code>
:: <code>HubAction(String request, Protocol protocol, String dni)</code>
:: <code>HubAction(String request, Protocol protocol, String dni, Map options)</code>
:: <code>HubAction(String request, Protocol protocol)</code>
:: <code>HubAction(String request, Protocol protocol, Map options)</code>
:: <code>HubAction(Map params)</code>
:: <code>HubAction(Map params, String dni)</code>
:: <code>HubAction(Map params, String dni, Map options)</code>

:;Parameters
:: request - The command to send as a String, this can be a ZigBee, Z-Wave or Lan message to send.
:: protocol - The protocol to use when sending the message. See the Protocol documentation for more info.
:: dni - The device network Id to use when sending the message.
:: options - Optional settings when sending the command. See examples for usage. Possible values:
:::''callback'' - A method name to pass the response from the HubAction back to. If not specified the response will be handed to the parse method of a Device or will be discarded if this HubAction was called from an App.
:::''destinationAddress'' - The destination address to use when sending LAN messages. In the format ip:port, if no port is specified it defaults to 80.
:::''destinationPort'' - The port number to use when sending UPNP discovery messages. Defaults to 1900.
:::''type'' - The type of message to send if its not a standard HTTP request.
::::''HubAction.LAN_TYPE_UDPCLIENT'' - Send message as a UDP package.
::::''HubAction.LAN_TYPE_RAW'' - Send message as a raw TCP message.
:::''secureCode'' - Used as part of a wake on lan request.
:::''encoding''
:::''ignoreResponse'' - (true/false) Used as part of UDP messages, instructs the system to ignore any response from the device to this message.
:::''parseWarning'' - (true/false) Used as part of UDP messages, instructs the system to send any error message back to the parse method or callback method of the device. (Since 2.2.0)
:::''timeout'' - Used as part of UPD or TCP messages. Sets the timeout for response from the device, defaults to 10 seconds, acceptable range is 1 to 300.
:: params - a list of parameters for sending a Lan message. Possible values:
:::''method'' - The http method to use, ie GET, POST, etc.
:::''path'' - The path to access on the http endpoint.
:::''query'' - Any query parameters to use when calling the path.
:::''body'' - The request body to send.
:::''headers'' - Additional headers to use in the http request.

:;Examples

//Create and send a Z-Wave message
def hubAction = new hubitat.device.HubAction(new hubitat.zwave.commands.basicv1.BasicGet().format(), hubitat.device.Protocol.ZWAVE)
sendHubCommand(hubAction)

// Protocol.LAN examples

// Send UDP Message
new HubAction("My UDP Message", Protocol.LAN, [type: HubAction.Type.LAN_TYPE_UDPCLIENT])

// Send Binary UDP Message
new HubAction("48756269746174", Protocol.LAN, [type: HubAction.Type.LAN_TYPE_UDPCLIENT, encoding: HubAction.Encoding.HEX_STRING])

// Send Wake On Lan to mac address 00:11:22:33:44:55
new HubAction("wake on lan 00:11:22:33:44:55", Protocol.LAN)

// Send Wake On Lan to mac address 00:11:22:33:44:55 with secure code
new HubAction("wake on lan 00:11:22:33:44:55", Protocol.LAN, [secureCode: "112233"])

// Send a UPnP SSDP discovery message
new HubAction("lan discovery urn:schemas-somecompany-com:device:deviceName:1", Protocol.LAN)

===<code>getAction</code>===

Can be used to get the request value of the HubAction.

:;Signature
:: <code>String getAction()</code>

===<code>getCallbackMethod</code>===

:;Signature
:: <code>String getCallbackMethod()</code>

===<code>getURI</code>===

:;Signature
:: <code>URI getURI()</code>

Device Object

2020-04-05T15:51:59Z

Dman2306: Added documentation for most of the updateSetting overloads

The Device object (Technically DeviceWrapper, ChildDeviceWrapper and ParentDeviceWrapper) is composed of methods that allow you to interact with the settings and values of a device. This object is available to Apps that have been given access via a device selection input, as child devices of Apps and other devices and a driver also has access to this via the device object.

===<code>events</code>===
:Retrieve a list of events for the device. By default the maximum number of events returned in the list is 10 which can be overridden by the max option.

:;Signature
:: <code>List<Event> events()</code>
:: <code>List<Event> events(Map options)</code>

:;Parameters
::options - Optional values for getting the list of events. Possible values:
:::''max'' - The maximum number of events to retrieve.

:;Returns
::List of Event objects for the device

===<code>eventsSince</code>===
:Retrieve a list of events since a date/time.

:;Signature
:: <code>List<Event> eventsSince(Date startDate)</code>
:: <code>List<Event> eventsSince(Date startDate, Map options)</code>

:;Parameters
:: startDate - The date/time to list events since.
::options - Optional values for getting the list of events. Possible values:
:::''max'' - The maximum number of events to retrieve.

:;Returns
::A list of Events (defaults to 10 events unless otherwise specified in options)

:;Examples

// Get events since 8:00 am today
def events = eventsSince(timeToday("08:00"))

// Get a maximum of 5 events
def events = eventsSince(timeToday("08:00"), [max:5])

===<code>getName</code>===
:Retrieve the name of the device.

:;Signature
:: <code>String getName()</code>

:;Parameters
:: none

:;Returns
::String - The name of the device

===<code>setName</code>===
:Update the name of the device.

:;Signature
:: <code>void setName(String name)</code>

:;Parameters
::name - the new name for the device.

:;Returns
::none

===<code>getLabel</code>===
:Retrieve the label of the device.

:;Signature
:: <code>String getLabel()</code>

:;Parameters
:: none

:;Returns
::String - The label of the device

===<code>setLabel</code>===
:Update the label of the device.

:;Signature
:: <code>void setLabel(String label)</code>

:;Parameters
::label - the new label for the device.

:;Returns
::none

===<code>hasAttribute</code>===
:Determines if the device has the specified attribute. This works for both built-in and custom attributes.

:;Signature
::<code>Boolean hasAttribute(String attribute)</code>

:;Parameters
::attribute- The attribute to check for.

:;Returns
::True if the attribute exists, false otherwise.

===<code>hasCapability</code>===
:Determines if the device has the specified capability.

:;Signature
::<code>Boolean hasCapability(String capability)</code>

:;Parameters
::capability - The capability to check for.

:;Returns
::True if the capability exists, false otherwise.

===<code>hasCommand</code>===
:Determines if the device has the specified command. This works for both built-in and custom commands.

:;Signature
::<code> Boolean hasCommand(String command)</code>

:;Parameters
::command - The command to check for.

:;Returns
::True if the command exists, false otherwise.

===<code>updateSetting</code>===
:Updates the value of a setting (preference) to the specified value. If the setting does not exist, this method will create it.

:;Signature
::<code>void updateSetting(String name, Long value)</code>
::<code>void updateSetting(String name, Boolean value)</code>
::<code>void updateSetting(String name, String value)</code>
::<code>void updateSetting(String name, Double value)</code>
::<code>void updateSetting(String name, Date value)</code>
::<code>void updateSetting(String name, List value)</code>

:;Parameters
::name - The name of the setting to update
::value - The value to store in the setting

:;Returns
::None

==<code>Additional to be documented</code>==
List<Event> eventsBetween(Date startDate, Date endDate)
List<Event> eventsBetween(Date startDate, Date endDate, Map options = null)
List<State> statesSince(String attributeName, Date startDate)
List<State> statesSince(String attributeName, Date startDate, Map options = null)
void sendEvent(Map properties)
void updateSetting(String name, Map options)
void removeSetting(String name)
void clearSetting(String name)
Long getIdAsLong()
String getId()
String getEndpointId()
String getZigbeeId()
Hub getHub()
Map getData()
void updateDataValue(String name, String value)
String getDataValue(String name)
String getDeviceDataByName(String name)
String getStatus()
String getDisplayName()
void setDisplayName(String displayName)
String getDeviceNetworkId()
void setDeviceNetworkId(String dni)
Object currentValue(String attributeName)
Object currentValue(String attributeName, boolean skipCache)
State currentState(String attributeName)
State currentState(String attributeName, boolean skipCache)
Object latestValue(String attributeName)
Object latestValue(String attributeName, boolean skipCache)
State latestState(String attributeName)
State latestState(String attributeName, boolean skipCache)
List<State> getCurrentStates()
List<Command> getSupportedCommands()
List<Attribute> getSupportedAttributes()
List<Capability> getCapabilities()
Date getLastActivity()
Long getParentDeviceId()
Long getParentAppId()
Boolean getIsComponent()
boolean isDisabled()

Location Object

2020-04-05T14:25:48Z

Dman2306: Added missing hsmStatus property

The Location object is composed of methods that allow you to interact with the settings and values of a location. This object is available to Apps and Drivers via the "getLocation()" method or simply using the property "location".

==Properties==
===<code>id</code>===
A unique id for the location, as a Long.
===<code>name</code>===
The name of the location as a String.
===<code>temperatureScale</code>===
The temperature scale of the location as a String (C or F).
===<code>timeZone</code>===
The time zone of the location as a TimeZone object.
===<code>zipCode</code>===
The zip code of the location as a String.
===<code>latitude</code>===
The latitude of the location as a BigDecimal.
===<code>longitude</code>===
The longitude of the location as a BigDecimal.
===<code>sunrise</code>===
The sunrise of the location as a Date.
===<code>sunset</code>===
The sunset of the location as a Date.
===<code>hsmStatus</code>===
The current status of the Hubitat Safety Monitor. This is a String of one of the following values: armedAway, armingAway, armedHome, armingHome, armedNight, armingNight, disarmed, allDisarmed
===<code>hubs</code>===
A list of hubs for this location as a List<Hub>. In Hubitat there is only one Hub in the list.
===<code>hub</code>===
The Hub for this location.

==Methods==
===<code>getFormattedLatitude</code>===
===<code>getFormattedLongitude</code>===
===<code>getTimeFormat</code>===
===<code>getModes</code>===
:Get a list of modes for the location.

:;Signature
:: <code>List<Mode> getModes()</code>

===<code>getMode</code>===
:Get the current mode of the location.

:;Signature
:: <code>String getMode()</code>

===<code>setMode</code>===
===<code>currentMode</code>===

App Definition

2020-04-05T00:43:52Z

Dman2306: Overview of the definition section of an app

==Overview==
The app definition provides the Hubitat Elevation hub with information about an App you wish to install.

==Structure==
definition(
...
)

==Entries==
:: author - The author of this app
:: category - A category description of this app
:: description - A text description of the app that is displayed in the popup when the '''Add User App'' button is clicked
:: documentationLink - A link to the documentation for this app
:: iconUrl - Not currently used, should be set to an empty string
:: iconX2Url - Not currently used, should be set to an empty string
:: iconX3Url - Not currently used, should be set to an empty string
:: importUrl - The URL where the Groovy code for this app can be found
:: name - The name of the app
:: namespace - The namespace within which the Groovy class for the application will be stored
:: oauth - [true/false] - defines whether this app makes use of OAuth
:: parent - If this is a child app, specifies the parent app in the format <code>namespace</code>:<code>app name</code>
:: singleInstance - [true/false] - If set to true, on a single instance of this app can be installed. The default is false
:: videoLink - A link to a video recording associated with this app

==Example==
definition(
name: "My First App",
namespace: "myfirstapp",
author: "John Smith",
description: "This is the first Hubitat app I've created",
category: "General",
iconUrl: "",
iconX2Url: "",
iconX3Url: ""
)

Developer Documentation

2020-04-05T00:33:47Z

Dman2306: Added links for sections of an app and driver

App Object

2020-04-02T15:41:08Z

Dman2306: Added a few more api url methods

==Provided Methods==
===<code>createAccessToken</code>===
:Creates an OAuth access token that can be used as part of the OAuth functionality of a properly configured app. The function will return the token, but will also automatically set the state variable <code>state.accessToken</code> to the return value. This value can then be passed to any API Endpoint (for example those defined in the <code>mappings</code> section of an app) using a query string parameter called <code>access_token</code>.

:;Signature
:: <code>String createAccessToken()</code>

:;Parameters
::None

:;Returns
::The OAuth access token.

===<code>getApiServerUrl</code>===
:Returns the base URL of the Hubitat cloud API.

:;Signature
:: <code>String getApiServerUrl()</code>

:;Parameters
::None

:;Returns
::The base URL of the Hubitat cloud API, generally https://cloud.hubitat.com/api

===<code>getFullApiServerUrl</code>===
:Returns the full URL of the Hubitat cloud API for a specific App.

:;Signature
:: <code>String getFullApiServerUrl()</code>

:;Parameters
::None

:;Returns
::The URL of the Hubitat cloud API for the app, generally https://cloud.hubitat.com/api/<code>hubid</code>/apps/<code>appid</code>

===<code>getLocalApiServerUrl</code>===
:Returns the base URL of the Hubitat local API.

:;Signature
:: <code>String getLocalApiServerUrl()</code>

:;Parameters
::None

:;Returns
::The base URL of the Hubitat local API, generally https://<code>hubip</code>/apps/api

===<code>getFullLocalApiServerUrl</code>===
:Returns the base URL of the Hubitat local API for a specific App.

:;Signature
:: <code>String getFullLocalApiServerUrl()</code>

:;Parameters
::None

:;Returns
::he URL of the Hubitat local API for the app, generally generally https://<code>hubip</code>/apps/api/<code>appid</code>

===<code>getHubUID</code>===
:Retrieves a unique identifier that represents your hub.

:;Signature
:: <code>String getHubUID()</code>

:;Parameters
:: None

:;Returns
:: A UUID that uniquely identifies your hub.

===<code>subscribe</code>===
:Subscribe to events sent from a device, app or location.

:;Signature
:: <code>void subscribe(InstalledAppWrapper app, handlerMethod)</code>
:: <code>void subscribe(Location location, handlerMethod)</code>
:: <code>void subscribe(DeviceWrapper device, String attributeName, handlerMethod, Map options = null)</code>
:: <code>void subscribe(DeviceWrapperList devices, String attributeName, handlerMethod, Map options = null)</code>
:: <code>void subscribe(Location location, String attributeName, handlerMethod, Map options = null)</code>

:;Parameters
::app - Installed App to subscribe to.
::location - Location to subscribe to.
::device - Device to subscribe to.
::handlerMethod - The method to run when an event is received.
::attributeName - The name of the attribute to subscribe to.
::options - Optional values to configure the subscribe. Possible values:
:::''filterEvents'' - Used for device subscriptions. Set to false to receive all events, defaults to true and events that do not have a changed value will not be processed.

===<code>unsubscribe</code>===
:Unsubscribe from events sent from a device or all event subscriptions.

:;Signature
:: <code>void unsubscribe()</code>
:: <code>void unsubscribe(DeviceWrapper device)</code>
:: <code>void unsubscribe(List<DeviceWrapper> deviceList)</code>
:: <code>void unsubscribe(DeviceWrapper device, String attributeName)</code> (Since 2.0.7)
:: <code>void unsubscribe(List<DeviceWrapper> deviceList, String attributeName)</code> (Since 2.1.0)
:: <code>void unsubscribe(DeviceWrapper device, String attributeName, String handlerMethod)</code> (Since 2.1.0)
:: <code>void unsubscribe(List<DeviceWrapper> deviceList, String attributeName, String handlerMethod)</code> (Since 2.1.0)
:: <code>void unsubscribe(InstalledAppWrapper installedApp)</code> (Since 2.1.2)
:: <code>void unsubscribe(Location location)</code> (Since 2.1.2)
:: <code>void unsubscribe(Location location, String attributeName)</code> (Since 2.1.2)
:: <code>void unsubscribe(String handlerMethod)</code> (Since 2.1.2)

:;Parameters
::device - The device to unsubscribe from.
::deviceList - A list of devices to unsubscribe from.
::attributeName - which attribute you want to unsubscribe from.
::handlerMethod - The name of a method which was subscribed to a device event.
::location - The location to unsubscribe from.
::installedApp - The installed app to unsubscribe from.

:;Returns
::None

===<code>addChildDevice</code>===
:Creates a new child device and returns that device from the method call.

:;Signature
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId)</code> (since 2.1.9)
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Map properties)</code> (since 2.1.9)
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Long hubId)</code> (deprecated)
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Long hubId, Map properties)</code> (deprecated)

:;Parameters
::namespace - The namespace of the child driver to add as a child device (optional, if not specified it will default the the namespace of the parent)
::typeName - The name of the child driver to add as a child device
::deviceNetworkId - unique identifier for this device
::hubId - present for backwards compatibility, pass 1.
::properties - optional parameters for this child device. Possible values listed below

:;Properties
::boolean isComponent - true or false, if true, device will still show up in device list but will not be able to be deleted or edited in the UI. If false, device can be modified/deleted on the UI.
::String name - name of child device, if not specified, driver name is used.
::String label - label of child device, if not specified it is left blank.

:;Returns
::ChildDeviceWrapper

===<code>getChildDevices</code>===
:Gets a list of all child devices for this device.

:;Signature
:: <code>List<ChildDeviceWrapper> getChildDevices()</code>
:: <code>List<ChildDeviceWrapper> getAllChildDevices()</code>

:;Parameters
::None

:;Returns
::List<ChildDeviceWrapper>

===<code>getChildDevice</code>===
:Gets a specific child device with the device network id specified.

:;Signature
:: <code>ChildDeviceWrapper getChildDevice(String deviceNetworkId)</code>

:;Parameters
::deviceNetworkId - The unique identifier for the device

:;Returns
::ChildDeviceWrapper

===<code>deleteChildDevice</code>===
:Deletes a specific child device with the device network id sepcified.

:;Signature
:: <code>void deleteChildDevice(String deviceNetworkId)</code>

:;Parameters
::deviceNetworkId - The unique identifier for the device

:;Returns
::None

==User Defined Methods==
===<code>installed</code>===
:This method is called when the app is first installed.

:;Signature
:: <code>void installed()</code>

===<code>updated</code>===
:This method is called when the preferences of an installed app are updated.

:;Signature
:: <code>void updated()</code>

===<code>uninstalled</code>===
:This method is called when the app is uninstalled. This method can be used to do any cleanup that is necessary.

:;Signature
:: <code>void uninstalled()</code>

== <code>Additional to be documented</code> ==
Map getState()
String apiServerUrl(String url)
String localApiServerUrl(String url)
String fullLocalApiServerUrl(String url)
void setLocationMode(String mode)
void pause(Long millisecs)
InstalledAppWrapper getParent()
InstalledAppWrapper addChildApp(String namespace, String name, String label, Map properties = null)
void deleteChildApp(Long childAppId)
DeviceWrapper getSubscribedDeviceById(Long deviceId)
void sendEvent(Map properties)
void sendEvent(DeviceWrapper device, Map properties)
void sendEvent(String dni, Map properties)
List<Event> getLocationEventsSince(String attributeName, Date startDate, Map options = null)
void subscribe(Object thing, String attributeName, handlerMethod, Map options = null)
void subscribe(location, handlerMethod)
List<InstalledApp> getAllChildApps()
List<InstalledApp> getChildApps()
InstalledAppWrapper getChildAppById(Long childAppId)
InstalledAppWrapper getChildAppByLabel(String childAppLabel)

InstalledApp Object

2020-04-02T15:18:07Z

Dman2306:

===<code>getInstallationState</code>===
:Returns a value indicating whether the app is currently installed or, if you are in the initial setup, that it is not.

:;Signature
:: <code>String getInstallationState()</code>

:;Parameters
::None

:;Returns
::<code>COMPLETE</code> if the app is installed, otherwise <code>INCOMPLETE</code>.

=== <code>getLabel</code> ===
:Get the current label of the installed app.

:;Signature
:: <code>String getLabel()</code>

:;Parameters
::None

:;Returns
::The current label of the installed app

:;Example
::<code> def appLabel = app.getLabel()
log.debug "app label is ${appLabel}"</code>

=== <code>updateLabel</code> ===
:Update the label of the installed app

:;Signature
::void updateLabel(String label)

:;Parameters
::label - new label for installed app

:;Returns
::None

== <code>Additional Methods to Document</code> ==
void updateSetting(String name, Map options)
void updateSetting(String name, Long value)
void updateSetting(String name, Boolean value)
void updateSetting(String name, String value)
void updateSetting(String name, Double value)
void updateSetting(String name, Date value)
void updateSetting(String name, List value)
void removeSetting(String name)
void clearSetting(String name)
Long getId()
Long getName()
List<EventSubscriptionWrapper> getSubscriptions()

Device Object

2020-04-02T14:55:25Z

Dman2306: Added hasAttribute, hasCapability, and hasCommand

The Device object (Technically DeviceWrapper, ChildDeviceWrapper and ParentDeviceWrapper) is composed of methods that allow you to interact with the settings and values of a device. This object is available to Apps that have been given access via a device selection input, as child devices of Apps and other devices and a driver also has access to this via the device object.

===<code>events</code>===
:Retrieve a list of events for the device. By default the maximum number of events returned in the list is 10 which can be overridden by the max option.

:;Signature
:: <code>List<Event> events()</code>
:: <code>List<Event> events(Map options)</code>

:;Parameters
::options - Optional values for getting the list of events. Possible values:
:::''max'' - The maximum number of events to retrieve.

:;Returns
::List of Event objects for the device

===<code>eventsSince</code>===
:Retrieve a list of events since a date/time.

:;Signature
:: <code>List<Event> eventsSince(Date startDate)</code>
:: <code>List<Event> eventsSince(Date startDate, Map options)</code>

:;Parameters
:: startDate - The date/time to list events since.
::options - Optional values for getting the list of events. Possible values:
:::''max'' - The maximum number of events to retrieve.

:;Returns
::A list of Events (defaults to 10 events unless otherwise specified in options)

:;Examples

// Get events since 8:00 am today
def events = eventsSince(timeToday("08:00"))

// Get a maximum of 5 events
def events = eventsSince(timeToday("08:00"), [max:5])

===<code>getName</code>===
:Retrieve the name of the device.

:;Signature
:: <code>String getName()</code>

:;Parameters
:: none

:;Returns
::String - The name of the device

===<code>setName</code>===
:Update the name of the device.

:;Signature
:: <code>void setName(String name)</code>

:;Parameters
::name - the new name for the device.

:;Returns
::none

===<code>getLabel</code>===
:Retrieve the label of the device.

:;Signature
:: <code>String getLabel()</code>

:;Parameters
:: none

:;Returns
::String - The label of the device

===<code>setLabel</code>===
:Update the label of the device.

:;Signature
:: <code>void setLabel(String label)</code>

:;Parameters
::label - the new label for the device.

:;Returns
::none

===<code>hasAttribute</code>===
:Determines if the device has the specified attribute. This works for both built-in and custom attributes.

:;Signature
::<code>Boolean hasAttribute(String attribute)</code>

:;Parameters
::attribute- The attribute to check for.

:;Returns
::True if the attribute exists, false otherwise.

===<code>hasCapability</code>===
:Determines if the device has the specified capability.

:;Signature
::<code>Boolean hasCapability(String capability)</code>

:;Parameters
::capability - The capability to check for.

:;Returns
::True if the capability exists, false otherwise.

===<code>hasCommand</code>===
:Determines if the device has the specified command. This works for both built-in and custom commands.

:;Signature
::<code> Boolean hasCommand(String command)</code>

:;Parameters
::command - The command to check for.

:;Returns
::True if the command exists, false otherwise.

==<code>Additional to be documented</code>==
List<Event> eventsBetween(Date startDate, Date endDate)
List<Event> eventsBetween(Date startDate, Date endDate, Map options = null)
List<State> statesSince(String attributeName, Date startDate)
List<State> statesSince(String attributeName, Date startDate, Map options = null)
void sendEvent(Map properties)
void updateSetting(String name, Map options)
void updateSetting(String name, Long value)
void updateSetting(String name, Boolean value)
void updateSetting(String name, String value)
void updateSetting(String name, Double value)
void updateSetting(String name, Date value)
void updateSetting(String name, List value)
void removeSetting(String name)
void clearSetting(String name)
Long getIdAsLong()
String getId()
String getEndpointId()
String getZigbeeId()
Hub getHub()
Map getData()
void updateDataValue(String name, String value)
String getDataValue(String name)
String getDeviceDataByName(String name)
String getStatus()
String getDisplayName()
void setDisplayName(String displayName)
String getDeviceNetworkId()
void setDeviceNetworkId(String dni)
Object currentValue(String attributeName)
Object currentValue(String attributeName, boolean skipCache)
State currentState(String attributeName)
State currentState(String attributeName, boolean skipCache)
Object latestValue(String attributeName)
Object latestValue(String attributeName, boolean skipCache)
State latestState(String attributeName)
State latestState(String attributeName, boolean skipCache)
List<State> getCurrentStates()
List<Command> getSupportedCommands()
List<Attribute> getSupportedAttributes()
List<Capability> getCapabilities()
Date getLastActivity()
Long getParentDeviceId()
Long getParentAppId()
Boolean getIsComponent()
boolean isDisabled()

Common Methods Object

2020-04-02T14:41:55Z

Dman2306: Added temperature conversion methods

These methods can be used in both Apps and Drivers

===<code>celsiusToFahrenheit</code>===
:Converts a given Celsius temperature to Fahrenheit.

:;Signature
:: <code>BigDecimal celsiusToFahrenheit(BigDecimal val)</code>

:;Parameters
:: A temperature in Celsius.

:;Returns
:: The specified temperature in Fahrenheit.

===<code>fahrenheitToCelsius</code>===
:Converts a given Fahrenheit temperature to Celsius

:;Signature
:: <code>BigDecimal fahrenheitToCelsius(BigDecimal val)</code>

:;Parameters
:: A temperature in Fahrenheit.

:;Returns
:: The specified temperature in Celsius.

===<code>getLocation</code>===
:;Signature
:: <code>Location getLocation()</code>

===<code>getSunriseAndSunset</code>===
:Returns the sunset and sunrise values for the current day. (Common method since 2.1.0)

:;Signature
:: <code>Map getSunriseAndSunset()</code>
:: <code>Map getSunriseAndSunset(Map options)</code>

:;Parameters
:: options - Map with optional offset for sunrise or sunset, possible values are sunriseOffset and sunsetOffset and can either be a number of minutes or a String of the format Hours:Minutes

:;Returns
:: Map with with key values 'sunrise' and 'sunset' of type Date

:;Examples

// get today's sunrise and sunset
def riseAndSet = getSunriseAndSunset()
log.debug riseAndSet.sunrise
log.debug riseAndSet.sunset

// get sunrise time offset by 1 minute early, and get sunset offset by 1 hour, 5 minutes later
def offsetRiseAndSet = getSunriseAndSunset(sunriseOffset: -1, sunsetOffset: "1:05")

===<code>getTemperatureScale</code>===
:Get the current temperature scale set for the hub.

:;Signature
:: <code>String getTemperatureScale()</code>

:;Parameters
:: none

:;Returns
:: String - "F" or "C" based on the setting in the hub.

===<code>now</code>===
:;Signature
:: long now()

===<code>timeToday</code>===
: Get a Date object with today's date and the time specified

:;Signature
:: <code>Date timeToday(String timeString, TimeZone timeZone = null)</code>

:;Parameters
:: timeString - The time to use, can be either "HH:mm" or and ISO8601 date/time string
:: timeZone - (Optional) The timezone to use for the new Date.

:;Returns
:: Date - A Date object with today's date and the time that was passed as timeString

===<code>timeOfDayIsBetween</code>===
:Check if a date is between two dates.

:;Signature
:: <code>boolean timeOfDayIsBetween(Date start, Date stop, Date value[, TimeZone timeZone])</code>

:;Parameters

:: start - The date to start comparison against.
:: stop - The date to stop comparison against.
:: value - The date to compare
:: timezone - (Optional) The timezone to use for the comparison

:;Returns
:: boolean - true if the value date is between the start and stop dates, otherwise returns false.

===<code>unschedule</code>===
:Remove any scheduled tasks. If method is called without paramters, all schedules will be removed.

:;Signature
:: <code>void unschedule()</code>
:: <code>void unschedule(handlerMethod)</code>

:;Parameters
:: handlerMethod - Only remove schedules for this handlerMethod

===<code>asynchttpGet</code>===
:Send an http GET request and return control to the calling code. Any response from the call will be passed to the callback method.

:;Signature
:: <code>void asynchttpGet(callbackMethod, Map params, Map data = null)</code>

:;Parameters
:: callbackMethod - The name of a callback method to send the response to. Can be null if the response can be ignored.
:: params - the parameters to use to build the http GET call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::data - optional data to be passed to the callback method.

===<code>asynchttpPost</code>===
:;Signature
::<code>void asynchttpPost(String callbackMethod = null, Map params, Map data = null)</code>

:;Parameters
::callbackMethod - The name of a callback method to send the response to. Can be null if the response can be ignored.
::params - the parameters to use to build the http GET call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::data - optional data to be passed to the callback method.

===<code>asynchttpPatch</code>===
:;Signature
::<code>void asynchttpPatch(String callbackMethod = null, Map params, Map data = null)</code>

:;Parameters
::callbackMethod - The name of a callback method to send the response to. Can be null if the response can be ignored.
::params - the parameters to use to build the http PATCH call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::data - optional data to be passed to the callback method.

===<code>httpGet</code>===
:Send an http GET request. Any response from the call will be passed to the closure.

:;Signature
:: <code>void httpGet(String uri, Closure closure)</code>
:: <code>void httpGet(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::params - the parameters to use to build the http GET call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''textParser'' (since 2.1.1) - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>httpPost</code>===
:;Signature
:: <code>void httpPost(String uri, String body, Closure closure)</code>
:: <code>void httpPost(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::body - The body of the request as a String. Any encoding should be done before passing to the system.
::params - the parameters to use to build the http call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''textParser'' (since 2.1.1) - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>httpPostJson</code>===
:Similar to httpPost except that the contentType parameter is set to "application/json"
:;Signature
:: <code>void httpPostJson(String uri, String stringBody, Closure closure)</code>
:: <code>void httpPostJson(String uri, Map mapBody, Closure closure)</code>
:: <code>void httpPostJson(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::stringBody - The body of the request as a String. Any encoding should be done before passing to the system.
::mapBody - The body of the request as a Map.
::params - the parameters to use to build the http call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it as JSON.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''textParser'' (since 2.1.8) - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>httpPut</code>===
:;Signature
:: <code>void httpPut(String uri, String body, Closure closure)</code>
:: <code>void httpPut(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::body - The body of the request as a String. Any encoding should be done before passing to the system.
::params - the parameters to use to build the http call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''textParser'' (since 2.1.1) - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>httpPatch (Since 2.1.7)</code>===
:;Signature
:: <code>void httpPatch(String uri, String body, Closure closure)</code>
:: <code>void httpPatch(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::body - The body of the request as a String. Any encoding should be done before passing to the system.
::params - the parameters to use to build the http call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' - timeout in seconds for the request, max timeout is 300
:::''textParser'' - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>runIn</code>===
:;Signature
::<code>void runIn(Long delayInSeconds, String handlerMethod, Map options = null)</code>

:;Parameters
::delayInSeconds - How long to wait in seconds until the handler should be called, don't expect that it will be called in exactly that time.
::handlerMethod - The name of a handler method in your driver or app. The method name should not contain parentheses.
::options - Optional values to control the scheduling of this method
:::''overwrite'' - defaults to true which cancels the previous scheduled running of the handler method and schedules new, if set to false this will create a duplicate schedule.
:::''data'' - optional data to be passed to the handler method.
:::''misfire'' - If set to "ignore" then the scheduler will simply try to fire it as soon as it can. NOTE: if a scheduler uses this instruction, and it has missed several of its scheduled firings, then several rapid firings may occur as the scheduler attempts to catch back up to where it would have been.

:;Example:
<pre>
runIn(50, 'myMethod', [data: ["myKey":"myValue"]])
</pre>

===<code>runInMillis</code>===
:;Signature
:: <code>void runInMillis(Long delayInMilliSeconds, String handlerMethod, Map options = null)</code>

:;Parameters
:: delayInMilliseconds - How long to wait until the handler should be called, don't expect that it will be called in exactly that time.
:: handlerMethod - the name of a handler method in your driver or app. The method name should not contain parentheses.
::options - Optional values to control the scheduling of this method
:::''overwrite'' - defaults to true which cancels the previous scheduled running of the handler method and schedules new, if set to false this will create a duplicate schedule.
:::''data'' - optional data to be passed to the handler method.
:::''misfire'' - If set to "ignore" then the scheduler will simply try to fire it as soon as it can. NOTE: if a schduler uses this instruction, and it has missed several of its scheduled firings, then several rapid firings may occur as the scheduler attempts to catch back up to where it would have been.

:;Example:
<pre>
private processQueue(Map queue) {
if (isQueueEmpty(queue)) {
sendEvent name: 'lifxdiscovery', value: 'complete'
return
}
def data = getNext(queue)
sendPacket data.ipAddress, data.packet
runInMillis(queue.delay, 'processQueue', [data: queue])
}

runInMillis(50, 'processQueue', [data: queue])
</pre>

===<code>pauseExecution</code>===
:;Signature
:: <code> void pauseExecution(Long millisecs)</code>

:;Parameters
:: millisecs - The amount of time in milliseconds to pause.

===<code>textToSpeech</code>===
:Converts text to speech.

:;Signature
:: <code> Map textToSpeech(String stringToBeSynthesized, String voice = null)</code>

:;Parameters
::stringToBeSynthesized - The text to be converted to audio. The text may contain supported [https://docs.aws.amazon.com/polly/latest/dg/supportedtags.html SSML tags].
::voice - The name of a voice supported by Amazon Polly, you can find a list of voices [https://docs.aws.amazon.com/polly/latest/dg/voicelist.html here]. If not specified the default system setting is used.

:;Returns
:: Map - Returns a Map with two entries, <code>uri</code> which contains a URI to the MP3 file and <code>duration</code> is the length of the MP3 in seconds.

===<code>getTTSVoices</code>===
:Returns a list of the supported text-to-speech voices.

:;Signature
:: <code> Map getTTSVoices()</code>

:;Parameters
::None

:;Returns
:: Map - Returns a Map with three entries <code>name</code> which is the name of a voice that can be specified to <code>textToSpeech</code>, <code>gender</code> which contains either Male or Female, and <code>language</code> which contains the language of this voice.

===<code>toDateTime</code>===
:;Signature
:: <code>Date toDateTime(String dateTimeString)</code>

:;Parameters
::dateTimeString - A date/time string in ISO8601 format. ("yyyy-MM-dd", "yyyyMMdd'T'HHmmssX", "yyyy-MM-dd'T'HH:mm:ssX", "yyyy-MM-dd'T'HH:mm:ss.SSSX")

==<code>Additional to be documented</code>==

'''Signature:'''
void httpPutJson(String uri, String body, Closure closure)
void httpPutJson(String uri, Map body, Closure closure)
void httpPutJson(Map params, Closure closure)
void httpDelete(Map params, Closure closure)
String getMACFromIP(String ipAddr)
String convertTemperatureIfNeeded(BigDecimal value, String scale, Integer precision)
Object parseJson(String stringToParse)
GPathResult parseXML(String stringToParse)
Map parseLanMessage(String stringToParse)
void runEvery1Minute(String handlerMethod, Map options = null)
void runEvery5Minutes(String handlerMethod, Map options = null)
void runEvery10Minutes(String handlerMethod, Map options = null)
void runEvery15Minutes(String handlerMethod, Map options = null)
void runEvery30Minutes(String handlerMethod, Map options = null)
void runEvery1Hour(String handlerMethod, Map options = null)
void runEvery3Hours(String handlerMethod, Map options = null)
void runOnce(Date dateTime, String handlerMethod, Map options = null)
void runOnce(String dateTime, String handlerMethod, Map options = null)
void schedule(Date dateTime, String handlerMethod, Map options = null)
void schedule(String expression, String handlerMethod, Map options = null)
void asynchttpPut(String callbackMethod = null, Map params, Map data = null)
void asynchttpDelete(String callbackMethod = null, Map params, Map data = null)
void asynchttpHead(String callbackMethod = null, Map params, Map data = null)
String encrypt(String value)
String decrypt(String value)
void sendLocationEvent(Map properties)
Date timeTodayAfter(String startTimeString, String timeString, TimeZone timeZone = null) (Common method since 2.1.0)
Long timeOffset(Number minutes) (Common method since 2.1.0)
Long timeOffset(String hoursAndMinutesString) (Common method since 2.1.0)

App Object

2020-04-01T17:42:50Z

Dman2306: Added getHubUID, removed getApiServerUrl and createAccessToken from the to-be-documented list since they now are

==Provided Methods==
===<code>createAccessToken</code>===
:Creates an OAuth access token that can be used as part of the OAuth functionality of a properly configured app. The function will return the token, but will also automatically set the state variable <code>state.accessToken</code> to the return value. This value can then be passed to any API Endpoint (for example those defined in the <code>mappings</code> section of an app) using a query string parameter called <code>access_token</code>.

:;Signature
:: <code>String createAccessToken()</code>

:;Parameters
::None

:;Returns
::The OAuth access token.

===<code>getApiServerUrl</code>===
:Returns the base URL of the Hubitat cloud API.

:;Signature
:: <code>String getApiServerUrl()</code>

:;Parameters
::None

:;Returns
::The base URL of the Hubitat cloud API, generally https://cloud.hubitat.com/api

===<code>getHubUID</code>===
:Retrieves a unique identifier that represents your hub.

:;Signature
:: <code>String getHubUID()</code>

:;Parameters
:: None

:;Returns
:: A UUID that uniquely identifies your hub.

===<code>subscribe</code>===
:Subscribe to events sent from a device, app or location.

:;Signature
:: <code>void subscribe(InstalledAppWrapper app, handlerMethod)</code>
:: <code>void subscribe(Location location, handlerMethod)</code>
:: <code>void subscribe(DeviceWrapper device, String attributeName, handlerMethod, Map options = null)</code>
:: <code>void subscribe(DeviceWrapperList devices, String attributeName, handlerMethod, Map options = null)</code>
:: <code>void subscribe(Location location, String attributeName, handlerMethod, Map options = null)</code>

:;Parameters
::app - Installed App to subscribe to.
::location - Location to subscribe to.
::device - Device to subscribe to.
::handlerMethod - The method to run when an event is received.
::attributeName - The name of the attribute to subscribe to.
::options - Optional values to configure the subscribe. Possible values:
:::''filterEvents'' - Used for device subscriptions. Set to false to receive all events, defaults to true and events that do not have a changed value will not be processed.

===<code>unsubscribe</code>===
:Unsubscribe from events sent from a device or all event subscriptions.

:;Signature
:: <code>void unsubscribe()</code>
:: <code>void unsubscribe(DeviceWrapper device)</code>
:: <code>void unsubscribe(List<DeviceWrapper> deviceList)</code>
:: <code>void unsubscribe(DeviceWrapper device, String attributeName)</code> (Since 2.0.7)
:: <code>void unsubscribe(List<DeviceWrapper> deviceList, String attributeName)</code> (Since 2.1.0)
:: <code>void unsubscribe(DeviceWrapper device, String attributeName, String handlerMethod)</code> (Since 2.1.0)
:: <code>void unsubscribe(List<DeviceWrapper> deviceList, String attributeName, String handlerMethod)</code> (Since 2.1.0)
:: <code>void unsubscribe(InstalledAppWrapper installedApp)</code> (Since 2.1.2)
:: <code>void unsubscribe(Location location)</code> (Since 2.1.2)
:: <code>void unsubscribe(Location location, String attributeName)</code> (Since 2.1.2)
:: <code>void unsubscribe(String handlerMethod)</code> (Since 2.1.2)

:;Parameters
::device - The device to unsubscribe from.
::deviceList - A list of devices to unsubscribe from.
::attributeName - which attribute you want to unsubscribe from.
::handlerMethod - The name of a method which was subscribed to a device event.
::location - The location to unsubscribe from.
::installedApp - The installed app to unsubscribe from.

:;Returns
::None

===<code>addChildDevice</code>===
:Creates a new child device and returns that device from the method call.

:;Signature
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId)</code> (since 2.1.9)
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Map properties)</code> (since 2.1.9)
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Long hubId)</code> (deprecated)
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Long hubId, Map properties)</code> (deprecated)

:;Parameters
::namespace - The namespace of the child driver to add as a child device (optional, if not specified it will default the the namespace of the parent)
::typeName - The name of the child driver to add as a child device
::deviceNetworkId - unique identifier for this device
::hubId - present for backwards compatibility, pass 1.
::properties - optional parameters for this child device. Possible values listed below

:;Properties
::boolean isComponent - true or false, if true, device will still show up in device list but will not be able to be deleted or edited in the UI. If false, device can be modified/deleted on the UI.
::String name - name of child device, if not specified, driver name is used.
::String label - label of child device, if not specified it is left blank.

:;Returns
::ChildDeviceWrapper

===<code>getChildDevices</code>===
:Gets a list of all child devices for this device.

:;Signature
:: <code>List<ChildDeviceWrapper> getChildDevices()</code>
:: <code>List<ChildDeviceWrapper> getAllChildDevices()</code>

:;Parameters
::None

:;Returns
::List<ChildDeviceWrapper>

===<code>getChildDevice</code>===
:Gets a specific child device with the device network id specified.

:;Signature
:: <code>ChildDeviceWrapper getChildDevice(String deviceNetworkId)</code>

:;Parameters
::deviceNetworkId - The unique identifier for the device

:;Returns
::ChildDeviceWrapper

===<code>deleteChildDevice</code>===
:Deletes a specific child device with the device network id sepcified.

:;Signature
:: <code>void deleteChildDevice(String deviceNetworkId)</code>

:;Parameters
::deviceNetworkId - The unique identifier for the device

:;Returns
::None

==User Defined Methods==
===<code>installed</code>===
:This method is called when the app is first installed.

:;Signature
:: <code>void installed()</code>

===<code>updated</code>===
:This method is called when the preferences of an installed app are updated.

:;Signature
:: <code>void updated()</code>

===<code>uninstalled</code>===
:This method is called when the app is uninstalled. This method can be used to do any cleanup that is necessary.

:;Signature
:: <code>void uninstalled()</code>

== <code>Additional to be documented</code> ==
Map getState()
String getApiServerUrl()
String getFullApiServerUrl()
String apiServerUrl(String url)
String getLocalApiServerUrl()
String getFullLocalApiServerUrl()
String localApiServerUrl(String url)
String fullLocalApiServerUrl(String url)
void setLocationMode(String mode)
void pause(Long millisecs)
InstalledAppWrapper getParent()
InstalledAppWrapper addChildApp(String namespace, String name, String label, Map properties = null)
void deleteChildApp(Long childAppId)
DeviceWrapper getSubscribedDeviceById(Long deviceId)
void sendEvent(Map properties)
void sendEvent(DeviceWrapper device, Map properties)
void sendEvent(String dni, Map properties)
List<Event> getLocationEventsSince(String attributeName, Date startDate, Map options = null)
void subscribe(Object thing, String attributeName, handlerMethod, Map options = null)
void subscribe(location, handlerMethod)
List<InstalledApp> getAllChildApps()
List<InstalledApp> getChildApps()
InstalledAppWrapper getChildAppById(Long childAppId)
InstalledAppWrapper getChildAppByLabel(String childAppLabel)

Common Methods Object

2020-03-31T14:44:19Z

Dman2306: Added TTS methods

These methods can be used in both Apps and Drivers

===<code>getLocation</code>===
:;Signature
:: <code>Location getLocation()</code>

===<code>getSunriseAndSunset</code>===
:Returns the sunset and sunrise values for the current day. (Common method since 2.1.0)

:;Signature
:: <code>Map getSunriseAndSunset()</code>
:: <code>Map getSunriseAndSunset(Map options)</code>

:;Parameters
:: options - Map with optional offset for sunrise or sunset, possible values are sunriseOffset and sunsetOffset and can either be a number of minutes or a String of the format Hours:Minutes

:;Returns
:: Map with with key values 'sunrise' and 'sunset' of type Date

:;Examples

// get today's sunrise and sunset
def riseAndSet = getSunriseAndSunset()
log.debug riseAndSet.sunrise
log.debug riseAndSet.sunset

// get sunrise time offset by 1 minute early, and get sunset offset by 1 hour, 5 minutes later
def offsetRiseAndSet = getSunriseAndSunset(sunriseOffset: -1, sunsetOffset: "1:05")

===<code>getTemperatureScale</code>===
:Get the current temperature scale set for the hub.

:;Signature
:: <code>String getTemperatureScale()</code>

:;Parameters
:: none

:;Returns
:: String - "F" or "C" based on the setting in the hub.

===<code>now</code>===
:;Signature
:: long now()

===<code>timeToday</code>===
: Get a Date object with today's date and the time specified

:;Signature
:: <code>Date timeToday(String timeString, TimeZone timeZone = null)</code>

:;Parameters
:: timeString - The time to use, can be either "HH:mm" or and ISO8601 date/time string
:: timeZone - (Optional) The timezone to use for the new Date.

:;Returns
:: Date - A Date object with today's date and the time that was passed as timeString

===<code>timeOfDayIsBetween</code>===
:Check if a date is between two dates.

:;Signature
:: <code>boolean timeOfDayIsBetween(Date start, Date stop, Date value[, TimeZone timeZone])</code>

:;Parameters

:: start - The date to start comparison against.
:: stop - The date to stop comparison against.
:: value - The date to compare
:: timezone - (Optional) The timezone to use for the comparison

:;Returns
:: boolean - true if the value date is between the start and stop dates, otherwise returns false.

===<code>unschedule</code>===
:Remove any scheduled tasks. If method is called without paramters, all schedules will be removed.

:;Signature
:: <code>void unschedule()</code>
:: <code>void unschedule(handlerMethod)</code>

:;Parameters
:: handlerMethod - Only remove schedules for this handlerMethod

===<code>asynchttpGet</code>===
:Send an http GET request and return control to the calling code. Any response from the call will be passed to the callback method.

:;Signature
:: <code>void asynchttpGet(callbackMethod, Map params, Map data = null)</code>

:;Parameters
:: callbackMethod - The name of a callback method to send the response to. Can be null if the response can be ignored.
:: params - the parameters to use to build the http GET call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::data - optional data to be passed to the callback method.

===<code>asynchttpPost</code>===
:;Signature
::<code>void asynchttpPost(String callbackMethod = null, Map params, Map data = null)</code>

:;Parameters
::callbackMethod - The name of a callback method to send the response to. Can be null if the response can be ignored.
::params - the parameters to use to build the http GET call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::data - optional data to be passed to the callback method.

===<code>asynchttpPatch</code>===
:;Signature
::<code>void asynchttpPatch(String callbackMethod = null, Map params, Map data = null)</code>

:;Parameters
::callbackMethod - The name of a callback method to send the response to. Can be null if the response can be ignored.
::params - the parameters to use to build the http PATCH call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::data - optional data to be passed to the callback method.

===<code>httpGet</code>===
:Send an http GET request. Any response from the call will be passed to the closure.

:;Signature
:: <code>void httpGet(String uri, Closure closure)</code>
:: <code>void httpGet(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::params - the parameters to use to build the http GET call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''textParser'' (since 2.1.1) - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>httpPost</code>===
:;Signature
:: <code>void httpPost(String uri, String body, Closure closure)</code>
:: <code>void httpPost(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::body - The body of the request as a String. Any encoding should be done before passing to the system.
::params - the parameters to use to build the http call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''textParser'' (since 2.1.1) - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>httpPostJson</code>===
:Similar to httpPost except that the contentType parameter is set to "application/json"
:;Signature
:: <code>void httpPostJson(String uri, String stringBody, Closure closure)</code>
:: <code>void httpPostJson(String uri, Map mapBody, Closure closure)</code>
:: <code>void httpPostJson(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::stringBody - The body of the request as a String. Any encoding should be done before passing to the system.
::mapBody - The body of the request as a Map.
::params - the parameters to use to build the http call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it as JSON.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''textParser'' (since 2.1.8) - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>httpPut</code>===
:;Signature
:: <code>void httpPut(String uri, String body, Closure closure)</code>
:: <code>void httpPut(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::body - The body of the request as a String. Any encoding should be done before passing to the system.
::params - the parameters to use to build the http call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' (since 2.0.9) - timeout in seconds for the request, max timeout is 300
:::''textParser'' (since 2.1.1) - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>httpPatch (Since 2.1.7)</code>===
:;Signature
:: <code>void httpPatch(String uri, String body, Closure closure)</code>
:: <code>void httpPatch(Map params, Closure closure)</code>

:;Parameters
::uri - The full uri to send the request to.
::body - The body of the request as a String. Any encoding should be done before passing to the system.
::params - the parameters to use to build the http call. Possible values:
:::''uri'' - The uri to send the request to
:::''queryString'' - The raw, already-escaped query string.
:::''query'' - Add these parameters to the existing query string. If any of the parameters already exist in the query, these values will not replace them. Multiple values for the same query parameter may be added by putting them in a list.
:::''headers'' - Request headers
:::''path'' - The path component of this request. The value may be absolute or relative to the current path.
:::''contentType'' - The content-type used for any data in the request body, as well as the <code>Accept</code> content-type that will be used for parsing the response.
:::''requestContentType'' - Assign a different content-type for the request than is expected for the response.
:::''body'' - The request body. If this is a Map or Array, the system will take care of encoding it based on the requestContentType.
:::''timeout'' - timeout in seconds for the request, max timeout is 300
:::''textParser'' - possible values: true, false. If set to true, the response will be parsed as plain text, if false the system will attempt to determine the content type and parse the response into an object. Defaults to false.
:::''ignoreSSLIssues'' (since 2.1.8) - possible values: true, false. Ignores certificate issues for SSL connections. Cert does not have to be from a trusted authority and the hostname does not need to be verified. This is primarily for dev situations that make use of localhost, build, and test servers. Defaults to false.
::closure - code to handle a successful HTTP response. an object of type HttpResponseDecorator is passed to this code.

===<code>runIn</code>===
:;Signature
::<code>void runIn(Long delayInSeconds, String handlerMethod, Map options = null)</code>

:;Parameters
::delayInSeconds - How long to wait in seconds until the handler should be called, don't expect that it will be called in exactly that time.
::handlerMethod - The name of a handler method in your driver or app. The method name should not contain parentheses.
::options - Optional values to control the scheduling of this method
:::''overwrite'' - defaults to true which cancels the previous scheduled running of the handler method and schedules new, if set to false this will create a duplicate schedule.
:::''data'' - optional data to be passed to the handler method.
:::''misfire'' - If set to "ignore" then the scheduler will simply try to fire it as soon as it can. NOTE: if a scheduler uses this instruction, and it has missed several of its scheduled firings, then several rapid firings may occur as the scheduler attempts to catch back up to where it would have been.

:;Example:
<pre>
runIn(50, 'myMethod', [data: ["myKey":"myValue"]])
</pre>

===<code>runInMillis</code>===
:;Signature
:: <code>void runInMillis(Long delayInMilliSeconds, String handlerMethod, Map options = null)</code>

:;Parameters
:: delayInMilliseconds - How long to wait until the handler should be called, don't expect that it will be called in exactly that time.
:: handlerMethod - the name of a handler method in your driver or app. The method name should not contain parentheses.
::options - Optional values to control the scheduling of this method
:::''overwrite'' - defaults to true which cancels the previous scheduled running of the handler method and schedules new, if set to false this will create a duplicate schedule.
:::''data'' - optional data to be passed to the handler method.
:::''misfire'' - If set to "ignore" then the scheduler will simply try to fire it as soon as it can. NOTE: if a schduler uses this instruction, and it has missed several of its scheduled firings, then several rapid firings may occur as the scheduler attempts to catch back up to where it would have been.

:;Example:
<pre>
private processQueue(Map queue) {
if (isQueueEmpty(queue)) {
sendEvent name: 'lifxdiscovery', value: 'complete'
return
}
def data = getNext(queue)
sendPacket data.ipAddress, data.packet
runInMillis(queue.delay, 'processQueue', [data: queue])
}

runInMillis(50, 'processQueue', [data: queue])
</pre>

===<code>pauseExecution</code>===
:;Signature
:: <code> void pauseExecution(Long millisecs)</code>

:;Parameters
:: millisecs - The amount of time in milliseconds to pause.

===<code>textToSpeech</code>===
:Converts text to speech.

:;Signature
:: <code> Map textToSpeech(String stringToBeSynthesized, String voice = null)</code>

:;Parameters
::stringToBeSynthesized - The text to be converted to audio. The text may contain supported [https://docs.aws.amazon.com/polly/latest/dg/supportedtags.html SSML tags].
::voice - The name of a voice supported by Amazon Polly, you can find a list of voices [https://docs.aws.amazon.com/polly/latest/dg/voicelist.html here]. If not specified the default system setting is used.

:;Returns
:: Map - Returns a Map with two entries, <code>uri</code> which contains a URI to the MP3 file and <code>duration</code> is the length of the MP3 in seconds.

===<code>getTTSVoices</code>===
:Returns a list of the supported text-to-speech voices.

:;Signature
:: <code> Map getTTSVoices()</code>

:;Parameters
::None

:;Returns
:: Map - Returns a Map with three entries <code>name</code> which is the name of a voice that can be specified to <code>textToSpeech</code>, <code>gender</code> which contains either Male or Female, and <code>language</code> which contains the language of this voice.

===<code>toDateTime</code>===
:;Signature
:: <code>Date toDateTime(String dateTimeString)</code>

:;Parameters
::dateTimeString - A date/time string in ISO8601 format. ("yyyy-MM-dd", "yyyyMMdd'T'HHmmssX", "yyyy-MM-dd'T'HH:mm:ssX", "yyyy-MM-dd'T'HH:mm:ss.SSSX")

==<code>Additional to be documented</code>==

'''Signature:'''
BigDecimal celsiusToFahrenheit(BigDecimal val)
BigDecimal fahrenheitToCelsius(BigDecimal val)
void httpPutJson(String uri, String body, Closure closure)
void httpPutJson(String uri, Map body, Closure closure)
void httpPutJson(Map params, Closure closure)
void httpDelete(Map params, Closure closure)
String getMACFromIP(String ipAddr)
String convertTemperatureIfNeeded(BigDecimal value, String scale, Integer precision)
Object parseJson(String stringToParse)
GPathResult parseXML(String stringToParse)
Map parseLanMessage(String stringToParse)
void runEvery1Minute(String handlerMethod, Map options = null)
void runEvery5Minutes(String handlerMethod, Map options = null)
void runEvery10Minutes(String handlerMethod, Map options = null)
void runEvery15Minutes(String handlerMethod, Map options = null)
void runEvery30Minutes(String handlerMethod, Map options = null)
void runEvery1Hour(String handlerMethod, Map options = null)
void runEvery3Hours(String handlerMethod, Map options = null)
void runOnce(Date dateTime, String handlerMethod, Map options = null)
void runOnce(String dateTime, String handlerMethod, Map options = null)
void schedule(Date dateTime, String handlerMethod, Map options = null)
void schedule(String expression, String handlerMethod, Map options = null)
void asynchttpPut(String callbackMethod = null, Map params, Map data = null)
void asynchttpDelete(String callbackMethod = null, Map params, Map data = null)
void asynchttpHead(String callbackMethod = null, Map params, Map data = null)
String encrypt(String value)
String decrypt(String value)
void sendLocationEvent(Map properties)
Date timeTodayAfter(String startTimeString, String timeString, TimeZone timeZone = null) (Common method since 2.1.0)
Long timeOffset(Number minutes) (Common method since 2.1.0)
Long timeOffset(String hoursAndMinutesString) (Common method since 2.1.0)

InstalledApp Object

2020-03-30T18:35:40Z

Dman2306: Added getInstallationState and standardized formatting.

===<code>getInstallationState</code>===
:Returns a value indicating whether the app is currently installed or, if you are in the initial setup, that it is not.

:;Signature
:: <code>String getInstallationState()</code>

:;Parameters
::None

:;Returns
::<code>COMPLETE</code> if the app is installed, otherwise <code>INCOMPLETE</code>.

== <code>getLabel</code> ==
:Get the current label of the installed app.

:;Signature
:: <code>String getLabel()</code>

:;Parameters
::None

:;Returns
::The current label of the installed app

:;Example
::<code> def appLabel = app.getLabel()
log.debug "app label is ${appLabel}"</code>

=== <code>updateLabel</code> ===
:Update the label of the installed app

:;Signature
::void updateLabel(String label)

:;Parameters
::label - new label for installed app

:;Returns
::None

== <code>Additional Methods to Document</code> ==
void updateSetting(String name, Map options)
void updateSetting(String name, Long value)
void updateSetting(String name, Boolean value)
void updateSetting(String name, String value)
void updateSetting(String name, Double value)
void updateSetting(String name, Date value)
void updateSetting(String name, List value)
void removeSetting(String name)
void clearSetting(String name)
Long getId()
Long getName()
List<EventSubscriptionWrapper> getSubscriptions()

App Object

2020-03-30T18:19:20Z

Dman2306: Added createAccessToken

==Provided Methods==
===<code>createAccessToken</code>===
:Creates an OAuth access token that can be used as part of the OAuth functionality of a properly configured app. The function will return the token, but will also automatically set the state variable <code>state.accessToken</code> to the return value. This value can then be passed to any API Endpoint (for example those defined in the <code>mappings</code> section of an app) using a query string parameter called <code>access_token</code>.

:;Signature
:: <code>String createAccessToken()</code>

:;Parameters
::None

:;Returns
::The OAuth access token.

===<code>getApiServerUrl</code>===
:Returns the base URL of the Hubitat cloud API.

:;Signature
:: <code>String getApiServerUrl()</code>

:;Parameters
::None

:;Returns
::The base URL of the Hubitat cloud API, generally https://cloud.hubitat.com/api

===<code>subscribe</code>===
:Subscribe to events sent from a device, app or location.

:;Signature
:: <code>void subscribe(InstalledAppWrapper app, handlerMethod)</code>
:: <code>void subscribe(Location location, handlerMethod)</code>
:: <code>void subscribe(DeviceWrapper device, String attributeName, handlerMethod, Map options = null)</code>
:: <code>void subscribe(DeviceWrapperList devices, String attributeName, handlerMethod, Map options = null)</code>
:: <code>void subscribe(Location location, String attributeName, handlerMethod, Map options = null)</code>

:;Parameters
::app - Installed App to subscribe to.
::location - Location to subscribe to.
::device - Device to subscribe to.
::handlerMethod - The method to run when an event is received.
::attributeName - The name of the attribute to subscribe to.
::options - Optional values to configure the subscribe. Possible values:
:::''filterEvents'' - Used for device subscriptions. Set to false to receive all events, defaults to true and events that do not have a changed value will not be processed.

===<code>unsubscribe</code>===
:Unsubscribe from events sent from a device or all event subscriptions.

:;Signature
:: <code>void unsubscribe()</code>
:: <code>void unsubscribe(DeviceWrapper device)</code>
:: <code>void unsubscribe(List<DeviceWrapper> deviceList)</code>
:: <code>void unsubscribe(DeviceWrapper device, String attributeName)</code> (Since 2.0.7)
:: <code>void unsubscribe(List<DeviceWrapper> deviceList, String attributeName)</code> (Since 2.1.0)
:: <code>void unsubscribe(DeviceWrapper device, String attributeName, String handlerMethod)</code> (Since 2.1.0)
:: <code>void unsubscribe(List<DeviceWrapper> deviceList, String attributeName, String handlerMethod)</code> (Since 2.1.0)
:: <code>void unsubscribe(InstalledAppWrapper installedApp)</code> (Since 2.1.2)
:: <code>void unsubscribe(Location location)</code> (Since 2.1.2)
:: <code>void unsubscribe(Location location, String attributeName)</code> (Since 2.1.2)
:: <code>void unsubscribe(String handlerMethod)</code> (Since 2.1.2)

:;Parameters
::device - The device to unsubscribe from.
::deviceList - A list of devices to unsubscribe from.
::attributeName - which attribute you want to unsubscribe from.
::handlerMethod - The name of a method which was subscribed to a device event.
::location - The location to unsubscribe from.
::installedApp - The installed app to unsubscribe from.

:;Returns
::None

===<code>addChildDevice</code>===
:Creates a new child device and returns that device from the method call.

:;Signature
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId)</code> (since 2.1.9)
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Map properties)</code> (since 2.1.9)
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Long hubId)</code> (deprecated)
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Long hubId, Map properties)</code> (deprecated)

:;Parameters
::namespace - The namespace of the child driver to add as a child device (optional, if not specified it will default the the namespace of the parent)
::typeName - The name of the child driver to add as a child device
::deviceNetworkId - unique identifier for this device
::hubId - present for backwards compatibility, pass 1.
::properties - optional parameters for this child device. Possible values listed below

:;Properties
::boolean isComponent - true or false, if true, device will still show up in device list but will not be able to be deleted or edited in the UI. If false, device can be modified/deleted on the UI.
::String name - name of child device, if not specified, driver name is used.
::String label - label of child device, if not specified it is left blank.

:;Returns
::ChildDeviceWrapper

===<code>getChildDevices</code>===
:Gets a list of all child devices for this device.

:;Signature
:: <code>List<ChildDeviceWrapper> getChildDevices()</code>
:: <code>List<ChildDeviceWrapper> getAllChildDevices()</code>

:;Parameters
::None

:;Returns
::List<ChildDeviceWrapper>

===<code>getChildDevice</code>===
:Gets a specific child device with the device network id specified.

:;Signature
:: <code>ChildDeviceWrapper getChildDevice(String deviceNetworkId)</code>

:;Parameters
::deviceNetworkId - The unique identifier for the device

:;Returns
::ChildDeviceWrapper

===<code>deleteChildDevice</code>===
:Deletes a specific child device with the device network id sepcified.

:;Signature
:: <code>void deleteChildDevice(String deviceNetworkId)</code>

:;Parameters
::deviceNetworkId - The unique identifier for the device

:;Returns
::None

==User Defined Methods==
===<code>installed</code>===
:This method is called when the app is first installed.

:;Signature
:: <code>void installed()</code>

===<code>updated</code>===
:This method is called when the preferences of an installed app are updated.

:;Signature
:: <code>void updated()</code>

===<code>uninstalled</code>===
:This method is called when the app is uninstalled. This method can be used to do any cleanup that is necessary.

:;Signature
:: <code>void uninstalled()</code>

== <code>Additional to be documented</code> ==
Map getState()
String getHubUID()
String getApiServerUrl()
String getFullApiServerUrl()
String apiServerUrl(String url)
String getLocalApiServerUrl()
String getFullLocalApiServerUrl()
String localApiServerUrl(String url)
String fullLocalApiServerUrl(String url)
void setLocationMode(String mode)
String createAccessToken()
void pause(Long millisecs)
InstalledAppWrapper getParent()
InstalledAppWrapper addChildApp(String namespace, String name, String label, Map properties = null)
void deleteChildApp(Long childAppId)
DeviceWrapper getSubscribedDeviceById(Long deviceId)
void sendEvent(Map properties)
void sendEvent(DeviceWrapper device, Map properties)
void sendEvent(String dni, Map properties)
List<Event> getLocationEventsSince(String attributeName, Date startDate, Map options = null)
void subscribe(Object thing, String attributeName, handlerMethod, Map options = null)
void subscribe(location, handlerMethod)
List<InstalledApp> getAllChildApps()
List<InstalledApp> getChildApps()
InstalledAppWrapper getChildAppById(Long childAppId)
InstalledAppWrapper getChildAppByLabel(String childAppLabel)

App Object

2019-11-24T18:28:05Z

Dman2306: Added documentation for getApiServerUrl

==Provided Methods==
===<code>getApiServerUrl</code>===
:Returns the base URL of the Hubitat cloud API.

:;Signature
:: <code>String getApiServerUrl()</code>

:;Parameters
::None

:;Returns
::The base URL of the Hubitat cloud API, generally https://cloud.hubitat.com/api

===<code>subscribe</code>===
:Subscribe to events sent from a device, app or location.

:;Signature
:: <code>void subscribe(Object thing, handlerMethod)</code>
:: <code>void subscribe(Object thing, String attributeName, handlerMethod, Map options = null)</code>

:;Parameters
::thing - The device, installed app or location to subscribe to.
::handlerMethod - The method to run when an event is received.
::attributeName - The name of the attribute to subscribe to.
::options - Optional values to configure the subscribe. Possible values:
:::''filterEvents'' - Used for device subscriptions. Set to false to receive all events, defaults to true and events that do not have a changed value will not be processed.

===<code>unsubscribe</code>===
:Unsubscribe from events sent from a device or all event subscriptions.

:;Signature
:: <code>void unsubscribe()</code>
:: <code>void unsubscribe(DeviceWrapper device)</code>
:: <code>void unsubscribe(List<DeviceWrapper> deviceList)</code>
:: <code>void unsubscribe(DeviceWrapper device, String attributeName)</code> (Since 2.0.7)
:: <code>void unsubscribe(List<DeviceWrapper> deviceList, String attributeName)</code> (Since 2.1.0)
:: <code>void unsubscribe(DeviceWrapper device, String attributeName, String handlerMethod)</code> (Since 2.1.0)
:: <code>void unsubscribe(List<DeviceWrapper> deviceList, String attributeName, String handlerMethod)</code> (Since 2.1.0)
:: <code>void unsubscribe(InstalledAppWrapper installedApp)</code> (Since 2.1.2)
:: <code>void unsubscribe(Location location)</code> (Since 2.1.2)
:: <code>void unsubscribe(Location location, String attributeName)</code> (Since 2.1.2)
:: <code>void unsubscribe(String handlerMethod)</code> (Since 2.1.2)

:;Parameters
::device - The device to unsubscribe from.
::deviceList - A list of devices to unsubscribe from.
::attributeName - which attribute you want to unsubscribe from.
::handlerMethod - The name of a method which was subscribed to a device event.
::location - The location to unsubscribe from.
::installedApp - The installed app to unsubscribe from.

:;Returns
::None

===<code>addChildDevice</code>===
:Creates a new child device and returns that device from the method call.

:;Signature
:: <code>ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Map properties = [:])</code>

:;Parameters
::namespace - The namespace of the child driver to add as a child device (optional, if not specified it will default the the namespace of the parent)
::typeName - The name of the child driver to add as a child device
::deviceNetworkId - unique identifier for this device
::properties - optional parameters for this child device. Possible values listed below

:;Properties
::boolean isComponent - true or false, if true, device will still show up in device list but will not be able to be deleted or edited in the UI. If false, device can be modified/deleted on the UI.
::String name - name of child device, if not specified, driver name is used.
::String label - label of child device, if not specified it is left blank.

:;Returns
::ChildDeviceWrapper

===<code>getChildDevices</code>===
:Gets a list of all child devices for this device.

:;Signature
:: <code>List<ChildDeviceWrapper> getChildDevices()</code>
:: <code>List<ChildDeviceWrapper> getAllChildDevices()</code>

:;Parameters
::None

:;Returns
::List<ChildDeviceWrapper>

===<code>getChildDevice</code>===
:Gets a specific child device with the device network id specified.

:;Signature
:: <code>ChildDeviceWrapper getChildDevice(String deviceNetworkId)</code>

:;Parameters
::deviceNetworkId - The unique identifier for the device

:;Returns
::ChildDeviceWrapper

===<code>deleteChildDevice</code>===
:Deletes a specific child device with the device network id sepcified.

:;Signature
:: <code>void deleteChildDevice(String deviceNetworkId)</code>

:;Parameters
::deviceNetworkId - The unique identifier for the device

:;Returns
::None

==User Defined Methods==
===<code>installed</code>===
:This method is called when the app is first installed.

:;Signature
:: <code>void installed()</code>

===<code>updated</code>===
:This method is called when the preferences of an installed app are updated.

:;Signature
:: <code>void updated()</code>

===<code>uninstalled</code>===
:This method is called when the app is uninstalled. This method can be used to do any cleanup that is necessary.

:;Signature
:: <code>void uninstalled()</code>

== <code>Additional to be documented</code> ==
Map getState()
String getHubUID()
String getApiServerUrl()
String getFullApiServerUrl()
String apiServerUrl(String url)
String getLocalApiServerUrl()
String getFullLocalApiServerUrl()
String localApiServerUrl(String url)
String fullLocalApiServerUrl(String url)
void setLocationMode(String mode)
String createAccessToken()
void pause(Long millisecs)
InstalledAppWrapper getParent()
InstalledAppWrapper addChildApp(String namespace, String name, String label, Map properties = null)
void deleteChildApp(Long childAppId)
DeviceWrapper getSubscribedDeviceById(Long deviceId)
void sendEvent(Map properties)
void sendEvent(DeviceWrapper device, Map properties)
void sendEvent(String dni, Map properties)
List<Event> getLocationEventsSince(String attributeName, Date startDate, Map options = null)
void subscribe(Object thing, String attributeName, handlerMethod, Map options = null)
void subscribe(Object thing, handlerMethod)
List<InstalledApp> getAllChildApps()
List<InstalledApp> getChildApps()
InstalledAppWrapper getChildAppById(Long childAppId)
InstalledAppWrapper getChildAppByLabel(String childAppLabel)